Luo webhookille uusi allekirjoitussalaisuus. Vanha salaisuus jatkaa allekirjoittamista 24 tunnin ajan
ajankohtaan previous_secret_expires_at asti. Toinen vaihto tuona aikana poistaa vanhimman salaisuuden käytöstä heti.
Vaatii webhooks_manage-scopen.
Pyyntö
Polkuparametrit
string
vaadittu
Webhookin tunniste (UUID).
Runkoparametrit
Runko on valinnainen.
boolean
oletus:"false"
true poistaa nykyisen salaisuuden käytöstä heti, esimerkiksi vuodon jälkeen.
Vastaus
Onnistuessaan API palauttaa 200 OK sekä webhookin ja sen uuden 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
Tila
Kuvaus
400
Virheellinen pyyntö. Katso error-viesti.
401
Virheellinen API-avain.
403
API-avain puuttuu tai siltä puuttuu webhooks_manage-scope.
404
Webhookia ei löytynyt, tai se kuuluu toiselle API-avaimelle.