createSubscription

Web3 Services

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Smart Contract Platform

Templates

View / Update

Interact

Deploy / Import

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

Create a notification subscription

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

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.

Response

200SubscriptionResponse

Response Body

object

data

object

Contains information about a webhook notification subscription.

Show 6 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.

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  }
10}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy