Client Identifier webhook

The Client Identifier 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_CLIENT_IDENTIFIER

Supported events:

  • CREATE
  • UPDATE
  • DELETE

Summary

Webhook for identity related arbitrary client identifiers

Description

The client identifier concept allows association of arbitrary identifiers with an identity. This concept is very helpful when creating references across domains e.g. the Xero account ID to be combined with the HubSpot customer ID. The client identifier can also be used for other information like web sessions for attribution of experiences as identities don't need to include personal information and can be anonymous, only holding an arbitrary nonce for identification.

Listen to client identifier associations to trigger joining data sets or enhancing experiences.

Note that client identifiers are intended for short form identification material. For longer information sets use the identity's content entity, for example to store a author biography.

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_CLIENT_IDENTIFIER",
    "event" : "CREATE",
    "targetUrn" : "fdcb0191-8408-4132-abf7-57adeafe59e2"
  },
  "subscription" : {
    "urn" : "691be1de-09df-411d-ad4a-3cc7ec771cd4",
    "subject" : "IDENTITY_CLIENT_IDENTIFIER",
    "event" : "ALL",
    "destinationUrl" : "https://example.com/webhooks/clientidentifier",
    "auth" : "BEARER",
    "expirationTimestamp" : "2026-06-28T13:45:32",
    "eventsPerMinute" : 500
  },
  "v1" : {
    "urn" : "fdcb0191-8408-4132-abf7-57adeafe59e2",
    "url" : "/n/v1/clientidentifierfdcb0191-8408-4132-abf7-57adeafe59e2"
  }
}