Siirry pääsisältöön
POST
Rekisteröi HTTPS-osoite, joka vastaanottaa webhook-tapahtumia. API-avaimesi omistaa webhookin. Se vastaanottaa tapahtuman vain kohteista, joita avaimesi voi lukea. Yksi API-avain voi omistaa enintään 5 webhookia.
Vaatii webhooks_manage-scopen.

Pyyntö

Runkoparametrit

string
vaadittu
HTTPS-osoite portissa 443, jolla on julkinen isäntänimi eikä tunnistetietoja. Aniva ei seuraa uudelleenohjauksia.
string[]
vaadittu
Vastaanotettavat tapahtumatyypit, vähintään yksi. ["*"] tarkoittaa kaikkia tyyppejä. Arvoa ping ei voi listata.
string[]
vaadittu
1–5 sähköpostiosoitetta, joihin Aniva lähettää ilmoituksen, kun toimitukset epäonnistuvat toistuvasti.
string
Vapaamuotoinen teksti omaan käyttöösi, enintään 500 merkkiä.

Vastaus

Onnistuessaan API palauttaa tilakoodin 201 Created sekä webhookin ja sen salaisuuden.
string
vaadittu
Allekirjoitussalaisuus, whsec_ ja base64. Aniva näyttää sen vain tässä vastauksessa. Katso Vahvista allekirjoitus.
string
vaadittu
Webhookin tunniste (UUID).
string
vaadittu
HTTPS-osoite, johon Aniva lähettää tapahtumat.
string
Vapaamuotoinen teksti omaan käyttöösi. Voi olla null.
string[]
vaadittu
Tapahtumatyypit, joita tämä webhook vastaanottaa. * tarkoittaa kaikkia tyyppejä.
string[]
vaadittu
Osoitteet, joihin Aniva lähettää sähköpostia, kun toimitukset epäonnistuvat toistuvasti.
string
vaadittu
enabled tai disabled.
string
ISO 8601 UTC -aikaleima, jolloin webhook poistettiin käytöstä. null, kun webhook on käytössä.
string
Syy siihen, miksi webhook poistettiin käytöstä. Katso Virheilmoitukset. null, kun webhook on käytössä.
string
ISO 8601 UTC -aikaleima, jolloin nykyinen epäonnistumisputki alkoi. null, kun viimeisin toimitus onnistui.
string
ISO 8601 UTC -aikaleima, jolloin edellinen salaisuus lakkaa allekirjoittamasta. null, kun vaihto ei ole käynnissä.
string
vaadittu
ISO 8601 UTC -aikaleima, jolloin webhook luotiin.
string
vaadittu
Viimeisimmän muutoksen ISO 8601 UTC -aikaleima.

Virhevastaukset