Ressource: Kanal
Benachrichtigungskanal zur Überwachung von Ressourcenänderungen.
JSON-Darstellung |
---|
{ "payload": boolean, "id": string, "resourceId": string, "resourceUri": string, "token": string, "expiration": string, "type": string, "address": string, "params": { string: string, ... }, "kind": string } |
Felder | |
---|---|
payload |
Ein boolescher Wert, der angibt, ob eine Nutzlast gebraucht wird. Optional. |
id |
Eine UUID oder ein ähnlicher eindeutiger String, der diesen Kanal identifiziert. |
resourceId |
Eine intransparente ID, die die auf diesem Kanal beobachtete Ressource identifiziert. Stabil in verschiedenen API-Versionen. |
resourceUri |
Eine versionsspezifische Kennung für die beobachtete Ressource. |
token |
Eine beliebige Zeichenfolge, die an die Zieladresse gesendet wird, wobei jede Benachrichtigung über diesen Kanal gesendet wird. Optional. |
expiration |
Datum und Uhrzeit des Ablaufs des Benachrichtigungskanals in Millisekunden als Unix-Zeitstempel. Optional. |
type |
Der für diesen Kanal verwendete Übermittlungsmechanismus. Gültige Werte sind „web_hook“ und „webhook“. |
address |
Die Adresse, an die Benachrichtigungen für diesen Kanal gesendet werden. |
params |
Zusätzliche Parameter, die das Verhalten des Übermittlungskanals steuern. Optional. Ein Objekt, das eine Liste von |
kind |
Kennzeichnet dies als Benachrichtigungskanal, über den nach Änderungen an einer Ressource ( |
Methoden |
|
---|---|
|
Beendet das Ansehen von Ressourcen über diesen Kanal. |