Skip to main content

Pull pending integration events

POST 
/v1/integration/events/pull

Claim a batch of pending events for your provider. Pulled events become invisible to further pulls until you acknowledge them or their visibility timeout expires, so two workers polling in parallel will not receive the same event. Deduplicate by event id anyway: delivery is at-least-once.

A JSON request body is required, even to accept the defaults: send {}. max_batch_size accepts 1-100 but is capped server-side at 50; omitting it defaults to 10. The visibility timeout is 300 seconds by default: acknowledge within that window or the event becomes visible again and is redelivered.

total_pending and has_more count events in PENDING and IN_PROGRESS, so immediately after a pull they still include the batch you just claimed. Use next_poll_after_seconds (1 when events were returned, 5 when the batch was empty) as the backoff hint for your polling loop. These figures are configuration defaults and can be tuned per environment.

Request​

Responses​

Events claimed. count is how many came back, total_pending how many remain, and next_poll_after_seconds how long to wait before polling again.