Ferndesk

Webhooks

Obtener una entrega

Devuelve un único registro de entrega para un endpoint, incluidos el estado, el código de respuesta, los intentos y el calendario de reintentos. Requiere el scope webhooks:manage.

Scope requerido: webhooks:manage

GET /webhooks/{id}/deliveries/{deliveryId}

Obtener una entrega

curl --request GET \
  --url 'https://api.ferndesk.com/v1/webhooks/{ID}/deliveries/{DELIVERYID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "eventType": "<string>",
  "status": "pending",
  "responseStatus": 1,
  "attempts": 1,
  "error": "<string>",
  "createdAt": "<string>",
  "deliveredAt": "<string>",
  "nextRetryAt": "<string>"
}

Registro de entrega

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API tienen el prefijo fdsk_ y deben mantenerse en secreto. Puedes generar y administrar claves desde la página Configuración de desarrolladores.

    Las claves pueden restringirse a cualquier subconjunto de estos scopes (cada endpoint indica el scope que requiere mediante x-required-scopes):

    • content:read: Leer y buscar artículos, colecciones, secciones y traducciones del centro de ayuda
    • content:write: Crear y editar borradores de artículos, usuarios y tareas; mover artículos y colecciones
    • content:publish: Publicar, retirar la publicación, restaurar y enviar contenido a la papelera (hacer que los cambios sean visibles)
    • analytics:read: Leer informes, análisis y comentarios sobre artículos del centro de ayuda
    • conversations:read: Leer conversaciones y transcripciones del asistente de IA
    • webhooks:manage: Crear y administrar suscripciones a webhooks salientes

    Otorgar content:write o content:publish implica content:read. Las claves creadas antes de la asignación de scopes tienen scopes nulos = acceso total (modo heredado).

Path Parameters

  • deliveryId string obligatorio

    ID de entrega (whdl_...). Ejemplo: whdl_01JXY9AZK4KV

  • id string obligatorio

    ID del endpoint del webhook (whep_...). Ejemplo: whep_01JXY9AZK4KV

Response

application/json
  • id string

    ID de entrega (whdl_...).

  • eventType string

    Tipo de evento entregado.

  • status string enum enum

    Estado del ciclo de vida de la entrega. Allowed values: pending, success, failed.

  • responseStatus integer | null

    Estado HTTP devuelto por el endpoint, o null antes del primer intento o en caso de error de red.

  • attempts integer

    Intentos de entrega realizados hasta ahora.

  • error string | null

    Último mensaje de error, si el intento más reciente falló.

  • createdAt string

    Marca de tiempo ISO 8601 en UTC.

  • deliveredAt string | null

    Cuándo se realizó correctamente la entrega por primera vez, si es el caso.

  • nextRetryAt string | null

    Cuándo está programado el próximo reintento, para entregas fallidas pendientes.