README

Azure event sinks for mageos-async-events

Installation

composer require mage-os/mageos-async-events-azure

Authentication

Microsoft Entra is used to authenticate with Azure services. An Azure Service Principal with the EventGrid Data Sender role is required so that the notifier can relay events into Azure Event Grid.

Configure OAuth parameters in the Magento admin panel.

Under Stores -> Services -> Async Events Azure set the Tenant ID, Client ID and the Client Secret.

Best Practices

• Create a resource group for Magento and assign RBAC permissions to the service principal at the resource group level.
• Create a separate Event Grid topic for each Magento website.
• For further filtering such as based on magento stores or event types, use Azure Event Grid's advanced filtering capabilities.

Azure event sinks

Azure Event Grid

This module provides an event sink for Azure Event Grid. This allows you to relay events into Azure Event Grid, enabling you to integrate with other Azure services or third-party applications that support Event Grid.

The Event Grid topic must use the CloudEvents schema. Events are sent in the structured content mode of CloudEvents.

Create an Event Grid Subscription

The following is an example to create an Event Grid subscription for the example.event

curl --location --request POST 'https://test.mageos.dev/rest/V1/async_event' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "asyncEvent": {
        "event_name": "example.event",
        "recipient_url": "Event Grid Topic Endpoint",
        "verification_token": "secret",
        "metadata": "eventgrid"
    }
}'

Contributing

This is a repository for distribution only. Contributions are welcome on the development repository mageos-async-events-sinks