Item Added To Category

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an item is added to a category.

Permissions
Read categories
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Read v3 catalog
Manage v3 catalog
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.categories.v1.category.

slugstring

Event name. Expected item_added_to_category.

entityIdstring

ID of the entity associated with the event.

eventTimestringformat date-time

Event timestamp.

triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring

If present, indicates the action that triggered the event.

actionEventActionEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{
  "data": {
    "eventType": "wix.categories.v1.category_item_added_to_category",
    "instanceId": "<app-instance-id>",
    "data": "<stringified-JSON>",
    // The identity field is sent as a stringified JSON
    "identity": {
      "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
      "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
      "memberId": "<memberId>", // in case of MEMBER
      "wixUserId": "<wixUserId>", // in case of WIX_USER
      "appId": "<appId>" // in case of APP
    }
  }
}

ItemAddedToCategory
JSON
{
  "id": "8b764e0b-c8da-4da7-b1af-2297b6db859f",
  "entityFqdn": "wix.categories.v1.category",
  "slug": "item_added_to_category",
  "entityId": "05f9cc2f-b5df-4287-aa32-3314179192b8",
  "actionEvent": {
    "bodyAsJson": {
      "categoryId": "05f9cc2f-b5df-4287-aa32-3314179192b8",
      "addedItem": {
        "catalogItemId": "babd2bcc-ea03-4b63-8053-0ec59c73fc36",
        "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e"
      },
      "treeReference": {
        "appNamespace": "@wix/stores"
      }
    }
  },
  "eventTime": "2024-06-27T09:23:55.967722889Z",
  "triggeredByAnonymizeRequest": false
}
Did this help?