Configurando webhooks

La API utiliza la notificación de webhook para mantener su sistema informado de los cambios relacionados con su organización de forma automática. Se envía un recurso de evento a su receptor de webhook cada vez que ocurre un evento significativo.

La CLI de ricloud-py contiene implementaciones de muestra de un punto final de webhook.

Creando una configuración de webhook

Lo único que se necesita para crear una configuración de webhook es la URL a la que la API enviará los eventos salientes.

ricloud-py implementa un comando de ayuda:

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

La llamada cURL equivalente se vería así:

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>"
}'

La respuesta a esta solicitud contendrá el secret webhook, que será importante para asegurar la implementación del receptor de webhook en producción.

Verificación de firmas de eventos

Cada solicitud de webhook incluye un Ricloud-Signature que debe utilizarse para verificar que el contenido de la solicitud no se haya modificado. El encabezado también contiene una marca de tiempo, que se utiliza en el proceso de verificación, para contrarrestar los ataques de repetición.

ricloud-py incluye una implementación de este proceso de verificación de firma.