Przejdź do głównej treści
POST
Zarejestruj adres HTTPS, który odbiera zdarzenia webhooków. Właścicielem webhooka jest twój klucz API. Webhook odbiera zdarzenie tylko dla obiektów, które twój klucz może odczytać. Klucz API może mieć maksymalnie 5 webhooków.
Wymaga zakresu webhooks_manage.

Żądanie

Parametry treści

string
wymagane
Adres HTTPS na porcie 443 z publicznym hostem i bez danych uwierzytelniających. Aniva nie podąża za przekierowaniami.
string[]
wymagane
Typy zdarzeń do odbierania, co najmniej jeden. ["*"] oznacza wszystkie typy. Nie można podać ping.
string[]
wymagane
Od 1 do 5 adresów, na które Aniva wysyła e-maile, gdy dostarczenia wciąż się nie udają.
string
Dowolny tekst na własne potrzeby, maksymalnie 500 znaków.

Odpowiedź

W przypadku powodzenia API zwraca 201 Created wraz z webhookiem i jego sekretem.
string
wymagane
Sekret podpisujący, whsec_ oraz base64. Aniva pokazuje go tylko w tej odpowiedzi. Zobacz Zweryfikuj podpis.
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