Configs Webhook

La risorsa di configurazione webhook viene utilizzata dall'API per inviare eventi al ricevitore webhook.
Un'organizzazione può avere una configurazione predefinita per il webook che viene utilizzata da tutte le chiavi di quell'organizzazione che non specificano una configurazione webhook di loro proprietà.
attributi
nome | genere | descrizione |
---|---|---|
id | ID di configurazione webhook | Identificatore di risorse |
resource | string, sempre webhook_config | Specificatore del tipo di risorsa. |
organisation | ID dell'organizzazione | L'organizzazione a cui appartiene la risorsa. |
url | stringa | L'URL da indirizzare quando si inviano eventi. |
secret | stringa | Il segreto condiviso utilizzato per verificare le firme degli eventi. |
state | stringa | Uno di: new , valid , invalid , deactivated . |
date_created | appuntamento | Quando la risorsa è stata creata. |
Segreto
Quando viene creata una configurazione webhook, accanto a essa verrà generato un segreto che verrà utilizzato per firmare gli eventi inviati dall'API. Si consiglia vivamente di implementare il ricevitore webhook per verificare la firma degli eventi in arrivo utilizzando questo segreto. Per ulteriori dettagli sulla procedura di verifica della firma, consultare i documenti di configurazione di webhook .
stati
-
new
è appena stato creato o aggiornato di recente ma non ancora testato. -
valid
ha superato la convalida ed è pronto per essere utilizzato. Un'organizzazione deve avere almeno una configurazione di webhook in questo stato per poter essere utilizzata. -
invalid
ha superato il test di convalida. Deve essere aggiornato o ritestato. -
deactivated
è stato disattivato dall'organizzazione proprietaria.
Crea POST /configs/webhook
Questa azione creerà un'attività webhook_config.test
per convalidare i dettagli dell'endpoint. Se il ricevitore webhook non è ancora configurato, questo test fallirà probabilmente e imposterà la configurazione sullo stato invalid
. Tuttavia, la configurazione può sempre essere riesaminata utilizzando l' azione di test .
parametri
nome | genere | descrizione |
---|---|---|
url | necessario | L'URL del tuo ricevitore webhook. |
Utilizzando 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/" }'
Usando ricloud-py
import ricloud webhook_config = ricloud.WebhookConfig.create(url='https://www.mywebhook.com/webhooks/')
Recupera GET /configs/webhook/{webhook_config ID}
Utilizzando cURL
curl https://ricloud-api.reincubate.com/configs/webhook/<webhook_config ID> \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud webhook_config = ricloud.WebhookConfig.retrieve(<webhook_config ID>)
Elenco GET /configs/webhook
Le configurazioni di Webhook nello stato deactivated
sono nascoste per impostazione predefinita e possono essere elencate solo mediante filtraggio esplicito.
parametri
nome | genere | descrizione |
---|---|---|
state | stringa | Filtra le configurazioni di webhook secondo il loro stato. |
date_created | filtro datetime | Filtra per data di creazione della risorsa. |
Aggiorna POST /configs/webhook/{webhook_config ID}
Questa azione creerà un'attività webhook_confg.test
in background per convalidare qualsiasi modifica apportata alla configurazione.
L'attributo state
può essere modificato in deactivated
nel caso in cui si stia sostanzialmente ritirando una configurazione.
parametri
nome | genere | descrizione |
---|---|---|
url | stringa | Aggiorna l'URL. |
state | stringa | Solo su new o deactivated . |
Utilizzando 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/", }'
Usando 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/')
Test POST /configs/webhook/{webhook_config ID}/test
Questa azione crea un'attività webhook_config.test
che invia un evento di test utilizzando la configurazione specificata. Il risultato del test aggiornerà di conseguenza l'attributo di state
della configurazione del webook.
Utilizzando cURL
curl https://ricloud-api.reincubate.com/configs/webhook/<webhook_config ID>/test \ -H 'Authorization: Token <your key_token>'
Usando 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()