Webhook Details and Code Samples

Alerting and Reporting

NetCloud Feature
Monitoring and Diagnostics > Alerts and Logs
ft:locale
en-US
ft:sourceName
Paligo_Prod

Webhooks (aka "Push alerts") provide a simplified messaging standard (RFC8030) for communication between remote applications. Application inter-messaging is often accomplished using a message queueing/subscribing approach. Webhooks use a simpler, direct-messaging approach that requires less overhead and includes the capability to authenticate messages between remote applications.

The webhooks model follows this process:

  1. An event occurs in a remote application.

  2. The remote application is configured to call a URL you provide, when the event occurs. This URL will typically be routed to a function in your application, or "webhook." The event-providing remote application sends a message that, by design, your application can understand. The convention is to use messages that are JSON objects. These messages describe state changes in the remote application that your application wants to know.

  3. Your application can take some action based on the message contents. The action your application takes could be anything from updating a database to sending an email.

The NetCloud webhook implementation is used to notify your application when NetCloud alerts occur. This process uses the following steps.

  1. Tell NetCloud where to send, or push, the message.

    1. Configure an Alert Push Destination using the alert_push_destination endpoint. Use a URL in the endpoint field that points to your function for processing the message, and add a "secret" value in the authentication field to allow the message to be validated by your webhook.

  2. Test the Alert Push Destination by using the test_alert_push_destination endpoint.

Configure an Alert Rule and reference the Alert Push Destination. This is done by adding the value from the Alert Push Destination's destination_config_id field to the http_destinations field in the Alert Rule. This links the Alert Push Destination to the Alert Rule.

To view additional documentation on Webhooks, including additional code samples, refer to https://developer.cradlepoint.com/documentation/webhooks.