Saltar al contenido principal
POST
Configurar webhook

Configurar webhook

Establece la URL de webhook de la cuenta. Hay una sola URL por cuenta y ambos eventos van a ella.
Una clave API no puede llamar a este endpoint. Cambiar la URL del webhook —o leer el secreto de firma— requiere una sesión abierta por usted mismo en el sitio web. Con una clave API la petición se rechaza:
Response
De lo contrario, una clave robada bastaría para dirigir sus eventos al servidor de otra persona. Configure la URL en Dashboard → API; en esa misma página se muestra el secreto de firma.

Cuerpo de la petición

string
requerido
URL del webhook. En este endpoint solo HTTPS, y no debe apuntar a localhost, 127.0.0.1, 0.0.0.0 ni ::1. Además, la entrega se rechaza en el momento del envío hacia cualquier host que resuelva a una dirección privada, loopback o link-local.

Respuesta

string
La URL ahora configurada.
string
El secreto de firma para X-Webhook-Signature. Se genera la primera vez que se establece una URL en la cuenta y no cambia después.
Response

La puerta del panel

El panel usa un segundo par de endpoints sobre los mismos campos de la cuenta: GET /api/v1/account/webhook para leer la URL y el secreto, y PATCH /api/v1/account/webhook para establecerlos o borrarlos. Aceptan los mismos valores con dos diferencias: PATCH admite también una URL http://, y enviar {"webhook_url": null} borra el webhook. Borrar la URL conserva el secreto, de modo que volver a activar el webhook más adelante no invalida el código de verificación que ya tenga desplegado. Ambos endpoints requieren también una sesión del sitio web.