Consume events for a consumer group
Poll the next batch of platform events for a managed consumer group. Reads in order from the group’s server-side committed offset and does NOT advance it — commit meta.next_offset via POST /events/consume/commit only after you have durably processed the batch. This is at-least-once: a crash before commit re-delivers the same batch, so deduplicate on each event’s id. A group that has never committed starts at the beginning of the retained window.
Authorizations
Dashboard JWT token from Clerk
Headers
Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Query Parameters
Consumer-group name (1–128 chars of letters, digits, ._:-, starting alphanumeric). Offsets are tracked per group, so independent consumers use distinct groups.
Maximum events to return (1–500, default 100).