Alladdin

Work in progress

Site en construction

الموقع قيد الإنشاء

Alladdin

Products Webhooks

Back to Webhooks →

3 events

Common headers

Every webhook request includes these headers:

x-alladdin-webhook-event string

Event name, e.g. invoice.create

x-alladdin-webhook-date string · ISO 8601

x-alladdin-webhook-signature string

HMAC-SHA256 signature with the sha256= prefix (see below)

x-alladdin-webhook-id string

Unique event identifier; use it as an idempotency key

x-alladdin-webhook-account-id string

Identifier of the Alladdin account that triggered the event

x-alladdin-webhook-version string

Webhook system version (e.g. v1)

product.create POST

Product Created

Sent when a new product is created in Alladdin.

Payload

object

Product data included in webhook payloads

id string

Product unique identifier

name string

Product name

description string | null

Product description

kind string

Product kind (simple, variants, lots, serial_numbers, pack)

sku string | null

Stock Keeping Unit code

barcode string | null

Barcode

price string | null

Sale price

cost string | null

Cost price

stock string

Available stock

variants[] object[]

Product variants

id string

Variant unique identifier

sku string | null

Stock Keeping Unit code

barcode string | null

Barcode

price string | null

Sale price

cost string | null

Cost price

stock string | null

Available stock

description string | null

Variant description

packItems[] object[]

Pack composition, present only for pack products

productId string

Identifier of the product included in the pack

variantId string | null

Identifier of the variant included in the pack, when the pack item is a variant

units string

Units of this product included in the pack

Example payload

json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "kind": "string",
  "sku": "string",
  "barcode": "string",
  "price": "string",
  "cost": "string",
  "stock": "string",
  "variants": [
    {
      "id": "string",
      "sku": "string",
      "barcode": "string",
      "price": "string",
      "cost": "string",
      "stock": "string",
      "description": "string"
    }
  ],
  "packItems": [
    {
      "productId": "string",
      "variantId": "string",
      "units": "string"
    }
  ]
}

product.update POST

Product Updated

Sent when an existing product is updated in Alladdin.

Payload

object

Product data included in webhook payloads

id string

Product unique identifier

name string

Product name

description string | null

Product description

kind string

Product kind (simple, variants, lots, serial_numbers, pack)

sku string | null

Stock Keeping Unit code

barcode string | null

Barcode

price string | null

Sale price

cost string | null

Cost price

stock string

Available stock

variants[] object[]

Product variants

id string

Variant unique identifier

sku string | null

Stock Keeping Unit code

barcode string | null

Barcode

price string | null

Sale price

cost string | null

Cost price

stock string | null

Available stock

description string | null

Variant description

packItems[] object[]

Pack composition, present only for pack products

productId string

Identifier of the product included in the pack

variantId string | null

Identifier of the variant included in the pack, when the pack item is a variant

units string

Units of this product included in the pack

Example payload

json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "kind": "string",
  "sku": "string",
  "barcode": "string",
  "price": "string",
  "cost": "string",
  "stock": "string",
  "variants": [
    {
      "id": "string",
      "sku": "string",
      "barcode": "string",
      "price": "string",
      "cost": "string",
      "stock": "string",
      "description": "string"
    }
  ],
  "packItems": [
    {
      "productId": "string",
      "variantId": "string",
      "units": "string"
    }
  ]
}

product.delete POST

Product Deleted

Sent when a product is deleted (moved to trash) in Alladdin.

Payload

object

Product data included in delete webhook payloads

id string

Product unique identifier

kind string

Product kind (simple, variants, lots, serialnumbers, pack)

deletedAt string

Deletion timestamp in ISO 8601 format

Example payload

json
{
  "id": "string",
  "kind": "string",
  "deletedAt": "string"
}