Skip to main content
Breaking changes carry a date here. See Versioning.
​
Breaking
API contract
This release sets one contract across the API.
  • Every error has type, code, message, request_id, and doc_url. The doc_url links to the entry on the errors page.
  • Every list endpoint returns data and pagination, and takes limit and cursor.
  • Enum values are UPPER_SNAKE strings.
  • You archive a resource with PATCH and a status of ARCHIVED.
  • Requests authenticate with Authorization: Bearer.
  • You change participant and group tags, attributes, and counters with PATCH.
  • Any participant path accepts ext: followed by your external_id in place of the participant ID.
  • Durations use the units in Limits and durations. Money amounts are strings.
  • The VOID_PENDING rule action cancels a pending accrual by reference.
  • Webhook deliveries carry the Standard Webhooks headers, and you can send a test delivery to an endpoint.
  • A rejected event produces an event.rejected webhook.