Webhooks

Send a test event

POST/webhooks/{webhookId}/test

Sends a webhook this API subscribed a signed sample of any event (fictional people), or a test.ping, right away. The try shows in its delivery log. A failed test still answers 200, with sent: false and the answer the address gave.

Try itSend a real request with your API key

API key webhookId path Body JSON

This changes your workspace, as the same change in the app would. Your key stays in this page and goes only to Salesteam.

Path

webhookIdstringRequired
The webhook.

Headers

Idempotency-Keystring
Any unique value up to 255 characters, like a UUID. The request runs once; repeats within 24 hours get the first answer, with Idempotent-Replayed: true. Up to 255 characters.

Body optional

eventone of
The event to send a sample of. Without it (or null), a test.ping.
Inside it
One of these shapes:
Option 1: An event type
Option 2
Option 3

Answer

200 OK What happened.

dataWebhookTestResultRequired
Inside it
- sentbooleanRequired
- messagestringRequired
- deliveryDeliveryRequired
  Inside it
  - idstringRequired
  - destinationIdstringRequired
  - eventIdstringRequired
  - eventone ofRequired
    Inside it
    One of these shapes:
    Option 1: An event type
    Option 2
  - statusstringRequired
    One of queued, retrying, sent, failed.
  - attemptsintegerRequired
  - statusCodeinteger
    The answer the address gave.
  - errorstring
  - nextAttemptAtstring · date-time
  - createdAtstring · date-timeRequired
  - updatedAtstring · date-timeRequired

Errors

400 Bad requestinvalid_request invalid_json duplicate_in_request
401 Unauthorizedunauthorized
404 Not foundnot_found not_in_campaign
422 Can’t processidempotency_key_reused
429 Too many requestsrate_limited
500 Server errorserver_error

Every error has the same shape. See Errors.