Skip to main content
Skip table of contents

Azure Event Grid

Edition: SaaS Enterprise

Event Grid notifications follow the default Event Grid schema. The notification specific content is contained in the data object. Fields subject, eventType, and id are constructed from the notification content.

Setting up Azure Event Grid for notifications

To enable delivery of Agile Data Engine events to Azure Event Grid:

  1. Create a custom Event Grid Topic with the following settings:

    • Set EventGridSchema as input schema

    • Enable public network access

    • Enable system assigned identity (to authenticate event delivery to further Azure services)

  2. Provide the topic endpoint address and an access key securely to Agile Data Engine support.

  3. Once support has configured event delivery to the Event Grid topic, configure event subscriptions to deliver events to further services.

Currently supported event types

Event Grid event type

Notification type reference

AdeCore.WorkflowOrchestration.WorkflowFailure

WorkflowFailure

AdeCore.WorkflowOrchestration.WorkflowSuccess

WorkflowSuccess

AdeCore.WorkflowOrchestration.SmokeTestFailure

SmokeTestFailure

Example notification

JSON
[
  {
    "subject": "/s1234567/datahub/runtime",
    "eventType": "AdeCore.WorkflowOrchestration.WorkflowFailure",
    "id": "4fd01f17-4403-4a20-be86-3728611b4ad4",
    "data": {
      "sourceId": "cf1e80db-3c1a-4b7b-88b7-2518b229603a",
      "tenant": "s1234567",
      "installation": "datahub",
      "environment": "runtime",
      "notificationId": "4fd01f17-4403-4a20-be86-3728611b4ad4",
      "notificationChannel": "0bf43704-8ac7-4ca8-86e1-155de3e56389",
      "notificationLevel": "WARN|ERROR",
      "notificationType": "OPERATIONAL",
      "notificationTime": "2022-01-13T12:50:05.358Z",
      "notificationSource": "AdeCore/WorkflowOrchestration",
      "contentText": "Workflow MY_DAG failed: Some problem description.",
      "contentType": "WorkflowFailure",
      "contentLink": "https://external.runtime.datahub.s1234567.agiledataengine.com/dagger/graph?dag_id=MY_DAG&execution_date=2022-01-12T10%3A16%3A58.119141%2B00%3A00"
    },
    "dataVersion": 1,
    "metadataVersion": 1,
    "eventTime": "2022-01-13T12:50:05.358Z",
    "topic": "/subscriptions/6e79ca94-7fe6-4f22-a1b5-8af31cfc7bef/resourceGroups/resource-group-name/providers/Microsoft.EventGrid/topics/topic-name"
  }
]

Field

Type

Notes

subject

String

Subject is build from tenant, installation and environment fields to indicate the origin of the event.

eventType

String

Combined from data fields notificationSource and contentType separating them with a dot (.) and replacing any slashes (/) with dots. (.)

id

UUID

Notification id.

Same as notificationId in data section.

data

Object

Contains versioned data of the notification.

Notification content v1

metadataVersion

Integer

EventGrid schema version.

dataVersion

Integer

Data content version.

Currently only version 1.

eventTime

Timestamp

Time when the notification was sent.

topic

String

EventGrid topic information.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.