Criar webhook
Um webhook vale para todos os documentos dentro da sua conta. Não é necessário criar mais de um webhook. Ou seja, você fará a ação abaixo uma vez apenas e não para cada documento.
Você pode criar um webhook em sua conta em Configurações > Integração > Webhooks.
Alternativamente, você pode criar/deletar o webhook com estes endpoints:
Criar webhook
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 |
|---|---|---|
url* | string | |
type* | string | Tipos de eventos que você deseja receber. Opções: "" (todos - default) | "doc_signed" | "doc_created" | "doc_deleted" |
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
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
Exemplo de requisição
Last updated
