On Start Trip

​

Before you start

• Field workers use the field app.
• The start trip / end trip feature is turned on for your organization.
• The event can only come from the field app. Nothing in the web app starts a trip.

​

Set it up

1. On Workflow › Automation, click New.
2. Name: for example “Notify on trip start”.
3. Event: On Start Trip.
4. Automation Type: Webhook, the only type this event allows.
5. Fill in the webhook URL and any Headers, for example:

   Setting	Example
   URL	https://api.example.com/trip/start
   Header name	Authorization
   Header value	Bearer your_api_token_here

6. Click Submit, make sure the automation is Active, and ask a field worker to start a trip to test it.

​

Use cases

​

Webhook payload

{
  "event": "on_start_trip",
  "timestamp": "2024-01-15T08:30:00.000Z",
  "user": {
    "id": "user_id_123",
    "name": "Budi Santoso",
    "email": "[email protected]",
    "phone": "+6281234567890"
  },
  "trip": {
    "startTime": "2024-01-15T08:30:00.000Z",
    "startLocation": { "latitude": -6.2088, "longitude": 106.8456, "address": "Jakarta, Indonesia" }
  },
  "hub": { "id": "hub_id_456", "name": "Jakarta Hub" }
}

​

Troubleshooting

• Check that its Active switch is on.
• Check that start trip / end trip is turned on for your organization.
• A field worker without a connection sends the trip start when they come back online.
• Look at the log for failed runs and their responses.