We refreshed our doc site!
Bookmarked links may have changed
Read release notes
Create a notification subscription
POSThttps://api.circle.com/v1/notifications/subscriptions
Subscribe to receiving notifications at a given endpoint. The endpoint should be able to handle AWS SNS subscription requests. For more details see https://docs.aws.amazon.com/mobile/sdkforxamarin/developerguide/sns-send-http.html. Note, the sandbox environment allows a maximum of 3 active subscriptions; otherwise, this is limited to 1 active subscription and subsequent create requests will be rejected with a Limit Exceeded error.
Body parameters
endpoint
string
Required
URL of the subscriber endpoint. Must be publicly accessible and utilize HTTPS.
Response
RequestChoose a language
ResponseChoose an example
1{
2 "data": {
3 "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
4 "endpoint": "https://example.org/handler/for/notifications",
5 "subscriptionDetails": [
6 {
7 "url": "arn:aws:sns:us-east-1:<...>:fcb4a2c9-9c4f-4706-b312-6b22650f5d17",
8 "status": "confirmed"
9 }
10 ]
11 }
12}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
