POST/v3/live/webhooks/destinations

Create a webhook destination

Registers a new URL to receive outbound webhook events for the authenticated customer

Version: v3
Rate limit: Tier 4 · 10–500 rps by plan
Billing: No entitlement required · Create a webhook destination

Request body

eventTypesstring[]Optional
Events this destination receives. The published event types are person.enriched and person.contact.enriched. Unrecognized values are accepted but never deliver anything.
person.enrichedperson.contact.enriched
Enter adds a value · Backspace on empty removes the last
urlstringOptional
HTTPS destination the event is POSTed to. Must be an absolute URL with a host and no embedded credentials. A host that resolves to a private, loopback, link-local or other reserved address is rejected.

Headers: x-api-key Required · API key for authentication

Response

environmentstring
eventTypesstring[]
Events this destination receives: the registered list, de-duplicated and sorted. Only person.enriched and person.contact.enriched are delivered; any other value is kept but never delivers anything.
idinteger (int64)
isActiveboolean
urlstring
HTTPS destination events are POSTed to

Status codes

Response

Example

{
  "environment": "live",
  "eventTypes": [
    "person.enriched",
    "person.contact.enriched"
  ],
  "id": 42,
  "isActive": true,
  "url": "https://example.com/webhooks/aggknowledge"
}