SDK Explorer

Create a notification subscription by configuring an endpoint to receive notifications.

For details, see the Notification Flows guide.

Parameters
input
object
Required

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.

Responses
Example
1const response = await client.createSubscription({
2  endpoint: 'https://example.org/handler/for/notifications',
3})
4console.log(response)
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?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.