You can use our webhooks to get notifications from Lirium when certain events happen, for example when an order gets confirmed.
Webhook payload object common properties
The following table shows the common properties of all the webhook event payload, and each webhook event payload also contains properties unique to the event.
You can find the unique properties for each action
in the following individual event type sections' examples.
Key | Type | Description | Notes |
---|---|---|---|
id | string | Event id | |
action | string | The webhook payload contain an action property and its value specifies the activity that triggered the event. | - partner-order-created - partner-order-closed - partner-order-updated - order-closed - order-updated - incoming-funds - customer-product-changed |
[entity] | object | This node contains the entity that trigger the event, exactly like you'd get it by calling its Details endpoint | customer or order data |