Saltar al contingut principal
PATCH
Modifica un webhook. Envia només els camps que vulguis canviar. Envia status: "enabled" per tornar a activar un webhook desactivat. Consulta Avisos de fallada.
Requereix l’àmbit webhooks_manage.

Sol·licitud

Paràmetres de ruta

string
requerit
Identificador del webhook (UUID).

Paràmetres del cos

string
Nou URL HTTPS. Les mateixes regles que a Crear.
string[]
Nova llista de tipus d’esdeveniment. Substitueix la llista anterior.
string[]
Nova llista d’1 a 5 adreces. Substitueix la llista anterior.
string
Nova descripció, de 500 caràcters com a màxim. null l’esborra.
string
enabled o disabled. Desactivar-lo cancel·la els lliuraments pendents.

Resposta

Si té èxit, l’API retorna 200 OK amb el webhook actualitzat.
string
requerit
Identificador del webhook (UUID).
string
requerit
L’URL HTTPS al qual Aniva envia els esdeveniments.
string
Text lliure per a la teva referència. Pot ser null.
string[]
requerit
Tipus d’esdeveniments que rep aquest webhook. * vol dir tots els tipus.
string[]
requerit
Adreces a les quals Aniva envia un correu electrònic quan els lliuraments continuen fallant.
string
requerit
enabled o disabled.
string
Instant UTC ISO 8601 en què es va desactivar el webhook. null mentre està activat.
string
Motiu pel qual es va desactivar el webhook. Consulta Avisos d’error. null mentre està activat.
string
Instant UTC ISO 8601 en què va començar la ratxa actual d’errors. null quan l’últim lliurament ha tingut èxit.
string
Instant UTC ISO 8601 en què el secret anterior deixa de signar. null quan no hi ha cap rotació en curs.
string
requerit
Instant UTC ISO 8601 en què es va crear el webhook.
string
requerit
Instant UTC ISO 8601 de l’últim canvi.

Respostes d’error