To set up Callback Notifications
The examples below demonstrate three approaches to setup callback notifications with webhooks.
Basic Authentication
HTTP RequestPUT <host domain>/api/sign/v1/callback/register HTTP HeadersAccept: application/json Content-Type: application/json Request Payload{
"callbackUrl":"https://your.domain/your.callback.listener.endpoint",
"authType": "Basic",
"username": "your.username",
"password": "your.password"
} All fields are required when creating or updating the callback. When you provide an empty string for the callbackUrl, it disables the callback.
Response Payload{
"callbackUrl":"https://your.domain/your.callback.listener.endpoint",
"authType": "Basic",
"username": "your.username",
"password": "your.password"
}
Bearer Token Authentication
HTTP RequestPUT <host domain>/api/sign/v1/callback/register HTTP HeadersAccept: application/json Content-Type: application/json Request Payload{
"callbackUrl":"https://your.domain/your.callback.listener.endpoint",
"authType": "Bearer",
"bearerToken": "your.bearer.token"
} All fields are required when creating or updating the callback. When you provide an empty string for the callbackUrl, it disables the callback.
Response Payload{
"callbackUrl":"https://your.domain/your.callback.listener.endpoint",
"authType": "Bearer",
"bearerToken": "your.bearer.token"
}
No Authentication
HTTP RequestPUT <host domain>/api/sign/v1/callback/register HTTP HeadersAccept: application/json Content-Type: application/json Request Payload{
"callbackUrl":"https://your.domain/your.callback.listener.endpoint",
"authType": "None"
} All fields are required when creating or updating the callback. When you provide an empty string for the callbackUrl, it disables the callback.
Response Payload{
"callbackUrl":"https://your.domain/your.callback.listener.endpoint",
"authType": "None"
}
