Events reference

This is the catalog of every webhook event GIFQ sends, across all domains. Each event shares the standard envelope; only its data shape differs.

New event families are added here over time — your consumer should ignore event values it does not recognize.

All events

EventDomainFires whendata present?Reference
payout.quote_createdpayoutAn FX quote is issued for a sendYespayout.quote_created
payout.quote_confirmedpayoutThe recipient confirms a cross-currency quoteYespayout.quote_confirmed
payout.quote_canceledpayoutThe recipient cancels an open quoteYespayout.quote_canceled
payout.status_changedpayoutA non-terminal status transition occursNopayout.status_changed
payout.terminal_statepayoutThe send reaches a terminal statusYespayout.terminal_state

How to read an event page

Every event page follows the same structure:

  1. Triggered when — the condition that produces the event.
  2. Envelope — the event carries the standard envelope; the page lists the domain identifiers it includes.
  3. Event-specific fields — only what this event adds or promotes beyond the envelope (e.g. tx_hash), and whether data is present or omitted.
  4. data shape — the structure of this event's data object, or a link to the shared domain data shape when events in a domain share one snapshot.
  5. Example — a full JSON body.
  6. What to do on receipt — recommended handling.