Siirry pääsisältöön
PATCH
Muokkaa webhookia. Lähetä vain kentät, joita haluat muuttaa. Lähetä status: "enabled" ottaaksesi pois käytöstä olevan webhookin uudelleen käyttöön. Katso Virheilmoitukset.
Vaatii webhooks_manage-scopen.

Pyyntö

Polkuparametrit

string
vaadittu
Webhookin tunniste (UUID).

Runkoparametrit

string
Uusi HTTPS-URL. Samat säännöt kuin kohdassa Luo.
string[]
Uusi luettelo tapahtumatyypeistä. Korvaa vanhan luettelon.
string[]
Uusi 1–5 osoitteen luettelo. Korvaa vanhan luettelon.
string
Uusi kuvaus, enintään 500 merkkiä. null tyhjentää sen.
string
enabled tai disabled. Käytöstä poistaminen peruuttaa odottavat toimitukset.

Vastaus

Onnistuessaan API palauttaa 200 OK ja päivitetyn webhookin.
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