Ugrás a fő tartalomhoz
POST
Regisztrálj egy HTTPS URL-t, amely webhookeseményeket fogad. A webhook a te API-kulcsodhoz tartozik. Csak olyan objektumokról kap eseményt, amelyeket a kulcsod olvashat. Egy API-kulcsnak legfeljebb 5 webhookja lehet.
A webhooks_manage scope szükséges hozzá.

Kérés

Törzsparaméterek

string
kötelező
HTTPS URL a 443-as porton, nyilvános hoszttal és hitelesítő adatok nélkül. Az Aniva nem követi az átirányításokat.
string[]
kötelező
A fogadni kívánt eseménytípusok, legalább egy. A ["*"] minden típust jelent. A ping nem adható meg a listában.
string[]
kötelező
1–5 cím, amelyre az Aniva e-mailt küld, ha a kézbesítések folyamatosan sikertelenek.
string
Szabad szöveg saját hivatkozáshoz, legfeljebb 500 karakter.

Válasz

Siker esetén az API 201 Created státusszal adja vissza a webhookot és annak titkos kulcsát.
string
kötelező
Az aláíró titkos kulcs: whsec_ és base64. Az Aniva csak ebben a válaszban jeleníti meg. Lásd: Az aláírás ellenőrzése.
string
kötelező
Webhook-azonosító (UUID).
string
kötelező
A HTTPS URL, amelyre az Aniva az eseményeket küldi.
string
Szabad szöveg saját hivatkozáshoz. Lehet null.
string[]
kötelező
Azok az eseménytípusok, amelyeket ez a webhook fogad. A * minden típust jelent.
string[]
kötelező
Címek, amelyekre az Aniva e-mailt küld, ha a kézbesítések folyamatosan sikertelenek.
string
kötelező
enabled vagy disabled.
string
A webhook letiltásának ISO 8601 UTC időpontja. null, amíg engedélyezve van.
string
A webhook letiltásának oka. Lásd: Hibaértesítések. null, amíg engedélyezve van.
string
Az aktuális hibasorozat kezdetének ISO 8601 UTC időpontja. null, ha az utolsó kézbesítés sikeres volt.
string
Az az ISO 8601 UTC időpont, amikor az előző titkos kulcsot már nem használja aláíráshoz. null, ha nincs folyamatban kulcsrotáció.
string
kötelező
A webhook létrehozásának ISO 8601 UTC időpontja.
string
kötelező
Az utolsó módosítás ISO 8601 UTC időpontja.

Hibaválaszok