webhooks

Create a webhook endpoint

post/v1/webhooks

Request

urlstring required

Where deliveries go: a public https address

topicsstring[] required

The topics to receive

include_piiboolean

Send contact details (identities, email and phone answers); needs profiles:read, and identity.captured needs it

descriptionstring nullable

Your own label for the endpoint, at most 200 characters

The existing endpoint with this URL and configuration, and its secret.

secretstring required

The signing secret (whsec_...); shown only here

{
  "endpoint": {
    "id": "whe_7c9e6679742540de944be07fc1f90ae7",
    "failing_since": "2026-09-01T12:00:00Z"
  }
}

No recorded changes to this operation across all 1 revision of this API.