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

Testing webhooks on ZapSign

PreviousHow webhooks worksNextCreate Webhook

Last updated 7 months ago

Was this helpful?

You can register as many webhooks as you like.To facilitate webhook testing without having to configure a local server, tools like Webhook Site are a great option. They allow you to capture and visualize events received by the API quickly, helping with debugging and validating webhooks in real-time.


1. Creating a Webhook in Webhook.site

  • Step 1: Go to .

  • Step 2: On the homepage, you will see a unique URL automatically generated. This will be your endpoint to receive webhooks.

Leave this tab open as this is where you will view the data sent by ZapSign’s webhook.

2. Configuring the Webhook in ZapSign

  • Step 2: Navigate to Settings > Integrations > ZapSign API > Webhooks.

  • Step 3: Add the URL generated by Webhook.site in the field where ZapSign requests the webhook endpoint and define the events for which you want to receive webhooks. Click "+" to add the address.

3. Triggering an Event in ZapSign

Create a document or trigger an event in ZapSign, then check Webhook.site for the received POST request, which will contain all the event details, including document ID, status, and payload.

In the next chapter, we’ll go into more detail on how to create webhooks, both via the web interface and API.

Step 1: Access ZapSign via or environment.

production
sandbox
Webhook.site
You can register as many webhooks as you like.
Example of a webhook request received on webhook.site.