Skip to content

Webhook event

Offer status changed

The status of an offer to your company changed, for example it expired or another company took it.

EVENTofferStatusChangedEventSent to transfer companies

When it is sent

Sent on every status change of an offer to your company: when it is sent to you (NOTIFIED), when you accept or decline it, when it expires, and when another company accepts the journey first (MISSED).

Payload

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

  • offerIdinteger · int64

    The offer.

  • journeyIdinteger · int64

    The journey offered.

  • transferCompanyIdinteger · int64

    Your transfer company id.

  • previousStatusenum
    PENDING
    Created, not yet sent to the transfer company.
    NOTIFIED
    Sent to the transfer company; it can be accepted or declined.
    SKIPPED_NOTIFICATION
    Created without a notification being sent.
    ACCEPTED
    Accepted by this transfer company.
    DECLINED
    Declined by this transfer company.
    EXPIRED
    Not answered before the expiry time.
    MISSED
    Another transfer company accepted the journey first.
  • newStatusenum
    PENDING
    Created, not yet sent to the transfer company.
    NOTIFIED
    Sent to the transfer company; it can be accepted or declined.
    SKIPPED_NOTIFICATION
    Created without a notification being sent.
    ACCEPTED
    Accepted by this transfer company.
    DECLINED
    Declined by this transfer company.
    EXPIRED
    Not answered before the expiry time.
    MISSED
    Another transfer company accepted the journey first.
  • createdstring · date-time

    When the status changed.

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.