Heroku Kafka API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "heroku_kafka",
"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",
"config": {
"consumer_group": "consumer_group",
"servers": "serveraddress1:8080, serveraddress2:8080",
"sync_type": "Unpacked | Packed",
"client_cert": "client_certificate_value",
"key_store_type": "PKCS12",
"trust_store_type": "PKCS12",
"security_protocol": "PLAINTEXT | TLS | SASL",
"client_cert_key": "client_certificate_key",
"message_type": "Avro | Json | Text | Protobuf",
"trusted_cert": "trusted_certificate_value",
"schema": "schema_name"
}
}Config parameters
| Name | Description |
|---|---|
consumer_group | Heroku Kafka consumer group name. |
servers | Comma-separated list of Heroku Kafka servers in the format server:port. |
sync_type | Heroku Kafka sync type. Unpacked messages must be valid JSON. |
client_cert | Heroku Kafka client certificate. Required for TLS security protocol. |
key_store_type | Key Store Type |
trust_store_type | Trust Store Type |
security_protocol | Security protocol for Heroku Kafka interaction. |
client_cert_key | Heroku Kafka client certificate key. Required for TLS security protocol. |
message_type | Heroku Kafka message type. |
trusted_cert | Heroku Kafka trusted certificate. Required for TLS security protocol. |
schema | 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
consumer_groupandserversparameters in the request.POST https://api.fivetran.com/v1/connections{ "service": "heroku_kafka", "group_id": "group_id", "config": { "consumer_group": "consumer_group", "servers": "serveraddress1:8080, serveraddress2:8080" } }By using the Connect Card or the Fivetran dashboard.