Back to top
Home / Knox Webhook Notification (preview) /

Release notes

Last updated December 6th, 2023

Knox Webhook Notification v1

August 2023

The Knox Webhook Notification API currently provides the following APIs:

API Description
POST /kwn/v1/subscriptions

Creates a subscription.

Requires:

  • The subscription URL or "callback".
  • A set of Knox cloud services events. For example, the Knox Guard device enrollment event.
GET /kwn/v1/subscriptions Retrieves the subscription associated with a customer.
GET /kwn/v1/subscriptions/{subscriptionId} Retrieves the subscription associated with a particular subscriptionId. Used to identify the URL that Knox Webhook Notification uses to dispatch change notifications.
PUT /kwn/v1/subscriptions/{subscriptionId} Updates an existing subscription associated with a particular subscriptionId.
DELETE /kwn/v1/subscriptions/{subscriptionId} Deletes an existing subscription associated with a particular subscriptionId.

The Knox Webhook Notification API currently supports subscription calls to the following Knox cloud service events:

Knox cloud service Event Description
Knox E-FOTA KE_DEVICE_BULK_CREATE: Bulk upload Allows bulk upload of devices.
Knox E-FOTA KE_DEVICE_BULK_REFRESH: Bulk refresh Forces the Knox E-FOTA client app to refresh on multiple devices.
Knox E-FOTA KE_DEVICE_BULK_DELETE: Bulk deletion Allows bulk deletion of devices.
Knox E-FOTA KE_CAMPAIGN_DELETE: Campaign deletion Deletes an existing Knox E-FOTA campaign.
Knox E-FOTA KE_DEVICE_STATUS_CHANGE: Device status change Change in device status (operation or client status).
Knox E-FOTA KE_DEVICE_BULK_LICENSE_UNENROLL: Bulk license unenrolling Bulk license unerolling of devices.

Knox Webhook Notification v0.1

March 2023

The Knox Webhook Notification API currently provides the following APIs:

API Description
POST /kcs/kwn/v0.1/subscriptions

Creates a subscription.

Requires:

  • The subscription URL or "callback".
  • A set of Knox cloud services events. For example, the Knox E-FOTA device upload event.
GET /kcs/kwn/v0.1/subscriptions Retrieves the subscription associated with a customer.
GET /kcs/kwn/v0.1/subscriptions/{subscriptionId} Retrieves the subscription associated with a particular subscriptionId. Used to identify the URL that Knox Webhook Notification uses to dispatch change notifications.
PUT /kcs/kwn/v0.1/subscriptions/{subscriptionId} Updates an existing subscription associated with a particular subscriptionId.
DELETE /kcs/kwn/v0.1/subscriptions/{subscriptionId} Deletes an existing subscription associated with a particular subscriptionId.

The Knox Webhook Notification API currently supports subscription calls to the following Knox cloud service events:

Knox cloud service Event Description
Knox E-FOTA KE_DEVICE_BULK_CREATE: Bulk upload Allows bulk upload of devices.
Knox E-FOTA KE_DEVICE_BULK_REFRESH: Bulk refresh Forces the Knox E-FOTA client app to refresh on multiple devices.
Knox E-FOTA KE_DEVICE_BULK_DELETE: Bulk deletion Allows bulk deletion of devices.
Knox E-FOTA KE_CAMPAIGN_DELETE: Campaign deletion Deletes an existing Knox E-FOTA campaign.
Knox E-FOTA KE_DEVICE_STATUS_CHANGE: Device status change Change in device status (operation or client status).

Is this page helpful?