← Volver al índice de esquemas

`WebhookEndpoint`

Recurso JSON:API de un endpoint webhook, con URL receptora, eventos suscritos, estado y representación del secreto.

ExtiendeJsonApiResourceBase

Propiedades

Campo	Tipo	Descripción
`type`*	`string`	Tipo de recurso JSON:API. Siempre `webhook_endpoint`.
`id`*	`string (uuid)`	Identificador único del endpoint webhook (UUID v4).
`attributes`*	`object`	Datos del endpoint webhook (URL receptora, eventos suscritos, estado y secreto).
`url`*	`string (uri)`	URL receptora del webhook. En producción se rechaza si no usa HTTPS, si resuelve a una dirección privada o si pasa de 2048 caracteres.
`events`*	`array`	Eventos a los que se suscribe el endpoint webhook. Entre 1 y 10.
`description`*	`string \| null`	Etiqueta libre para distinguir el endpoint webhook de los demás.
`status`*	`string`	Estado actual del webhook — `active`: Recibe entregas; `disabled`: Se desactivó manualmente; `auto_disabled`: Se desactivó automáticamente tras superar el umbral de fallos consecutivos.
`consecutive_failures`*	`integer`	Cantidad de fallos consecutivos. Se reinicia al primer éxito.
`last_delivery_at`*	`TimestampUTC \| null`	Fecha y hora de la última entrega exitosa, en ISO 8601 UTC. `null` cuando el endpoint aún no completó ninguna entrega.
`secret`	`string`	Clave compartida para verificar firmas. Solo presente en la respuesta de creación y de rotación del endpoint; se omite en cualquier otra respuesta. Se usa para validar las cabeceras `X-Platform-Signature` y `X-Platform-Signature-Timestamped` de cada entrega.
`secret_hint`	`string`	Últimos 4 caracteres del secret, con el prefijo `...`. Presente en cualquier respuesta donde el `secret` completo está oculto.
`created_at`*	`string (date-time)`	Timestamp ISO 8601 en UTC con sufijo `Z` explícito; por ejemplo, `"2026-05-01T05:14:38Z"`. Los campos `_at`, `_end`, `_start` y `_date` adoptan esta forma. `meta.datetime` describe el mismo contrato en la respuesta.
`updated_at`*	`string (date-time)`	Timestamp ISO 8601 en UTC con sufijo `Z` explícito; por ejemplo, `"2026-05-01T05:14:38Z"`. Los campos `_at`, `_end`, `_start` y `_date` adoptan esta forma. `meta.datetime` describe el mismo contrato en la respuesta.

Usado en operaciones

GET /v1/webhooks
POST /v1/webhooks
PUT /v1/webhooks/{id}
POST /v1/webhooks/{id}/regenerate-secret