To set up Callback Notifications
The examples below demonstrate three approaches to setup callback notifications with webhooks.
Basic Authentication
PUT <host domain>/api/sign/callback/v1/registerAccept: application/json Content-Type: application/json{
"callbackUrl":"https://your.domain/your.callback.listener.endpoint",
"authType": "Basic",
"username": "your.username",
"password": "your.password",
"status": true,
"events": "PACKAGE_CREATE,PACKAGE_ACTIVATE,PACKAGE_DEACTIVATE,PACKAGE_EXPIRE,PACKAGE_ARCHIVE,PACKAGE_RESTORE,PACKAGE_TRASH,PACKAGE_DELETE,PACKAGE_READY_FOR_COMPLETE,TEMPLATE_CREATE,NOTARY_COMMISSION_CREATED,RECORDINGS_READY,COMPOSITION_FAILED,EDEPOSIT_SUCCESS,EDEPOSIT_ATTEMPT_FAILURE,EDEPOSIT_FAILURE,PACKAGE_SMS_NOTIFICATIONS_LIMIT_REACHED,EMAIL_BOUNCE,DOCUMENT_VIEWED,SIGNER_LOCKED,COBROWSE_REQUEST,DOCUMENT_SIGNED,KBA_FAILURE,ROLE_REASSIGN,SIGNER_COMPLETE,PACKAGE_ATTACHMENT,PACKAGE_COMPLETE,PACKAGE_DECLINE,RECIPIENT_OPT_OUT_SMS"
}Events and Status fields are optional.
If Status is set to false, this disables the callback.
If Events is not specified, default behavior is to enable all events.
When you provide an empty string for the callbackUrl, it disables the callback.
Bearer Token Authentication
PUT <host domain>/api/sign/callback/v1/registerAccept: application/json Content-Type: application/json{
"callbackUrl":"https://your.domain/your.callback.listener.endpoint",
"authType": "Bearer",
"bearerToken": "your.bearer.token",
"status": true,
"events": "PACKAGE_CREATE,PACKAGE_ACTIVATE,PACKAGE_DEACTIVATE,PACKAGE_EXPIRE,PACKAGE_ARCHIVE,PACKAGE_RESTORE,PACKAGE_TRASH,PACKAGE_DELETE,PACKAGE_READY_FOR_COMPLETE,TEMPLATE_CREATE,NOTARY_COMMISSION_CREATED,RECORDINGS_READY,COMPOSITION_FAILED,EDEPOSIT_SUCCESS,EDEPOSIT_ATTEMPT_FAILURE,EDEPOSIT_FAILURE,PACKAGE_SMS_NOTIFICATIONS_LIMIT_REACHED,EMAIL_BOUNCE,DOCUMENT_VIEWED,SIGNER_LOCKED,COBROWSE_REQUEST,DOCUMENT_SIGNED,KBA_FAILURE,ROLE_REASSIGN,SIGNER_COMPLETE,PACKAGE_ATTACHMENT,PACKAGE_COMPLETE,PACKAGE_DECLINE,RECIPIENT_OPT_OUT_SMS"
}A bearer access token must be authorized. In order to retrieve your bearer token, refer to Obtaining the JWT access token.
Events and Status fields are optional.
If Status is set to false, this disables the callback.
If Events is not specified, default behavior is to enable all events.
When you provide an empty string for the callbackUrl, it disables the callback.
No Authentication
PUT <host domain>/api/sign/callback/v1/registerAccept: application/json Content-Type: application/json{
"callbackUrl":"https://your.domain/your.callback.listener.endpoint",
"authType": "None",
"status": true,
"events": "PACKAGE_CREATE,PACKAGE_ACTIVATE,PACKAGE_DEACTIVATE,PACKAGE_EXPIRE,PACKAGE_ARCHIVE,PACKAGE_RESTORE,PACKAGE_TRASH,PACKAGE_DELETE,PACKAGE_READY_FOR_COMPLETE,TEMPLATE_CREATE,NOTARY_COMMISSION_CREATED,RECORDINGS_READY,COMPOSITION_FAILED,EDEPOSIT_SUCCESS,EDEPOSIT_ATTEMPT_FAILURE,EDEPOSIT_FAILURE,PACKAGE_SMS_NOTIFICATIONS_LIMIT_REACHED,EMAIL_BOUNCE,DOCUMENT_VIEWED,SIGNER_LOCKED,COBROWSE_REQUEST,DOCUMENT_SIGNED,KBA_FAILURE,ROLE_REASSIGN,SIGNER_COMPLETE,PACKAGE_ATTACHMENT,PACKAGE_COMPLETE,PACKAGE_DECLINE,RECIPIENT_OPT_OUT_SMS"
}Events and Status fields are optional.
If Status is set to false, this disables the callback.
If Events is not specified, default behavior is to enable all events.
When you provide an empty string for the callbackUrl, it disables the callback.