Skip to main content

How to set up Web Hooks

Set up Web Hooks to receive real-time status updates from Addo Sign — no need to poll the API, changes trigger auto-callbacks.

Updated over a week ago

Using Web Hooks

You can use Web Hooks (technically called web callbacks or HTTP push APIs) to make changes to your company’s website or web apps with custom interactions.

This allows your company to receive real-time updates whenever a transaction in Addo Sign changes status.

Web Hooks: When a Transaction Changes Status

A Web Hook is triggered whenever a transaction changes status. The most common status changes are listed below:

  • Completed: The transaction has been signed by all parties.

  • Expired: The signing deadline has passed.

  • Transaction state changed: Notifications can be sent at each stage:

    1. Transaction started

    2. Awaiting new signer

    3. Signed

    4. Returned to sender/signer

    5. Error during sending/receiving

  • Cancelled: Typically covers situations where a transaction has been manually stopped or withdrawn before completion.

    This means the sender has cancelled the signing process. No further actions (e.g. signing, reminders, redirects) will occur. The transaction is considered terminated and will not reach completion.

  • Rejected: A signer has refused to sign the document.

  • Document Opened: A signer has opened one or more documents in the transaction.

  • Document Signed: A signer has signed a document in the transaction.

  • Redirect url: Redirects a signer to a specified website after signing. The landing page URL must start with either http:// or https://.

  • Invitation: An invitation has been sent to a signer.

  • Reminder: A new reminder has been sent to the signer.

  • Bounce Delivery: When an email bounces back to our system, we trigger a callback to the sender with the relevant information.

In short, you redirect the signer to a URL depending on the status change.

This means you don’t need to set up an API to fetch data — updates are pushed to you live whenever a status change occurs.

Certificate and Security

Some server setups require a security certificate for the above Web Hooks to function properly.

This certificate is usually provided by the company’s IT department.

Did this answer your question?