Event Types

Catalog of webhook event Type.Action values and payload conventions.

Each delivery is a JSON object. The platform injects:

"event": "Payment.Updated"

where the value is Type.Action from the internal event enum.

Event types (Type)

Type	Meaning
Payment	Customer payment lifecycle
Plan	Plan / catalog definition
Subscription	Subscription lifecycle
Invoice	Invoice lifecycle
Customer	Customer records
Account	Account alerts (for example low balance / virtual account alert actions)
Transaction / CryptoTransaction / OfframpTransaction	On-chain or offramp transaction notifications when raised
Org / MerchantContract	Organisation or contract-level events

Event actions (Action)

Common actions:

Action	Typical use
Created	Resource created
Updated	Status or field change
Canceled	Subscription or similar cancellation
Overdue	Invoice overdue
Refunded	Refund applied
Settled	Settlement-related payment stage
Processed / Queued / Enabled / Disabled	Operational transitions
Delayed	Delayed processing (may also notify internal ops)
LowBalanceDetected / VirtualAccountAlert	Account monitoring

Exact action availability depends on the resource.

Common merchant events

Plan

event value	When
Plan.Created	Plan created (one-time or recurring)
Plan.Updated	Plan field or enabled flag changed

Subscription

event value	When
Subscription.Created	Subscription created
Subscription.Updated	Status changes (for example Active)
Subscription.Canceled	Subscription canceled

Payment

event value	When
Payment.Created	Payment created
Payment.Updated	Status transition: treat Succeeded as paid

Payments may include nested customer, plan, currency, and crypto_transaction (hash, chain_id) when relevant.

Invoice

event value	When
Invoice.Created	Invoice opened
Invoice.Overdue	Invoice past due / dunning

Payload conventions

Typical fields (vary by type):

Field	Description
id	Resource id
org_id / org	Owning organisation: always validate
status	Resource status string
amount, currency	Monetary fields as strings/codes
customer / customer_id	Payer details
reference	Merchant reference when set
metadata	Arbitrary metadata
event	Type.Action string
payment_method	e.g. Crypto, Deposit, ProxyWallet
crypto_transaction	On-chain hash / chain when present

Filtering noise

Some organisations configure notification properties so certain zero-amount proxy-wallet updates are not delivered until paid. Treat the event log as the source of truth for what was attempted.

Full field reference

For exhaustive schemas, use the event document models in the API reference and test against sandbox deliveries.

Next steps

• Event History and Replay
• Webhook Best Practices