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",
  "config": {
    "connection_string": "connection_string",
    "consumer_group": "consumer_group",
    "message_type": "Text | Json",
    "sync_type": "Packed | Unpacked",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`connection_string`	Connection string of the Event Hub Namespace you want to sync.
`consumer_group`	Name of consumer group created for Fivetran.
`message_type`	Message type.
`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 two 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 using the Connect Card or the Fivetran dashboard.