Webhooks
Fetch a Webhook
Return json data about a webhook.
URL
/webhooks/:id
Method
GET
Success Response
code: 200
Content:
{
"data": {
"customer_id": 1,
"url": "https://www.example.com",
"active": true,
"yyyy-MM-dd'T'HH:mm:ss'Z'",
"updated_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"id": "123f2db6-4558-46f9-90d8-8e6765c5b857"
}
}
Fetch Webhooks
Return json data about webhooks.
URL
/webhooks
Method
GET
Data parameters
search=[string] Term to match against webhook url.
page=[integer] Page number to return.
items=[integer] How many items per page.
order=[string] Direction to sort.
order_by=[string] Field to sort on.
Success Response
code: 200
Content:
{
"data": [
{
"customer_id": 1,
"url": "https://www.example.com",
"active": true,
"yyyy-MM-dd'T'HH:mm:ss'Z'",
"updated_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"id": "123f2db6-4558-46f9-90d8-8e6765c5b857"
}
]
}
Create a Webhook
Creates a webhook.
URL
/webhooks
Method
POST
Data Parameters
url=[string] Publicly accessible https URL.
Success Response
code: 200
Content:
{
"data": {
"customer_id": 1,
"url": "https://www.example.com",
"active": true,
"yyyy-MM-dd'T'HH:mm:ss'Z'",
"updated_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"id": "123f2db6-4558-46f9-90d8-8e6765c5b857"
}
}
Update a Webhook
Updates a webhook.
URL
/webhooks
Method
PUT
Data Parameters
url=[string] Publicly accessible https URL.
Success Response
code: 200
Content:
{
"data": {
"customer_id": 1,
"url": "https://www.example.com",
"active": true,
"yyyy-MM-dd'T'HH:mm:ss'Z'",
"updated_at": "yyyy-MM-dd'T'HH:mm:ss'Z'",
"id": "123f2db6-4558-46f9-90d8-8e6765c5b857"
}
}
Destroy a Webhook
Destroys a webhook.
URL
/webhooks/:id
Method
DELETE
Success Response
code: 200