v50

latestOpenAPI 3.0.0Proprietaryraw.githubusercontent.com2026-06-1841147599.2 KB

Webhooks

Test a webhook

Sends a test event to the specified webhook endpoint to verify connectivity.

post/v3/webhooks/{id}/test

Path parameters

idstring uuid required

Headers

Idempotency-Keystring

Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

event_typestring required

Example request

{
  "event_type": "message.sent",
  "sandbox": false
}

Response

Test completed

successboolean

Indicates whether the request was successful