Skip to main content
⌘ K

Dokobit Webhooks

· Updated ·

To make the automated document management process more manageable and flexible, Dokobit delivers noteworthy information about your documents to your application using webhooks. It is a method of altering the web page or web application with custom callbacks as a combination of elements that create an event notification and can be used to initiate a reaction in your integration.

You can use these events to perform actions, such as downloading the document to store it on your side, triggering an event in your document management system, informing signing participants about the completed signing process in your Customer Relationship Management system and much more.

The main advantage is that your system does not need to make periodic calls to our APIs. Instead, you can idle while we inform you when something worthy of action has happened right away.

Webhooks are delivered via HTTPS protocol (port 443) that uses the TLS 1.2 to ensure secure communication. We expect an HTTP 200 OK response to our POST webhook requests as an acknowledgement that you received the webhook without any problems.

Any response code outside the HTTP 2xx range will indicate that you did not receive the webhook. If the delivery fails, the request will be repeated three times - after 5 minutes, 1 hour, and 24 hours. This ensures that the information will reach your system, and you do not need to implement additional status checking mechanisms to keep track of your signed documents.

The postback payload is sent to your provided URL, which must be accessible for our services. You can limit access to the URL by whitelisting our IP addresses (General API Services Information).

The attribute “postback_url” can be used with the following methods:

  • Signing creation using Portal API. Types of notifications:
    • signing_created - Document signing created;
    • signer_approved - Document was approved;
    • signer_declined - Document signer has declined to sign the document;
    • signer_signed - Document signed by one of the signers;
    • document_received  - Document delivery was confirmed by the receiver;
    • signing_completed - Document signed by all parties;
    • signing_archived - Signing archived successfully;
    • signing_archive_failed - Signing archiving failed.
  • Signing creation with Universal API. Types of notifications:
    • signing_created  - Document signing created;
    • signer_declined  - Document signer has declined to sign the document;
    • signer_signed  - Document signed by one of the signers;
    • document_received  - Document delivery was confirmed by the receiver;
    • signing_completed  - Document signed by all parties.
  • Signing creation with Documents Gateway. Types of notifications:
    • signer_signed - Document signed by one of the signers;
    • signing_completed - Document signed by all parties;
    • signing_archived - Signing archived successfully;
    • signing_archive_failed - Signing archiving failed.
  • Signing archiving with Documents Gateway. Types of notifications:
    • signing_archived - Signing archived successfully;
    • signing_archive_failed - Signing archiving failed.

Dokobit Portal users could also implement webhooks by setting a document category in the Portal with a postback URL. More information can be found here.

Related articles