v4
latestOpenAPI 3.0.32026-08-0161180264.4 KBintegrations
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
Response
Leased batch of outbound messages (possibly empty)