Sign in

d0dcc5024bd1

latestOpenAPI 3.0.42026-08-104969330.3 KB
WebhookEvents

List webhook events dispatched for a case.

Returns all webhook events dispatched for the given case, scoped to your webhook subscriptions. Results are ordered newest-first.

Use cases:

  • Verify that a specific event (e.g. case.updated) fired after a state transition.
  • Inspect the exact payload delivered on each attempt.
  • Find the event ID to replay via POST /webhooks/events/{id}/replay.
  • Part of the CI-loop ASSERT step: after advancing a test case, query this endpoint to confirm the correct events fired.

Filtering:

  • caseId (required): restricts to events for this case.
  • since (optional): only returns events created at or after this ISO 8601 timestamp.

Note: Only events for your subscriptions are returned — events from other collection partners' subscriptions are never exposed.

get/webhooks/events

Query parameters

caseIdstring uuid
sincestring date-time

Response

List of webhook events

idstring uuid

Unique identifier for this event record. Use this ID to replay the event via POST /webhooks/events/{id}/replay.

subscriptionIdstring uuid

The webhook subscription this event was dispatched to.

caseIdstring uuid nullable

The collection case this event relates to.

eventTypestring nullable

The event type (e.g. "case.assigned", "case.updated", "case.closed", "payment.created", "chat.created").

payloadstring nullable

The full JSON payload that was (or will be) delivered.

createdAtstring date-time

When this event was first recorded (UTC).

deliveredAtstring date-time nullable

When the event was successfully delivered (UTC). Null if delivery has not yet succeeded.

attemptCountinteger

Number of delivery attempts made so far.

lastResponseCodeinteger nullable

HTTP status code returned by the subscriber endpoint on the last attempt.

lastErrorstring nullable

Error message from the last failed delivery attempt. Null on successful delivery.