Webhook event types

Use this page to find the event names to put in a subscription's subscribedEvents, and to see what each event means.

Call GET /v3/platform/webhook-event-types to read event definitions, descriptions, routing scopes, and projection metadata. Use the event names below in a subscription's subscribedEvents.

This page lists the events you can subscribe to. The catalog response is the source of truth for event names, so check it before you rely on a name.

curl https://api.wingspan.app/v3/platform/webhook-event-types \
  -H "Authorization: Bearer $WINGSPAN_TOKEN"

// (trimmed)
{
  "data": [
    {
      "type": "Invoice.Paid",
      "contractStatus": "Published",
      "availableForSubscription": true,
      "resource": "Invoice",
      "domain": "payments",
      "payloadTier": "ResourceLifecycle",
      "moneyMovement": true,
      "allowedRoutingSubjectTypes": ["Account"],
      "description": "Emitted when Invoice records the Paid transition."
    }
  ]
}

How to read an event name

Every event type is {Resource}.{Event}, for example Invoice.Paid. The event describes a recorded transition: Invoice.Paid corresponds to the invoice's events.paidAt. Per-leg events identify the affected leg in context. You can subscribe to:

• An exact name: Invoice.Paid.
• Every event for one resource: Invoice.*.
• Every event: *.

A wildcard also matches new event types for that resource, so your handler should ignore types it doesn't recognize.

What's in each event

Every event is a small reference, not a copy of the resource. Invoice, InvoicePayment, Payable, FundsMovement, and Payout events carry only the resource id in data. Other projections can include status and externalId. Fetch the resource from its API for the rest, including the fields you use for reconciliation. Some events add one of these:

The Sent to column below lists the scope types that can receive each event (see Create a subscription). For events marked Both parties, each entitled payer or payee Account receives a separate event. These copies have different id values and share one occurrenceId.

Payments

FundsMovement

A single movement of money between accounts that backs a payment. Both the payer and the payee Account receive their own copy of each event.

GroupMember

A payee added to a payee group.

InternalAccount

A Wingspan-held financial account that belongs to an Account.

Invoice

A billing document. Each entitled payer or payee Account receives its own copy of an event.

InvoicePayment

One payment attempt against an invoice. Events carry parent: { type: "Invoice", id } so you know which invoice it belongs to.

Mandate

An authorization to debit a funding source (for example, an ACH debit authorization).

Payable

A payment obligation from a payer to a payee. Both the payer and the payee Account receive their own copy of each event.

Payee

The payer-owned record of someone you pay.

PayeeEngagement

A payer's engagement with a payee.

PayrollSchedule

A payer's pay-period cadence configuration.

Payout

A payout aggregates delivery transfers. Each entitled Account receives its own copy of an event. data contains the payout's id; read the payout for its transfers, amounts, and recovery state.

Payable.Paid describes the payment obligation and FundsMovement.Completed describes one money movement. Neither alone establishes payout completion. Where the caller can read the payout, transfers[].fundsMovementId links it to the underlying movements. A later return can follow completion; Payout.Returned does not imply an aggregate Returned status. See Paid vs DepositConfirmed.

Finance

ExternalBankAccount

A bank account outside Wingspan that an Account has linked.

Statement

A periodic account statement.

Transaction

A ledger transaction on an Account's financial account.

Transfer

A transfer between an Account's own financial accounts or external bank accounts.

Compliance

BackgroundCheck

A background check ordered for a payee.

DocumentTemplate

A reusable document template used for e-signature.

InsuranceCoverage

A payee's insurance coverage record.

InsuranceImport

A bulk import of insurance coverage records.

InsuranceMonitor

Ongoing monitoring of a payee's insurance coverage.

SharedFileRequest

A request for a payee to upload a file.

SignatureRequest

A request for one or more parties to sign a document.

VaultFile

A file stored in the vault at /v3/compliance/vault-files.

Platform

Account

A business entity in Wingspan.

AccountingClass

A class record read from a connected accounting system.

AccountingConnection

A connection to an accounting system such as QuickBooks Online.

AccountingCustomer

A customer record read from a connected accounting system.

AccountingItem

An item record read from a connected accounting system.

AccountingVendor

A vendor record read from a connected accounting system.

ApiKey

An API key issued to a Person or a ServiceAccount.

ComplianceEntity

The verified legal identity (name, tax ID, address, and entity type) behind an Account or a Person. V1 called this a monitored entity, or ME.

Notification

A notification in a Person's inbox. Only a Person scope can receive these.

NotificationSubscription

An Account-level rule that routes notifications.

Operation

An AsyncOperation returned with a 202 Accepted. Poll GET /v3/platform/operations/{operationId} for the typed result.

Organization

A tenant that groups Accounts.

Role

A custom role definition. System roles never change, so they emit no events.

ServiceAccount

A machine identity owned by an Account or an Organization.

Related pages

• Webhooks overview
• Create a subscription
• Paid vs DepositConfirmed
• Recover missed events