SitesWebhooks

getSiteWebhook

GET
/api/v1/sites/{site_id}/webhooks/{webhook_id}

Get Site Webhook Details

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

site_id*string
Formatuuid
webhook_id*string
Formatuuid

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/webhooks/000000ab-00ab-00ab-00ab-0000000000ab"
{  "created_time": 0,  "enabled": true,  "headers": {},  "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "modified_time": 0,  "name": "string",  "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "secret": "string",  "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "splunk_token": "string",  "topics": [    "location"  ],  "type": "http-post",  "url": "string",  "verify_cert": true}

createSiteWebhook POST

Webhook defines a webhook, modeled after [github\u2019s model](https://developer.github.com/webhooks/). There is two types of webhooks: * webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-be01e694-7253-4195-8563-78e2a745e114)) * raw data webhooks ([examples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace/folder/224925-e2d5d5f8-4bdb-4efc-93e4-90f4b33d0b2b)) ##### Webhooks Webhooks can be configured at the org level (subset of topics only) and at the site level. It is possible to have multiple topics in the same webhook configuration and/or to have multiple webhooks configured at the same time. ##### Client Raw Data Webhooks Raw data webhooks are a special subset of webhooks that provide insight into raw data packets emitted by a client, identified by their advertising MAC address (assets, discovered BLE, connected Wi-Fi, unconnected Wi-Fi). The data that client raw data webhooks encompasses are reporting AP information, RSSI Data, and any special packets/telemetry packets that the client may emit. Note that client raw webhooks are the raw data coming from the client and do not contain the X,Y location data of the client. In order to get the location data for a client please see our location webhooks. Clients can be identified uniquely across these client raw data topics and location webhook topic using MAC address as the Unique identifier (client identifier). ###### Client Raw Data Webhooks Topics Topics that correspond to client raw data for different client types. * `asset-raw-rssi` - Raw data from packets emitted by named and filtered assets * `discovered-raw-rssi` - Raw data from packets emitted by passive BLE devices * `wifi-conn-raw` - Raw data from packets emitted by connected devices * `wifi-unconn-raw` - Raw data from packets emitted by unconnected devices (passive) ### Asset Filtering for Client Raw Data Webhooks The `asset-raw-rssi` webhook topic supports filtering of raw data by incorporating asset filters in the webhook payload. The filter topic allows multiple Webhooks to receive a subset of the a`asset-raw-rssi` data by assigning asset filters to a given webhook. The `asset-raw-rssi` filter topic is filtered-asset-rssi. A webhook assigned to a filter topic can take a list of AssetFilter IDs, which act as inclusive filters to determine which named asset and filtered asset data is sent to the assigned filter topic. Filters can be applied to multiple webhooks, and the same data can be sent to multiple filter topics. ### Rules for Configuring Client Raw Data Webhooks 1. Only four instances of a webhook object can contain a specific filter topic. - A site-level entry will override an org-level entry for the same client raw data webhook topic. 2. An assigned asset filter must exist and belong to the same site as the webhook it is assigned to.

deleteSiteWebhook DELETE

Delete Site Webhook