Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Juniper Mist AI Orgs Webhooks API

An Org Webhook is a configuration that allows real-time events and data from the Org to be pushed to a provided url.It enables the collection of information about various topics such as device events, alarms, and audits updates at the org level.The Webhook can be set up and customized using the Mist API, allowing users to receive and analyze specific data from a particular site.

Juniper Mist AI Orgs Webhooks API is one of 211 APIs that Juniper Mist AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orgs Webhooks. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 5 paths, and defines 28 schemas. It is described by OpenAPI 3.1.0, at version 2604.1.1.

Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.

8 operations 5 paths 28 schemas 1 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2604.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, HTTP Basic, API Key
License
Resource Areas
1

Authentication & Security 3

Juniper Mist AI Orgs Webhooks API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…
  • basicAuth — While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
  • csrfToken — This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Orgs Webhooks 8

An Org Webhook is a configuration that allows real-time events and data from the Org to be pushed to a provided url. It enables the collection of information about various topics…

GET
/api/v1/orgs/{org_id}/webhooks
listOrgWebhooks
listOrgWebhooks 3 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/webhooks
createOrgWebhook
createOrgWebhook 1 param body → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/webhooks/{webhook_id}
deleteOrgWebhook
deleteOrgWebhook 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/webhooks/{webhook_id}
getOrgWebhook
getOrgWebhook 2 params → 200400401403404429
PUT
/api/v1/orgs/{org_id}/webhooks/{webhook_id}
updateOrgWebhook
updateOrgWebhook 2 params body → 200400401403404429
GET
/api/v1/orgs/{org_id}/webhooks/{webhook_id}/events/count
countOrgWebhooksDeliveries
countOrgWebhooksDeliveries 11 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/webhooks/{webhook_id}/events/search
searchOrgWebhooksDeliveries
searchOrgWebhooksDeliveries 12 params → 200400401403404429
POST
/api/v1/orgs/{org_id}/webhooks/{webhook_id}/ping
pingOrgWebhook
pingOrgWebhook 2 params → 200400401403404429

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are webhook (24 properties), webhook_delivery (14 properties), search_webhook_delivery (6 properties), response_count (6 properties). Each schema is shown below with its type and property counts.

id
string
Unique ID of the object instance in the Mist Organization
response_count
object
6 properties 6 required
search_webhook_delivery_results
array
webhook_delivery_status
string
webhook delivery status. enum: failure, success
response_http403
object
1 property
search_webhook_delivery
object
6 properties
webhook_assetfilter_ids
array
Only if type==asset-raw-rssi. List of ids to associated asset filters. These filters will be applied to messages routed to a filtered-asset-rssi webhook
webhook_delivery_topic
string
webhook topic. enum: alarms, audits, device-updowns, occupancy-alerts, ping
count_results
array
count_result
object
1 property 1 required
webhook_oauth2_grant_type
string
required when type==oauth2. enum: clientcredentials, password
webhook_delivery
object
14 properties
webhook_type
string
enum: aws-sns, google-pubsub, http-post, oauth2, splunk
site_id
string
webhook
object
24 properties
response_http404
object
1 property
timestamp
number
Epoch (seconds)
response_http400_webhook
object
2 properties
modified_time
number
When the object has been modified for the last time, in epoch
webhooks
array
response_http400
object
1 property
webhook_topics
array
List of supported webhook topics available with the API Call [List Webhook Topics](/operations/listWebhookTopics)
webhook_oauth2_scopes
array
Required when type==oauth2, if provided, will be used in the token request
response_http429
object
1 property
webhook_delivery_distinct
string
webhook topic. enum: status, statuscode, topic, webhookid
response_http401
object
1 property
org_id
string
created_time
number
When the object has been created, in epoch

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-orgs-webhooks-api-openapi.yml Raw ↑

Other APIs Juniper Mist AI publishes across the network.

Juniper Mist WebSocket Streaming API
Juniper Mist Webhooks API
Juniper Mist AI Admins API
Juniper Mist AI Admins Login API
Juniper Mist AI Admins Login - OAuth2 API
Juniper Mist AI Admins Logout API
Juniper Mist AI Admins Lookup API
Juniper Mist AI Admins Recover Password API
Juniper Mist AI Constants Definitions API
Juniper Mist AI Constants Events API
Juniper Mist AI Constants Models API
Juniper Mist AI Installer API