API Reference

Create a notification subscription

posthttps://api.circle.com/v2/notifications/subscriptions

Reference
Playground

Create a notification subscription by configuring an endpoint to receive notifications. For details, see the Notification Flows guide.

Header parameters

X-Request-Id

string

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

Body parameters

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.

notificationTypes

array of strings

The notification types to subscribe to. If not provided, the webhook will be unrestricted, and a notification is sent for every notification type. If the wildcard (*) or any combination of the wildcard and a set of notification types is provided, the webhook will also be unrestricted. If a set of notification types are provided, the webhook will be restricted. The restricted status of the webhook is returned in the response object. Each category of notification types also has a wildcard, which will restrict to all notification types from that category.

Allowed values*transactions.*transactions.inboundtransactions.outboundchallenges.*challenges.accelerateTransactionchallenges.cancelTransactionchallenges.changePinchallenges.contractExecutionchallenges.createTransactionchallenges.createWalletchallenges.initializechallenges.restorePinchallenges.setPinchallenges.setSecurityQuestionscontracts.*contracts.eventLogmodularWallet.*modularWallet.userOperationmodularWallet.inboundTransfermodularWallet.outboundTransfertravelRule.*travelRule.statusUpdatetravelRule.denytravelRule.approverampSession.*rampSession.completedrampSession.depositReceivedrampSession.expiredrampSession.failedrampSession.kycApprovedrampSession.kycRejectedrampSession.kycSubmitted

Response

200SubscriptionResponse

Response Body

object

data

object

Contains information about a webhook notification subscription.

Show 8 properties

string

Required

System-generated unique identifier of the resource.

name

string

Required

Name of the webhook notification subscription.

endpoint

string

Required

URL of the endpoint subscribing to notifications. Must be enabled to receive notifications.

enabled

boolean

Required

Whether the subscription is enabled. true indicates the subscription is enabled.

createDate

string

Required

Date and time the resource was created, in ISO-8601 UTC format.

updateDate

string

Required

Date and time the resource was last updated, in ISO-8601 UTC format.

notificationTypes

array of strings

The notification types on which a notification will be sent.

restricted

boolean

Whether the webhook is restricted to specific notification types. An unrestricted webhook will notify on all notification types. A restricted webhook will only notify on the notification types in the notificationTypes field.

400BadRequestResponse

401NotAuthorizedResponse

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
4    "name": "Transactions Webhook",
5    "endpoint": "https://example.org/handler/for/notifications",
6    "enabled": true,
7    "createDate": "2023-01-01T12:04:05Z",
8    "updateDate": "2023-01-01T12:04:05Z",
9    "notificationTypes": [
10      "*"
11    ],
12    "restricted": false
13  }
14}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy