GET
/
v1
/
http-consumers
/
{id}
curl --request GET \
  --url https://api.sequin.io/v1/http-consumers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "c906b4a4-0cda-4f46-bd80-255f570c195d",
  "stream_id": "f0f70b52-5243-489c-879b-a1ae3f02abfd",
  "deliver_policy": "all",
  "ack_wait_ms": 30000,
  "max_deliver": -1,
  "max_ack_pending": 1000,
  "name": "Choam Corp - Primary Consumer",
  "metadata": { "custom_property": 42 },
  "created_at": "2023-12-15 01:29:29",
  "updated_at": "2023-12-15 01:29:29"
}

Request parameters

id
string
required

ID of the consumer.

Response fields

{
  "id": "c906b4a4-0cda-4f46-bd80-255f570c195d",
  "stream_id": "f0f70b52-5243-489c-879b-a1ae3f02abfd",
  "deliver_policy": "all",
  "ack_wait_ms": 30000,
  "max_deliver": -1,
  "max_ack_pending": 1000,
  "name": "Choam Corp - Primary Consumer",
  "metadata": { "custom_property": 42 },
  "created_at": "2023-12-15 01:29:29",
  "updated_at": "2023-12-15 01:29:29"
}
id
string

ID of the consumer.

stream_id
string

ID of the stream the consumer reads from.

deliver_policy
string

Where in the stream the consumer starts.

  • all (default): the consumer will start from the beginning of the stream.
  • new: the consumer will start from the most recent message.
  • last: the consumer will start from the last message it received.
  • 1h: the consumer will start from the most recent message from the last hour.
ack_wait_ms
integer

How long to wait for a message to be acknowledged, in milliseconds. Defaults to 30000 (30 seconds).

If a worker doesn’t acknowledge a message within this time, the message will be redelivered (i.e. reappear for other workers to process).

max_deliver
integer

Maximum number of times a message can be redelivered to workers. For example, if a message causes your workers to crash, it will be redelivered up to max_deliver times before being discarded.

Defaults to -1, which means there is no maximum.

max_ack_pending
integer

Maximum number of outstanding, acknowledged messages a consumer will allow at a time. Defaults to 1000.

After your workers have checked out max_ack_pending messages, the consumer will stop delivering messages until some are acknowledged.

metadata
object

Metadata for the sync. This is a JSON object that you can use to store any additional information you want to associate with the sync.

created_at
string

Timestamp of when the sync was created, in ISO 8601 format.

updated_at
string

Timestamp of when the sync was last updated, in ISO 8601 format.