Azure Event Hubs Trigger Outputs and Integrations

George Alpizar
George Alpizar
  • Updated

Overview

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

Before you begin

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


Review Parameters

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

Visual Editor YAML Description
Name name

Enter a descriptive name for the output or integration.

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

This parameter is required. 

Review the following example:

name: eventhub-test
Integration integration_name

This parameter only appears when you create an individual output.

This parameter refers to the organization-level integration created in the Integrations page. If you enter this name, then the rest of the fields will be automatically populated.

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 field. In this situation, the name should be used to refer to the specific instance of the destination in the workflows.

This parameter is optional. 

Review the following example:

integration_name: ed-alert-azureevent
Not applicable type

Enter eventhub.

This parameter is required. 

Review the following example:

type: eventhub
Endpoint endpoint

Enter the Event Hubs endpoint.

This parameter is required. 

Review the following example:

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

Enter the Azure AD token.

This parameter is required. 

Review the following example:

token: "test-token"
Custom Headers and Custom Fields custom_headers and custom_fields

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.

This parameter is optional. 

Review the following example: 

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

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"

Share this document