Flow Webhook Events

Flow Webhook Events

BETA: This endpoint is subject to change without notice.

Synapto Flow publishes the following webhook events in addition to the events listed in the main Webhooks guide. The same webhook infrastructure applies — signatures, retry behavior, and delivery details are identical. Configure event destinations in Settings > Developer in the Dashboard.

Event types

Transfer events

Event TypePayload FieldDescription
transfer.settledtransferA transfer has settled — funds are available in the destination account

Payout events

Event TypePayload FieldDescription
payout.createdpayoutA payout has been created and is awaiting approval
payout.paidpayoutA payout has been successfully sent from the custodial bank account
payout.failedpayoutA payout has failed — funds are returned to the available balance

Settlement events

Event TypePayload FieldDescription
payment_intent.settledpayment_intentA payment intent's funds have settled — balance lines have moved to SETTLED
refund.settledrefundA refund has settled

Event payload

Events are delivered as JSON. The payload field varies by event type — it contains the full resource at the time the event was generated.

Example: payout.paid

{
  "name": "accounts/acct_YOUR_ACCOUNT/events/evt_EVENT_ID",
  "type": "payout.paid",
  "event_time": "2026-01-16T14:30:00Z",
  "payout": {
    "name": "accounts/acct_YOUR_ACCOUNT/payouts/po_PAYOUT_ID",
    "state": "PAID",
    "external_bank_account_name": "accounts/acct_YOUR_ACCOUNT/external-bank-accounts/ba_BANK_ACCOUNT_ID",
    "currency": "GBP",
    "amount": "150000",
    "create_time": "2026-01-15T10:30:00Z",
    "update_time": "2026-01-16T14:30:00Z"
  }
}

Example: transfer.settled

{
  "name": "accounts/acct_YOUR_ACCOUNT/events/evt_EVENT_ID",
  "type": "transfer.settled",
  "event_time": "2026-01-15T10:30:00Z",
  "transfer": {
    "name": "accounts/acct_PARENT_ACCOUNT/transfers/txfr_TRANSFER_ID",
    "type": "DIRECT",
    "source_account_name": "accounts/acct_PARENT_ACCOUNT",
    "destination_account_name": "accounts/acct_CHILD_ACCOUNT",
    "currency": "GBP",
    "amount": "50000",
    "description": "January payout split",
    "create_time": "2026-01-15T10:30:00Z",
    "update_time": "2026-01-15T10:30:00Z"
  }
}

Related events

The following events from the main Webhooks guide are also relevant to Flow integrations:

Event TypeDescription
account.updatedAn account's details or capabilities have changed
account.external_bank_account.createdAn external bank account has been added to an account

Setup

Webhook configuration, signature verification, and retry behavior are covered in the Webhooks guide.