Skip to main content
POST
Register Event Hub Function

Authorizations

X-EntityToken
string
header
required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json

A title can have many functions, RegisterEventHubFunction associates a function name with an event hub name and connection string.

A title can have many functions, RegisterEventHubFunction associates a function name with an event hub name and connection string.

ConnectionString
string
required

A connection string for the namespace of the event hub for the Azure Function.

EventHubName
string
required

The name of the event hub for the Azure Function.

FunctionName
string
required

The name of the function to register

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 1, 2026