Events

Casap publishes one event today.

Event When it fires
dispute.updated Any time a dispute changes.

There is no separate event per kind of change. One event type covers dispute creation, status changes, credits, card replacement and closure, and the message tells you which of those happened by carrying the dispute's new state.

More event types may be added later. Switch on the type field and ignore any value you do not recognise, so a new event does not break your handler.

dispute.updated

Fires on every committed change to a dispute, whether the customer, an agent, or Casap's own processing caused it. The message carries the full state of the dispute after the change rather than a description of what changed.

data carries four fields.

Field What it carries
dispute Full dispute state after the change.
statusMessage Customer facing summary of the current state.
timeline Customer facing milestones for the dispute.
requiredActions Everything you are expected to do for this dispute right now. The key is absent when nothing is outstanding.

requiredActions is the part you act on, and it is a snapshot rather than a change log. See Reading requiredActions for the rules and the action types it can carry.

Because every message is a full snapshot, a message you miss is corrected by the next one for the same dispute. Notifications are the exception: each one is sent in a single message and never repeated. See Delivery and ordering.

For the envelope around data, see Overview. For complete messages taken from a live feed, see Captured payloads.