Create a Consumer
This endpoint creates a Consumer.
Request parameters
ID of the stream the consumer will read from.
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.
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).
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.
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 for the consumer. This is a JSON object that you can use to store any additional information you want to associate with the consumer.
Response fields
ID of the consumer.
ID of the stream the consumer reads from.
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.
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).
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.
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 for the sync. This is a JSON object that you can use to store any additional information you want to associate with the sync.
Timestamp of when the sync was created, in ISO 8601 format.
Timestamp of when the sync was last updated, in ISO 8601 format.
Was this page helpful?