Summary:
List and create custom webhook groups
URL:
http(s)://{server hostname}/api/webhooks/groups
Methods summary
- GET Method - list custom webhook groups
- POST Method - create a custom webhook group
GET Method detail
Returns a list of custom webhook groups.
Response:
Name | Description |
---|---|
groupID |
ID of the group. |
groupName | group name. |
authType |
type of authentication, choose from: 1 = basic 3 = API Key Header 4 = API Key Body 5 = API Key Query |
authKey | name of the authentication key. This field is not applicable if the Basic authentication type is selected. |
endpointCount | number of webhook endpoints assigned to this webhook group. |
ruleCount | number of webhook rules associated with this webhook group. |
count | total number of webhook groups on this server. |
Example:
INPUT
curl -v -u -k admin:admin https://localhost/api/webhooks/groups?media=json -H "content-type:application/json"
OUTPUT
{
"items" : [
{
"groupID" : 23,
"groupName" : "Junipermist",
"authMethod" : {
"authType" : 1,
"authKey" : "not used"
},
"endpointCount" : 0,
"ruleCount" : 0
},
{
"groupID" : 24,
"groupName" : "Anewgroup",
"authMethod" : {
"authType" : 1,
"authKey" : "not used"
},
"endpointCount" : 0,
"ruleCount" : 0
},
],
"count" : 2
}
POST Method detail
Create a new custom webhook group.
Request:
Name | Description |
---|---|
group name |
name of the webhook group. Entuity recommends that the name reflects the devices in the group, because no checks are undertaken to validate the devices' manufacturer(s). You will not be able to use the same name as a group that already exists. |
authMethod | authentication method. |
authType |
type of authentication, choose from: 1 = basic 3 = API Key Header 4 = API Key Body 5 = API Key Query |
authKey | name of the authentication key. This is not applicable if the 'Basic' authentication type is selected. |
Response:
A confirmation of the addition.
Example:
Input
curl -v -u -k admin:admin https://localhost/api/webhooks/groups?media=json -X POST -H "content-type:application/json" -d \
'{
"groupName" : "Junipermist",
"authMethod" : {
"authType" : "1",
"authKey" : "not used"
}
}
Output
{
"successCount" : 1,
"failureCount" : 0,
"errorCode" : 0,
"message" : "Webhook group 'Junipermist' created successfully with ID 23.
"otherResults" : []
Comments
0 comments
Please sign in to leave a comment.