Webhook-configs
De webhook-configuratiebron wordt door de API gebruikt om gebeurtenissen naar uw webhook-ontvanger te verzenden.
Een organisatie kan een standaard webook-configuratie hebben die wordt gebruikt door alle sleutels binnen die organisatie die geen webhook-configuratie van hun eigen specificeren.
attributen
| naam | type | Beschrijving |
|---|---|---|
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. |
Geheim
Wanneer een webhook-configuratie wordt gemaakt, wordt er een geheim naast gegenereerd dat zal worden gebruikt om gebeurtenissen te ondertekenen die door de API worden verzonden. Het wordt ten zeerste aanbevolen dat u uw webhook-ontvanger implementeert om de handtekening van inkomende gebeurtenissen te verifiëren met behulp van dit geheim. Zie de configuratiehulpprogramma's voor webhook voor meer informatie over de handtekeningverificatieprocedure.
Staten
-
newis net gemaakt of recentelijk bijgewerkt maar nog niet getest. -
validis verstreken validatie en is klaar om te worden gebruikt. Een organisatie moet ten minste één webhook-configuratie in deze status hebben om bruikbaar te zijn. -
invalidis mislukt de validatietest. Moet worden bijgewerkt of opnieuw worden getest. -
deactivatedis uitgeschakeld door de eigenaarorganisatie.
Maak POST /configs/webhook
Met deze actie wordt een webhook_config.test taak gemaakt om de details van het eindpunt te valideren. Als de Webhook-ontvanger nog niet is ingesteld, zal deze test waarschijnlijk mislukken en de configuratie instellen op de invalid status. De configuratie kan echter altijd opnieuw worden getest met behulp van de testactie .
parameters
| name | type | description |
|---|---|---|
url |
required | The URL of your webhook receiver. |
CURL gebruiken
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/" }'
Ricloud-py gebruiken
import ricloud webhook_config = ricloud.WebhookConfig.create(url='https://www.mywebhook.com/webhooks/')
Ophalen GET /configs/webhook/{webhook_config ID}
CURL gebruiken
curl https://ricloud-api.reincubate.com/configs/webhook/<webhook_config ID> \ -H 'Authorization: Token <your key_token>'
Ricloud-py gebruiken
import ricloud webhook_config = ricloud.WebhookConfig.retrieve(<webhook_config ID>)
Lijst GET /configs/webhook
Webhook-configs in de deactivated status zijn standaard verborgen en kunnen alleen worden weergegeven door expliciete filtering.
parameters
| name | type | description |
|---|---|---|
state |
string | Filter webhook configs by their state. |
date_created |
datetime filter | Filter by resource creation date. |
Update POST /configs/webhook/{webhook_config ID}
Met deze actie wordt een webhook_confg.test taak op de achtergrond gemaakt om wijzigingen in de configuratie te valideren.
Het state kan alleen worden gewijzigd in deactivated in het geval dat u in wezen een configuratie met pensioen gaat.
parameters
| name | type | description |
|---|---|---|
url |
string | Update the URL. |
state |
string | Only to new or deactivated. |
CURL gebruiken
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/", }'
Ricloud-py gebruiken
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
Met deze actie wordt een webhook_config.test taak gemaakt die een webhook_config.test verzendt met behulp van de opgegeven configuratie. Het resultaat van de test zal het state van de webook-configuratie dienovereenkomstig bijwerken.
CURL gebruiken
curl https://ricloud-api.reincubate.com/configs/webhook/<webhook_config ID>/test \ -H 'Authorization: Token <your key_token>'
Ricloud-py gebruiken
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()
