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
  • Signature Validation
  • 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

Events

Understand the events that are sent by webhooks

ZapSign sends the following events via webhook:

  • doc_created This event is sent when a document is created.

  • created_signer This event is sent when a new signer is added to an ongoing document.

  • doc_deleted Notifies when a document has been deleted, either from the platform or via the API.

  • doc_signed Triggered when a signer signs the document. The webhook specifies which signer signed the document.

  • doc_refused Indicates that a document has been refused by the signer.

  • email_bounce Notifies about failures in email delivery.

  • signature_notification_sent Notifies when the document is sent to the signer via email or WhatsApp (parameter send_automatic_email or send_automatic_whatsapp).

  • doc_viewed Notifies when the signer views the document (opens the signing link).

  • doc_read_confirmation Notifies when the signer confirms reading the document (clicks the "Continue" button after viewing the document).

  • signer_authentication_failed Notifies when the signer has exceeded the maximum number of attempts to verify their identity using the Facial Recognition and Identity Validation methods.

  • background_check_completed Notifies when a background check has completed.

You will be able to differentiate one from the other by the attribute "event_type" which will follow with every webhook.

"event_type": "doc_created"

Check the body of each event in the upcoming chapters!

PreviousWebhooks logsNextDocument

Last updated 1 month ago

Was this helpful?