Summary:
Inspect information about events for a specified custom webhook group, and add a webhook endpoint to a specified custom webhook group.
URL:
http(s)://{server hostname}/api/webhooks/groups/{group id}/events
Methods summary
- GET Method - details information about events for a specified custom webhook group, specified by group id.
- POST Method - add a webhook endpoint to a specified custom webhook group.
GET Method detail
Returns information about events in the specified webhook group, specified by group id.
Response:
Name | Description |
---|---|
eventName | name of the custom webhook event. |
eventDescription | description of the event. This is informational only. |
eventID | ID of the event. |
eventSeverity |
severity of the event, select from: 2 - Info 4 - Minor 6 - Major 8 - Severe 10 - Critical |
count |
total number of events. |
Example:
INPUT
curl -u admin:admin https://localhost/api/webhooks/groups/23/events -H "content-type:application/json"
OUTPUT
{
"items" : [ {
"containerID" : 23,
"events" : [ {
"eventName" : "Meraki Device Came Up",
"eventDescription" : "Test Meraki Device Came Up Event",
"eventID" : 8,
"eventSeverity" : 6
}, {
"eventName" : "Meraki Test Event",
"eventDescription" : "Test Meraki Event Description",
"eventID" : 10,
"eventSeverity" : 10
} ]
} ],
"count" : 1
}
POST Method detail
Add a webhook endpoint to a specified custom webhook group.
Request:
Name | Description |
---|---|
objectID | ID of the object on which the endpoint URL is found. |
serverID | ID of the server on which the webhook group is hosted. |
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. |
Example:
INPUT
curl -u admin:admin https://localhost/api/webhooks/groups/anewgroup/endpoints -X POST -H "content-type:application/json" -d \
OUTPUT
'{
"objectID": "5482",
"serverID": "{serveriD}",
"payloadMax": "10",
"saveEnabled" : "false"
}'
Comments
0 comments
Please sign in to leave a comment.