Skip to main content
POST
/
v1
/
notifications
/
subscriptions
Create a notification subscription
curl --request POST \
  --url https://api-sandbox.circle.com/v1/notifications/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endpoint": "https://example.org/handler/for/notifications"
}
'
{
  "data": {
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "endpoint": "https://example.org/handler/for/notifications",
    "subscriptionDetails": [
      {
        "url": "arn:aws:sns:us-east-1:<...>:fcb4a2c9-9c4f-4706-b312-6b22650f5d17",
        "status": "confirmed"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
endpoint
string
required

URL of the subscriber endpoint. Must be publicly accessible and utilize HTTPS.

Example:

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

Response

Successfully created a notification subscription.

​
data
object