1. Home
  2. Docs
  3. IoT Data Orchestration
  4. Notification Event Webhooks

Notification Event Webhooks

 

The IoTGtw cloud service supports a number of notification events. The notification exact notification event to enable can be controlled through the device Service Template. The notification events in a Service Template will apply to all devices associated to that Service Template. When the event criteria is met, a webhook is fired off to a pre-defined upstream application (notification endpoint).

Notification endpoint can be defined in the Messaging Endpoint Profile associated to the Service Template. When a notification event occurs and a notification endpoint is defined, the IoTGtw service will push the notification to the endpoint specified in the Primary Messaging Endpoint Profile of the Service Template, if the primary endpoint is unreachable for any reason, the endpoint defined in the secondary Messaging Endpoint Profile is used (if configured). If both are unreachable then the notification push attempt is considered to have failed. Note that Outbound notifications are not queued for later re-delivery but can be stored and for later retrieval and or historical analysis if the Event Storage Service is enabled in the Service Template.

 

Notification Events

“Notify on Msg Sent”

Indicate whether to send out an outbound notification event when a messages has been transmitted to a the device. For example this is useful for devices that do not support acknowledgement and or devices that go to deep sleep for along period of time, your application workflow may require this hook in order to be informed when a queued message has been finally transmitted to the device.

 

“Notify on Msg Delivery”

Indicate whether to send out an outbound notification event when a transmitted downlink message has been acknowledged by the device.

 

“Notify on Wakeup”

Indicate whether to send out an outbound notification event when an uplink event is detected from a device that was previously in idle state (see device idle threshold).

 

“Notify on Connect”

Only applicable for radius enabled accounts. Indicate whether to send out an outbound notification event when a device previously disconnected has established a new connection / successfully authenticated.

 

“Notify on Disconnect”

Only applicable for radius enabled accounts. Indicate whether to send out an outbound notification event when a device previously connected has closed/lost its connection and or when the connection is considered no longer valid and closed.

 

“Notify on Error”

Indicate whether to send out an outbound notification event when an error occurs for an uplink event i.e. an uplink message from the device could not be delivered to the data endpoint configured on this service template, or device validation failed, device attempts to use SAP not permitted, for managed_tls and dtls services if device certificate validation fails, etc.

 

“Events Storage Service”

This services requires that you have the event_notification_service enabled on your account. By default the notifications events generated and sent to your application endpoints are not stored in the device queues. The event storage service adds the capability to store the notification events. The event related to each device will become visible in the device shipped queue or failed queue depending on whether the notification was successfully delivered.

 

Was this article helpful to you? Yes No

How can we help?