API Reference
Validate webhook
API Reference
Validate webhook
Validate your webhook is configured correctly
POST
/
ingest
/
validate
The validate endpoint is used to validate that your server is creating a signature / header format that will be accepted by our API.
The webhook provider sends a request to the webhook URL with a validation token in the request body.
The webhook URL must respond with the validation token in the response body and create a signature in the response header.
Authorizations
Authorization
string
headerrequiredThe client ID associated with your account.
x-optech-webhook-signature
string
headerrequiredThe signature of the webhook - should be generated as a SHA256 hash of the payload and the secret key.
Body
application/json
data
object
requiredThe return data for the tool request.
Response
200 - application/json
code
enum<integer>
Available options:
200 data
string
The return data for the tool request.
Was this page helpful?