searchSiteWebhooksDeliveries
GET https://{{host}}/api/v1/sites/:site_id/webhooks/:webhook_id/events/search
Topics Supported: - alarms - audits - device-updowns - occupancy-alerts - ping
Query Parameters
| Name | Type | Description |
|---|---|---|
org_id | string | org ID |
site_id | string | site ID |
webhook_id | string | webhook object ID |
status | string | optional, success / failure |
status_code | int | HTTP response status code |
topic | string | optional, webhook topic |
Response Parameters
| Name | Type | Description |
|---|---|---|
id | string | delivery ID |
req_headers | object | HTTP request headers |
req_url | string | HTTP request URL |
req_payload | object | HTTP request payload |
resp_headers | object | HTTP response headers |
resp_body | string | HTTP response body |
error | string | error message, if there is one |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
status_code | number | ||
topic | string | alarms / audits / device-updowns / occupancy-alerts / ping | |
limit | number |
RESPONSES
status: OK
{"results":[{"id":"47ea9366-bf66-427a-886a-153104bbf355","org_id":"929e52a7-9edc-4e2f-a836-1af577b043ed","site_id":"21134243-0667-44ae-8f58-42b640ad39bb","webhook_id":"6b0b5d05-430a-4414-86ca-eb081aff03e8","status_code":200,"status":"success","topic":"ping","req_headers":"{\"Content-Type\":[\"application/json\"],\"User-Agent\":[\"Mist-webhook\"]}","req_url":"http://example.com","req_payload":"{\"topic\":\"ping\",\"events\":[{\"id\":\"6b0b5d05-430a-4414-86ca-eb081aff03e8\",\"name\":\"webhook event delivery test\",\"site_id\":\"21134243-0667-44ae-8f58-42b640ad39bb\",\"timestamp\":1685985159.0102212}]}","resp_headers":"{\"Access-Control-Allow-Credentials\":[\"true\"],\"Access-Control-Allow-Methods\":[\"OPTIONS, HEAD, GET, POST, PUT, DELETE\"],\"Access-Control-Allow-Origin\":[\"*\"],\"Access-Control-Expose-Headers\":[\"Date, Server, X-Frame-Options\"],\"Access-Control-Max-Age\":[\"3600\"],\"Content-Length\":[\"3\"],\"Content-Type\":[\"text/html; charset=utf-8\"],\"Date\":[\"Mon, 05 Jun 2023 17:12:39 GMT\"],\"Server\":[\"Apache/2.4.18 (Ubuntu)\"],\"X-Frame-Options\":[\"SAMEORIGIN\"]}","resp_body":"Ok"},{"id":"55b0f02f-ebf6-4ad2-8b10-200508a97581","org_id":"fc7e2967-e7ef-41e6-b007-1217713de05a","site_id":"256c3a35-9cb7-436e-bc6d-314972645d95","webhook_id":"7a11b901-f719-4c91-8aef-deb8699a6364","status_code":200,"status":"success","topic":"audits","req_headers":"{\"Content-Type\":[\"application/json\"],\"User-Agent\":[\"Mist-webhook\"]}","req_url":"http://example.com","req_payload":"{\"topic\":\"audits\",\"events\":[{\"admin_name\":\"John Doe john.doe@juniper.net\",\"after\":\"{\"radio_config\": {\"band_24\": {\"disabled\": false, \"allow_rrm_disable\": false, \"power_min\": null, \"power_max\": null, \"power\": 10, \"preamble\": \"short\", \"channels\": [1, 10], \"bandwidth\": 20}}}\",\"before\":\"{\"radio_config\": {\"band_24\": {\"disabled\": false, \"allow_rrm_disable\": false, \"power_min\": 8, \"power_max\": 18, \"power\": null, \"preamble\": \"long\", \"channels\": [1, 10], \"bandwidth\": 20}}}\",\"id\":\"737909a2-04ff-4aeb-b9da-cc924e74a4dd\",\"message\":\"Update Site Settings\",\"org_id\":\"fc7e2967-e7ef-41e6-b007-1217713de05a\",\"site_id\":\"256c3a35-9cb7-436e-bc6d-314972645d95\",\"site_name\":\"Test Site\",\"src_ip\":\"1.2.3.4\",\"timestamp\":1685956576.923601,\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36\"}]}","resp_headers":"{\"Access-Control-Allow-Credentials\":[\"true\"],\"Access-Control-Allow-Methods\":[\"OPTIONS, HEAD, GET, POST, PUT, DELETE\"],\"Access-Control-Allow-Origin\":[\"*\"],\"Access-Control-Expose-Headers\":[\"Date, Server, X-Frame-Options\"],\"Access-Control-Max-Age\":[\"3600\"],\"Content-Length\":[\"3\"],\"Content-Type\":[\"text/html; charset=utf-8\"],\"Date\":[\"Mon, 05 Jun 2023 17:12:39 GMT\"],\"Server\":[\"Apache/2.4.18 (Ubuntu)\"],\"X-Frame-Options\":[\"SAMEORIGIN\"]}","resp_body":"Ok"}]}