GuidesAPI Reference
Log In
Guides

Cadastrar Webhook em um documento (Versões 1.0 e 2.0)

Cadastrar Webhook em um documento (1.0)

🚧

Importante

Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.

Ex.: https://secure.d4sign.com.br/api/v1/safes?tokenAPI={SEU-TOKEN}&cryptKey={SEU-CRYPT-KEY}

POST/documents/{UUID-DOCUMENT}/webhooks

Testar endpoint 🧪\

Esse objeto irá cadastrar o webhook no documento.

{
    "Content-Type": "application/json"
}
{
    "url": "http://www.seudominio.com/"
}
{
    "message": "Webhook successfully registered"
}
ParâmetroDescrição
url (obrigatório)URL que receberá o POSTBack da D4Sign após o documento atingir a fase FINALIZADO

Cadastrar ou Atualizar uma URL de Webhook (2.0)

🚧

Importante

  1. Não esqueça de enviar o tokenAPI e cryptKey em sua requisição.
  2. Garanta que a versão do Webhook 2.0 esteja ativa na conta.
    ( Opções da conta > Dev(API) > Webhook > Ativar Webhook 2.0 )

POST/webhooks/v2/

Testar endpoint 🧪

Este endpoint permite cadastrar ou atualizar a URL de destino (webhook) para o recebimento automatizado de notificações de eventos do Webhook 2.0 associados a um cofre ou documento específico da conta.

{
    "Content-Type": "application/json"
}
{
"type": "cofre",
"uuid": "36c718f3-6d7a-4113-bc5e-73512443ffed",
"url": "https://meusistema.com.br/receber-webhook"
}  
{
"message": "URL cadastrada/atualizada com sucesso!",
"url": "https://meusistema.com.br/receber-webhook"
}

Parâmetro

Tipo

Description

type (obrigatório)

String

O tipo de recurso a monitorar. Deve corresponder estritamente a "cofre" ou "documento".

uuid
(obrigatório)

String

O identificador único universal (UUID) do cofre ou documento informado.

url
(obrigatório)

String

A URL válida do sistema externo que receberá os disparos (POST) originados por eventos.

**Nota: ** Caso o prefixo "http://" ou "https://" não seja inserido, o sistema prefixará "http://" de forma automática.