Saltar al contingut principal
POST
Registra un URL HTTPS que rep esdeveniments de webhook. La teva clau d’API és la propietària del webhook. Només rep un esdeveniment per als objectes que la teva clau pot llegir. Una clau d’API pot tenir com a màxim 5 webhooks.
Requereix l’àmbit webhooks_manage.

Sol·licitud

Paràmetres del cos

string
requerit
URL HTTPS al port 443 amb un amfitrió públic i sense credencials. Aniva no segueix redireccions.
string[]
requerit
Tipus d’esdeveniments per rebre, com a mínim un. ["*"] vol dir tots els tipus. No es pot incloure ping.
string[]
requerit
D’1 a 5 adreces a les quals Aniva envia un correu electrònic quan els lliuraments continuen fallant.
string
Text lliure per a la teva referència, de 500 caràcters com a màxim.

Resposta

Si té èxit, l’API retorna 201 Created amb el webhook i el seu secret.
string
requerit
El secret de signatura, whsec_ més base64. Aniva només el mostra en aquesta resposta. Consulta Verifica la signatura.
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