Test Webhook Custom Auth Parameters

Use this API to test the custom auth parameters for a given webhook custom auth function id.

This API added with the 25.2 release of Encompass.

Usage Notes

  • On a successful 2XX response, the response returns the HTTP status code in the tokenTestOKResponse object.
  • Non-2xx failure responses return in the tokenTestFailureResponse object with actionable messages and error codes. Refer to the following error codes:

Network / Socket Errors

Error CodeMessage
ECONNABORTEDConnection timed out after 10000ms while requesting token from {url}
ENOTFOUNDUnable to resolve hostname for token URL: {url} - please verify the URL is correct
ECONNREFUSEDConnection refused by token server at {url} - the server may be down or not accepting connections
ECONNRESETConnection was reset by token server at {url} - the server closed the connection unexpectedly
ETIMEDOUTTCP connection timed out while connecting to token server at {url} - the server may be unreachable
EHOSTUNREACHToken server host is unreachable at {url} - verify network connectivity and the URL
ENETUNREACHNetwork is unreachable while connecting to token server at {url} - verify network connectivity

TLS / Certificate Errors

Error CodeMessage
CERT_HAS_EXPIREDTLS/SSL certificate error while connecting to token server at {url}: {error.message}
DEPTH_ZERO_SELF_SIGNED_CERTTLS/SSL certificate error while connecting to token server at {url}: {error.message}
UNABLE_TO_VERIFY_LEAF_SIGNATURETLS/SSL certificate error while connecting to token server at {url}: {error.message}
ERR_TLS_CERT_ALTNAME_INVALIDTLS/SSL certificate error while connecting to token server at {url}: {error.message}
Path Params
string
required
Headers
string

Bearer token

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Resource Not Found

500

Internal Server Error

Language
LoadingLoading…
Response
Choose an example:
application/json