What is a webhook ?

A webhook is a method used in web development that allows one application to provide real-time information to another application over HTTP, it's essentially a way for apps to communicate with each other automatically.

When an event occurs in the source app, a notification is sent out as an HTTP POST request to a specified URL - this is the webhook URL.
This request carries a payload with information about the event that has occurred.
The receiving application, which has been configured to listen for such notifications at the given URL, can then take immediate action based on the transmitted data.

It's a simple, efficient, and server-friendly way for applications to extend their functionality and integrate with external services without the need for constant polling.

Event list

You can find the list of all the available webhook events here.

We will update and add more events in the upcoming months.

Auto retry

Currently there is no auto-retry scenario, Edusign's Technical team is working hardly to add if soon.

However, if the webhooks fails, Edusign will send a notification into the dashboard.
Moreover, webhooks automatically timeout at 15 seconds.

Webhook security

Webhooks HMAC is a security technique where both the sender and receiver of a message share a secret key.
When sending data, the sender creates a unique signature (HMAC) using this key and the message content.

The receiver, upon getting the message, uses the same key to create its own signature. If this signature matches the one sent with the message, it confirms the message is authentic and hasn't been tampered with, allowing the receiver to trust and process the message.

Once the webhook is received, you can retrieve the HMAC in the headers (x-edusign-hmac), and you can use the Client Secret of your app to compare the HMAC.

🔍

Edusign library

You can also use the Edusign library to retrieve the HMAC and compare it the the Client Secret of your app.
You can retrieve our library here.