Evia Sign
  • Welcome to Evia Sign
    • What can Evia Sign do?
  • How to send signature request?
    • How to enable multiple signatories to access and sign documents at the same time?
    • How to add approvers and CC recipients to a signature request?
    • How do you add authentication to your request?
    • How do you send a private message?
  • How to sign documents?
    • Opening a document through Evia Sign inbox
    • Explore the different ways to add your signature
  • How to draft documents?
    • Components of DRAFTS in Evia Sign
  • Explore Evia Sign Inbox
  • How to create and use templates
    • Components of TEMPLATES
  • How to save your signature and initial?
  • How to add date stamp to your signature?
  • How to set up automatic reminders & expiration for signature requests
  • Users
    • How to import O365 users?
    • How to add new users?
    • How to delete users?
    • How to activate and deactivate users?
  • How do I change the current subscription plan of my account?
    • How to cancel and renew plan?
    • How do I purchase additional user licenses?
  • How to work with Enadoc Integration?
  • Terms to be familiar
  • FAQs
    • How to login into Evia Sign?
    • How do I make an account recovery?
    • How do you configure stamps?
    • How do you manually send reminders to signatories?
    • How do you view document history?
    • How do you decline a document?
    • How do you download a document?
    • What is a digitally certified document?
    • How are additional user licenses purchased?
    • How do you send reminders to signatories?
    • How to modify your session duration?
    • How do I monitor the request usage of my Evia Sign account?
  • Release Notes
  • Evia Sign API
    • V1
      • Overview
      • Authorization of the API Access
      • Requests
        • Document Upload
        • Send Requests
      • Request Types
        • Template
        • Fixed Positioning
        • Auto Stamping
    • V2
      • Welcome to Evia Sign API Version2
      • How to Migrate from API v1 to v2
        • Basic Guide with minimal changes
        • Access Token Request (v1 ➞ v2)
      • Authorization & Authentication
        • How to Register Your Application
        • Requesting the Authorization Code
        • Exchange Authorization Code for Access Token
      • Upload Document for Signing
      • Creating a Signature Request
      • Add Signatory to a Signature Request
      • Add Stamps to a Signatory
      • Send Signature Request
      • Webhook Management
      • Glossary & Common Fields
  • Welcome to the New and Improved Evia Sign
  • How to Use the PDF Commenting Feature in Evia Sign
  • How to Upload Documents from SharePoint in Evia Sign
Powered by GitBook
On this page
  • Create a Webhook
  • Request URL
  • Required Headers
  • Request Body Schema
  • Field Descriptions
  • Supported Events
  • Example: Create a Webhook
  • Event Payloads
  • Delete a Webhook
  • Possible Errors and How to Handle Them

Was this helpful?

  1. Evia Sign API
  2. V2

Webhook Management

Webhooks allow your application to automatically receive real-time updates when specific events occur in the Evia Sign platform — such as when a signature request is sent, or completed.

By configuring webhooks, you can eliminate the need for polling and seamlessly automate backend processes like notifications, updates, or workflows.

Create a Webhook

This operation allows you to create a webhook in Evia Sign by submitting your callback URL and subscribing to specific event types. Once created, Evia Sign will send structured payloads to your URL every time a selected event is triggered.

Request URL

POST/api/v2/webhooks

This is the request URL used to create and subscribe a new webhook.

Your application must include the destination URL (url) and specify one or more event types (events) it wants to subscribe to.

Required Headers

These headers are essential for authorizing the request and ensuring the server processes the payload correctly.

Header
Required
Description

Authorization

✅ Yes

Bearer token obtained from the OAuth 2.0 flow

Content-Type

✅ Yes

Must be set to application/json

Request Body Schema

The structure used to define your webhook’s behavior — including where the data should be sent and which events to listen for.

{
  "url": "https://yourdomain.com/callback",
  "events": ["request.sent", "request.completed"]
}

This payload defines:

  • The public HTTPS where Evia Sign will send updates.

  • The events your system wants to subscribe to.

Field Descriptions

Details about the fields expected in the request body — so developers understand what to send and why it matters.

Field
Type
Required
Description

url

string

✅ Yes

Your HTTPS endpoint to receive event notifications. Must be publicly accessible.

events

array

✅ Yes

List of event types to subscribe to (see supported events).

Supported Events

A list of available webhook event types that can be subscribed to. These determine what kinds of changes will trigger a callback to your server.

Event Name
Description

request.sent

Triggered when a signature request has been received.

request.completed

Triggered when all required signatures are completed.

Example: Create a Webhook

A ready-to-use payload sample that shows how to submit a webhook creation request.

{
  "url": "https://webhooks.yourdomain.com/evia-sign",
  "events": ["request.sent", "request.completed"]
}

Event Payloads

Illustrates what your server will receive when each subscribed event occurs. Useful for developers to prepare their endpoint to handle incoming data correctly.

request.sent

{
  "Name": "Jane Doe",
  "Email": "jane@example.com",
  "Subject": "Contract.pdf",
  "Link": "https://evia.enadocapp.com/sign/#/sign/abc123"
}
Field
Type
Description

Name

string

Name of the participant (initiator or signer).

Email

string

Email address of the recipient.

Subject

string

Title or filename of the document.

Link

string

Direct signing URL.


request.completed

{
  "RequestId": "abc123",
  "Status": "Completed"
}
Field
Type
Description

RequestId

string

Unique ID of the completed signature request.

Status

string

Final status (Completed, Cancelled, etc.).

Delete a Webhook

Describes how to remove an existing webhook subscription when it’s no longer needed

Request URL

DELETE /api/v2/webhooks/webhookID

Replace webhookId with the actual ID of the webhook to be deleted.

Possible Errors and How to Handle Them

A quick-reference table to help developers troubleshoot issues like malformed payloads, missing tokens, or duplicate registrations.

Status Code
Error Message
Explanation

400

Bad Request

The request body is malformed or missing required fields.

401

Unauthorized

Access token is missing or expired.

404

Webhook Not Found

The given webhook ID does not exist.

PreviousSend Signature RequestNextGlossary & Common Fields

Last updated 24 days ago

Was this helpful?