Zasób: kanał
Kanał powiadomień używany do sprawdzania zmian w zasobach.
Zapis JSON |
---|
{ "payload": boolean, "id": string, "resourceId": string, "resourceUri": string, "token": string, "expiration": string, "type": string, "address": string, "params": { string: string, ... }, "kind": string } |
Pola | |
---|---|
payload |
Wartość logiczna wskazująca, czy wymagany jest ładunek. Opcjonalnie: |
id |
identyfikator UUID lub podobny, unikalny ciąg znaków identyfikujący ten kanał; |
resourceId |
Nieprzejrzysty identyfikator określający zasób oglądany na tym kanale. Stabilny w różnych wersjach interfejsu API. |
resourceUri |
Identyfikator wersji monitorowanego zasobu. |
token |
Dowolny ciąg znaków dostarczany na adres docelowy wraz z każdym powiadomieniem przesłanym przez ten kanał. Opcjonalnie: |
expiration |
Data i godzina wygaśnięcia kanału powiadomień wyrażona jako sygnatura czasowa systemu Unix w milisekundach. Opcjonalnie: |
type |
Typ mechanizmu wyświetlania stosowanego w przypadku tego kanału. Prawidłowe wartości to „web_hook” czy „webhook”. |
address |
Adres, na który są dostarczane powiadomienia z tego kanału. |
params |
Dodatkowe parametry kontrolujące zachowanie kanału wyświetlania. Opcjonalnie: Obiekt zawierający listę par |
kind |
Identyfikuje go jako kanał powiadomień używany do obserwowania zmian w zasobie, czyli |
Metody |
|
---|---|
|
Przestaje oglądać zasoby z tego kanału. |