Skip to main content
WEBHOOK

Body

application/json

Envelope sent to your endpoint for every webhook notification. The shape of the notification field depends on notificationType.

​
subscriptionId
string<uuid>
required

ID of the webhook subscription that produced this notification.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

​
notificationId
string<uuid>
required

Unique ID for this event notification. Stable across retries of the same event.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

​
notificationType
enum<string>
required

The type of notification.

Available options:
transactions.inbound
​
notification
TransactionNotification · object
required

The transaction object delivered in the body of a transactions.inbound or transactions.outbound webhook notification.

Required properties are always present in the payload, even when their values are empty or null. Inbound events leave more fields empty than outbound events, since a deposit is observed onchain rather than built and broadcast by Circle.

This object is smaller than the Transaction returned by the transaction REST endpoints. Call GET /transactions/{id} to retrieve fields omitted from this notification.

​
timestamp
string<date-time>
required

When the notification was produced.

​
version
integer
required

The version of the notification schema.

Response

200

Webhook received successfully.