Skip to main content
This section covers all webhook events related to tags, including tag updates and deletions.

Event Types

The following tag-related events are available:
  • tags.updated - Triggered when a tag is updated
  • tags.deleted - Triggered when a tag is deleted

Tag Updated Event

The tags.updated event is triggered when a tag is created or modified.

Event Structure

{
  "event_type": "tags.updated",
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "key": "tag-key",
    "name": "Tag Name",
    "translations": {
      "name": [
        {
          "country_code": "us",
          "value": "Tag Name"
        },
        {
          "country_code": "es",
          "value": "Nombre de Etiqueta"
        }
      ]
    },
    "filterable": false,
    "attributes": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174001",
        "name": "Color",
        "description": "Color attribute",
        "key": "color",
        "template_key": "color_template",
        "values": {
          "color": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174002",
              "key": "red",
              "type": "color",
              "value": "Red",
              "translations": {
                "value": [
                  {
                    "country_code": "us",
                    "value": "Red"
                  },
                  {
                    "country_code": "es",
                    "value": "Rojo"
                  }
                ]
              }
            }
          ]
        },
        "translations": {
          "name": [
            {
              "country_code": "us",
              "value": "Color"
            },
            {
              "country_code": "es",
              "value": "Color"
            }
          ],
          "description": [
            {
              "country_code": "us",
              "value": "Color attribute"
            },
            {
              "country_code": "es",
              "value": "Atributo de color"
            }
          ]
        },
        "filterable": true,
        "translatable": true,
        "created_at": "2024-02-12T12:00:00Z",
        "updated_at": "2024-02-12T12:00:00Z"
      }
    ],
    "created_at": "2024-02-12T12:00:00Z",
    "updated_at": "2024-02-12T12:00:00Z",
    "status": "active"
  }
}

Field Descriptions

FieldTypeDescription
idstringUnique identifier for the tag
keystringUnique key identifier for the tag
namestringDisplay name of the tag
translationsobjectLocalized content for the tag
filterablebooleanWhether the tag can be used for filtering
attributesarrayAssociated attributes for the tag
created_atstringCreation timestamp
updated_atstringLast update timestamp
statusstringTag status (active, inactive)

Tag Deleted Event

The tags.deleted event is triggered when a tag is removed from the system.

Event Structure

{
  "event_type": "tags.deleted",
  "payload": {
    "tag_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Field Descriptions

FieldTypeDescription
tag_idstringUnique identifier of the deleted tag