Retrieve a Callback

Use this endpoint to retrieve an existing callback. A successful response returns the callback’s name, URL, and batch size.

Service URL:

/rest/api/v1.3/notifications/callbacks/{callbackName}

Path Parameters:

callbackName – Name of the callback to retrieve.

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

{
  "name": "<callback_name>",
  "url": "<callback_url>",
  "batchSize": <batch_size>,
  "links": [
    {
      "rel": "self",
      "href": "<callback_url>",
      "method": "GET"
    },
    {
      "rel": "deleteCallBack",
      "href": "<callback_url>",
      "method": "DELETE"
    },
    {
      "rel": "createCallBack",
      "href": "<callback_url>",
      "method": "POST"
    },
    {
      "rel": "updateCallBack",
      "href": "<callback_url>",
      "method": "PUT"
    }
  ]
}

Sample Response Body - Failure

404 Not Found

Callback not found: Requests fail if the callback name specified is not found. The error resembles:

{
  "type": "",
  "title": "Object not found",
  "errorCode": "OBJECT_NOT_FOUND",
  "detail": "CallBack [<callback_name>] not found",
  "errorDetails": []
}