Exemplo de POST da Notificação

Instruções iniciais

Com o intuito de auxiliar na fase de testes, disponibilizamos exemplos de notificação para eventos. As informações de retorno dos webhooks vem no Header (cabeçalho) da resposta HTTP.

Quais são os requisitos para realizar os testes?

Endpoint: para testar notificações webhook através da API de exemplo de post, é necessário informar o endpoint onde as notificações devem ser entregues. Configure o webhook de destino para receber as notificações. Isso garante que todas notificações sejam enviadas para o destino correto e que o teste seja bem-sucedido.
Método de monitoramento forma de monitorar eventos, como uma ferramenta de log ou um serviço de webhook para verificar as notificações enviadas.

Parâmetros da requisição

A tabela a seguir lista os parâmetros de requisição no header necessários para testar a funcionalidade de notificação de eventos

Parâmetro	Tipo	Descrição
webhook-event-id opcional	String	Identificador do webhook
webhook-event-type opcional	String	String composta do resource e trigger
webhook-resource-id opcional	String	String com o identificador do recurso. Este identificador torna possível o controle interno de qual fatura foi paga, por exemplo

Veja a cURL de exemplo com parte da requisição para teste de notificação de pagamento

curl --location --request POST 'https://your_url.com' \
--header 'user-agent: Cora-Webhook' \
--header 'webhook-event-id: evt_lEhFeN5OQ90y4mIN1aj399CA' \
--header 'webhook-event-type: invoice.paid' \
--header 'webhook-resource-id: inv_zXmtr2n0RpmIwdjfnNokhA' \
--header 'content-length: 0' \
--header 'connection: keep-alive'

Dicas de implementação

Premissas

Embora o tipo do evento possa variar de acordo com a ação que desencadeou a notificação, uma tabela com os possíveis status está disponível em nossa documentação para que usuários possam entender claramente o estado atual da operação.

Status HTTP

Código de erro	Descrição
200 (OK)	A solicitação foi bem-sucedida. Isso significa que a notificação foi enviada com sucesso.
404 (Not Found)	O endpoint informado não foi encontrado. Isso pode acontecer quando a URL não estiver disponível ou quando o endereço indicado na solicitação estiver incorreto. Ao receber este retorno, a solicitação não foi bem-sucedida.

Response (404 | Not Found)

404 - Not Found

Response (200 | OK)

{
    "success": true
}

Integração Direta e Testes

Esta plataforma de documentação, atualmente, não permite o upload de informações importantes como certificados e private keys. Por isso, não recomendamos o uso dela para testes da modalidade de Integração Direta.

Para fazer os testes que incluam essas informações sensíveis pedimos que use um sistema de sua escolha.