Přejít na hlavní obsah
POST
Zaregistruj HTTPS URL, která bude přijímat události webhooků. Vlastníkem webhooku je tvůj API klíč. Přijímá události jen pro objekty, které tvůj klíč může číst. Jeden API klíč může vlastnit nejvýše 5 webhooků.
Vyžaduje scope webhooks_manage.

Požadavek

Parametry těla

string
povinné
HTTPS URL na portu 443 s veřejným hostitelem a bez přihlašovacích údajů. Aniva nesleduje přesměrování.
string[]
povinné
Typy událostí k příjmu, alespoň jeden. ["*"] znamená všechny typy. ping nelze uvést.
string[]
povinné
1 až 5 adres, na které Aniva pošle e-mail, když doručování opakovaně selhává.
string
Volný text pro tvou vlastní poznámku, nejvýše 500 znaků.

Odpověď

Při úspěchu API vrátí 201 Created s webhookem a jeho tajným klíčem.
string
povinné
Podpisový tajný klíč, whsec_ a base64. Aniva ho zobrazí jen v této odpovědi. Viz Ověření podpisu.
string
povinné
Identifikátor webhooku (UUID).
string
povinné
HTTPS URL, na kterou Aniva posílá události.
string
Volný text pro tvou vlastní poznámku. Může být null.
string[]
povinné
Typy událostí, které tento webhook přijímá. * znamená všechny typy.
string[]
povinné
Adresy, na které Aniva posílá e-maily, když doručování opakovaně selhává.
string
povinné
enabled nebo disabled.
string
Čas v ISO 8601 UTC, kdy byl webhook vypnut. null, dokud je zapnutý.
string
Proč byl webhook vypnut. Viz Oznámení o selhání. null, dokud je zapnutý.
string
Čas v ISO 8601 UTC, kdy začala aktuální série selhání. null, pokud poslední doručení uspělo.
string
Čas v ISO 8601 UTC, kdy předchozí tajný klíč přestane podepisovat. null, pokud neprobíhá rotace.
string
povinné
Čas v ISO 8601 UTC, kdy byl webhook vytvořen.
string
povinné
Čas poslední změny v ISO 8601 UTC.

Chybové odpovědi