v1

latestOpenAPI 3.1.02026-08-04127114.4 KB
Webhooks

User Tags Notification Webhook

Non-data-rich User Tags webhook. When user tag processing completes, you will receive a POST request containing a guid that you can use to fetch the user tags.

This webhook type (USER_TAGS_NOTIFICATION) sends only a notification with identifiers. You must fetch the actual tag data from the /users/tags/{guid} endpoint using the provided guid.

Use this webhook type when you prefer smaller webhook payloads and want to fetch results on-demand.

postWebhookuserTagsNotification

Headers

X-Webhook-Verificationstring

A SHA-256 HMAC signature of the webhook payload that can be used to verify the authenticity of the webhook.

Payload

guidstring
tenant_idstring

The ID of the tenant for the users included in this update, if they are from a tenant environment.

Example payload

{
  "guid": "3961c39e-e1c6-45ec-acd0-9a7793dabe02"
}

Response

Success