Azure Event Hubs Triggering Output and Integration

George Alpizar
George Alpizar
  • Updated

Overview

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

Before you begin

To create this output, you must have an Azure AD token.


Review Sample Configuration

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

    - name: eventhub-test
      type: eventhub
      endpoint: https://eventshub-test.servicebus.windows.net/test/messages
      token: "test-token"
      notify_content:
        custom_fields:
          "test-field": "test"
      custom_headers:
        X-header1: "test-header"

Review Parameters

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


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: eventhub-test

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-azureevent

type

Required

Enter eventhub.

Review the following example:

type: eventhub

endpoint

Required

Enter the Event Hubs endpoint.

Review the following example:

endpoint: https://eventshub-test.servicebus.windows.net/test/messages

token

Required

Enter the Azure AD token.

Review the following example:

token: "test-token"

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: 

notify_content: 
custom_fields:
"test-field": "test"
custom_headers:
X-header1: "test-header"

 


Share this document