Sign in

v1

latestOpenAPI 3.1.02026-08-04127114.4 KB
Webhooks

User Tags Data-Rich Webhook

Data-rich User Tags webhook. When user tag processing completes, you will receive a POST request with a JSON payload containing the full user tags data directly in the payload.

This webhook type (USER_TAGS_DATA) sends the complete user tags results, including all created, deleted, and modified tags with their scores.

Use this webhook type when you want to receive user tag changes directly without needing to fetch them from a separate endpoint.

postWebhookuserTagsData

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

tenant_idstring

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

Example payload

{
  "userTags": {
    "created": [
      {
        "user_id": "409088",
        "user_tag_id": 61,
        "tag_name": "Home Improvement Loan"
      }
    ],
    "deleted": [
      {
        "user_id": "409088",
        "user_tag_id": 46,
        "tag_name": "Movie Goer"
      }
    ],
    "modified": [
      {
        "user_id": "409088",
        "user_tag_id": 46,
        "tag_name": "Movie Goer",
        "previous_value": 50,
        "new_value": 75,
        "delta": 25
      }
    ]
  }
}

Response

Success