Collection Created

Triggered when a collection is created.

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

collection_Idstring

Collection ID (generated automatically by the catalog).

namestring

Collection name.

mediaMedia

Media items (images, videos, etc.) associated with this collection.

slugstring

Collection slug

visibleboolean

Collection visible status

originatedFromVersionstring

Information about the version of the catalog from where this event was triggered.

Event Body

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

JSON


{
  "data": {
    "eventType": "com.wix.ecommerce.catalog.api.v1.CollectionCreated",
    "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
    }
  }
}

Sample Data Shown:Collection Created

JSON


{
  "collectionId": "1044e7e4-37d1-0705-c5b3-623baae212fd",
  "name": "My collection",
  "slug": "my-collection",
  "visible": true,
  "media": {
    "mainMedia": {
      "thumbnail": {
        "url": "https://static.wixstatic.com/media/bc001baa4397444f809fa5f147c28a9e.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
        "width": 50,
        "height": 50
      },
      "mediaType": "image",
      "title": "",
      "image": {
        "url": "https://static.wixstatic.com/media/bc001baa4397444f809fa5f147c28a9e.jpg/v1/fit/w_1920,h_1280,q_90/file.jpg",
        "width": 1920,
        "height": 1280
      },
      "id": ""
    },
    "items": [
      {
        "thumbnail": {
          "url": "https://static.wixstatic.com/media/bc001baa4397444f809fa5f147c28a9e.jpg/v1/fit/w_50,h_50,q_90/file.jpg",
          "width": 50,
          "height": 50
        },
        "mediaType": "image",
        "title": "",
        "image": {
          "url": "https://static.wixstatic.com/media/bc001baa4397444f809fa5f147c28a9e.jpg/v1/fit/w_1920,h_1280,q_90/file.jpg",
          "width": 1920,
          "height": 1280
        },
        "id": ""
      }
    ]
  }
}

Did this help?