Cisco DNA Centers - Raise Webhook Events - RESTful API

Summary:

Enable or disable webhook events on a DNA Center.

URL:

http(s)://{server hostname}/api/webhook/cloudAlert/DNAC/{ObjectID}?serverId={serverId}

Methods summary

PUT Method detail

Methods summary

• PUT Method - enable or disable webhook events on a DNA Center.

PUT Method detail

Enable or disable webhook events on a DNA Center.

Example:

INPUT
curl -k -X POST -u admin:admin https://localhost/api/webhook/cloudAlert/DNAC/<ObjectID>?serverId=<serverId> -H "content-type:application/json" -d \
'{ 
  "version": null,
  "instanceId": "8169d18b-ef31-4163-8d90-d9e535b55fb5",
  "eventId": "NETWORK-NON-FABRIC_WIRED-1-200",
  "namespace": "ASSURANCE",
  "name": null,
  "description": null,
  "type": "NETWORK",
  "category": "ALERT",
  "domain": "Connectivity",
  "subDomain": "Non-Fabric Wired",
  "severity": 1,
  "source": "ndp",
  "timestamp": 1583315649978,
  "tags": [ "tag1", "tag2" ],
  "details": {
  "Type": "Network Device",
  "Assurance Issue Details":  "This network device ABC is unreachable from controller. The device role is EDGE",
  "Assurance Issue Priority": "P1",
  "Device": "1.2.3.4",
  "Assurance Issue Name": "Network Device 2.3.4.5 Is Unreachable From Controller",
  "Assurance Issue Category": "Availability",
  "Assurance Issue Status": "active"
},
  "ciscoDnaEventLink": "dna/assurance/issueDetails?issueId=8169d18b-ef31-4163-8d90-d9e535b55fb5",
  "note": "To programmatically get more info see here - https://<ip-address>/dna/platform/app/consumer-portal/developer-toolkit/apis?apiId=8684-39bb-4e89-a6e4",
  "tntId": "",
  "context": null,
  "tenantId": ""
}'

OUTPUT (when Webhook is enabled)
{
"message" : "Success. DNA Center Alert Webhook received and Entuity event raised."
}

OUTPUT (when Webhook is disabled)
{
   "code" : 403,
   "contactEmail" : null,
   "description" : "Webhook is not enabled for this DNA Center",
   "homeRef" : "/",
   "reasonPhrase" : "Forbidden",
   "uri" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4"
}