About events

Learn how webhook events work in EverTransit.

When configuring a webhook, you can use the UI to choose which events will send you payloads. Only subscribing to specific events limits the number of HTTP requests to your server. You can also subscribe to all current events and you can change the list of subscribed events anytime.

Each event corresponds to a certain action that can happen in your fleet. For example, if you subscribe to the ride.createdevent, you'll receive detailed payloads as JSON every time a ride is created in your fleet.

For a complete list of available webhook events and their payloads, see "Event List".

Event object common properties

Name	Type	Description
idempotemcyKey	string	The idempotemcyKey is the id associated with an occurrence of a specific event. It can be used to ensure that an occurrence of an event is not processed more than once.
eventName	string	The name of the event.
publishTime	string	The date and time when the event was published.
data	object	Object containing the API resource relevant to the event. For example, an ride.created event will have a full ride object as the value of the object key.

Payload example

{
  "idempotencyKey": "1111111111111111",
  "eventName": "ride.created",
  "publishTime": "2022-05-02T16:15:55.147Z",
  "data": {
   ...
  }
}