{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Sites Webhooks API", "version": "2604.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Sites Webhooks", "type": "folder" }, "items": [ { "info": { "name": "listSiteWebhooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/webhooks", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "Get List of Site Webhooks" }, { "info": { "name": "createSiteWebhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/webhooks", "params": [ { "name": "site_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Webhook defines a webhook, modeled after [github\\u2019s model](https://developer.github.com/webhooks/).\n\n\nThere is two types of webhooks:\n* webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-be01e694-7253-4195-8563-78e2a745e114)) \n* raw data webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-e2d5d5f8-4bdb-4efc-93e4-90f4b33d0b2b))\n\n\n##### Webhooks\nWebhooks can be co" }, { "info": { "name": "getSiteWebhook", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/webhooks/:webhook_id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "webhook_id", "value": "", "type": "path" } ] }, "docs": "Get Site Webhook Details" }, { "info": { "name": "updateSiteWebhook", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mist.com/api/v1/sites/:site_id/webhooks/:webhook_id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "webhook_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Site Webhook" }, { "info": { "name": "deleteSiteWebhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mist.com/api/v1/sites/:site_id/webhooks/:webhook_id", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "webhook_id", "value": "", "type": "path" } ] }, "docs": "Delete Site Webhook" }, { "info": { "name": "countSiteWebhooksDeliveries", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/webhooks/:webhook_id/events/count", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "webhook_id", "value": "", "type": "path" }, { "name": "error", "value": "", "type": "query" }, { "name": "status_code", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query", "description": "Webhook delivery status" }, { "name": "topic", "value": "", "type": "query", "description": "Webhook topic" }, { "name": "distinct", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Count Site Webhooks deliveries\n\n\nTopics Supported:\n- alarms\n- audits\n- device-updowns\n- occupancy-alerts\n- ping" }, { "info": { "name": "searchSiteWebhooksDeliveries", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/webhooks/:webhook_id/events/search", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "webhook_id", "value": "", "type": "path" }, { "name": "error", "value": "", "type": "query" }, { "name": "status_code", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query", "description": "Webhook delivery status" }, { "name": "topic", "value": "", "type": "query", "description": "Webhook topic" }, { "name": "limit", "value": "", "type": "query" }, { "name": "start", "value": "", "type": "query", "description": "Start time (epoch timestamp in seconds, or relative string like \"-1d\", \"-1w\")" }, { "name": "end", "value": "", "type": "query", "description": "End time (epoch timestamp in seconds, or relative string like \"-1d\", \"-2h\", \"now\")" }, { "name": "duration", "value": "", "type": "query", "description": "Duration like 7d, 2w" }, { "name": "sort", "value": "", "type": "query", "description": "On which field the list should be sorted, -prefix represents DESC order" }, { "name": "search_after", "value": "", "type": "query", "description": "Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the `next` URL from the previous response and should not be manually constructed." } ] }, "docs": "Search Site Webhooks deliveries\n\n\nTopics Supported:\n- alarms\n- audits\n- device-updowns\n- occupancy-alerts\n- ping" }, { "info": { "name": "pingSiteWebhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/webhooks/:webhook_id/ping", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "webhook_id", "value": "", "type": "path" } ] }, "docs": "Send a Ping event to the webhook" } ] } ], "bundled": true }