Skip to main content
POST
https://api.sequinstream.com/api/
/
api
/
http_pull_consumers
/
{consumer_id_or_name}
/
receive
curl --request POST \
  --url https://api.sequinstream.com/api/http_pull_consumers/orders-pull-consumer/receive \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  -d '{ "batch_size": 10 }'

{
  "data": [
    {
      "ack_id": "MTYyeJ7abUjl1pO",
      "record": {
        "id": 1234,
        "customer_id": 789,
        "status": "shipped"
      },
      "changes": {
        "status": "pending"
      },
      "action": "update",
      "metadata": {
        "table_schema": "public",
        "table_name": "orders",
        "commit_timestamp": "2024-03-20T15:30:00Z",
        "commit_lsn": 123456789,
        "commit_idx": 1,
        "database_name": "myapp-prod", // deprecated
        "consumer": {
          "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "name": "orders_webhook",
          "annotations": {"my-custom-key": "my-custom-value"}
        },
        "database": {
          "id": "12345678-9abc-def0-1234-56789abcdef0",
          "name": "myapp-prod",
          "annotations": {"my-custom-key": "my-custom-value"},
          "database": "myapp-prod",
          "hostname": "db.example.com"
        }
      }
    }
  ]
}
You can use either POST or GET to receive messages from a Sequin Stream.

​
Request parameters

​
id_or_name
string
required
The ID or name of the Sequin Stream.
​
batch_size
integer
Number of messages to try to fetch from the stream. Defaults to 1.The count of returned messages may be less than the requested batch size if there are fewer messages available for the consumer.
​
wait_for
integer | string
Amount of time to wait for messages to become available in the stream, in milliseconds. Defaults to 0.When wait_for is greater than 0, the request will block until any messages are available or wait_for milliseconds have passed.Therefore, you can use wait_for to implement long polling.Instead of passing in an integer, you can also pass in a duration string, like "60s", "5000ms", or "5m".

​
Response fields

The response is an object with a data property that contains a list of messages. Within each message is an ack_id and a data property that contains the message data.
​
data
list
required
curl --request POST \
  --url https://api.sequinstream.com/api/http_pull_consumers/orders-pull-consumer/receive \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  -d '{ "batch_size": 10 }'

{
  "data": [
    {
      "ack_id": "MTYyeJ7abUjl1pO",
      "record": {
        "id": 1234,
        "customer_id": 789,
        "status": "shipped"
      },
      "changes": {
        "status": "pending"
      },
      "action": "update",
      "metadata": {
        "table_schema": "public",
        "table_name": "orders",
        "commit_timestamp": "2024-03-20T15:30:00Z",
        "commit_lsn": 123456789,
        "commit_idx": 1,
        "database_name": "myapp-prod", // deprecated
        "consumer": {
          "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
          "name": "orders_webhook",
          "annotations": {"my-custom-key": "my-custom-value"}
        },
        "database": {
          "id": "12345678-9abc-def0-1234-56789abcdef0",
          "name": "myapp-prod",
          "annotations": {"my-custom-key": "my-custom-value"},
          "database": "myapp-prod",
          "hostname": "db.example.com"
        }
      }
    }
  ]
}