Utilizando Webhooks

Introdução

O recurso Webhooks permite que desenvolvedores e integradores de terceiros especifiquem um ou mais recursos da API para os quais desejam ser notificados quando ocorrem ações de Criação, Atualização ou Exclusão.

Os benefícios do recurso Webhooks incluem:

• Melhoria do desempenho, substituindo a verificação com atualizações assíncronas;
• Eliminação da lógica/código de verificação em integrações de terceiros para determinar alterações em recursos;
• Aumento da eficiência, pois o código só precisa ser executado quando um recurso mudar.

Customizando o Recebimento de Informações

Por padrão, nossos webhooks retornam o payload em formato JSON, porém, há casos em que os desenvolvedores, no momento da integração, precisam receber em um formato diferente, ou mesmo que toda a informação seja inserida em um único campo.

Para isso, ao criar a autenticação do webhook, você poderá realizar duas customizações:

1. Criar um campo onde todo o payload de retorno será inserido;
2. Utilizar uma URL Proxy para poder alterar o formato do payload recebido.

1. Campo Customizado

Caso deseje que todo o payload seja incluído em um único campo, marque esta opção e insira o nome do campo desejado.

Desta forma, enviaremos o payload com todas as informações do webhook para este campo.

No exemplo abaixo, solicitamos que todo o payload seja inserido no campo "campoUnico":

{
"Body":
        {
        "campoUnico":
            {
            "id":"7ol64158-f94c-960f-8d35-7d76042ec",
            "companyId":35,
            "name":"BILL_SWAPPED",
            "userId":"33",
            "resourceId":"203",
            "dateTime":"2023-05-11 17:21:55",
            "metadata":
                {
                "preAuthorizationId":181,
                "file":"file base64",
                "fileExtension":"application/pdf",
                "billNumber":"432",
                "dueDate":"2023-05-30",
                "ourNumber":"324",
                "contracted":
                    {
                    "name":"EMPRESA FORNECEDOR",
                    "taxId":"16166332000180"
                    },
               "contractor":
                   {
                   "name":"EMPRESA CONSTRUTORA",
                   "taxId":"73538818000136"
                   },
               "invoice":
                   {
                   "number":"1",
                   "externalId":"Projeto 2",
                   "grossValue":10000,
                   "discountedGrossValue":9000
                   }
               }
             }
          }
}

2. URL Proxy

Caso necessite receber o evento do webhook em um formato diferente de JSON, é possível cadastrar uma URL Proxy que para receber as informações, alterar seu formato e então enviar para a URL final de recebimento no formato correto.

Webhook

Para começar a utilizar nosso webhook, é necessário contratar o plano de integração.

Caso a sua empresa não possua o plano de integração, ou caso haja dúvidas sobre sua contratação, entre em contato em atendimento@onepay.com.br.

Havendo a contratação do plano de integração:

1. Acesse o menu Integração nas configurações da empresa
2. Cadastre o Webhook de acordo com a autenticação desejada
3. Informe o campo customizado, se houver
4. Informe a URL Proxy, se houver
5. Selecione os Recursos desejados