Create a notification subscription

POST {{baseUrl}}/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 Params

endpoint string (REQUIRED) URL of the subscriber endpoint. Must be publicly accessible and utilize HTTPS.

Request Body

{"endpoint"=>"https://webhook.site/f0c4231b-50b4-4d3a-9239-e36d1e1e8a7b"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"data":{"id":"02da464c-426b-40ca-aa2c-4a7899f5dcb5","endpoint":"https://webhook.site/f0c4231b-50b4-4d3a-9239-e36d1e1e8a7b","subscriptionDetails":[{"url":"arn:aws:sns:us-east-1:908968368384:sandbox_platform-notifications-topic:1b8c6ff7-f633-420e-a45b-4c8941960e33","status":"pending"},{"url":"arn:aws:sns:us-west-2:908968368384:sandbox_platform-notifications-topic:f3bee00e-60d4-45ee-a7f2-d1824e5d3cec","status":"pending"}]}}