API
Verificando conta Raims

Enviar um evento para um webhook

Escolha um destino para receber o evento original, mesmo sem uma entrega anterior.

POSThttps://api.raims.com/v1/webhook_events/{event_id}/deliveries

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

Para os erros gerais, consulte Códigos HTTP das respostas.