Webhook Triggering Output and Integration

George Alpizar
George Alpizar
  • Updated

Overview

This output type sends notifications and alerts to a specified Webhook URL.


Review Sample Configuration

The following sample configuration displays an output without the name of the organization-level integration:

      - name: webhook-integration
        type: webhook
        endpoint: "localhost"
        payload:
          signature: "{{.MetricName}}"
          source_id: "{{.Host}}"
          external_id: "{{.EDAC}}"
          manager: "edgedelta"
          source: "{{.Host}}"
          class: "application"
          agent_location: "{{.Host}}"
          type: "{{.SourceType}}"
          agent_time: "{{.Epoch}}"
        notify_content:
          advanced_content: |
            {
              "foo": {
                "title": "{{ .Title }}",
                "message": "{{ .Message }}",
                "foo2": "bar2"
              }
            }

Review Parameters

Review the following parameters that you can configure in the Edge Delta App.

teesting

name

Required

Enter a descriptive name for the output or integration.

For outputs, this name will be used to map this destination to a workflow.

Review the following example:

name: webhook-output

integration_name

Optional 

This parameter refers to the organization-level integration created in the Integrations page. 

If you need to add multiple instances of the same integration into the config, then you can add a custom name to each instance via the name parameter. In this situation, the name should be used to refer to the specific instance of the destination in the workflows.

Review the following example:

integration_name: ed-alert-webhook

type

Required 

Enter webhook.

Review the following example:

type: webhook

endpoint

Required 

Enter the Webhook API endpoint.

Review the following example:

endpoint: "localhost"

username

Optional

Enter the username for Webhook basic authentication.

Review the following example:

username: user1

password

Optional 

Enter the password for Webhook basic authentication.

Review the following example:

password: 12345

custom_headers and custom_fields

Optional 

This parameter is used to customize the notification content.

If you do not want to use default fields in a notification, then you can create custom headers and fields.

To learn more, see Review Notify Content Parameters.

Review the following example: 

custom_headers: 
Accept: "application/vnd.pagerduty+json;version=2"
Content-Type: "application/json"
Authorization: "Token token=XXXXXXXXXX"
From: "user@edgedelta.com"

notify_content: advanced_content

Optional 

A payload is JSON object that is used to define metadata about the message.

You are responsible for ensuring the validity of the JSON object. 

Additionally, configurations you make in this parameter will override all other configurations, including custom_fields, title, and disable_default_fields.

To learn more, see Review Template Values for Trigger Payloads.

Review the following example: 

        notify_content:
          advanced_content: |
            {
              "foo": {
                "title": "{{ .Title }}",
                "message": "{{ .Message }}",
                "foo2": "bar2"
              }
            }

 


 

Share this document