Enviar um evento para um webhook
Escolha um destino para receber o evento original, mesmo sem uma entrega anterior.
Informe o evento no caminho e o webhook no corpo. O destino precisa estar ativo, selecionar o tipo do evento e pertencer à mesma empresa e ambiente autenticado. O pedido permite a primeira entrega do evento para esse cadastro.
O evento deve ter até 15 dias e manter seu corpo original disponível. A
resposta retorna o delivery_id para acompanhamento; aceitar o pedido não
confirma o recebimento pelo receptor. Com a fila pausada, a entrega aguarda
a retomada dentro de seu próprio prazo.
Veja Enviar para um webhook para conferir os limites, preservar a identificação do evento e tratar duplicatas.
Parâmetros de caminho
Identificador do evento original que será enviado ao webhook escolhido.
Cabeçalhos
Chave única escolhida pelo seu sistema para identificar esta requisição. Ao repetir a tentativa, envie a mesma chave e os mesmos parâmetros. Sem este header, a requisição é processada normalmente. Consulte o guia de idempotência para os prazos e o tratamento de respostas pendentes ou incertas.
1 a 255 caracteres
Parâmetros do corpo
Usar exemplo substitui os campos do corpo.
Identificador do webhook ativo que seleciona o tipo do evento. Use um cadastro da mesma empresa e ambiente da chave.
Até 26 caracteres
Respostas
Corpo da resposta
Pedido aceito. Consulte a nova entrega para acompanhar seu resultado.
Pedido de reenvio aceito.
Identificador da nova entrega. Use-o para acompanhar o reenvio.
Identificador original preservado no conteúdo enviado.
Corpo da resposta
Um campo está ausente ou tem formato inválido. Confira os detalhes antes de reenviar.
Código e explicação do erro retornado pela API.
Código estável do erro.
Explicação do erro em inglês. Em validações, resume a categoria; os detalhes identificam as correções. Use os códigos para tratar a resposta.
Falhas em campos recebidos ou referências enviadas no corpo, com campo, código e explicação. Omitido em erros gerais e quando não há correção de campo a indicar.
Nome público do campo JSON, parâmetro de consulta, parâmetro de rota ou header relacionado ao erro. Campos aninhados e listas preservam o caminho e o índice. $ representa a raiz do corpo JSON.
Motivo do erro no campo, como REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD ou INVALID_TYPE.
Explicação em inglês sobre o problema nesse campo ou parâmetro e a correção disponível. Não use o texto para decidir o fluxo da integração.
Corpo da resposta
O evento ou o webhook informado não foi encontrado no escopo da chave.
Código e explicação do erro retornado pela API.
Código estável do erro.
Explicação do erro em inglês. Em validações, resume a categoria; os detalhes identificam as correções. Use os códigos para tratar a resposta.
Falhas em campos recebidos ou referências enviadas no corpo, com campo, código e explicação. Omitido em erros gerais e quando não há correção de campo a indicar.
Nome público do campo JSON, parâmetro de consulta, parâmetro de rota ou header relacionado ao erro. Campos aninhados e listas preservam o caminho e o índice. $ representa a raiz do corpo JSON.
Motivo do erro no campo, como REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD ou INVALID_TYPE.
Explicação em inglês sobre o problema nesse campo ou parâmetro e a correção disponível. Não use o texto para decidir o fluxo da integração.
Corpo da resposta
O evento passou do prazo, seu corpo está indisponível, o destino não permite o envio ou o evento é de teste. Confira a condição retornada antes de fazer outro pedido.
Código e explicação do erro retornado pela API.
Código estável do erro.
Explicação do erro em inglês. Em validações, resume a categoria; os detalhes identificam as correções. Use os códigos para tratar a resposta.
Falhas em campos recebidos ou referências enviadas no corpo, com campo, código e explicação. Omitido em erros gerais e quando não há correção de campo a indicar.
Nome público do campo JSON, parâmetro de consulta, parâmetro de rota ou header relacionado ao erro. Campos aninhados e listas preservam o caminho e o índice. $ representa a raiz do corpo JSON.
Motivo do erro no campo, como REQUIRED, INVALID_TAXID, UNKNOWN_FIELD, DUPLICATE_FIELD ou INVALID_TYPE.
Explicação em inglês sobre o problema nesse campo ou parâmetro e a correção disponível. Não use o texto para decidir o fluxo da integração.
Para os erros gerais, consulte Códigos HTTP das respostas.