Events

List events

GET/api/v1/eventsScope any key

What changed in the agency, in order, for the last 30 days: the same events webhooks deliver. Only the events the key may read (a trip event needs trips:read, a payment event payments:read, a contact event contacts:read). Poll it to catch up after a webhook outage, or instead of webhooks.

Query parameters

afterstringoptional

The next_cursor of a previous response: a position in the agency's whole stream of events, so it also moves past events of types you did not ask for. Omit it to start at the oldest event kept (30 days).

typescomma-separated listoptional

Comma-separated list of event types. Omit it for every type the key may read.

trip.createdtrip.updatedtrip.deletedtrip.status_changedtrip.acceptedtrip.publishedtrip.unpublishedpayment.createdpayment.updatedpayment.paidpayment.deletedcontact.createdcontact.updatedcontact.deleted

limitintegeroptionalDefault 100

How many events per response, from 1 to 500.

Returns

A list of Event objects.

object"list"

dataarray of Event

next_cursorstring

Where to continue: pass it as after next time. Always present, even with no new events.

has_moreboolean

More events are waiting right now: ask again at once.

Errors

401unauthorizedNo key, a malformed one, or a key that does not exist or was revoked. Send it as Authorization: Bearer <key>.

403api_not_enabledRoundPlan has not turned on API access for this agency.

403subscription_inactiveThe agency's trial expired or its subscription ended.

400invalid_requestA query parameter is not valid. The message says which.

429rate_limitedToo many requests. Wait the seconds in Retry-After. See Errors and rate limits.

500internal_errorSomething went wrong on our side. Retry later.