v4

latestOpenAPI 3.0.32026-08-0161180264.4 KB
integrations

pollOutboundMessages

Poll outbound messages for an integration's poll-mode use cases. Takes a lease on the head-of-line batch of the integration's FIFO stream: the returned messages stay invisible to subsequent polls until they are acknowledged or the visibility timeout elapses. POST because taking a lease mutates server state — auto-retrying middleware must not burn leases. One in-flight batch per stream: while a lease is active (or another poll wins the race), the response is an empty batch (messages: []), not an error. Requires the integration:consume grant.

post/v1/integrations/{integrationId}/outbound/messages/poll

Path parameters

integrationIdstring uuid required

The integration ID

Request body

limitinteger

Maximum number of messages to lease in this batch. The ~5.5 MB response cap may truncate the batch earlier when payloads are large — the leased run shrinks accordingly.

Response

Leased batch of outbound messages (possibly empty)

visibility_timeout_secondsinteger required

Effective visibility timeout for this lease — a per-integration server-side setting (default 300 seconds)

has_moreboolean required

Whether more messages are available beyond this batch