> For the complete documentation index, see [llms.txt](https://docs.zapsign.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zapsign.com.br/zapsign-api/english/webhooks/testing-webhooks-on-zapsign.md).

# Testing webhooks on ZapSign

Webhook availability and the number of registrations depend on your plan, market and account terms. Confirm that the feature is enabled under Settings > Integrations > ZapSign API and check the official Plans and Pricing page for your market (<https://zapsign.co/plans-and-prices>). To test without configuring a local server, you can use Webhook.site to capture and inspect incoming events. Use fictitious documents and test contacts: the receiver may receive signer data and document links.

***

#### <mark style="background-color:blue;">1. Creating a Webhook in Webhook.site</mark>

* Step 1: Go to [Webhook.site](https://webhook.site).
* Step 2: On the homepage, you will see a unique URL automatically generated. This will be your endpoint to receive webhooks.

&#x20;Leave this tab open as this is where you will view the data sent by ZapSign’s webhook.<br>

<figure><img src="https://1401277393-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M4noMoX5ZGb2-RhWjjf-1703796690%2Fuploads%2FeuYeU0AYUwynV6HTTEKK%2Fimage.png?alt=media&amp;token=44167abf-7c22-4668-8735-d6bab198e04f" alt=""><figcaption></figcaption></figure>

#### <mark style="background-color:blue;">2. Configuring the Webhook in ZapSign</mark>

* Step 1: Access ZapSign via [production](https://app.zapsign.co/acesso/entrar?lang=en\&hsCtaTracking=4edd8973-b121-4d30-afbd-31b31d410c11%7C08438d37-01e6-4986-b7a5-dd7709a36146) or [sandbox](https://sandbox.app.zapsign.com.br/acesso/entrar) environment.
* 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.<br>

<figure><img src="https://1401277393-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M4noMoX5ZGb2-RhWjjf-1703796690%2Fuploads%2Fa3C1HEP4qxn7VW95RDOZ%2Fimage.png?alt=media&amp;token=8944f112-96c8-4d80-b648-e46780e29044" alt=""><figcaption><p>Webhook configuration: confirm availability and registration limits for your account.</p></figcaption></figure>

#### <mark style="background-color:blue;">3. Triggering an Event in ZapSign</mark>

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.

<figure><img src="https://1401277393-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M4noMoX5ZGb2-RhWjjf-1703796690%2Fuploads%2F0NHIUGEd5p0WmFbz8daE%2Fimage.png?alt=media&amp;token=59730dcf-9787-4af1-93f1-66b78cb19d23" alt=""><figcaption><p>Example of a webhook request received on webhook.site.</p></figcaption></figure>

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zapsign.com.br/zapsign-api/english/webhooks/testing-webhooks-on-zapsign.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
