Webhooks

Os webhooks são uma ferramenta poderosa para manter seus sistemas sincronizados em tempo real. Permitem que a Grafeno notifique sua aplicação automaticamente sempre que ocorrer um evento relevante, como mudanças no status de um cadastro.

📘

Testando o recebimento de Webhooks

Recomendamos o uso de serviços como o Beeceptor para facilitar o teste de recebimento dos webhooks da Grafeno relacionados aos cadastros.

Webhooks de Cadastros

Mantenha-se atualizado instantaneamente sobre o progresso dos seus cadastros através de notificações em tempo real da Grafeno. Estas incluem eventos como aprovação, rejeição ou pendências de validação no cadastro.

Estrutura dos webhooks

ParâmetroDescriçãoFormato
signatureassinatura criptografada do webhook para garantir a origem da informação.string
changestatus da notificação.string
data.idid do cadastro.string
data.pendenciesestrutura de pendências, caso o cadastro retorne com pendências.string
data.pendencies.textpendência do cadastro.string

Eventos de notificação para cadastros

EventoDescrição
approvedIndica que a solicitação de cadastro foi aprovada com sucesso.
rejectedIndica que a solicitação de cadastro foi rejeitada.
validation_pendenciesIndica que a solicitação de cadastro possui pendências de validação.

Exemplo de Criação de Webhook:

{
  "signature": "3dZ7or36/nL7h+ldLCisFulMX9y3jxGu0lDIzyRkdhjXNky0X2r3ApfpijYi\nCO8LnN7bHXDcaN7cmQzXiTQndGXDGRGX8eSRnmINng7Nwh3rhLLdGMIc2qK2\nqQNWBGjPgkM8rwVLSskQK5j78hSr7Cb/k39f3uE3GfFCiF3O9fxfliyHGoVD\nniIQEeivthRzguO0c8RVrc83xjqI27YQbsIszXNaP0EhCP1z5N3oCOmhb+Ic\nz8pHeUQ4J7Af2QPLswCbDthDjtAjCl2dGF70sFcqx93YE2QQVeiYRCeY9Ex0\ni+19vAdqa4gKM4WO5A1lKBglMz8X227mN9q0ghhCJA==\n",
  "change": "approved",
  "data": {
    "id": "4056455d-8614-45a9-adf5-1592c28499fc"
  }
}
{
  "signature": "0DRBAOl4aSRVuv1z4ivweYfAYdH+OFww9IUENSvJNpgLaLzbd6YhDNPkSDPk\ny1+yoa8EPV7UoJorTgs5EIVS+EtoucxxGZb4bGbuWMjHEeyLAxvbAb27EQEf\n2XtE0CRCkBYucBiKtWKrBfvKYGagSY4LBV/jHQ4UbIX6BmDw10myZeP/1Ldq\nqAyhxiWiTGd8pOSn6pBjHIVGwC5IdgxzdWe2/5L2mPqj+eNVNNumVc7NPoAa\nVdCTt3cn6NHjOiegrM8OdN8bqs6kLYLeegaxce00g16ks0NwAGsYZUJU8uhB\njMZsPQj2oBy4llhCRPRxHR5HbNNiPQgLzv4rVfpUaQ==\n",
  "change": "validation_pendencies",
  "data": {
    "id": "8ecd3308-f779-4c95-830e-49a5f767ebc2",
    "pendencies": [
      {
        "text": "O RG do sócio está expirado."
      }
    ]
  }
}
{
  "signature": "3Z/b7mojyOfqe63qRc5mbwuKzEt+r764vgs2CDrNYcUw9RsXDFVekOKJrkZD\nps07pO7y5cmC/b5L+G2FYVe3+ZJjpCStxvojHQHlvaoAgo5j5EmQPdbcK+rF\nCLDzGaI8IsKkP/9LEHMLuv/vfOrH67yz0BGnNImyM/Bnj9VLz40bN1I0dLAu\nqWzLVxqlV0OG9TsHdK29AKbInUsXQduEnFasSaAqD4fATcAvoKrFFJoe4lMW\nZ/Hu0pxfNXN/oYHhNMxeTegC99D4b7+V0KxIUCnQB9WWz2YLAsiz/hbN5OKR\nnMPwnUtWDF9QqXDZ/Rpy6KBDN4YdDSfwZ5wzem07Qg==\n",
  "change": "rejected",
  "data": {
    "id": "17e4ae95-9348-4089-8870-4d4d2de61e49"
  }
}