v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB

webhooks

Verify webhook

Send a test event in order to verify your webhook endpoint, it needs to respond with HTTP 200 to be verified. Webhook needs to be verified before it will receive identification events.

post/webhooks/{id}/verification

Path parameters

idstring required

Webhook ID

Headers

X-API-Versionstring required

Management API version.

Response

Webhook verification process initiated. Make sure webhook is active in order to receive identification events.

environmentobject nullable required

Environment ID this webhook is associated with. Null if global.

Example response

{
  "data": {
    "id": "wh_HYv9YfsIIUjpvR",
    "description": "My Webhook",
    "url": "https://website.com/webhook"
  }
}