Telephone webhook

The Telephone webhook is described below. Note that webhooks deliver only the event notification. The actual data must be read using the provided event details.

Webhook Subject: IDENTITY_TELEPHONE

Supported events:

• CREATE
• UPDATE
• DELETE

Summary

Webhook for events related to association of a telephone number with an identity.

Description

Listen to telephone number events in order to trigger experiences like updating contact information for a customer or phone number verification.

Example

Below is an example webhook payload (pretty printed):

{
  "trigger" : {
    "urn" : "6099cb4a-00a5-4e08-8a8d-c570254b5757",
    "owner" : {
      "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
      "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
    },
    "timestamp" : "2026-05-29T13:45:32",
    "subject" : "IDENTITY_TELEPHONE",
    "event" : "CREATE",
    "targetUrn" : "fdcb0191-8408-4132-abf7-57adeafe59e2"
  },
  "subscription" : {
    "urn" : "691be1de-09df-411d-ad4a-3cc7ec771cd4",
    "subject" : "IDENTITY_TELEPHONE",
    "event" : "ALL",
    "destinationUrl" : "https://example.com/webhooks/telephone",
    "auth" : "BEARER",
    "expirationTimestamp" : "2026-06-28T13:45:32",
    "eventsPerMinute" : 500
  },
  "v1" : {
    "urn" : "fdcb0191-8408-4132-abf7-57adeafe59e2",
    "url" : "/n/v1/telephone/fdcb0191-8408-4132-abf7-57adeafe59e2"
  }
}