Skip to main content
POST
Create a webhook subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Request-Id
string<uuid>

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Body

application/json

Schema for the request payload to create a new subscription.

Required parameters to create a new subscription.

endpoint
string
required

URL of the endpoint to subscribe to notifications. Must be publicly accessible, use HTTPS, and respond with a 2XX status to a POST request.

Example:

"https://example.org/handler/for/notifications"

notificationTypes
enum<string>[]

The notification types to subscribe to. If not provided, the webhook is unrestricted and a notification is sent for every notification type. If the wildcard (*) is provided, the webhook is also unrestricted. If a set of notification types is provided, the webhook is restricted to those types. Each category has a wildcard — for example, mint.* restricts to every mint event.

The type of notification that can be subscribed to. Supports wildcard patterns — for example, mint.* subscribes to every mint event. The * wildcard subscribes to every Digital Asset Accounts notification type.

Available options:
*,
custody.*,
custody.transfer,
mint.*,
mint.deposits,
mint.payout,
mint.wire,
mint.addressBookRecipients,
bankAccounts.*,
bankAccounts.created,
bankAccounts.updated,
bankAccounts.denied
Example:

Response

Successfully created webhook subscription.

data
Subscription · object

Contains information about a webhook notification subscription.