Webhooks are used to send real-time events to external listeners. When a webhook is triggered, Commerce Layer sends a POST request to the webhook's callback URL. The object in the request body has the same format that you get when fetching the resource through the API.
The webhook object
A webhook object is returned as part of the response body of each successful list, retrieve, create or update API call.
The webhook unique identifier
The webhook endpoint URL
Unique name for the webhook.
The identifier of the resource/event that will trigger the webhook.
URI where the webhook subscription should send the POST request when the event occurs.
List of related resources that should be included in the webhook body.
The circuit breaker state, by default it is 'closed'. It can become 'open' once the number of consecutive failures overlaps the specified threshold, in such case no further calls to the failing callback are made.
The number of consecutive failures recorded by the circuit breaker associated to this webhook, will be reset on first successful call to callback.
boolean, value is 'true'
Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count.
Time at which the resource was created.
Time at which the resource was last updated.
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
Any identifier of the third party system that defines the reference code
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
The last associated event callbacks.
The resource environment (can be one of test or live)