Documentation is now available for the Fall 2020 Update release!

Webhook Integration

Describes how to stream alerts using webhook.

Leave Feedback

Introduction

Using Alerts streaming, subscribe to data streams of raw or deduped Opsramp alerts to your webhook.

Prerequisites:

  • Webhook URL for subscription
  • Access credential of a Partner

Alert streaming requires the following two steps:

  1. Configuring the integration as a partner: Install the Webhook integration and configure for alert streaming.
  2. Enabling the configured integration: Enable the integration configured for the desired clients from Exports.

Step 1: Configuring the integration

Install and configure the webhook integration.

To install and configure:

  1. From All Clients, select a client.
  2. Go to Setup > Integrations > Integrations.
  3. From Available Integrations > Exports, click Webhook.
  4. Click Install on the Webhook Integration page.
  5. Enter a unique Name for the integration on the Install Webhook Integration dialog box and click Install.
    The Alert Streaming Configuration tab displays the Webhook Configuration section.
  6. Enter the following details and click Save:
    • Webhook URL: Requires your webhook URL.
    • Headers: Default header is Content-Type. Click + to add more headers.
      OpsRamp supports only JSON content-type.
    • Payload: Enter a payload or select the desired category for the default payloads available as Placeholders on the right pane.Now, apply the configured integration to stream alerts.

Step 2: Enabling alert stream

  1. Go to Setup > Exports > Streaming Export.
  2. Click + to add new streaming.
  3. Perform the following options on the New Streaming Export page and click Save & Run:
    • Streaming Export Name: Enter a unique name.
    • Clients: Select names of all clients for whom you want to trigger streaming.
    • Export Category Type: Select Alerts from the drop-down menu.
    • Stream Exports to: Select the Webhook integration. The drop-down menu lists all the integrations that are configured for alert streaming.
    • Send raw events: Select the checkbox to stream raw events. Deduped alerts are the default option for streaming.

After successful configuration, the alert streaming starts for the selected channel. The alerts are visible at Alert Browser on the console.

View alerts of the Target Customer

To view streaming alerts:

  1. Go to Setup > Alerts.
  2. Search for the related alert and view.

More information: Create Stream Export