← Volver al índice de esquemas

CreateWebhookRequest

Cuerpo de `POST /v1/webhooks` con la URL HTTPS receptora, los eventos suscritos y una etiqueta opcional.

Propiedades

CampoTipoDescripción
url*string (uri)URL receptora del webhook. Se rechaza si resuelve a una dirección privada o si pasa de 2048 caracteres y, en producción, también si no usa HTTPS.
events*arrayEventos a los que se suscribe el endpoint webhook. Entre 1 y 10.
descriptionstring | nullEtiqueta libre para distinguir el endpoint webhook de los demás. `null` la omite; más de 255 caracteres responde `422 webhook_description_too_long`.

Usado en operaciones

  • POST /v1/webhooks