ZapSign API
English
English
  • General Information
  • Getting Started
  • ZapSign Environments
  • Ready-to-use requests!
  • Authentication
    • Static token
    • JWT Authentication
      • Get access token
      • Refresh your access token
  • Types of Tokens
  • API versioning
  • Rate Limit Policies
  • Incident alerts
  • How Payment Works
  • Status Code
  • Account
    • Plan Information
    • List account users
    • Create account users
    • Delete account user
  • Documents
    • Create document via Upload
    • OneClick (ClickWrap)
      • Create document (OneClick)
    • Create document via Template
    • Add attachment (extra document)
    • Add attachment (extra document) via Template
    • Detail document
    • List documents
    • Delete document
    • Document Audit Trail
    • Optional: Place signatures
    • Reject Documents
  • Signers
    • Detail signer
    • Update signer
    • Add signer
    • Delete signer
    • Batch sign via API
    • Reject Documents by User
  • Templates
    • Create template (DOCX)
      • Configure Template Form
    • List templates
    • Get template
    • Update template
    • Delete template
  • Partnerships
    • Update Payment Status
    • Create Account
  • TIMESTAMP
    • Add timestamp
  • Background Check
  • Introduction
  • Understanding the Result
  • Creating a Background Check
    • Person Check
    • Company check
  • Retrieve a Check
  • Check details
  • Webhooks
    • How webhooks works
    • Testing webhooks on ZapSign
    • Create Webhook
    • Webhooks logs
    • Events
      • Document
        • Doc created
        • Doc deleted
        • Created signer
      • Signer
        • Signature request send
        • Document viewed
        • Reading confirmation
        • Doc signed
        • Doc refused
        • Email bounce
        • Failed Validation
      • Background check
        • Background check completed
    • Reprocessing Documents and Webhooks
    • Delete Webhook
  • Widget
    • How widget works
Powered by GitBook
On this page

Was this helpful?

  1. Webhooks

How webhooks works

Set up your webhooks in less than 1 minute.

Webhooks are automatic notifications essential for system integration, as they notify your server directly, eliminating the need to constantly check the status of an operation. With webhooks, you can:

  • Reduce repetitive API queries to check the status of a document (commonly known as polling);

  • Synchronize systems and integrations, ensuring that information between different platforms is always up to date and consistent;

  • Automate post-event processes so that subsequent tasks are performed automatically.

Do I need to have an API Plan to use webhooks? No, webhooks are freely available to all users. But API users are strongly recommended to use webhooks instead of polling.


ZapSign supports webhooks to notify you of events such as document creation, signature, document rejection, document completion, or email delivery failure. When such an event occurs, we send an HTTP POST request to the URL configured in your application containing details about the event in JSON format.

Your application should return status 200 when receiving a webhook, otherwise, ZapSign will retry the sending, generating duplicates and/or unnecessary requests.

PreviousCheck detailsNextTesting webhooks on ZapSign

Last updated 7 months ago

Was this helpful?