Skip to main content

Get All Webhook Endpoints

This endpoint retrieves all webhook endpoints

info

This operation requires authentication and 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
200OKnoneInline

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
» countintegerfalsenonenone
» nextstring(uri)¦nullfalsenonenone
» previousstring(uri)¦nullfalsenonenone
» results[Endpoint]falsenoneList of results

Example responses

{
"count": 123,
"next": "string",
"previous": "string",
"results": [
{
"id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_active": true,
"target": "https://example.com",
"description": "string",
"events": [
{
"type": "comment.created",
"added_at": "2019-08-24T14:15:22Z"
}
],
"ssl_cert_verification": true
}
]
}