curl -X PATCH "https://api.sequinstream.com/api/sinks/kafka-ids" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"status": "disabled",
"batch_size": 50,
"message_grouping": true,
"load_shedding_policy": "pause_on_full"
}'
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-kafka-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "kafka",
"hosts": "localhost:9092",
"tls": false,
"topic": "records",
"username": "kafka_user",
"password": "kafka_password",
"sasl_mechanism": "PLAIN"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-sqs-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "sqs",
"queue_url": "https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue",
"region": "us-east-1",
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-rabbitmq-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "rabbitmq",
"host": "localhost",
"port": 5672,
"username": "guest",
"password": "guest",
"virtual_host": "/",
"tls": false,
"exchange": "records"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-redis-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "redis_stream",
"host": "localhost",
"port": 6379,
"stream_key": "records",
"database": 0,
"tls": false,
"username": "redis_user",
"password": "redis_password"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-azure-event-hub-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "azure_event_hub",
"namespace": "my-namespace",
"event_hub_name": "records",
"shared_access_key_name": "RootManageSharedAccessKey",
"shared_access_key": "your-shared-access-key"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-nats-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "nats",
"host": "localhost",
"port": 4222,
"username": "nats_user",
"password": "nats_password",
"jwt": "your-jwt-token",
"nkey_seed": "your-nkey-seed",
"tls": false
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-gcp-pubsub-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "gcp_pubsub",
"project_id": "my-project",
"topic_id": "records",
"credentials": "base64-encoded-credentials",
"use_emulator": false,
"emulator_base_url": "http://localhost:8085"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-s2-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "s2",
"basin": "my-basin",
"stream": "my-stream",
"access_token": "my-access-token"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-sequin-stream-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "sequin_stream"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-webhook-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "webhook",
"http_endpoint": "my-endpoint",
"http_endpoint_path": "/webhook",
"batch": true
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-elasticsearch-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "elasticsearch",
"endpoint_url": "http://localhost:9200",
"index_name": "records",
"auth_type": "basic",
"auth_value": "base64-encoded-credentials",
"batch_size": 100
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-kinesis-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "kinesis",
"stream_arn": "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream",
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-meilisearch-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "meilisearch",
"endpoint_url": "http://localhost:7700",
"index_name": "records",
"primary_key": "id",
"api_key": "your-api-key",
"batch_size": 100,
"timeout_seconds": 5
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-redis-string-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "redis_string",
"host": "localhost",
"port": 6379,
"database": 0,
"tls": false,
"username": "redis_user",
"password": "redis_password",
"expire_ms": 3600000,
"mode": "static"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-sns-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "sns",
"topic_arn": "arn:aws:sns:us-east-1:123456789012:MyTopic",
"region": "us-east-1",
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"is_fifo": false
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-typesense-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "typesense",
"endpoint_url": "http://localhost:8108",
"collection_name": "records",
"api_key": "your-api-key",
"batch_size": 100,
"timeout_seconds": 5
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
Sink consumers
Update sink consumer
PATCH
/
sinks
/
{sink_id_or_name}
curl -X PATCH "https://api.sequinstream.com/api/sinks/kafka-ids" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"status": "disabled",
"batch_size": 50,
"message_grouping": true,
"load_shedding_policy": "pause_on_full"
}'
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-kafka-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "kafka",
"hosts": "localhost:9092",
"tls": false,
"topic": "records",
"username": "kafka_user",
"password": "kafka_password",
"sasl_mechanism": "PLAIN"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-sqs-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "sqs",
"queue_url": "https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue",
"region": "us-east-1",
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-rabbitmq-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "rabbitmq",
"host": "localhost",
"port": 5672,
"username": "guest",
"password": "guest",
"virtual_host": "/",
"tls": false,
"exchange": "records"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-redis-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "redis_stream",
"host": "localhost",
"port": 6379,
"stream_key": "records",
"database": 0,
"tls": false,
"username": "redis_user",
"password": "redis_password"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-azure-event-hub-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "azure_event_hub",
"namespace": "my-namespace",
"event_hub_name": "records",
"shared_access_key_name": "RootManageSharedAccessKey",
"shared_access_key": "your-shared-access-key"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-nats-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "nats",
"host": "localhost",
"port": 4222,
"username": "nats_user",
"password": "nats_password",
"jwt": "your-jwt-token",
"nkey_seed": "your-nkey-seed",
"tls": false
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-gcp-pubsub-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "gcp_pubsub",
"project_id": "my-project",
"topic_id": "records",
"credentials": "base64-encoded-credentials",
"use_emulator": false,
"emulator_base_url": "http://localhost:8085"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-s2-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "s2",
"basin": "my-basin",
"stream": "my-stream",
"access_token": "my-access-token"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-sequin-stream-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "sequin_stream"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-webhook-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "webhook",
"http_endpoint": "my-endpoint",
"http_endpoint_path": "/webhook",
"batch": true
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-elasticsearch-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "elasticsearch",
"endpoint_url": "http://localhost:9200",
"index_name": "records",
"auth_type": "basic",
"auth_value": "base64-encoded-credentials",
"batch_size": 100
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-kinesis-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "kinesis",
"stream_arn": "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream",
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-meilisearch-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "meilisearch",
"endpoint_url": "http://localhost:7700",
"index_name": "records",
"primary_key": "id",
"api_key": "your-api-key",
"batch_size": 100,
"timeout_seconds": 5
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-redis-string-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "redis_string",
"host": "localhost",
"port": 6379,
"database": 0,
"tls": false,
"username": "redis_user",
"password": "redis_password",
"expire_ms": 3600000,
"mode": "static"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-sns-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "sns",
"topic_arn": "arn:aws:sns:us-east-1:123456789012:MyTopic",
"region": "us-east-1",
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"is_fifo": false
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-typesense-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "typesense",
"endpoint_url": "http://localhost:8108",
"collection_name": "records",
"api_key": "your-api-key",
"batch_size": 100,
"timeout_seconds": 5
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
Updates an existing sink consumer.
The request body can include any of the following fields:
Request fields
The name or ID of the sink consumer to update
The name of the sink consumer
The current status of the sink consumer (active, disabled, paused)
The source configuration for the sink consumer
Show source properties
Show source properties
List of schemas to include, or null to include all
List of schemas to exclude, or null to exclude none
List of tables to include, or null to include allA table name can be specified with schema (e.g.
my-schema.my-table) or without (e.g. my-table) which defaults to schema public.List of tables to exclude, or null to exclude noneA table name can be specified with schema (e.g.
my-schema.my-table) or without (e.g. my-table) which defaults to schema public.Additional configuration for individual tables.To configure which tables are consumed, see the
source field.The database actions to include in the sink (insert, update, delete)
The filter function for the sink consumer
The transform function for the sink consumer
The routing function for the sink consumer
Whether to enable message grouping for ordering purposes. When
true (default), messages are grouped by primary key or custom grouping columns. When false, grouping is disabled for higher throughput batching.Number of records to batch together (1-1000)
The maximum number of times a message will be retried if delivery fails. Once this limit is reached, the message will be discarded.
Defaults to
null, meaning messages are retried indefinitely.Determines how Sequin handles overload when sink consumers can’t keep up with incoming messages.
Options are:
pause_on_full(default) — pauses replication until the buffer has room againdiscard_on_full— drops messages for overloaded consumers to avoid pausing replication
The format of the timestamp in the source data.
Possible values include
iso8601 and unix_microsecond.Additional metadata you can attach to this sink consumer. Annotations can be any JSON object (not a list or a scalar).Annotations are passed in the default message shape to your destination. They are also available in filter, transform, and routing functions.
The destination configuration for the sink consumer. The shape varies by destination type.
Show Kafka
Show Kafka
Must be “kafka”
Comma-separated list of Kafka hosts
Whether to use TLS
Kafka topic name
Optional username for authentication
Optional password for authentication
Optional SASL mechanism (PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, AWS_MSK_IAM)
AWS region (required for AWS_MSK_IAM)
AWS access key ID (required for AWS_MSK_IAM)
AWS secret access key (required for AWS_MSK_IAM)
Show SQS
Show SQS
Show Kinesis
Show Kinesis
Show RabbitMQ
Show RabbitMQ
Show Redis Stream
Show Redis Stream
Show Redis String
Show Redis String
Must be “redis_string”
Redis host
Redis port
Redis database number (default: 0)
Whether to use TLS
Optional username for authentication
Optional password for authentication
Optional TTL in milliseconds for the keys
Mode of operation (static or dynamic, default: static)
Show Azure Event Hub
Show Azure Event Hub
Show NATS
Show NATS
Show GCP PubSub
Show GCP PubSub
Show Elasticsearch
Show Elasticsearch
Must be “elasticsearch”
Elasticsearch endpoint URL
Elasticsearch index name
Authentication type (api_key, basic, bearer)
Authentication value, either an API key or a base64-encoded string of a username and password
Number of documents to batch together (default: 100)
Show Meilisearch
Show Meilisearch
Must be “meilisearch”
Meilisearch endpoint URL
Meilisearch index name
Primary key field name (default: “id”)
Meilisearch API key
Number of documents to batch together (default: 100)
Request timeout in seconds (default: 5)
Show S2
Show S2
Show Sequin Stream
Show Sequin Stream
Must be “sequin_stream”
Show SNS
Show SNS
Show Typesense
Show Typesense
Show Webhook
Show Webhook
Must be “webhook”
HTTP endpoint name
HTTP endpoint path
Whether the webhook body should be wrapped in a list to support batching. Defaults to
true.Response fields
The unique identifier of the sink consumer
The name of the sink consumer
The current status of the sink consumer (active, disabled, paused)
The source database for the sink consumer
The source configuration for the sink consumer. This determines which tables are consumed.
Show source properties
Show source properties
List of schemas to include, or null to include all
List of schemas to exclude, or null to exclude none
List of tables to include, or null to include allA table name can be specified with schema (e.g.
my-schema.my-table) or without (e.g. my-table) which defaults to schema public.List of tables to exclude, or null to exclude noneA table name can be specified with schema (e.g.
my-schema.my-table) or without (e.g. my-table) which defaults to schema public.Additional configuration for individual tables.To configure which tables are consumed, see the
source field.The database actions to include in the sink (insert, update, delete)
The destination configuration for the sink consumer. The shape varies by destination type.
Show destination properties
Show destination properties
Show Azure Event Hub properties
Show Azure Event Hub properties
Show Elasticsearch properties
Show Elasticsearch properties
Show GCP PubSub properties
Show GCP PubSub properties
Show Webhook properties
Show Webhook properties
Must be “webhook”
HTTP endpoint name
HTTP endpoint path
Whether the webhook body should be wrapped in a list to support batching.
Show Kafka properties
Show Kafka properties
Must be “kafka”
Comma-separated list of Kafka hosts
Whether to use TLS
Kafka topic name
Optional username for authentication
Optional password for authentication
Optional SASL mechanism (plain, scram_sha_256, scram_sha_512, aws_msk_iam)
AWS region (required for aws_msk_iam)
AWS access key ID (required for aws_msk_iam)
AWS secret access key (required for aws_msk_iam)
Show Kinesis properties
Show Kinesis properties
Show Meilisearch properties
Show Meilisearch properties
Must be “meilisearch”
Meilisearch endpoint URL
Meilisearch index name
Primary key field name (default: “id”)
Meilisearch API key
Number of documents to batch together (default: 100)
Request timeout in seconds (default: 5)
Show NATS properties
Show NATS properties
Show RabbitMQ properties
Show RabbitMQ properties
Show Redis Stream properties
Show Redis Stream properties
Show Redis String properties
Show Redis String properties
Must be “redis_string”
Redis host
Redis port
Redis database number (default: 0)
Whether to use TLS
Optional username for authentication
Optional password for authentication
Optional TTL in milliseconds for the keys
Mode of operation (static or dynamic, default: static)
Show S2 properties
Show S2 properties
Show Sequin Stream properties
Show Sequin Stream properties
Must be “sequin_stream”
Show SNS properties
Show SNS properties
Show SQS properties
Show SQS properties
Show Typesense properties
Show Typesense properties
The filter function for the sink consumer
The transform function for the sink consumer
The routing function for the sink consumer
The enrichment function for the sink consumer
Whether message grouping is enabled for delivery orderingSee message grouping and ordering for more details.
The maximum number of times a message will be retried if delivery fails
User-defined annotations for the sink consumer
Array of active backfill IDs
Number of records to batch together (1-1000)
Determines how Sequin handles overload when sink consumers can’t keep up with incoming messages
The format of the timestamp in the source data
curl -X PATCH "https://api.sequinstream.com/api/sinks/kafka-ids" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"status": "disabled",
"batch_size": 50,
"message_grouping": true,
"load_shedding_policy": "pause_on_full"
}'
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-kafka-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "kafka",
"hosts": "localhost:9092",
"tls": false,
"topic": "records",
"username": "kafka_user",
"password": "kafka_password",
"sasl_mechanism": "PLAIN"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-sqs-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "sqs",
"queue_url": "https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue",
"region": "us-east-1",
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-rabbitmq-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "rabbitmq",
"host": "localhost",
"port": 5672,
"username": "guest",
"password": "guest",
"virtual_host": "/",
"tls": false,
"exchange": "records"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-redis-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "redis_stream",
"host": "localhost",
"port": 6379,
"stream_key": "records",
"database": 0,
"tls": false,
"username": "redis_user",
"password": "redis_password"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-azure-event-hub-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "azure_event_hub",
"namespace": "my-namespace",
"event_hub_name": "records",
"shared_access_key_name": "RootManageSharedAccessKey",
"shared_access_key": "your-shared-access-key"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-nats-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "nats",
"host": "localhost",
"port": 4222,
"username": "nats_user",
"password": "nats_password",
"jwt": "your-jwt-token",
"nkey_seed": "your-nkey-seed",
"tls": false
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-gcp-pubsub-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "gcp_pubsub",
"project_id": "my-project",
"topic_id": "records",
"credentials": "base64-encoded-credentials",
"use_emulator": false,
"emulator_base_url": "http://localhost:8085"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-s2-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "s2",
"basin": "my-basin",
"stream": "my-stream",
"access_token": "my-access-token"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-sequin-stream-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "sequin_stream"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-webhook-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "webhook",
"http_endpoint": "my-endpoint",
"http_endpoint_path": "/webhook",
"batch": true
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-elasticsearch-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "elasticsearch",
"endpoint_url": "http://localhost:9200",
"index_name": "records",
"auth_type": "basic",
"auth_value": "base64-encoded-credentials",
"batch_size": 100
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-kinesis-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "kinesis",
"stream_arn": "arn:aws:kinesis:us-east-1:123456789012:stream/my-stream",
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-meilisearch-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "meilisearch",
"endpoint_url": "http://localhost:7700",
"index_name": "records",
"primary_key": "id",
"api_key": "your-api-key",
"batch_size": 100,
"timeout_seconds": 5
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-redis-string-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "redis_string",
"host": "localhost",
"port": 6379,
"database": 0,
"tls": false,
"username": "redis_user",
"password": "redis_password",
"expire_ms": 3600000,
"mode": "static"
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-sns-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "sns",
"topic_arn": "arn:aws:sns:us-east-1:123456789012:MyTopic",
"region": "us-east-1",
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"is_fifo": false
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
{
"id": "4ed2a8e5-47a7-4b51-9270-d2f4fdcb94fb",
"name": "my-typesense-sink",
"status": "active",
"database": "my-database",
"source": {
"include_schemas": null,
"exclude_schemas": null,
"include_tables": null,
"exclude_tables": null
},
"tables": [
{
"name": "public.products",
"group_column_names": ["category"]
}
],
"actions": ["insert", "update", "delete"],
"destination": {
"type": "typesense",
"endpoint_url": "http://localhost:8108",
"collection_name": "records",
"api_key": "your-api-key",
"batch_size": 100,
"timeout_seconds": 5
},
"filter": "none",
"transform": "id-transform",
"routing": "none",
"message_grouping": true,
"max_retry_count": null,
"annotations": {},
"active_backfills": [],
"batch_size": 50,
"load_shedding_policy": "pause_on_full",
"timestamp_format": "iso8601",
"health": {
"name": "Consumer health",
"status": "healthy",
"checks": [
{
"name": "Sink configuration",
"status": "healthy"
},
...
]
}
}
⌘I