API
Verificando conta Raims

Criar um webhook

Cadastre um destino para receber os eventos selecionados da sua empresa.

POSThttps://api.raims.com/v1/webhooks

Cadastre uma URL de recebimento e selecione os eventos que sua integração precisa acompanhar. Guarde o segredo retornado em um ambiente privado da aplicação: as consultas de configuração não retornam esse valor. Se o receptor ainda não estiver pronto, cadastre com is_active: false.

Veja Cadastrar o destino e Receber e validar eventos antes de iniciar o recebimento.

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.

Nome para identificar o destino.

1 a 25 caracteres

URL HTTPS que recebe os eventos. Use a porta padrão 443 e um endereço público externo à Raims.

1 a 512 caracteres

Códigos dos eventos que este destino deve receber. Consulte o catálogo de eventos disponíveis.

charge.paid

Define se o destino pode receber eventos após o cadastro.

true

Respostas

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