Webhook event types
Every webhook event you can subscribe to in the Wingspan V3 API, grouped by resource, with what each one means.
Use this page to find the event names to put in a subscription's subscribedEvents, and to see what each event means.
This list reflects the Wingspan event catalog as of 2026-09-25. It contains 111 event types. We add events over time, so for the current list call GET /v3/platform/webhook-event-types and keep only entries where availableForSubscription is true. That endpoint also returns reserved names that aren't available yet (contractStatus: Planned); you can't subscribe to those, and a subscription that names one exactly is rejected with 422.
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 part matches a timestamp on the resource: Invoice.Paid fires when the invoice gets its events.paidAt. You can subscribe to:
- An exact name:
Invoice.Paid. - Every event for one resource:
Invoice.*. - Every event:
*.
A wildcard also picks up new event types for that resource as we publish them, 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. data carries the resource id and, for most events, its status and externalId. Fetch the resource from its API for the rest. Some events add one of these:
| Field | When it's present | Example |
|---|---|---|
context | Per-leg events, where one resource has several parts (such as notification channels). | Notification.Delivered carries context.channel. |
parent | Sub-resource events. It names the parent resource. | InvoicePayment.Completed carries parent: { "type": "Invoice", "id": "..." }. |
confirmation | Only on *.DepositConfirmed events. | See Paid vs DepositConfirmed. |
The Sent to column below lists the scope types that can receive each event (see Create a subscription). Events marked Both parties go to the payer's Account and the payee's Account as two separate events that 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.
| Event | Meaning | Sent to |
|---|---|---|
FundsMovement.Created | A funds movement was created. | Account (Both parties) |
FundsMovement.Processing | A funds movement started processing. | Account (Both parties) |
FundsMovement.Completed | A funds movement completed. | Account (Both parties) |
FundsMovement.Failed | A funds movement failed. | Account (Both parties) |
FundsMovement.Returned | The funds movement was returned by the rail after it was processed. | Account (Both parties) |
FundsMovement.Cancelled | A funds movement was cancelled. | Account (Both parties) |
GroupMember
A payee added to a payee group.
| Event | Meaning | Sent to |
|---|---|---|
GroupMember.Created | A payee was added to a group. | Account |
InternalAccount
A Wingspan-held financial account that belongs to an Account.
| Event | Meaning | Sent to |
|---|---|---|
InternalAccount.Opened | An internal account was opened. | Account |
InternalAccount.Closed | An internal account was closed. | Account |
InternalAccount.Created | An internal account was created. | Account |
InternalAccount.Updated | An internal account was updated. | Account |
Invoice
A billing document. Both the payer and the payee Account receive their own copy of each event.
| Event | Meaning | Sent to |
|---|---|---|
Invoice.PaymentInTransit | Payment on the invoice has started and is in transit. | Account (Both parties) |
Invoice.Paid | Wingspan marked the invoice paid. Funds may still be in transit. See Paid vs DepositConfirmed. | Account (Both parties) |
Invoice.DepositConfirmed | Wingspan's originating bank or provider reported the outbound payment as processed. It does not mean the recipient's bank posted the funds, and a return is still possible. See Paid vs DepositConfirmed. | Account (Both parties) |
Invoice.Returned | A payment on the invoice was returned after it was sent. | Account (Both parties) |
Invoice.PaymentFailed | A payment attempt on the invoice failed. | Account (Both parties) |
InvoicePayment
One payment attempt against an invoice. Events carry parent: { type: "Invoice", id } so you know which invoice it belongs to.
| Event | Meaning | Sent to |
|---|---|---|
InvoicePayment.Initiated | An invoice payment was initiated. | Account (Both parties) |
InvoicePayment.Processing | An invoice payment started processing. | Account (Both parties) |
InvoicePayment.Completed | An invoice payment completed. | Account (Both parties) |
InvoicePayment.Failed | An invoice payment failed. | Account (Both parties) |
InvoicePayment.Returned | An invoice payment was returned. | Account (Both parties) |
InvoicePayment.Cancelled | An invoice payment was cancelled. | Account (Both parties) |
Mandate
An authorization to debit a funding source (for example, an ACH debit authorization).
| Event | Meaning | Sent to |
|---|---|---|
Mandate.Created | A mandate was created. | Account |
Mandate.Activated | A mandate was activated. | Account |
Mandate.Consumed | The mandate was used for a debit and is no longer available for reuse. | Account |
Mandate.Revoked | A mandate was revoked. | Account |
Mandate.Expired | A mandate expired. | Account |
Mandate.EvidenceApproved | Evidence supporting the mandate was approved. | Account |
Mandate.EvidenceRejected | Evidence supporting the mandate was rejected. | Account |
Payable
A payment obligation from a payer to a payee. Both the payer and the payee Account receive their own copy of each event.
| Event | Meaning | Sent to |
|---|---|---|
Payable.Paid | Wingspan marked the payable paid. Funds may still be in transit. See Paid vs DepositConfirmed. | Account (Both parties) |
Payable.Returned | The payment for the payable was returned. Returned is final for that payable; create a new payable to pay again. | Account (Both parties) |
Payable.PartiallyPaid | Part of the payable's amount has been paid. | Account (Both parties) |
Payee
The payer-owned record of someone you pay.
| Event | Meaning | Sent to |
|---|---|---|
Payee.Activated | The payee recorded an Activated transition (it sets events.activatedAt). For example, it follows associate-account once the payee's activation conditions are met. It isn't an invitation-accepted signal. See Payees. | Account |
PayrollSchedule
A payer's pay-period cadence configuration.
| Event | Meaning | Sent to |
|---|---|---|
PayrollSchedule.Created | A payroll schedule was created. | Account |
Finance
Statement
A periodic account statement.
| Event | Meaning | Sent to |
|---|---|---|
Statement.Created | A statement was created. | Account |
Statement.Updated | A statement was updated. | Account |
Transaction
A ledger transaction on an Account's financial account.
| Event | Meaning | Sent to |
|---|---|---|
Transaction.Created | A transaction was created. | Account |
Transaction.Updated | A transaction was updated. | Account |
Transfer
A transfer between an Account's own financial accounts or external bank accounts.
| Event | Meaning | Sent to |
|---|---|---|
Transfer.Created | A transfer was created. | Account |
Transfer.Updated | A transfer was updated. | Account |
Transfer.Processed | A transfer was processed. | Account |
Transfer.Completed | A transfer completed. | Account |
Transfer.Cancelled | A transfer was cancelled. | Account |
Transfer.Failed | A transfer failed. | Account |
Compliance
BackgroundCheck
A background check ordered for a payee.
| Event | Meaning | Sent to |
|---|---|---|
BackgroundCheck.Created | A background check was created. | Account |
BackgroundCheck.Sent | A background check was sent. | Account |
BackgroundCheck.Submitted | A background check was submitted. | Account |
BackgroundCheck.Completed | A background check completed. | Account |
BackgroundCheck.Failed | A background check failed. | Account |
DocumentTemplate
A reusable document template used for e-signature.
| Event | Meaning | Sent to |
|---|---|---|
DocumentTemplate.Created | A document template was created. | Account |
InsuranceCoverage
A payee's insurance coverage record.
| Event | Meaning | Sent to |
|---|---|---|
InsuranceCoverage.Updated | An insurance coverage was updated. | Account |
InsuranceCoverage.Created | An insurance coverage was created. | Account |
InsuranceImport
A bulk import of insurance coverage records.
| Event | Meaning | Sent to |
|---|---|---|
InsuranceImport.Created | An insurance import was created. | Account |
InsuranceImport.Processed | An insurance import was processed. | Account |
InsuranceImport.Submitted | An insurance import was submitted. | Account |
InsuranceMonitor
Ongoing monitoring of a payee's insurance coverage.
| Event | Meaning | Sent to |
|---|---|---|
InsuranceMonitor.Created | An insurance monitor was created. | Account |
InsuranceMonitor.Updated | An insurance monitor was updated. | Account |
SharedFileRequest
A request for a payee to upload a file.
| Event | Meaning | Sent to |
|---|---|---|
SharedFileRequest.Created | A shared file request was created. | Account |
SharedFileRequest.Uploaded | A shared file request received an uploaded file. | Account |
SharedFileRequest.Submitted | A shared file request was submitted. | Account |
SharedFileRequest.Completed | A shared file request completed. | Account |
SharedFileRequest.Failed | A shared file request failed. | Account |
SharedFileRequest.Processing | A shared file request started processing. | Account |
SharedFileRequest.PendingSubmission | Files were uploaded and the request is waiting to be submitted. | Account |
SignatureRequest
A request for one or more parties to sign a document.
| Event | Meaning | Sent to |
|---|---|---|
SignatureRequest.Created | A signature request was created. | Account |
SignatureRequest.Sent | A signature request was sent. | Account |
SignatureRequest.Reminded | A reminder was sent to a signer who has not signed yet. | Account |
SignatureRequest.Completed | A signature request completed. | Account |
SignatureRequest.Cancelled | A signature request was cancelled. | Account |
VaultFile
A file stored in the vault at /v3/compliance/vault-files.
| Event | Meaning | Sent to |
|---|---|---|
VaultFile.Created | A vault file was created. | Account |
VaultFile.Updated | A vault file was updated. | Account |
Platform
Account
A business entity in Wingspan.
| Event | Meaning | Sent to |
|---|---|---|
Account.Closed | An account was closed. | Account |
Account.Updated | An account was updated. | Account |
AccountingClass
A class record read from a connected accounting system.
| Event | Meaning | Sent to |
|---|---|---|
AccountingClass.Created | An accounting class was created. | Account |
AccountingClass.Refreshed | An accounting class was refreshed from the accounting system. | Account |
AccountingConnection
A connection to an accounting system such as QuickBooks Online.
| Event | Meaning | Sent to |
|---|---|---|
AccountingConnection.Created | An accounting connection was created. | Account |
AccountingConnection.Connected | An accounting connection finished connecting. | Account |
AccountingConnection.TokenRefreshed | Wingspan refreshed the connection's partner OAuth token. | Account |
AccountingConnection.Disconnected | The partner link was torn down. | Account |
AccountingCustomer
A customer record read from a connected accounting system.
| Event | Meaning | Sent to |
|---|---|---|
AccountingCustomer.Created | An accounting customer was created. | Account |
AccountingCustomer.Refreshed | An accounting customer was refreshed from the accounting system. | Account |
AccountingItem
An item record read from a connected accounting system.
| Event | Meaning | Sent to |
|---|---|---|
AccountingItem.Created | An accounting item was created. | Account |
AccountingItem.Refreshed | An accounting item was refreshed from the accounting system. | Account |
AccountingVendor
A vendor record read from a connected accounting system.
| Event | Meaning | Sent to |
|---|---|---|
AccountingVendor.Created | An accounting vendor was created. | Account |
AccountingVendor.Refreshed | An accounting vendor was refreshed from the accounting system. | Account |
ApiKey
An API key issued to a Person or a ServiceAccount.
| Event | Meaning | Sent to |
|---|---|---|
ApiKey.Created | An api key was created. | Account, Organization, Person |
ApiKey.Revoked | An API key was revoked and no longer authenticates. | Account, Organization, Person |
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.
| Event | Meaning | Sent to |
|---|---|---|
ComplianceEntity.Created | A compliance entity was created. | Account, Person |
ComplianceEntity.Updated | A compliance entity was updated. | Account, Person |
Notification
A notification in a Person's inbox. Only a Person scope can receive these.
| Event | Meaning | Sent to |
|---|---|---|
Notification.Created | A notification was created. | Person |
Notification.Sent | A notification was sent on one channel. context.channel is InApp, Email, or SMS. | Person |
Notification.Delivered | A notification was delivered on one channel. context.channel is InApp, Email, or SMS. | Person |
Notification.Failed | A notification failed on one channel. context.channel is InApp, Email, or SMS. | Person |
Notification.Viewed | The recipient viewed the notification. | Person |
Notification.Dismissed | The notification was dismissed. | Person |
NotificationSubscription
An Account-level rule that routes notifications.
| Event | Meaning | Sent to |
|---|---|---|
NotificationSubscription.Created | A notification subscription was created. | Account |
NotificationSubscription.Deleted | A notification subscription was deleted. | Account |
Operation
An AsyncOperation returned with a 202 Accepted. Poll GET /v3/platform/operations/{operationId} for the typed result.
| Event | Meaning | Sent to |
|---|---|---|
Operation.Created | An async operation started. | Account, Person |
Operation.Completed | An async operation finished and every item succeeded. | Account, Person |
Operation.PartiallyCompleted | An async operation finished and some, but not all, items failed. | Account, Person |
Operation.Failed | An async operation failed. Read error on the operation. | Account, Person |
Operation.Cancelled | The owning service cancelled the async operation. | Account, Person |
Organization
A tenant that groups Accounts.
| Event | Meaning | Sent to |
|---|---|---|
Organization.Created | An organization was created. | Organization |
Role
A custom role definition. System roles never change, so they emit no events.
| Event | Meaning | Sent to |
|---|---|---|
Role.Created | A role was created. | Account, Organization |
Role.Updated | A role was updated. | Account, Organization |
Role.Deleted | A role was deleted. | Account, Organization |
ServiceAccount
A machine identity owned by an Account or an Organization.
| Event | Meaning | Sent to |
|---|---|---|
ServiceAccount.Created | A service account was created. | Account, Organization |
ServiceAccount.Updated | A service account was updated. | Account, Organization |
ServiceAccount.Activated | A service account was activated. | Account, Organization |
ServiceAccount.Inactivated | A service account was inactivated. | Account, Organization |
ServiceAccount.Disabled | A service account was disabled. | Account, Organization |
Events you might expect but won't find yet
Some events V1 users relied on, and some that appear in older design documents, aren't available for subscription yet. These include the other payee events (such as Payee.Created and Payee.Deactivated), payee link request events, engagement eligibility changes, Payout.*, Payable.DepositConfirmed, payroll run events, and tax form and filing events. Until they're published, read the resource directly or watch the related events above (for example, FundsMovement.* and Payable.Paid for money movement). Check GET /v3/platform/webhook-event-types for the current list.
Related pages
Updated 10 days ago