omnilabs.sh · multi-channel commerce operations

omnilabs.shdocs

Dark theme off

Channel Reporting Sale Product Group Product Warehouse Carrier Template Webhooks

Dark theme off

Webhooks

Webhooks for notifying external systems about specific sale-related events.

Webhook

type

The type of webhook event (e.g., SALE_CREATED, SALE_IN_DELIVERY, SALE_COMPLETED).

data

The encoded payload shared with the configured API endpoint.

Initialization vector to decrypt the payload using AES-256-CBC.

{} The Webhooks resource

1{
2  "type": "SALE_CREATED",
3  "data": "ENCODED PAYLOAD",
4  "iv": "INITIALIZATION VECTOR"
5}

webhook

SALE_CREATED Webhook

Triggered when a sale is created, sending the encoded sale resource to the configured API endpoint.

Response

{
  "event": "SALE_CREATED",
  "data": {
    "sale_id": "clz2me042000914c4o0ssjzds",
    "client_name": "Lucas Santini",
    "total_amount": 500,
    "status": "New"
  }
}

webhook

SALE_IN_DELIVERY Webhook

Triggered when a sale status changes to 'In Delivery', sending the encoded tracking information and sale ID to the configured API endpoint.

Response

{
  "event": "SALE_IN_DELIVERY",
  "data": {
    "sale_id": "clz2me042000914c4o0ssjzds",
    "tracking_code": "123456789",
    "carrier_type": "DPD",
    "tracking_link": "https://www.dpdgroup.com/fr/mydpd/my-parcels/search?"
  }
}

webhook

SALE_COMPLETED Webhook

Triggered when a sale status changes to 'Completed', sending the encoded sale ID to the configured API endpoint.

Response

{
  "event": "SALE_COMPLETED",
  "data": {
    "sale_id": "clz2me042000914c4o0ssjzds"
  }
}