Configuraciones webhook

Actualizado

La API utiliza el recurso de configuración de webhook para enviar eventos a su receptor de webhook.

Una organización puede tener una configuración de webook predeterminada que utilizan todas las claves dentro de esa organización que no especifican una configuración de webhook propia.

Atributos

nombre escribe descripción
id webhook config ID Resource identifier.
resource string, always webhook_config Resource type specifier.
organisation organisation ID The organisation the resource belongs to.
url string The url to target when sending events.
secret string The shared secret used to verify event signatures.
state string One of: new, valid, invalid, deactivated.
date_created datetime When the resource was created.

Secreto

Cuando se crea una configuración de webhook, se generará un secreto a su lado que se utilizará para firmar los eventos enviados por la API. Se recomienda encarecidamente que implemente su receptor de webhook para verificar la firma de los eventos entrantes utilizando este secreto. Para obtener más detalles sobre el procedimiento de verificación de firmas, consulte los documentos de configuración de webhook .

Estados

  • new acaba de ser creado o actualizado recientemente, pero aún no probado.
  • valid ha pasado la validación y está listo para ser utilizado. Una organización debe tener al menos una configuración de webhook en este estado para poder ser utilizada.
  • invalid ha fallado la prueba de validación. Debe ser actualizado o reexaminado.
  • deactivated ha sido desactivado por la organización propietaria.

Crear POST /configs/webhook

Esta acción creará una tarea webhook_config.test para validar los detalles del punto final. Si el receptor de webhook aún no está configurado, es probable que esta prueba falle y establezca la configuración en invalid estado invalid . Sin embargo, la configuración siempre se puede volver a probar utilizando la acción de prueba .

Parámetros

name type description
url required The URL of your webhook receiver.

Usando cURL

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

Utilizando ricloud-py

import ricloud

webhook_config = ricloud.WebhookConfig.create(url='https://www.mywebhook.com/webhooks/')

Recuperar GET /configs/webhook/{webhook_config ID}

Usando cURL

curl https://ricloud-api.reincubate.com/configs/webhook/<webhook_config ID> \
  -H 'Authorization: Token <your key_token>'

Utilizando ricloud-py

import ricloud

webhook_config = ricloud.WebhookConfig.retrieve(<webhook_config ID>)

Lista GET /configs/webhook

Las configuraciones de webhook en el estado deactivated están ocultas por defecto y solo pueden ser listadas por filtrado explícito.

Parámetros

name type description
state string Filter webhook configs by their state.
date_created datetime filter Filter by resource creation date.

Actualizar POST /configs/webhook/{webhook_config ID}

Esta acción creará una tarea webhook_confg.test en segundo plano para validar los cambios realizados en la configuración.

El atributo de state solo se puede cambiar a deactivated en el caso de que básicamente esté retirando una configuración.

Parámetros

name type description
url string Update the URL.
state string Only to new or deactivated.

Usando cURL

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

Utilizando ricloud-py

import ricloud

webhook_config = ricloud.WebhookConfig.update_with_id(
  <webhook_config ID>,
  url='https://www.myupdatedwebhook.com/webhooks/'
)

# OR

webhook_config = ricloud.WebhookConfig.retrieve(<webhook_config ID>)

webhook_config.update(url='https://www.myupdatedwebhook.com/webhooks/')

Prueba POST /configs/webhook/{webhook_config ID}/test

Esta acción crea una tarea webhook_config.test que envía un evento de prueba utilizando la configuración especificada. El resultado de la prueba actualizará el atributo de state de la configuración del webook en consecuencia.

Usando cURL

curl https://ricloud-api.reincubate.com/configs/webhook/<webhook_config ID>/test \
  -H 'Authorization: Token <your key_token>'

Utilizando ricloud-py

import ricloud

test_task = ricloud.WebhookConfig.test_with_id(<webhook_config ID>)

# OR

webhook_config = ricloud.WebhookConfig.retrieve(<webhook_config ID>)

test_task = webhook_config.test()

¿Cómo podemos ayudar?

¡Nuestro equipo de soporte está aquí para ayudar!

Nuestro horario de atención es de lunes a viernes de 9 a.m. a 5 p.m. GMT. El tiempo es actualmente 2:40 AM GMT.

Intentamos responder todos los mensajes en un plazo de un día laboral.

Nuestro increíble equipo de soporte.

¿Podemos mejorar este artículo?

Nos encanta escuchar de los usuarios: ¿por qué no enviarnos un correo electrónico, dejar un comentario o tuitear? @reincubate?

© 2008 - 2024 Reincubate Ltd. Todos los derechos reservados. Registrado en Inglaterra y Gales #5189175, VAT GB151788978. Reincubate® y Camo® son marcas registradas. Política de privacidad & condiciones.