Skip to main content
POST
Test connection to a webhook

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Body

application/json
certificateId
string
required

Existing certificate identifier.

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9._-]+$
webhookUrl
string
required

A webhook URL over which a connectivity test will be performed.

Minimum string length: 1

Response

Success.

certificateId
string

Existing certificate identifier.

webhookUrl
string

A webhook URL over which a connectivity test will be performed.

result
enum<string>

Connection test result. Indicates whether the test to connection passed.

Available options:
SUCCESS,
FAIL
failReasons
string[]

Contains reasons why the connection test was failed.

Contains reasons why the connection test was failed.

hint
string

Contains a hint how the client can fix the errors.