Events

Read retained events

Recover notifications missed by your receiver or poll changes without hosting a webhook endpoint. The feed follows durable publication order within your workspace.

Before you call

Use events:read. Start without a cursor, then retain the returned position. Optional type/reportId/interviewId filters must remain unchanged while following a cursor.

Required scope: events:read.

What happens next

Process items durably before saving nextCursor, even on an empty page. Use hasMore to drain retained pages. Deleted bodies appear as minimal tombstones; a cursor is an opaque credential-like value, not an offset.

Recovery

EVENT_CURSOR_EXPIRED returns 410 after retained history is lost. Reconcile current reports/interviews and establish a fresh position. Polling does not resend webhooks; use catch-up or replay for receiver redelivery.

Follow the complete workflow · Errors and retries

get/api/v1/events

Request

  • Base URL: https://app.probbai.com
  • URL: https://app.probbai.com/api/v1/events
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size, 1–100; defaults to 25.

cursorstring

Opaque cursor from the previous page. Repeat all filters unchanged. Never decode or construct a cursor yourself.

type'batch.completed' | 'report.completed' | 'report.result_ready' | 'report.deleted' | 'report.failed' | 'report.requires_action' | 'webhook.test' | 'interview.invited' | 'interview.started' | 'interview.completed' | 'interview.expired' | 'interview.preparation_failed' | 'interview.result_ready' | 'interview.result_failed' | 'interview.invitation_failed'

Event type. Subscribe to the events needed for your workflow and process unknown future types safely.

reportIdstring

Report ID returned by upload preparation, admission, discovery, or an event. It must belong to the API key's workspace.

interviewIdstring

Logical interview attempt ID returned by invitation. A reinterview receives a new ID.

Response

Process items durably before saving nextCursor, even on an empty page. Use hasMore to drain retained pages. Deleted bodies appear as minimal tombstones; a cursor is an opaque credential-like value, not an offset.

Changes

No recorded changes to this operation across all 1 revision of this API.