Webhooks
Event Catalog
A comprehensive guide to all webhook events available in the Straddle platform
Event Catalog
Overview
Webhooks notify you when important events occur in the Straddle platform. This catalog details all available events and their payloads.You can browse the complete event catalog in your Straddle Dashboard or reference our full object documentation.
Event Categories
Accounts
Monitor the lifecycle of embedded client accounts in your platform
LinkedBankAccounts
Monitor the lifecycle of Linked Bank Accounts for embedded client accounts in your platform
Representatives
Monitor the lifecycle of Representatives for embedded client accounts in your platform
CapabilityRequests
Monitor the lifecycle of CapabilityRequests for embedded client accounts in your platform
Payments
Track charges and payouts through our multi-rail payment network
Customers
Stay updated on customer verification and Paykey status changes
Accounts Events
Account events are specifically relevant for platforms using our embedded payments functionality. They help you monitor the lifecycle and status changes of accounts you manage.These events are not relevant for businesses building on Straddle directly.
| Event | Description |
|---|---|
account.created.v1 | Fired when a new embedded Straddle account is created. This event includes the account details, business profile, and its initial capabilities and status. |
account.event.v1 | Triggered when any significant change occurs to an embedded account’s status or configuration. This includes verification updates, capability changes, and settings adjustments. |
LinkedBankAccount Events
LinkedBankAccount events are specifically relevant for platforms using our embedded payments functionality. They help you monitor the lifecycle and status changes of accounts you manage.These events are not relevant for businesses building on Straddle directly.
| Event | Description |
|---|---|
linked_bank_account.created.v1 | Fired when a platform creates a new embedded merchant account’s LinkedBankAccount. This event contains the LinkedBankAccount details. |
linked_bank_account.event.v1 | Triggered when any significant change occurs to a platform-created embedded account’s linked bank account. This includes updates to the linked bank account status or values. |
Representative Events
Representative events are specifically relevant for platforms using our embedded payments functionality. They help you monitor the lifecycle and status changes of accounts you manage.These events are not relevant for businesses building on Straddle directly.
| Event | Description |
|---|---|
representative.created.v1 | Fired when a platform creates a new embedded merchant account’s representative. This event contains the representative details. |
representative.event.v1 | Triggered when any significant change occurs to a platform-created embedded account’s representatives. This includes updates to the representative status or values. |
CapabilityRequest Events
CapabilityRequest events are specifically relevant for platforms using our embedded payments functionality. They help you monitor the lifecycle and status changes of accounts you manage.These events are not relevant for businesses building on Straddle directly.
| Event | Description |
|---|---|
capability_request.created.v1 | Fired when a platform creates a new embedded merchant account’s CapabilityRequest. This event contains the CapabilityRequest details. |
capability_request.event.v1 | Triggered when any significant change occurs to a platform-created embedded account’s capability request. This includes updates to the capability request status or values. |
Payments
Payment events encompass money movements, including charges (incoming funds) and payouts (outgoing funds). They provide real-time updates on transaction processing, fraud screening, settlement status, and more.| Event | Description |
|---|---|
charge.created.v1 | Fired when a new charge is initiated. Includes details about the charge, the associated Paykey and bank account, and the initial payment status. |
charge.event.v1 | Triggered throughout the charge lifecycle to indicate status changes and key updates—such as successful processing, failures, fraud detections, and settlement status. |
payout.created.v1 | Fired when a new payout is initiated to send funds to a customer’s bank account. Includes amount, destination bank details, selected payment rail, and initial status. |
payout.event.v1 | Triggered throughout the payout lifecycle. Indicates status changes, processing steps, failures, rail optimizations, and final settlement outcomes. |
Customers
Customer and Paykey events center around the core components of payment authorization. Customers represent the payers, while Paykeys link verified customers to their funding sources, ensuring secure and compliant transactions.| Event | Description |
|---|---|
customer.created.v1 | Fired when a new customer is created. Includes customer profile details, verification status, and the initial compliance screening outcome. |
customer.event.v1 | Triggered when a customer’s profile or status changes. This may include verification updates, compliance checks, risk rating changes, or modifications to customer data. |
paykey.created.v1 | Fired when a new Paykey is generated to link a customer to their bank account. Includes tokenized details, verification status, and initial fraud screening results. |
paykey.event.v1 | Triggered when important updates occur to a Paykey’s status or associated bank account. This may include verification changes, fraud alerts, or usage permission modifications. |
Use these events to build reactive, secure, and informed applications. By subscribing to the relevant events, you can automate downstream actions such as updating internal records, sending notifications to customers, or initiating additional compliance checks.
Subscribe to both
created and event webhook types for each resource to ensure you receive comprehensive updates about your integration.