Collections create

Webhookcollections/create

Triggered when a collection is created.

Requires the collection access scope. Minimum supported version: 202007.

Request headers

X-Shoplazza-Topicstring
The event that triggered this delivery, e.g. orders/create
Example: orders/create
X-Shoplazza-Hmac-Sha256string

Base64-encoded HMAC-SHA256 signature of the request body, generated with your app's Client Secret. Use it to verify the request comes from Shoplazza

X-Shoplazza-Shop-Domainstring
The domain of the store that generated the event
Example: example.myshoplaza.com
X-Shoplazza-Api-Versionstring
The API version used to serialize the payload
Example: 2025-06
X-Shoplazza-Deduplication-IDstring

Deduplication ID for this delivery. It stays the same across retries of the same event—use it for idempotency

Request body

Schema

• collection object

  idstring

  Collection ID

  titlestring

  Collection name

  handlestring

  Collection handle (a URL-friendly unique alias)

  descriptionstring

  Collection description

  MetaKeywordstring

  SEO keyword list

  meta_titlestring

  SEO title of the collection

  meta_descriptionstring

  SEO description of the collection

  sort_orderstring

  Sorting rule for products in the collection (see the create-collection API for possible values)

  urlstring

  Storefront collection detail page URL (excluding the store domain)

  created_atstring

  Time when the collection was created (ISO-8601 format)

  updated_atstring

  Time when the collection was last updated (ISO-8601 format)

  image object

  Collection cover image

  srcstring

  Image source URL

  pathstring

  Image path (excluding the domain; src includes the domain)

  widthinteger

  Image width in pixels

  heightinteger

  Image height in pixels

Example

{
  "collection": {
    "id": "string",
    "title": "string",
    "handle": "string",
    "description": "string",
    "MetaKeyword": "string",
    "meta_title": "string",
    "meta_description": "string",
    "sort_order": "string",
    "url": "string",
    "created_at": "string",
    "updated_at": "string",
    "image": {
      "src": "string",
      "path": "string",
      "width": 0,
      "height": 0
    }
  }
}