Verify a Callback

Use this interface to verify a callback. A callback must be verified before it can be subscribed to event notifications. A successful response returns a message indicating the verification was successful, and you can subscribe the callback to subscriptions.

Service URL:

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

Path Parameters:

callbackName – Name of the callback to verify.

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

{
  "status": "Successfully verified [<callback_name>] "
}

Sample Response Body - Failure

400 Bad Request

Callback already exists: Requests fail if a callback with the same name specified already exists. The error resembles:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Callback with name [<callback_name>] already exists",
  "errorDetails": []
}

Invalid callback URL: Requests fail if the system cannot connect to the callback URL. Error resembles:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Could not connect to callback url [<callback_url> ]",
  "errorDetails": []
}