Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

To set up Callback Notifications

The examples below demonstrate three approaches to setup callback notifications with webhooks.

Basic Authentication

HTTP Request
PUT <host domain>/api/sign/callback/v1/register
HTTP Headers
Accept: 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 Request
PUT <host domain>/api/sign/callback/v1/register
HTTP Headers
Accept: 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 Request
PUT <host domain>/api/sign/callback/v1/register
HTTP Headers
Accept: 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"
}