Configurando webhooks

A API faz uso de notificações do webhook para manter seu sistema informado sobre mudanças relacionadas à sua organização automaticamente. Um recurso de evento é enviado ao seu receptor de webhook sempre que um evento significativo ocorre.

A CLI do ricloud-py contém uma amostra de implementações de um terminal da webhook.

Criando uma configuração de webhook

A única coisa necessária para criar uma configuração de webhook é a URL para a qual a API enviará eventos de saída.

ricloud-py implementa um comando auxiliar:

> ricloud webhook-config create --url "<webhook receiver URL>"

A chamada cURL equivalente seria semelhante a:

curl https://ricloud-api.reincubate.com/configs/webhook \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "<webhook receiver URL>"
}'

A resposta a essa solicitação conterá o secret do webhook, que será importante para proteger a implementação do seu receptor webhook na produção.

Verificando Assinaturas de Eventos

Cada solicitação de webhook inclui um cabeçalho Ricloud-Signature que deve ser usado para verificar se o conteúdo da solicitação não foi alterado. O cabeçalho também contém um registro de data e hora, que é usado no processo de verificação, para impedir ataques de repetição.

O ricloud-py inclui uma implementação deste processo de verificação de assinaturas.