Webhook-Konfigurationen

Aktualisierte
Cover image for: Webhook-Konfigurationen

Die Webhook-Konfigurationsressource wird von der API verwendet, um Ereignisse an Ihren Webhook-Empfänger zu senden.

Eine Organisation kann eine Standard-Webook-Konfiguration haben, die von allen Schlüsseln in dieser Organisation verwendet wird, die keine eigene Webook-Konfiguration angeben.

Attribute

Name Typ Bezeichnung
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.

Geheimnis

Wenn eine Webhook-Konfiguration erstellt wird, wird daneben ein Geheimnis generiert, mit dem von der API gesendete Ereignisse signiert werden. Es wird dringend empfohlen, dass Sie Ihren Webhook-Empfänger implementieren, um die Signatur eingehender Ereignisse mithilfe dieses Geheimnisses zu überprüfen. Weitere Informationen zur Überprüfung der Signatur finden Sie in den Konfigurationsdokumenten für Webhooks .

Zustände

  • new wurde gerade erstellt oder kürzlich aktualisiert, aber noch nicht getestet.
  • valid hat die Validierung bestanden und kann verwendet werden. Eine Organisation muss mindestens eine Webhook-Konfiguration in diesem Status haben, um verwendet werden zu können.
  • invalid hat den Validierungstest nicht bestanden. Muss aktualisiert oder erneut getestet werden.
  • deactivated wurde von der besitzenden Organisation deactivated .

Erstellen Sie POST /configs/webhook

Diese Aktion erstellt eine webhook_config.test Task, um die Endpunktdetails zu webhook_config.test . Wenn der Webhook-Empfänger noch nicht eingerichtet ist, schlägt dieser Test wahrscheinlich fehl und setzt die Konfiguration auf den invalid Status. Allerdings kann die Config immer erneut getestet werden , die unter Verwendung von Testaktion .

Parameter

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

CURL verwenden

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

Mit Ricloud-Py

import ricloud

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

GET /configs/webhook/{webhook_config ID}

CURL verwenden

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

Mit Ricloud-Py

import ricloud

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

Liste GET /configs/webhook

Webhook-Konfigurationen im deactivated Zustand sind standardmäßig ausgeblendet und können nur durch explizite Filterung aufgelistet werden.

Parameter

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

Aktualisieren Sie POST /configs/webhook/{webhook_config ID}

Diese Aktion erstellt im Hintergrund eine webhook_confg.test Task, um alle an der Konfiguration vorgenommenen Änderungen zu überprüfen.

Das Statusattribut kann nur in den deactivated state geändert werden, wenn Sie im Wesentlichen eine Konfiguration zurückziehen.

Parameter

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

CURL verwenden

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

Mit 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/')

Testen Sie POST /configs/webhook/{webhook_config ID}/test

Diese Aktion erstellt eine webhook_config.test Task, die ein webhook_config.test mit der angegebenen Konfiguration sendet. Das Ergebnis des Tests wird das Update state Attribut der WeBook Konfiguration entsprechend.

CURL verwenden

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

Mit 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()

Wie können wir helfen?

Unser Support-Team hilft Ihnen gerne weiter!

Unsere Bürozeiten sind Montag bis Freitag von 9 bis 17 Uhr GMT. Die Zeit ist aktuell 12:18 nachm. GMT.

Wir bemühen uns, auf alle Mitteilungen innerhalb eines Arbeitstages zu antworten.

Unser großartiges Supportteam

Können wir diesen Artikel verbessern?

Wir hören gerne von Nutzern: Warum schicken Sie uns nicht eine E-Mail, schreiben Sie einen Kommentar oder tweeten Sie @reincubate?

© 2008 - 2023 Reincubate Ltd. Alle Rechte vorbehalten. Registriert in England und Wales #5189175, VAT GB151788978. Reincubate® und Camo® sind eingetragene Marken. Datenschutz-Bestimmungen & Begriffe. Mit Liebe in London gebaut.