Get all Subscriptions for a Callback
Use this endpoint to retrieve all subscriptions associated with a callback.
A successful response returns the callback name, callback URL, and batch size. For the specified callback, all subscriptions associated with the callback are returned. Subscription details returned include the subscription name, subscription status, and subscription event types.
Service URL:
/rest/api/v1.3/notifications/subscriptions/{subscriptionName}
Path Parameters:
callbackName – Name of the callback to retrieve subscriptions for.
Request Method:
GET
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body - Required Properties:
Not applicable
Sample Request Body
Not applicable
Sample Response Body - Success
{
"callBackName": "<callback_name>",
"callBackUrl": "<callback_url>",
"batchSize": 200,
"subscriptions": [
{
"name": "Subscription_MMS",
"status": "ACTIVE",
"eventTypes": [
"MMS_SKIPPED",
"MMS_FAILED"
]
"filters": [
{
"eventTypes": [
"EMAIL_FAILED"
],
"values": [
{
"campaignNames": [
"vk_campaign_failed"
]
}
]
}
]
},
{
"name": "Subscription_EmailSMS",
"status": "ACTIVE",
"eventTypes": [
"EMAIL_BOUNCED",
"EMAIL_FAILED",
"EMAIL_SKIPPED",
"SMS_FAILED",
"SMS_SKIPPED",
"SMS_MO_FW_FAILED"
]
},
{
"name": "Subscription_WebPush",
"status": "ACTIVE",
"eventTypes": [
"WEBPUSH_FAILED",
"WEBPUSH_SKIPPED",
"WEBPUSH_BOUNCED",
"WEBPUSH_CLOSED"
]
},
{
"name": "Subscription_Push",
"status": "ACTIVE",
"eventTypes": [
"PUSH_SKIPPED",
"PUSH_FAILED",
"PUSH_BOUNCED"
]
}
],
"links": [
{
"rel": "self",
"href": "<callback_url>",
"method": "GET"
},
{
"rel": "deleteCallBack",
"href": "<callback_url>",
"method": "DELETE"
},
{
"rel": "getCallBack",
"href": "<callback_url>",
"method": "GET"
},
{
"rel": "verifyCallBack",
"href": "<callback_url>",
"method": "GET"
},
{
"rel": "createCallBack",
"href": "<callback_url>",
"method": "POST"
},
{
"rel": "updateCallBack",
"href": "<callback_url>",
"method": "PUT"
},
{
"rel": "getAllCallbacks",
"href": "<callback_url>",
"method": "GET"
}
]
}
For callbacks with subscriptions with no event types, or callbacks with no subscriptions:
{
"callBackName": "<callback_name>",
"callBackUrl": "<callback_url>",
"batchSize": 100,
"subscriptions": []
}
Sample Response Body - Failure
400 Bad Request
Invalid callback: Requests fail if the specified callback name cannot be found. The error resembles:
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "CallBack [<callback_name> ] does not exist",
"errorDetails": []
}