For the complete documentation index, see llms.txt. This page is also available as Markdown.

Criar webhook

duas formas de criar um webhooks na ZapSign, via interface web ou via chamada do endpoint na API. Dessa forma, você pode configurar webhooks de maneira flexível e eficiente, garantindo que seu sistema seja notificado em tempo real sobre os eventos importantes.

Lembre:se Não é necessário criar um webhook para cada documento, somente para cada evento que deseja.

Nesta seção: Criando webhooks via web; Criando webhooks via Api; Configurando Headers para webhooks;


Criando webhooks Via web

Passo 1: Em sua conta, navegue até área de Configurações>Integrações>Api ZapSign> Webhooks. Passo 2: Insira o endpoint (URL) do seu servidor que receberá os dados dos webhooks. Esse endpoint deve estar preparado para processar requisições POST e lidar com os dados JSON que a ZapSign enviará.

Passo 3: Defina quais eventos deseja monitorar. A ZapSign permite que você escolha cinco tipos de eventos, são eles:

Passo 4: Configure se deseja adicionar um filtro para receber notificações apenas de documentos criados a partir de um template específico. Além disso, é possível definir reintentos em caso de falha na notificação.


Criando webhooks via API

Você também pode criar seus endpoints via API, ajustando os cabeçalhos e eventos conforme a necessidade do seu fluxo de trabalho para uma integração perfeita!

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

Headers

Name
Type
Description

Authorization*

string

Api token a frente do texto "Bearer".

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

Request Body

Name
Type
Description

type*

string

Tipos de eventos que você deseja receber. Opções: "" (todos - default) | "doc_signed" | "doc_created" | "doc_deleted"| "doc_refused"|"email_bounce"

doc_token

string

Token do documento para associar o Webhook. Caso enviado, os webhooks serão disparados apenas para o documento em questão

headers

Array<Header>

Headers a serem enviados ao disparar o webhook. A configuração de cada header está abaixo

Configurando headers para webhooks

Também é possível implementar headers nos webhooks, garantindo maior segurança no envio de dados e otimizando o desempenho entre as aplicações.

Webhook - raiz do JSON:

  • headers - para cada header:

    • name (string) - Nome do cabeçalho HTTP a ser enviado.

    Ex: Authorization

    • value (string) - Valor do cabeçalho HTTP a ser enviado.

    Ex: Bearer SEU_TOKEN_DE_AUTENTICACAO

POST {{api_url}}/api/v1/user/company/webhook/header/

Exemplo de requisição

Faça um teste com a requisição pronta no Postman!

Last updated