Summary:
List all custom webhook endpoints.
URL:
http(s)://{server hostname}/api/webhooks/endpoints
Methods summary
- GET Method - list all custom webhook endpoints
GET Method detail
Returns a list of custom webhook endpoints.
Response:
| Name | Description |
|---|---|
| endpointID | ID of the endpoint. |
| objectID | ID of the object on which the endpoint URL is found. |
| serverID | ID of the server on which the endpoint object is found. |
| payloadMax | maximum number of payloads that Entuity will store at any one time. For example, if you specify a payload maximum of 3, then the 3 most recent payloads will be stored. When a new payload is received, the oldest of the 3 saved would then be deleted and replaced with the new one. Note, the payload maximum cannot be edited if payload collection is disabled. |
| saveEnabled | whether payload collection is enabled, either true or false. If false, this will prevent the saving of any further payloads. |
| endpointName | name of the object on which the endpoint URL is found. |
| groupName | name of the webhook group in which the endpoint URL is found. |
| payloadCount | number of saved payloads. |
| secret | secret key, if applicable. |
Example:
INPUT
curl -u admin:admin https://localhost/api/webhooks/endpoints -H "content-type:application/json"
OUTPUT
{
"items" : [
{
"endpointID" : 3,
"objectID" : 865,
"serverID" : "{serveriD}",
"payloadMax" : 1,
"saveEnabled" : true,
"endpointName" : "bottom2960",
"groupName" : "Anewgroup",
"payloadCount" : 0,
"secret" : ""
},
{
"endpointID" : 4,
"objectID" : 1147,
"serverID" : "{serveriD}",
"payloadMax" : 1,
"saveEnabled" : true,
"endpointName" : "quidway",
"groupName" : "Anewgroup",
"payloadCount" : 0,
"secret" : ""
}
],
"count" : 2
}
Comments
0 comments
Please sign in to leave a comment.