GuidesAPI Reference
Log In
Guides

Listagem de Webhooks (Versões 1.0 e 2.0)

Listar Webhook de um documento (Versão 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}

GET/documents/{UUID-DOCUMENT}/webhooks

Testar endpoint 🧪

Esse objeto irá retornar o webhook cadastrado no documento.

{
    "Content-Type": "application/json"
}
{
    "uuid": "9f08bf18-bf4b-410f-9701-c286e5b1cad1",
    "webhook_url": "http://sua-url-parar-receber-post.com"
}

Listar Webhook de um documento ou cofre (Versão 2.0)

🚧

Importante

  1. 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}

  1. Garanta que a versão do Webhook 2.0 esteja ativa na conta.
    (Opções da conta > Dev(API> Webhook > Ativar Webhook 2.0

GET/webhooks/v2/{type}' & {UUID-type}/

Testar endpoint 🧪

Este endpoint permite consultar e listar quais URLs de webhook já estão previamente cadastradas para escutar os eventos de um cofre ou documento.

Na URL da requisição é necessário informar o tipo de recurso ('cofre' ou 'documento') e qual e o uuid referente ao cofre ou documento.

{
    "Content-Type": "application/json"
}
{
  "type": "cofre",
  "uuid": "856cc169-9279-4622-90ce-7030fdf718ad",
  "webhook_url": "https://webhook.site/c0a21585-f113-415e-8a3c-f167dd9b3df3",
  "history": [
    "// [histórico de eventos do cofre/documento]"
  ]
}