Skip to content
Journey: Not started

Transfer company walk-through · Step 2 of 7

Receive a journey by webhook

Sample data. Nothing is sent to Transferz.

Why this step exists

When a journey is given to your fleet, Transferz sends journeyFleetAssignedEvent to your endpoint, with the pickup, drop-off, time and traveller details.

Check the signature, store the event and answer 2xx within 20 seconds. Then fetch the journey whenever you need its latest state.

The event arrives

Your endpoint · https://example.com/webhooks/transferz

Sample events

No events yet. Run the step and the event arrives here, as your endpoint would receive it.

Sample data · nothing is sent

Then fetch the details

Fetch the journey

This step has not been run yet, so this uses the sample journey. Run step 2 to use your own.

curl --request GET \  --url 'https://warpdrive.staging.transferz.com/transfercompanies/journeys/488213' \  --header 'Accept: application/json' \  --header 'X-Request-ID: req-ams-0002' \  --header 'X-API-Key: YOUR_STAGING_API_KEY'
Sample data · nothing is sent

Common pitfall

Answer first, work later. If you call the API or do slow work before answering, the delivery can time out and is retried, and later events for this journey wait behind it.

Was this helpful?