Azure Event Hubs API Configuration

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

Config parameters

Name	Description
`consumer_group`	Name of consumer group created for Fivetran.
`sync_type`	Sync type. Unpacked messages must be valid JSON.
`message_type`	Message type.
`connection_string`	Connection string of the Event Hub Namespace you want to sync.
`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.