GET
/
v1
/
http-consumers

Request parameters

metadata
json

Filter for consumers matching the properties supplied in this map. For example, {"custom_property": 42} will return all consumers with a custom_property of 42.

Response fields

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.