Get all webhook subscriptions

curl --request GET \
  --url https://api.circle.com/v2/cpn/notifications/subscriptions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "name": "Transactions Webhook",
      "endpoint": "https://example.org/handler/for/notifications",
      "enabled": true,
      "createDate": "2023-01-01T12:04:05Z",
      "updateDate": "2023-01-01T12:04:05Z",
      "notificationTypes": [
        "*"
      ],
      "restricted": false
    }
  ]
}

GET

cpn

notifications

subscriptions

Get all webhook subscriptions

curl --request GET \
  --url https://api.circle.com/v2/cpn/notifications/subscriptions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "name": "Transactions Webhook",
      "endpoint": "https://example.org/handler/for/notifications",
      "enabled": true,
      "createDate": "2023-01-01T12:04:05Z",
      "updateDate": "2023-01-01T12:04:05Z",
      "notificationTypes": [
        "*"
      ],
      "restricted": false
    }
  ]
}

Authorizations

Authorization

string

header

required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Response

Successfully retrieved webhook subscriptions.

data

Subscription · object[]

Show child attributes

data.id

string<uuid>

required

System-generated unique identifier of the resource.

Example:

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

data.name

string

required

Name of the webhook notification subscription.

Example:

"Transactions Webhook"

data.endpoint

string

required

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

Example:

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

data.enabled

boolean

required

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

Example:

true

data.createDate

string<date-time>

required

Date and time when the resource was created

Example:

"2023-01-01T12:04:05Z"

data.updateDate

string<date-time>

required

Date and time when the resource was last updated

Example:

"2023-01-01T12:04:05Z"

data.notificationTypes

enum<string>[]

The notification types on which a notification will be sent.

The type of notification that can be subscribed to. Supports wildcard patterns (e.g., 'cpn.payment.') to subscribe to all notifications within a category. The '' wildcard can be used to subscribe to all notifications.

Available options:

*,

cpn.payment.*,

cpn.payment.cryptoFundsPending,

cpn.payment.fiatPaymentInitiated,

cpn.payment.completed,

cpn.payment.failed,

cpn.payment.delayed,

cpn.rfi.*,

cpn.rfi.informationRequired,

cpn.rfi.inReview,

cpn.rfi.approved,

cpn.rfi.rejected,

cpn.transaction.*,

cpn.transaction.broadcasted,

cpn.transaction.completed,

cpn.transaction.failed

Example:

["*"]

data.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.

Example:

false

Ping

Create a webhook subscription

API Overview

Circle Payments Network

Get all webhook subscriptions

Authorizations

Response