The Webhook Object
Webhooks are used to send event data to an external system (i.e. your application).
Using the API, you can set up webhooks and subscribe to events programatically.
A webhook belongs to a Store.
Attributes
store_id
The ID of the store this webhook belongs to.
url
The URL that events will be sent to.
events
An array of events that will be sent.
See the list of available event types.
last_sent_at
An ISO 8601 formatted date-time string indicating when the last webhook event was sent. Will be null if no events have been sent yet.
created_at
An ISO 8601 formatted date-time string indicating when the object was created.
updated_at
An ISO 8601 formatted date-time string indicating when the object was last updated.
test_mode
A boolean indicating if the object was created within test mode.
{
"type": "webhooks",
"id": "1",
"attributes": {
"store_id": 6,
"url": "https://example.com/webhook/",
"events": ["order_created", "order_refunded"],
"last_sent_at": "2022-11-22T07:38:06.000000Z",
"created_at": "2022-06-07T08:32:47.000000Z",
"updated_at": "2022-06-07T08:41:37.000000Z",
"test_mode": false
}
}