Example Webhook Payload

The payload is delivered as a JSON object via a POST request.

Key Fields

• changeType: Can be INSERT or MODIFY.
• changeSource: Indicates the specific attribute set that triggered the update.

Possible values:

• Variant (General product attributes)
• Assets (Images/media)
• GroupName (Naming)
• Details (Extended product details)

classification is deprecated and retained for backward compatibility. Use strainType for new integrations.

The variant object below is an example shape. Depending on available source data, it may also include optional fields such as aromas, effects, topFlavor, flavors, helpsWith, appearance, growingConditions, energyScore, originCity, originState, craftDesignations, gradingResults, and tags.

{
  "partnerId": "PARTNER_ID",
  "companyId": "COMPANY_ID",
  "locationId": "LOCATION_ID|null",
  "changes": [
    {
      "variant": {
        "barcode": "00840773001480",
        "name": "Peach Ringz",
        "brand": "General Admission",
        "manufacturer": "Westleaf Labs",
        "description": "We brought vapes to the masses. ...",
        "shortDescription": "Sourced from quality whole-flower cultivars, ...",
        "delisted": false,
        "classification": "Sativa",
        "unitSize": 0.5,
        "unitOfMeasure": "g",
        "cannabisUnitOfMeasure": "%",
        "terpeneUnitOfMeasure": "",
        "packagedQuantity": 3,
        "productType": "Flower",
        "variantType": "Infused Pre-Roll",
        "strain": "Peach Ringz",
        "lineages": null,
        "thc": { "min": "36", "max": "42", "avg": "39" },
        "cbd": { "min": "0", "max": "2", "avg": "1" },
        "tac": null,
        "secondaryCannabinoids": null,
        "totalTerpene": null,
        "presentTerpenes": [
          "Alpha Pinene",
          "Beta Caryophyllene"
        ],
        "topTerpene": "Alpha Pinene",
        "assets": {
          "Product": [
            {
              "id": "00840773001473",
              "sizes": [
                {
                  "size": "small",
                  "url": "<url>"
                },
                {
                  "size": "large",
                  "url": "<url>"
                }
              ],
              "hash": "5045fb46375d9a7d47cbc5262d843dc6"
            }
          ]
        },
        "brandAssets": {
          "PrimaryBrand": [
            {
              "id": "dc79a3cc-0c68-4fef-bad7-09b86b72ca38",
              "sizes": [
                {
                  "size": "small",
                  "url": "<url>"
                },
                {
                  "size": "large",
                  "url": "<url>"
                }
              ],
              "hash": "bca38c50df0e9d75edf17de7fe931493"
            }
          ]
        },
        "catalogSource": {
          "assets": "BPD",
          "barcode": "BPD",
          "brand": "BPD",
          "brandAssets": "BPD",
          "cannabisUnitOfMeasure": "BPD",
          "cbd": "BPD",
          "classification": "BPD",
          "delisted": "BPD",
          "description": "BPD",
          "lineages": "BPD",
          "manufacturer": "BPD",
          "name": "BPD",
          "packagedQuantity": "BPD",
          "presentTerpenes": "BPD",
          "productType": "BPD",
          "secondaryCannabinoids": "BPD",
          "shortDescription": "BPD",
          "strain": "BPD",
          "tac": "BPD",
          "terpeneUnitOfMeasure": "BPD",
          "thc": "BPD",
          "topTerpene": "BPD",
          "totalTerpene": "BPD",
          "unitOfMeasure": "BPD",
          "unitSize": "BPD",
          "variantType": "BPD"
        },
        "companyId": "COMPANY_ID",
        "locationId": "LOCATION_ID|null"
      },
      "changeSource": "Variant",
      "changeType": "MODIFY",
      "timestamp": 1770852047
    }
  ]
}