Skip to content

WebhookEnvelope ​

Type: schema

Description ​

Body of every webhook request. The HMAC-SHA256 signature in X-CE-Signature is computed over the raw request body with the webhook secret. Use event_id as the idempotency key: retries of the same event reuse it while delivery_id changes per attempt.

TypeScript Definition ​

typescript
WebhookEnvelope: {{
            /** @description Event name, e.g. `order.created`. Also sent as the `X-CE-Event` header. */
            event: string;
            /** @description ULID shared by every delivery attempt of the same event. Also sent as `X-CE-Event-ID`. */
            event_id: string;
            /** @description ULID unique to this delivery attempt. Also sent as `X-CE-Delivery-ID`. */
            delivery_id: string;
            /**
             * Format: date-time
             * @description Time this delivery attempt was made.
             */
            timestamp: string;
            /** @description `true` when sent from the admin *Send test webhook* action. */
            is_test: boolean;
            payload: components["schemas"]["WebhookPayload"];
        };
        /**
         * WebhookPayload
         * @description The inner event record. `properties` carries the event-specific model documented on each webhook, and each webhook lists the ids it carries at the top level: its entity's (e.g. `order_number`, `cart_id`) and related entities'. The other keys are common to all events.
         */
}

Component References ​

ReferenceResolves To
components["schemas"]["WebhookPayload"]WebhookPayload

OpenAPI Schema ​

json
{
  "title": "WebhookEnvelope",
  "description": "Body of every webhook request. The HMAC-SHA256 signature in `X-CE-Signature` is computed over the raw request body with the webhook secret. Use `event_id` as the idempotency key: retries of the same event reuse it while `delivery_id` changes per attempt.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/WebhookEnvelope",
    "description": "API reference for the WebhookEnvelope schema"
  },
  "required": [
    "event",
    "event_id",
    "delivery_id",
    "timestamp",
    "payload",
    "is_test"
  ],
  "properties": {
    "event": {
      "description": "Event name, e.g. `order.created`. Also sent as the `X-CE-Event` header.",
      "type": "string"
    },
    "event_id": {
      "description": "ULID shared by every delivery attempt of the same event. Also sent as `X-CE-Event-ID`.",
      "type": "string"
    },
    "delivery_id": {
      "description": "ULID unique to this delivery attempt. Also sent as `X-CE-Delivery-ID`.",
      "type": "string"
    },
    "timestamp": {
      "description": "Time this delivery attempt was made.",
      "type": "string",
      "format": "date-time"
    },
    "is_test": {
      "description": "`true` when sent from the admin *Send test webhook* action.",
      "type": "boolean"
    },
    "payload": {
      "$ref": "#/components/schemas/WebhookPayload"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: