Azure Event Hubs API Configuration

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "azure_event_hub",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "LOW",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "data_checks": true,
  "config": {
    "auth_type": "SERVICE_PRINCIPAL_SECRET",
    "connection_string": "connection_string",
    "consumer_group": "consumer_group",
    "event_hub_name": "my-event-hub",
    "message_type": "Text | Json",
    "namespace": "my-namespace",
    "sync_type": "Packed | Unpacked",
    "schema": "schema_name"
  },
  "auth": {
    "client_certificate": "client_certificate",
    "client_certificate_private_key": "certificate_private_key",
    "client_certificate_private_key_passphrase": "certificate_private_key_passphrase",
    "client_id": "client_id",
    "client_secret": "client_secret",
    "tenant_id": "tenant_id"
  }
}

Config parameters

Name	Description
`auth_type`	Authentication type: `CONNECTION_STRING`, `SERVICE_PRINCIPAL_SECRET` or `SERVICE_PRINCIPAL_CERTIFICATE`. Defaults to `CONNECTION_STRING`.
`connection_string`	Connection string of the Event Hub Namespace you want to sync.
`consumer_group`	Name of consumer group created for Fivetran.
`event_hub_name`	Name of the single Event Hub to sync. Optional, used with service principal authentication; all Event Hubs in the namespace are synced when empty.
`message_type`	Message type.
`namespace`	Name of your Event Hubs namespace, without the `.servicebus.windows.net` suffix. Used with service principal authentication.
`sync_type`	Sync type. Unpacked messages must be valid JSON.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are three ways to authorize this connector type:

By specifying the values for the connection_string and consumer_group parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "azure_event_hub",
  "group_id": "group_id",
  "config": {
    "connection_string": "connection_string",
    "consumer_group": "consumer_group"
  }
}

By specifying the values for the tenant_id, client_id, client_secret, client_certificate, client_certificate_private_key and client_certificate_private_key_passphrase parameters in the auth section and the values for the auth_type, namespace, event_hub_name and consumer_group parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "azure_event_hub",
  "group_id": "group_id",
  "config": {
    "auth_type": "SERVICE_PRINCIPAL_SECRET",
    "namespace": "my-namespace",
    "event_hub_name": "my-event-hub",
    "consumer_group": "consumer_group"
  },
  "auth": {
    "tenant_id": "tenant_id",
    "client_id": "client_id",
    "client_secret": "client_secret",
    "client_certificate": "client_certificate",
    "client_certificate_private_key": "certificate_private_key",
    "client_certificate_private_key_passphrase": "certificate_private_key_passphrase"
  }
}

Auth Parameters

Name	Description
`client_certificate`	`Client Certificate` of your Microsoft Entra ID application. Used with the `SERVICE_PRINCIPAL_CERTIFICATE` authentication type.
`client_certificate_private_key`	`Certificate Private Key` of your Microsoft Entra ID application. Used with the `SERVICE_PRINCIPAL_CERTIFICATE` authentication type.
`client_certificate_private_key_passphrase`	`Certificate Private Key Passphrase`, if the private key is encrypted. Used with the `SERVICE_PRINCIPAL_CERTIFICATE` authentication type.
`client_id`	`Application (client) ID` of your Microsoft Entra ID application.
`client_secret`	`Client Secret` of your Microsoft Entra ID application. Used with the `SERVICE_PRINCIPAL_SECRET` authentication type.
`tenant_id`	`Directory (tenant) ID` of your Microsoft Entra ID application.

Service principal authentication. Use client_secret, or the certificate fields, depending on auth_type.

By using the Connect Card or the Fivetran dashboard.