Get all Events for Webhook
GET/webhook/:guid/event
Returns all the WebhookEvents attached to the Webhook.
Request
Path Parameters
The guid of the Webhook.
Responses
- 200
- 403
- 404
The attached WebhookEvents of Webhook found.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
The guid of the WebhookEvent.
The guid of the Webhook the WebhookEvent belongs to. Note, the WebhookEvent will be created due to a single trigger, the Webhook specifies the action to perform.
Possible values: [order-updated
, order-pending
, order-paid
, order-cancelled
]
The trigger that will invoke the Webhook.
The url to which to make POST request(s) after a trigger of the event. Only if a request fails, there can be a retry.
Data that is posted along with the event to the url.
Default value: 0
How many times have been tried communicating the WebhookEvent to the url.
Whether we received a HTTP 200 code on the response to any of the requests.
The time it was created.
The time it was last updated.
[
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"webhook_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event": "order-updated",
"url": "string",
"data": "string",
"tries": 0,
"communicated": true,
"created_at": "string",
"updated_at": "string"
}
]
When the authenticated User does not have the admin role.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}
When the Webhook to reinstate cannot be found or it has not been deleted.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}