Webhook

What is webhook and how do I configure it in emSigner?

In emSigner, a webhook is a mechanism that allows the system to send real-time notifications to other applications or systems when certain events occur. When a predefined action or event takes place in emSigner-like document signing or workflow completion-the webhook sends an HTTP POST request to a specified URL (the webhook endpoint) in the external system.

This request contains data about the event, enabling the external system to process it further, such as updating a database, triggering other workflows, or notifying users.

For example, if you want an external system to be notified immediately after a document is signed, you could configure a webhook in emSigner to send a notification to that system's endpoint. This integration approach is beneficial for automating workflows and keeping multiple systems synchronized in real-time.

Step 1: Log in to your emSigner account Click on the Settings tab in the top navigation bar. Under Integrations & Automation, click on the Webhooks for Real-Time Updates card.

Step 2: Create a new webhook On the Webhooks for Real-Time Updates page, click Create New in the top-right corner.

Step 3: Enter the webhook details On the Create Webhook page, enter the relevant details in the respective fields:

• Name — a friendly label for your webhook, used only for display

• Department — select the department from the dropdown; the webhook will apply only to activities linked to that department

• Request From — enter the source of the request

• Event — tick the necessary checkbox(es) for the event(s) you want to track: Recalled, Declined, Completed, Signed/Reviewed, Custom Status, or Voided

• Target — enter the target URL to which data will be sent. HTTPS is recommended. You can click Send to test the endpoint before saving

• Authentication — select the authentication scheme for your target URL, or choose "None" if it doesn't require one

Step 4: Save the webhook Once all the information is provided, click Save.

Step 5: Verify the webhook The newly created webhook will appear in the Webhooks for Real-Time Updates list with its Name, Request From, Event, Authentication, and Status (Active) displayed. Use the pencil icon in the Actions column to edit the webhook, or the trash icon to delete it.

• Users can track the status of documents based on the information related to different action events sent to the endpoint.

• Events like Recalled, Declined, Completed, Signed/Reviewed, Custom Status, and Voided can be ticked as per requirement.

• Upon successful completion of any one of the above-mentioned events, a notification will be triggered and JSON data will be pushed to the webhook endpoint with the document status details.