Saltar al contenido principal
POST
Registra una URL HTTPS que recibe eventos de webhook. Tu clave API es la propietaria del webhook. Solo recibe un evento para los objetos que tu clave puede leer. Una clave API puede tener como máximo 5 webhooks.
Requiere el scope webhooks_manage.

Solicitud

Parámetros del cuerpo

string
requerido
URL HTTPS en el puerto 443 con un host público y sin credenciales. Aniva no sigue redirecciones.
string[]
requerido
Tipos de evento que se recibirán, al menos uno. ["*"] significa todos los tipos. No se puede incluir ping.
string[]
requerido
De 1 a 5 direcciones a las que Aniva envía un correo cuando las entregas siguen fallando.
string
Texto libre para tu propia referencia, máximo 500 caracteres.

Respuesta

Si tiene éxito, la API devuelve 201 Created con el webhook y su secreto.
string
requerido
El secreto de firma, whsec_ seguido de base64. Aniva solo lo muestra en esta respuesta. Consulta Verificar la firma.
string
requerido
Identificador del webhook (UUID).
string
requerido
La URL HTTPS a la que Aniva envía los eventos.
string
Texto libre para tu propia referencia. Puede ser null.
string[]
requerido
Tipos de evento que recibe este webhook. * significa todos los tipos.
string[]
requerido
Direcciones a las que Aniva envía un correo cuando las entregas siguen fallando.
string
requerido
enabled o disabled.
string
Instante ISO 8601 UTC en el que se desactivó el webhook. null mientras esté activado.
string
Motivo por el que se desactivó el webhook. Consulta Avisos de fallo. null mientras esté activado.
string
Instante ISO 8601 UTC en el que empezó la racha actual de fallos. null cuando la última entrega tuvo éxito.
string
Instante ISO 8601 UTC en el que el secreto anterior deja de firmar. null cuando no hay ninguna rotación en curso.
string
requerido
Instante ISO 8601 UTC en el que se creó el webhook.
string
requerido
Instante ISO 8601 UTC del último cambio.

Respuestas de error