Skip to content
Cynox IoT Documentation

Creating a webhook

You can create webhooks using the Admin interface or via the GraphQL API.

Creating a webhook in the Admin interface

You can create Webhooks in the Admin interface. A webhook has the following properties:

  • Description: A purely informational description for your webhook.
  • URL: The URL of your Webhook endpoint.
  • Secret Key: The secret key for verifying message authenticity using HMAC.
  • Active: Whether this webhook is active, i.e. it will receive events
  • Events: The events you want this webhook to be subscribed to. Each event can individually be disabled as well. An event will only be delivered to a webhook if both the event and the webhook are active.

The following events are currently implemented:

  • Device command created: Receive a webhook when a matching device command is first created.
  • Device command updated: Receive a webhook when a matching device command updates its execution state.
  • Device metadata changed: Receive a webhook when the metadata (such as the label) of a matching device is changed.
  • Device report: Receive a webhook when a matching device reports data, such as a SocketSwitchStateReport.
  • Device status changed: Receive a webhook when a matching device updates its status (Offline, Available, etc.)