curl -X GET "https://api.sequinstream.com/api/sinks" \
-H "Authorization: Bearer YOUR_API_TOKEN"
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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
List sink consumers
GET
/
sinks
curl -X GET "https://api.sequinstream.com/api/sinks" \
-H "Authorization: Bearer YOUR_API_TOKEN"
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
Returns a list of all sink consumers.
Response fields
Where data is an array of objects with the following fields:
The source configuration for the sink consumer. This determines which tables are consumed.
Show source properties
Show source properties
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.Additional configuration for individual tables.To configure which tables are consumed, see the
source field.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
Whether the webhook body should be wrapped in a list to support batching.
Show Kafka properties
Show Kafka properties
Show Kinesis properties
Show Kinesis properties
Show Meilisearch properties
Show Meilisearch properties
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
Show S2 properties
Show S2 properties
Show SNS properties
Show SNS properties
Show SQS properties
Show SQS 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.
Determines how Sequin handles overload when sink consumers can’t keep up with incoming messages
curl -X GET "https://api.sequinstream.com/api/sinks" \
-H "Authorization: Bearer YOUR_API_TOKEN"
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}
{
"data": [
{
"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",
"enrichment": "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"
},
...
]
}
}
]
}

