Custom Webhook Group Details - RESTful API

Summary:

Inspect or delete a custom webhook group.

URL:

http(s)://{server hostname}/api/webhooks/groups/{group name}

Methods summary

GET Method detail

PUT Method detail

DELETE Method detail

Methods summary

• GET Method - inspect a custom webhook group
• PUT Method - modify a custom webhook group
• DELETE Method - delete a custom webhook group

GET Method detail

Returns information about the specified custom webhook group.

Response:

Information about the custom webhook group in the following format:

Example:

INPUT
curl -v -u -k admin:admin https://localhost/api/webhooks/groups/anewgroup?media=json -H "content-type:application/json"

OUTPUT
{
     "groupID" : 24,
     "groupName" : "Anewgroup",
     "authMethod" : {
       "authType" : 1,
       "authKey" : "not used"
     },
     "endpointCount" : 0,
     "ruleCount" : 0
   },

PUT Method detail

Modifies the specified custom webhook group.

Response:

Example:

INPUT
curl -u admin:admin -k https://localhost/api/webhooks/groups/anewgroup -H 'content-type:application/json' -X PUT
{
     "groupID" : "24",
     "groupName" : "Anewgroup",
     "authMethod" : {
       "authType" : 1,
       "authKey" : "not used"
      },
}

OUTPUT
{
    "successCount" : 1,
    "failureCount" : 0,
    "errorCode" : 0,
    "message" : "Succeeded to edit Webhook group 'anewgroup'.",
    "otherResults" : [ ]
}

DELETE Method detail

Deletes the specified custom webhook group.

Response:

Confirmation that the group has been deleted.

Example:

INPUT
curl -u admin:admin -k https://localhost/api/webhooks/groups/anewgroup -H 'content-type:application/json' -X DELETE

OUTPUT
{
  "successCount" : 1,
  "failureCount" : 0,
  "errorCode" : 0
  "message" : "Groups deleted successfully.",
  "otherResults" : []
}