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.

{
  "partes": [
    {
      "nome": "Cassiano Calegari",
      "email": "cassiano@autentique.com.br",
      "cpf": "36653414930",
      "nascimento": "1931-01-01",
      "empresa": "Autentique",
      "funcao": "assinar",
      "visualizado": { // Quando signatário visualiza o documento
        "created": "2018-01-01 17:09:02",
        "ipv4": "170.233.43.253",
        "geotrack": {
          "country": "Brasil",
          "countryISO": "BR",
          "state": "Rio Grande do Sul",
          "stateISO": "RS",
          "city": "Erechim",
          "zipcode": "99700",
          "latitude": -22.8305,
          "longitude": -43.2192
        }
      },
      "assinado": { // Quando signatário assina o documento
        "created": "2018-01-01 17:09:02",
        "ipv4": "170.233.43.253",
        "geotrack": {
          "country": "Brasil",
          "countryISO": "BR",
          "state": "Rio Grande do Sul",
          "stateISO": "RS",
          "city": "Erechim",
          "zipcode": "99700",
          "latitude": -22.8305,
          "longitude": -43.2192
        }
      },
      "rejeitado": { // Quando signatário visualiza o documento
        "created": "2018-01-01 17:09:02",
        "motivo": null, // ou string, com motivo escrito por signatário para rejeição do documento
        "ipv4": "170.233.43.253",
        "geotrack": {
          "country": "Brasil",
          "countryISO": "BR",
          "state": "Rio Grande do Sul",
          "stateISO": "RS",
          "city": "Erechim",
          "zipcode": "99700",
          "latitude": -22.8305,
          "longitude": -43.2192
        }
      },
      "mail": {
        "sent": false, // ou datetime: "2018-01-01 21:00:00"
        "opened": null, // ou datetime: "2018-01-01 21:00:00"
        "refused": null, // ou datetime: "2018-01-01 21:00:00"
        "delivered": null, // ou datetime: "2018-01-01 21:00:00"
        "reason": null // ou string, com erro retornado pelo servidor de email
      }
    }
  ],
  "documento": {
    "uuid": "9ab23456325c40c2a5023051cf4bbf0e",
    "nome": "Contrato de Marketing",
    "rejeitavel": true,
    "created": "2018-01-01 17:09:00",
    "updated": "2018-01-01 17:09:00",
    "excluido": false,
    "transacao": false,
    "pendente": 0,
    "publicado": "2018-01-01 17:09:01",
    "disponivel": true
  },
  "remetente": {
    "nome": "Cassiano Calegari",
    "empresa": "Autentique",
    "email": "cassiano@autentique.com.br",
    "cpf": "36653414930",
    "nascimento": "1931-01-01"
  },
  "arquivo": {
    "original":"https:\/\/storage.googleapis.com\/d6e\/ca2485d9e4bc5e2e8d6c8f18b95d3141\/e808f22467bf2173760ca9a6d3addbefab49f978c67ab5987.original.pdf",
    "assinado":"https:\/\/api.autentique.com.br\/documentos\/e808f22467bfa973760cf7a6d3addbefab49f978c67ab5987\/assinado.pdf"
  }
}

Last updated