Przejdź do głównej treści
PATCH
Zmień webhook. Wyślij tylko pola, które chcesz zmienić. Wyślij status: "enabled", aby ponownie uruchomić wyłączony webhook. Zobacz Powiadomienia o błędach.
Wymaga zakresu webhooks_manage.

Żądanie

Parametry ścieżki

string
wymagane
Identyfikator webhooka (UUID).

Parametry treści

string
Nowy adres URL HTTPS. Te same zasady co przy Tworzeniu.
string[]
Nowa lista typów zdarzeń. Zastępuje starą listę.
string[]
Nowa lista od 1 do 5 adresów. Zastępuje starą listę.
string
Nowy opis, maksymalnie 500 znaków. null czyści opis.
string
enabled lub disabled. Wyłączenie anuluje oczekujące dostarczenia.

Odpowiedź

W przypadku powodzenia API zwraca 200 OK ze zaktualizowanym webhookiem.
string
wymagane
Identyfikator webhooka (UUID).
string
wymagane
Adres HTTPS, na który Aniva wysyła zdarzenia.
string
Dowolny tekst na własne potrzeby. Może mieć wartość null.
string[]
wymagane
Typy zdarzeń odbierane przez ten webhook. * oznacza wszystkie typy.
string[]
wymagane
Adresy, na które Aniva wysyła e-maile, gdy dostarczenia wciąż się nie udają.
string
wymagane
enabled lub disabled.
string
Czas w formacie ISO 8601 UTC wyłączenia webhooka. null, gdy jest włączony.
string
Powód wyłączenia webhooka. Zobacz Powiadomienia o błędach. null, gdy jest włączony.
string
Czas w formacie ISO 8601 UTC rozpoczęcia bieżącej serii niepowodzeń. null, gdy ostatnie dostarczenie się powiodło.
string
Czas w formacie ISO 8601 UTC, kiedy poprzedni sekret przestanie podpisywać. null, gdy nie trwa rotacja.
string
wymagane
Czas w formacie ISO 8601 UTC utworzenia webhooka.
string
wymagane
Czas w formacie ISO 8601 UTC ostatniej zmiany.

Odpowiedzi z błędami