List of Webhooks APIs

HPE Aruba Networking Central supports the following Webhooks APIs Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software.:

  • GET /central/v1/webhooks—Gets a list of Webhooks.

The following is a sample response:

{ "count": 1, "settings": [ { "wid": "e26450be-4dac-435b-ac01-15d8f9667eb8", "name": "AAA Authentication, Authorization, and Accounting. AAA is a security framework to authenticate users, authorize the type of access based on user credentials, and record authentication events and information about the network access and network resource consumption.", "updated_ts": 1523956927, "urls Uniform Resource Locator. URL is a global address used for locating web resources on the Internet.": [ "https://example.org/webhook1", "https://example.org/webhook1" ], "secure_token": "KEu5ZPTi44UO4MnMiOqz" } ] }
  • POST /central/v1/webhooks—Creates Webhooks.

The following is a sample response:

{ "name": "AAA", "wid": "e829a0f6-1e36-42fe-bafd-631443cbd581" }
  • DELETE /central/v1/webhooks/{wid}—Deletes Webhooks.

The following is a sample response:

{ "wid": "e26450be-4dac-435b-ac01-15d8f9667eb8" }
  • GET /central/v1/webhooks/{wid}—Gets Webhooks settings for a specific item.

The following is a sample response:

{ "wid": "e26450be-4dac-435b-ac01-15d8f9667eb8", "name": "AAA", "updated_ts": 1523956927, "urls": [ "https://example.org/webhook1", "https://example.org/webhook1" ], "secure_token": "KEu5ZPTi44UO4MnMiOqz" }
  • PUT /central/v1/webhooks/{wid}—Updates Webhooks settings for a specific item.

The following is a sample response:

{ "name": "AAA", "wid": "e829a0f6-1e36-42fe-bafd-631443cbd581" }
  • GET /central/v1/webhooks/{wid}/token—Gets the Webhooks token for the Webhooks ID.

The following is a sample response:

{ "name": "AAA", "secure_token": "[{\"token\": \"zSMrzuYrblgBfByy2JrM\", \"ts\": 1523957233}]" }
  • PUT /central/v1/webhooks/{wid}/token—Refreshes the Webhooks token for the Webhooks ID.

The following is a sample response:

{ "name": "AAA", "secure_token": "[{\"token\": \"zSMrzuYrblgBfByy2JrM\", \"ts\": 1523957233}]" }
  • GET /central/v1/webhooks/{wid}/ping—Tests the Webhooks notification and returns whether success or failure.

The following is a sample response:

"Ping Response [{'url': 'https://example.org', 'status': 404}]"

Sample Webhooks Payload Format for Alerts

URL POST <webhook-url>

Custom Headers

Content-Type: application/json

X-Central-Service: Alerts

X-Central-Event: Radio-Channel-Utilization

X-Central-Delivery-ID: 72d3162e-cc78-11e3-81ab-4c9367dc0958

X-Central-Delivery-Timestamp: 2016-07-12T13:14:19-07:00

X-Central-Customer-ID: <########>

Refer to the following topics to view sample JSON JavaScript Object Notation. JSON is an open-standard, language-independent, lightweight data-interchange format used to transmit data objects consisting of attribute–value pairs. JSON uses a "self-describing" text format that is easy for humans to read and write, and that can be used as a data format by any programming language. content: