Docs API Reference

Notifications

A Notification is sent to Webhook subscribers when specific events occur in our system. Notifications may contain details about the event, and relevant metadata.

Notification Model

Attributes

id
string

Notification's unique identifier.
type
string

The notification type .
data
string

The associated metadata. Typically, this would contain data about the event.
accountId
string

The Account that the notification was triggered for.
test
boolean

Whether the notification is for testing purposes.
createdAt
timestamp

When the notification was created.

Notification types

Notification type	Description	Metadata
`payment-request:paid`	A Payment Request has been paid.	See Payment Activity Model
`payment-request:refund-initiated`	A refund of a Payment Request has been initiated.	See Payment Activity Model
`payment-request:refund-completed`	A Payment Request has been successfully refunded.	See Payment Activity Model