Skip to content

Webhook event

Traveller details updated

Traveller information of an assigned journey changed, for example the phone number or passenger count.

EVENTjourneyTravellerInfoUpdatedEventSent to transfer companies

When it is sent

Sent when a change to one of your journeys updates traveller details. Only the fields that changed have a value; the rest are null.

Payload

The body is a JSON object with one key, journeyTravellerInfoUpdatedEvent, holding:

  • createdstring · date-time

    When the change was confirmed.

  • journeyIdinteger · int64

    The journey.

  • adultPassengerCountinteger · int32 · nullable
  • childPassengerCountinteger · int32 · nullable

    Currently always null.

  • infantPassengerCountinteger · int32 · nullable

    Currently always null.

  • checkedLuggageCountinteger · int32 · nullable
  • carryOnLuggageCountinteger · int32 · nullable
  • firstNamestring · nullable
  • lastNamestring · nullable
  • driverCommentsstring · nullable
  • emailstring · nullable
  • phonestring · nullable
  • meetAndGreetstring · nullable

    New name sign text.

  • flightNumberstring · nullable
  • trainNumberstring · nullable
  • shipNamestring · nullable

How to acknowledge

Respond with any 2xx status (200 or 204) within 20 seconds. Anything else counts as a failed delivery: redirects (3xx) are not followed, 4xx and 5xx (including 401 and 403) fail, and so do connection errors and timeouts. Verify the signature, store the event, respond, and do the slow work afterwards. The response body is ignored (it is kept in the delivery log).

Signature

Header Authorization, format HMAC <base64 signature>, HMAC-SHA256.

The signature is HMAC-SHA256 over the raw request body, using your webhook secret (the HMAC key shown in the portal) as UTF-8 bytes; the result is standard Base64 with padding. Verify against the raw body bytes exactly as received, before any JSON parsing, never against JSON you parsed and serialised again. The body is not formatted the way your framework would print it: it is one line with ": " after each key and ", " between items, and keys can come in a different order than in the example (shorter keys first). The example on this page is pretty-printed for reading. Compare with a constant-time comparison. Without a configured secret, events are sent unsigned.

Retries and ordering

Failed deliveries are retried with exponential backoff: about 2, 4, 8, 16 and 32 minutes, then hourly, until the number of attempts configured for your account is reached; after that the event is dropped. The number of attempts is set per company by Transferz and defaults to a single attempt, so ask for retries to be enabled before go-live. There is no event id header: an event can arrive more than once, so make your handling idempotent (for example on journeyId, the event key, created and the status values).

Events for the same journey are delivered one at a time, in the order they happened (see created). If one fails, later events for that journey wait until it succeeds or is dropped; events for other journeys continue. Expect a delay of about ten seconds between the change and the delivery.