Add a custom endpoint or custom app destination to an eventstream

To connect your own application to an eventstream, add a custom endpoint or a custom app as a destination. By using this connection, you can consume real-time events from the eventstream to your own application. When you use the Apache Kafka protocol with custom endpoints or custom apps, you can consume real-time events by using the Apache Kafka protocol.

This article shows you how to add a custom endpoint destination or a custom app destination to an eventstream in Microsoft Fabric event streams.

Prerequisites

Before you start, make sure you have access to the workspace where your eventstream is located. The workspace must have a Fabric capacity or Fabric Trial workspace type.

• You need Contributor or higher permissions to edit the eventstream and add a Custom endpoint destination.
• To use Entra ID authentication to connect your application, you need Member or higher permissions.

If you're using Entra ID authentication, make sure the managed identity of the custom endpoint has the required permissions. Configure the necessary settings in the Admin portal:

1. Select Settings (gear icon) in the upper-right corner.

2. Select Admin portal under the Governance and insights section.

   

3. Activate the following tenant setting to grant the service principal access to Fabric APIs for creating workspaces, connections, or deployment pipelines:

   • On the Tenant settings page, in the Developer settings section, expand the Service principal can use Fabric API option.
   • Set to Enabled.
   • Apply to the entire organization.
   • Select Apply.

   

4. Enable this option to access all other APIs (enabled by default for new tenants):

   • Still on the Tenant settings page, expand the Allow Service principals to create and use profiles option.
   • Set to Enabled.
   • Apply to the entire organization.
   • Select Apply.

Add a custom endpoint as a destination

To route event data to your app, add a custom endpoint as your eventstream destination:

1. If you're in the live view, switch to edit mode by selecting Edit on the ribbon.

   

2. In edit mode, add a custom endpoint destination in one of the following ways:

   • Select Add destination on the ribbon, select Custom endpoint, and then connect the endpoint to your default stream or derived stream.

     

   • In the editor, select Transform events or add destination, and then select Custom endpoint.

     

3. For Destination name, enter a name for the custom endpoint. Then select Save.

   

   If you're using schemas at the source, for Input schema, select the schema for events. This field is the extra field you fill when you enable the schema support for an eventstream.

   

4. Connect the default stream tile to the custom endpoint tile if there's no existing connection.

   

5. To view the detailed information for your custom endpoint, select Publish.

   

Get endpoint details on the Details pane to consume events

In Live view, select the custom endpoint tile. The Details pane that appears includes three protocol tabs: Event Hub, AMQP, and Kafka.

Each protocol tab contains three pages: Basic, SAS Key Authentication, and Entra ID Authentication. These pages provide endpoint information specific to the selected protocol.

• The Basic page shows the name, type, and status of your custom endpoint.

  

• SAS Key Authentication and Entra ID Authentication are two supported authentication methods for connecting to your application:

  • SAS Key Authentication provides the information needed to produce and consume Eventstream data using Shared Access Signature (SAS) keys.
  • Entra ID Authentication enables a security principal (such as a user or service principal) to consume Eventstream data using Microsoft Entra ID authentication.

For steps to use Entra ID Authentication, see Enable Entra ID Authentication for an Application in Eventstream.
The following section describes how to connect to a custom endpoint destination using SAS Key Authentication.

Event hub

The Keys page on the Event Hub tab contains information related to an event hub's connection string. The information includes Event hub name, Shared access key name, Primary key, and Connection string-primary key.

The event hub format is the default for the connection string, and it works with the Azure Event Hubs SDK. This format allows you to connect to your eventstream via the Event Hubs protocol.

The following example shows what the connection string looks like in event hub format:

Endpoint=sb://eventstream-xxxxxxxx.servicebus.windows.net/;SharedAccessKeyName=key_xxxxxxxx;SharedAccessKey=xxxxxxxx;EntityPath=es_xxxxxxx

Select Show sample code on the Event Hub page to get ready-to-use code that includes the required information about connection keys in the event hub. Simply copy and paste it into your application for use.

Kafka

The Kafka format is compatible with the Apache Kafka protocol, which is a popular distributed streaming platform that supports high-throughput and low-latency data processing. You can use the Keys and Sample code information for the Kafka protocol format to connect to the eventstream and consume the events.

Select Show sample code on the Kafka page to get ready-made code, including the necessary connection keys in Kafka format. Simply copy it for your use.

For a clear guide on using the custom endpoint with the Kafka protocol, see this tutorial. It provides detailed steps for streaming and consuming events using the custom endpoint with the Kafka protocol.

AMQP

The AMQP format works with the AMQP 1.0 protocol, which is a standard messaging protocol that supports interoperability between various platforms and languages. Use this format to connect to your eventstream by using the AMQP protocol.

Select Show sample code on the AMQP page to get ready-to-use code with connection key information in AMQP format.

Choose the protocol format that suits your application needs and preferences, and then copy and paste the connection string into your application. You can also refer to or copy the sample code on the Sample code page, which shows how to send or receive events by using various protocols.

Related content

To learn how to add other destinations to an eventstream, see the following articles:

• Derived stream
• KQL Database
• Lakehouse
• Fabric Activator