API reference · Watchlists and webhooks

Send a signed test event (webhook.ping) to a URL

POST/v1/webhooks/test

Try it with your accountOpens in your dashboard, filled in; you see the cost before it runs.

Use it to verify your endpoint and signature check (X-AdLib-Signature: t=,v1=<hex HMAC-SHA256 of "."> with your webhook secret). Slack and Discord webhook URLs get a readable message instead, unsigned. One attempt, no retries; the call waits up to 20 seconds and returns the result (status delivered or failed, with the receiver's HTTP status and error), else status pending. Only public http(s) addresses: localhost, private and link-local hosts get invalid_webhook_url. 200 with the result, 202 while still pending (look it up under /v1/webhooks/deliveries/{id}).

Example request

Shell
curl -X POST "https://api.adlibapi.com/v1/webhooks/test" \
  -H "X-API-Key: $ADLIB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://hooks.example.com/adlib"}'

Send your key in the X-API-Key header. Try it in the explorer.

Request body

urlrequired
string

Your endpoint (https recommended)

Response

delivery_idrequired
integer
–
errorrequired
string

Why it failed (connection error or the receiver's status)

response_statusrequired
integer

The receiver's HTTP status

statusrequired
string

One of pending, delivered, failed