Skip to main content

Set up outbound notifications

Outbound integrations enable you to send data or notifications to tools such as ServiceNow and PagerDuty. Moogsoft Cloud also includes a generic outbound webhook that you can use to send data to other tools as appropriate. See also Outbound Integrations API.

Moogsoft includes two types of webhooks:

Incident webhook

The incident webhook is designed for use with Moogsoft incident workflow. If you need to work with alerts instead, use the alert webhook. Incident webhooks require the following information:

  • Name and (optional) Description — Define a unique name for your webhook, choose whether to send alerts or incidents, and optionally include a description.

  • Triggers — Select the field changes that cause the webhook to trigger.

  • Endpoint — The URL of the external system

  • Payload body — Define a JSON object with the alert or incident data you want to send.

    Payload body entry supports "smart type-ahead" functionality:

    1. Make sure there is a space before the cursor.

    2. Press the dollar sign ($) to open a pop-up menu.

    3. Select the alert or incident field you want to include in the payload.

    You can also use $outbound.<my_integration_name>.external_name or $outbound.<my_integration_name>.external_id to construct URLs which access ticket (or equivalent) information.

Alert webhook

The outbound alert webhook is designed to be flexible and generic enough to support any external tool that can ingest JSON objects over HTTP or HTTPS. Each webhook requires the following information:

  • Name and Scope — Define a unique name for your webhook, choose whether to send alerts or incidents, and optionally define a filter for outgoing notifications.

  • Create Operation and HTTP Configuration — Specify the request method and external endpoint where you want to send your alerts or incidents, provide authorization data for the external system, and define headers for the outbound webhook.

  • Payload Body for Create Operation — Define a JSON object with the alert or incident data you want to send.

    Payload body entry supports "smart type-ahead" functionality:

    1. Make sure there is a space before the cursor.

    2. Press the dollar sign ($) to open a pop-up menu.

    3. Select the alert or incident field you want to include in the payload.

      You can also enter ${alert_url} or ${incident_url} to include a URL in the payload. These URLs open the alert or incident directly in the Moogsoft UI.

  • Map the Response Payload — Optionally, describe how to parse responses to the webhook in order to generate links in Moogsoft to alerts or incidents in the external system.

  • Update Notifications — Optionally, enable sending updates to the external system when alerts or incidents change (for example, when status or severity changes).

  • Payload Body for Update Operation — When updates are enabled, define a JSON object with the updated alert or incident data you want to send.