Get (just) all (deleted) Webhooks
GET/webhook/:type
Returns all Webhooks of the requested Company. When the Company has no Webhooks an empty array will be returned.
The "trashed" operation returns all Webhooks including deleted Webhooks.
The "justtrashed" operation returns only the deleted Webhooks.
Note, "normal" will yield the same result as without a type.
Request
Path Parameters
- "normal"
- Returns all the Webhooks except those which are deleted.
- "trashed"
- Returns all the Webhooks including those which are deleted.
- "justtrashed"
- Returns all and only the deleted Webhooks.
Possible values: [normal
, trashed
, justtrashed
]
Type of operations for querying deleted Webhooks.
Responses
- 200
- 403
- 404
Webhooks found.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
The guid of the Webhook.
Possible values: [order-updated
, order-pending
, order-paid
, order-cancelled
]
The trigger that will invoke the Webhook.
Possible values: <= 65535 characters
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.
The time it was created.
The time it was last updated.
[
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"event": "order-updated",
"url": "string",
"created_at": "string",
"updated_at": "string"
}
]
Unauthorized. You do not have permission to manage Webhooks of the Company.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}
Company not found.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}