Merchants > API Reference > Callbacks > Tag Updates

Tag Updates

Tag update callbacks allow you to send a request to your internal system when a tag is added to or removed from a customer or supplier in the Ravelin dashboard. This allows you to keep your internal system in sync with Ravelin.

Callbacks are sent only for tag changes made manually in the Ravelin dashboard or by a rule. Sending customer or supplier tags through Ravelin API endpoints, as well as running bulk-tagging operations, does not trigger a callback.

To configure tag update callbacks, please contact us and provide us with your callback URL and an optional authorisation token.

To retrieve the current tags on a customer or supplier, or fetch the history of tag changes, see the Tag endpoint.

Callback format

Customer Tag Updates

Customer tag update callbacks are sent in the following format:

POST https://your-tag-update-callback-url.com HTTP/1.1
Authorization: token YOUR_AUTH_TOKEN_OPTIONAL
Content-Type: application/json; charset=utf-8

{
  "tags": [
    {
      "customerId" : "abc-123-ZYZ",
      "tagId": "t3",
      "tagName": "highroller",
      "action" : "TAG_ADDED",
      "timestamp" : "2006-04-30T12:00:00Z"
    },
    {
      "customerId" : "abc-123-ZYZ",
      "tagId": "t2",
      "tagName": "vip",
      "action" : "TAG_ADDED",
      "timestamp" : "2006-04-30T12:00:00Z"
    },
    {
      "customerId" : "abc-123-ZYZ",
      "tagId": "t1",
      "tagName": "staff",
      "action" : "TAG_REMOVED",
      "timestamp" : "2006-04-30T12:00:00Z"
    }
  ]
}

Show all

tags array

The list of customer tag updates.

Show definition

customerId string

The unique identifier of the customer.

tagId string

The ID of the tag.

tagName string

The name of the tag. Note: values may be served from cache and may not reflect the most recent changes.

action string

Whether the tag was added or removed.

One of: TAG_ADDED, or TAG_REMOVED.

timestamp string

The time at which the tag update occurred, as an RFC3339 timestamp string.

Supplier Tag Updates

Supplier tag update callbacks are sent in the following format:

POST https://your-tag-update-callback-url.com HTTP/1.1
Authorization: token YOUR_AUTH_TOKEN_OPTIONAL
Content-Type: application/json; charset=utf-8

{
  "tags": [
    {
      "supplierId" : "abc-123-ZYZ",
      "tagId": "t3",
      "tagName": "highroller",
      "action" : "TAG_ADDED",
      "timestamp" : "2006-04-30T12:00:00Z"
    },
    {
      "supplierId" : "abc-123-ZYZ",
      "tagId": "t2",
      "tagName": "vip",
      "action" : "TAG_ADDED",
      "timestamp" : "2006-04-30T12:00:00Z"
    },
    {
      "supplierId" : "abc-123-ZYZ",
      "tagId": "t1",
      "tagName": "staff",
      "action" : "TAG_REMOVED",
      "timestamp" : "2006-04-30T12:00:00Z"
    }
  ]
}