Callback Authentication

When subscribing to a webhook or making an async call, you have to include details of how this API can authenticate to in order to send the requested data to the specified destination endpoint.

Currently the following callback authentication methods are supported:

  • No authentication

  • Basic auth, using a username and password

  • Token auth, using a bearer token

Additional methods that are planned for development in future:

  • OAuth2

Below are the formats in which to supply the relevant authentication details in your request body.

No authentication

  "Callback": {
    "Endpoint": "https://myDestinationApi.com/myCallBackEndpoint/",
    "Authentication": {

"AuthenticationType": "NONE"

  }

Basic authentication

  "Callback": {
    "Endpoint": "https://myDestinationApi.com/myCallBackEndpoint/",
    "Authentication": {

"AuthenticationType": "BASIC",

"Credentials": {

"Username": "myTestUser",

"Password": "P@ssw0rd"

}

  }

Bearer authentication

  "Callback": {
    "Endpoint": "https://myDestinationApi.com/myCallBackEndpoint/",
    "Authentication": {

"AuthenticationType": "BEARER",

    "Token": {

        "Token": "12345678"

      }

  }