Create Webhook

A webhook applies to all documents within your account. It is not necessary to create more than one webhook. You can also create/delete webhooks inside your account in Settings > Integrations > Webhooks.

You can create a webhook in your account by going to Settings > Integration > Webhooks. Then, finalize by choosing an event and clicking on the "+" icon, as shown below:

Attention: The "All" option includes only document events (created, signed, deleted, and refused). It does not include the "Email bounce" event (for email delivery failures). For this event, you need to register it separately.

Create a webhook

POST https://api.zapsign.com.br/api/v1/user/company/webhook/

Headers

NameTypeDescription

Authorization*

string

apiToken ahead of the "Bearer" text.

Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

NameTypeDescription

url*

string

Ex: ”https://api.yoursite.com/webhook-zapsign/”

type*

string

Types of events you want to receive: "" (all) | "doc_signed" | "doc_created" | "doc_deleted"

doc_token

string

Document`s token to associate with. When defined, all the webhooks triggered will be for this document only.

headers

Array<Header>

Headers to be sent when the webhook is triggered. The configuration for each header is above

Headers configuration

Webhook - JSON root:

  • headers - for each header:

    • name (string) - Name of the HTTP header to be sent.

    Ex: Authorization

    • value (string) - Value of the HTTP header to be sent.

    Ex: Bearer YOUR_AUTHENTICATION_TOKEN

Request

Last updated