Event List

For each webhook event, you can review when the event occurs, an example payload, and descriptions of the payload object parameters.

You can create webhooks that subscribe to the events listed on this page. Each webhook event includes a description of the webhook properties and an example payload.

ride.created

Event emitted when a ride is created.

Event object properties

Name	Type	Description
passengers	number	The amount of passengers of the ride.
pickup	object	The pickup address of the ride.
scheduledTime	string	The date and time scheduled for the ride.
rider	object	The rider of the ride.
destination	object	The destination address of the ride.
createdTime	string	The date and time the ride was created.
status	string	The ride status.
service	object	The service level of the ride.
id	string	A unique identifier for the ride.
reservationNumber	string	The reservation number that identifies the ride.

Payload example

{
  ...
  "data": {
    "passengers": 1,
    "pickup": {
      "latitude": 40.7819869,
      "address": "1000 5th Ave, New York, NY 10028, US",
      "longitude": -73.9665138
    },
    "scheduledTime": "2022-05-02T19:15:00.000Z",
    "rider": {
      "phoneNumber": "[phone]",
      "id": "620de1fb2d1c3d001fbe773d",
      "email": "[e-mail]",
      "firstName": "Jane",
      "lastName": "Doe"
    },
    "destination": {
      "address": "175 5th Ave, New York, NY 10010, US",
      "latitude": 40.761675,
      "longitude": -73.9808468
    },
    "createdTime": "2022-05-02T16:15:54.496Z",
    "status": "scheduled",
    "service": {
      "description": "",
      "id": "6266c2fd1ee96c00186221bc",
      "name": "Sedan"
    },
    "id": "627003ba42684e001a0ac487",
    "reservationNumber": "RES-715PMM7"
  }
}

ride.driver.assigned

Event emitted when a driver is assigned to a ride.

Event object properties

Name	Type	Description
passengers	number	The amount of passengers of the ride.
pickup	object	The pickup address of the ride.
scheduledTime	string	The date and time scheduled for the ride.
rider	object	The rider of the ride.
destination	object	The destination address of the ride.
createdTime	string	The date and time the ride was created.
status	string	The ride status.
service	object	The service level of the ride.
id	string	A unique identifier for the ride.
reservationNumber	string	The reservation number that identifies the ride.

Payload example

{
  ...
  "data": {
    "reservationNumber": "RES-715R5DZ",
    "vehicle": {
      "color": "Red",
      "licensePlate": "NS12345",
      "year": 2018,
      "make": "Nissan",
      "model": "Sentra"
    },
    "pickup": {
      "address": "1000 5th Ave, New York, NY 10028, US",
      "latitude": 20.5908117,
      "longitude": -73.9808468
    },
    "status": "scheduled",
    "passengers": 1,
    "rider": {
      "email": "[e-mail]",
      "firstName": "Melissa",
      "phoneNumber": "[phone]",
      "lastName": "Pu",
      "id": "222222222222222222222222"
    },
    "destination": {
      "address": "175 5th Ave, New York, NY 10010, US",
      "latitude": 40.761675,
      "longitude": -73.9808468
    },
    "scheduledTime": "2022-05-05T06:31:00.000Z",
    "driver": {
      "lastName": "Broken",
      "phoneNumber": "[phone]",
      "firstName": "George",
      "id": "111111111111111111111111",
      "email": "[e-mail]"
    },
    "service": {
      "id": "6213e974d9e8ad002a003e7b",
      "description": "Up to 4 passengers.",
      "name": "Sedan"
    },
    "createdTime": "2022-05-05T05:32:12.400Z",
    "id": "6273615cf05d27001f1ba02b"
  },
}

ride.driver.unassigned

Event emitted when the driver is unassigned from a ride.

Event object properties

Name	Type	Description
passengers	number	The amount of passengers of the ride.
pickup	object	The pickup address of the ride.
scheduledTime	string	The date and time scheduled for the ride.
rider	object	The rider of the ride.
destination	object	The destination address of the ride.
createdTime	string	The date and time the ride was created.
status	string	The ride status.
service	object	The service level of the ride.
id	string	A unique identifier for the ride.
reservationNumber	string	The reservation number that identifies the ride.

Payload example

{
  ...
  "data": {
    "reservationNumber": "RES-715R5DZ",
    "service": {
      "description": "Up to 4 passengers.",
      "id": "6213e974d9e8ad002a003e7b",
      "name": "Sedan"
    },
    "id": "6273615cf05d27001f1ba02b",
    "unassignedDriver": {
      "phoneNumber": "[phone]",
      "lastName": "Broken",
      "id": "62198089d8cbf4001925e01d",
      "email": "[e-mail]",
      "firstName": "George"
    },
    "destination": {
      "address": "1000 5th Ave, New York, NY 10028, US",
      "latitude": 20.5908117,
      "longitude": -73.9808468
    },
    "pickup": {
      "address": "175 5th Ave, New York, NY 10010, US",
      "latitude": 40.761675,
      "longitude": -73.9808468
    },
    "rider": {
      "email": "[e-mail]",
      "firstName": "Melissa",
      "lastName": "Pu",
      "phoneNumber": "[phone]",
      "id": "222222222222222222222222"
    },
    "scheduledTime": "2022-05-05T06:31:00.000Z",
    "createdTime": "2022-05-05T05:32:12.400Z",
    "passengers": 1,
    "status": "scheduled"
  },
}

ride.status.updated

Event emitted when the ride status is updated.

Event object properties

Name	Type	Description
passengers	number	The amount of passengers of the ride.
pickup	object	The pickup address of the ride.
scheduledTime	string	The date and time scheduled for the ride.
rider	object	The rider of the ride.
destination	object	The destination address of the ride.
createdTime	string	The date and time the ride was created.
status	string	The ride status.
service	object	The service level of the ride.
id	string	A unique identifier for the ride.
reservationNumber	string	The reservation number that identifies the ride.

Payload example

{
  ...
  "data": {
    "pickup": {
      "address": "1000 5th Ave, New York, NY 10028, US",
      "latitude": 20.5908117,
      "longitude": -73.9808468
    },
    "status": "arrived",
    "id": "6273615cf05d27001f1ba02b",
    "rider": {
      "firstName": "Melissa",
      "email": "[e-mail]",
      "phoneNumber": "[phone]",
      "lastName": "Pu",
      "id": "222222222222222222222222"
    },
    "destination": {
      "address": "175 5th Ave, New York, NY 10010, US",
      "latitude": 40.761675,
      "longitude": -73.9808468
    },
    "createdTime": "2022-05-05T05:32:12.400Z",
    "scheduledTime": "2022-05-05T06:31:00.000Z",
    "passengers": 1,
    "reservationNumber": "RES-715R5DZ",
    "service": {
      "id": "6213e974d9e8ad002a003e7b",
      "description": "Up to 4 passengers.",
      "name": "Sedan"
    }
  }
}

invoice.created

Event emitted when an invoice is created.

Event object properties

Name	Type	Description
issuedTime	string	The date and time of issue of the invoice.
billingAddress	map	The address of the billing account.
createdTime	string	The date and time the invoice was created in the account.
account	map	The account info related to name, email, and legal name.
periodStartTime	string	The start date and time of the billing period.
terms	number	The due date interval of the invoice from the moment it is generated. For example, 45 days.
periodEndTime	string	The end date and time of the billing period.
number	string	A unique identifier for the invoice.
dueTime	string	The due date of the invoice.
lineItems	array	The date, amount, and description (reservation number) of the ride.

Payload example

{
  ...
  "data": {
    "issuedTime": "2022-05-05T23:28:24.408Z",
    "id": "62745f0b5a42750024c4a1f0",
    "billingAddress": {
      "city": "New York",
      "line1": "175 5th Ave"
    },
    "createdTime": "2022-05-05T23:34:35.488Z",
    "account": {
      "name": "Test Greenland Time",
      "email": "[e-mail]",
      "legalName": "Test Greenland Time"
    },
    "periodStartTime": "2022-05-04T05:00:00.000Z",
    "terms": 45,
    "periodEndTime": "2022-05-05T05:00:00.000Z",
    "number": "INV-000001",
    "dueTime": "2022-06-19T23:28:24.408Z",
    "lineItems": [
      {
        "date": "2022-05-05T23:20:00.000Z",
        "amount": 36000,
        "description": "Ride #RES-715RGRD"
      }
    ]
  }
}

customer.created

Event emitted when a customer is created.

Event object properties

Name	Type	Description
id	string	A unique identifier for the customer.
createdTime	string	The date and time the customer was created.
email	string	The email of the customer.
lastName	string	The last name of the customer.
fistName	string	The first name of the customer.
phoneNumber	string	The phone number of the customer.

Payload example

{
  "eventName": "customer.created",
  "idempotencyKey": "4608019838993546",
  "data": {
    "id": "62747e1bb245fe002340064f",
    "createdTime": "2022-05-06T01:47:07.256Z",
    "email": "[e-mail]",
    "lastName": "Keller",
    "firstName": "Helen",
    "phoneNumber": "[phone]"
  },
  "publishTime": "2022-05-06T01:47:08.251Z"
}

driver.created

Event emitted when a driver is created.

Event object properties

Name	Type	Description
id	string	A unique identifier for the driver.
lastName	string	The last name of the driver.
fistName	string	The first name of the driver.
createdTime	string	The date and time the driver was created.
phoneNumber	string	The phone number of the driver.
email	string	The email of the driver.

Payload example

{
  ...
  "data": {
    "phoneNumber": "[phone]",
    "firstName": "Melissa",
    "createdTime": "2022-02-23T04:54:52.715Z",
    "lastName": "Motto",
    "id": "222222222222222222222222",
    "email": "[e-mail]"
  },
  "publishTime": "2022-05-06T02:08:25.016Z"
}