Skip to main content

Get All Webhook Endpoints

This endpoint retrieves all webhook endpoints

info

This operation requires admin role.

HTTP Request

GET /api/v2/webhook/endpoint/

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalseNumber of results to return per page
offsetqueryintegerfalseThe initial index from which to return the results
orderingquerystringfalseWhich field to use when ordering the results. For sorting desc use - in front of the field name. Default to -created_at. Available values are created_at, is_active, updated_at

Example Request

const headers = {
'Accept':'application/json',
'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/webhook/endpoint/',
{
method: 'GET',

headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});

Responses

StatusMeaningDescriptionSchema
200OKResponse status codeInline

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
» countintegerfalsenoneTotal results count
» nextstring(uri)¦nullfalsenoneNext page url
» previousstring(uri)¦nullfalsenonePrevious page url
» resultslist(Endpoint)falsenoneList of results

Example responses

{
"count": "integer",
"next": "string(uri)",
"previous": "string(uri)",
"results": [
{
"id": "integer",
"created_at": "string",
"updated_at": "string",
"is_active": "boolean",
"target": "string",
"description": "string",
"events": [
{
"type": "string",
"added_at": "string"
}
],
"ssl_cert_verification": "boolean"
}
]
}