Criar um webhook
Cadastre um destino para receber os eventos selecionados da sua empresa.
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.
Parâmetros 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.
Define se o destino pode receber eventos após o cadastro.
Respostas
Para os erros gerais, consulte Códigos HTTP das respostas.