Webhooks

Home Painel Chaves de API

Search…

Introdução

Sobre o GraphQL

Integrando com a API

Usando o Altair

Criando um documento

Assinando um documento

Resgatando documentos

Criando pastas

Movendo documento para pasta

Sandbox/testes

Mensagens de erro

Webhooks

Como configurar webhooks e receber notificações de status dos documentos

Para conseguir usar os webhooks da API do Autentique, você precisa:
1.Acessar a página de configurações de acesso a API e registrar uma URL de callback. Para testes, recomendamos o uso do Beeceptor para receber os webhooks.
2.Pronto! Agora você receberá um evento de todos os documentos da conta, quando alguém assinar algum deles.
O corpo da requisição enviada quando alguma das partes assinar são as informações do documento no seguinte formato:
O formato abaixo é exibido em JSON para visualização, porém o webhook retorna os dados em x-www-form-urlencoded.
1
{
2
  "partes": [
3
    {
4
      "nome": "Cassiano Calegari",
5
      "email": "[email protected]",
6
      "cpf": "36653414930",
7
      "nascimento": "1931-01-01",
8
      "empresa": "Autentique",
9
      "funcao": "assinar",
10
      "visualizado": {
11
        "created": "2018-01-01 17:09:02",
12
        "motivo": null,
13
        "ipv4": "170.233.43.253",
14
        "geotrack": {
15
          "country": "Brasil",
16
          "countryISO": "BR",
17
          "state": null,
18
          "stateISO": null,
19
          "city": null,
20
          "zipcode": null,
21
          "latitude": -22.8305,
22
          "longitude": -43.2192
23
        }
24
      },
25
      "assinado": {},
26
      "rejeitado": {},
27
      "mail": {
28
        "sent": false, // or datetime: Y-m-d H:i:s
29
        "opened": null, // or datetime: Y-m-d H:i:s
30
        "refused": null, // or datetime: Y-m-d H:i:s
31
        "delivered": null, // or datetime: Y-m-d H:i:s
32
        "reason": null // or string
33
      }
34
    },
35
    {
36
      "nome": null,
37
      "email": "[email protected]",
38
      "cpf": null,
39
      "nascimento": null,
40
      "empresa": null,
41
      "funcao": "assinar",
42
      "visualizado": {},
43
      "assinado": {},
44
      "rejeitado": {},
45
      "mail": {
46
        "sent": false, // or datetime: Y-m-d H:i:s
47
        "opened": null, // or datetime: Y-m-d H:i:s
48
        "refused": null, // or datetime: Y-m-d H:i:s
49
        "delivered": null, // or datetime: Y-m-d H:i:s
50
        "reason": null // or string
51
      }
52
    }
53
  ],
54
  "documento": {
55
    "uuid": "9ab23456325c40c2a5023051cf4bbf0e",
56
    "nome": "Contrato de Marketing",
57
    "rejeitavel": true,
58
    "created": "2018-01-01 17:09:00",
59
    "updated": "2018-01-01 17:09:00",
60
    "assinatura": "e5b62017be1b46768e47e43e7a6fb233",
61
    "publicado": "2018-01-01 17:09:01",
62
    "disponivel": true
63
  },
64
  "remetente": {
65
    "nome": "Cassiano Calegari",
66
    "empresa": "Autentique",
67
    "email": "[email protected]",
68
    "cpf": "36653414930",
69
    "nascimento": "1931-01-01"
70
  },
71
  "arquivo": {
72
    "original":"https:\/\/storage.googleapis.com\/d6e\/ca2485d9e4bc5e2e8d6c8f18b95d3141\/e808f22467bf2173760ca9a6d3addbefab49f978c67ab5987.original.pdf",
73
    "assinado":"https:\/\/api.autentique.com.br\/documentos\/e808f22467bfa973760cf7a6d3addbefab49f978c67ab5987\/assinado.pdf"
74
  }
75
}
Copied!

Integrando com a API - Previous

Mensagens de erro

Last modified 1yr ago

Copy link