Ferndesk

Webhooks

Listar endpoints de webhook

Devuelve todos los endpoints de webhook de tu organización, del más reciente al más antiguo. Requiere el scope webhooks:manage.

Scope requerido: webhooks:manage

GET /webhooks

Listar endpoints de webhook

curl --request GET \
  --url 'https://api.ferndesk.com/v1/webhooks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
[
  {
    "id": "<string>",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "enabled": true,
    "description": "<string>",
    "failureCount": 1,
    "lastSuccessAt": "<string>",
    "lastFailureAt": "<string>",
    "disabledAt": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
]

Endpoints de webhook

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API llevan el prefijo fdsk_ y deben mantenerse secretas. Puedes generar y administrar claves desde la página de 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 efectivos los cambios)
    • 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).

Response

application/json
  • items[] object array item

    Carga útil del endpoint de webhook (nunca incluye el secreto de firma).

    + Show Child Attributes
    • id string

      ID del endpoint de webhook (whep_...).

    • url string

      URL HTTPS que recibe las cargas útiles de webhook enviadas mediante POST.

    • events[] string array

      Tipos de eventos suscritos (o *).

    • enabled boolean

      Indica si el endpoint recibe entregas actualmente. Los endpoints se desactivan automáticamente después de fallos prolongados.

    • description string | null

      Etiqueta opcional legible para humanos.

    • failureCount integer

      Fallos consecutivos de entrega. Se restablece a 0 tras cualquier éxito o al volver a habilitarlo.

    • lastSuccessAt string | null
    • lastFailureAt string | null
    • disabledAt string | null

      Cuándo se desactivó automáticamente el endpoint, si corresponde.

    • createdAt string

      Marca de tiempo ISO 8601 en UTC.

    • updatedAt string

      Marca de tiempo ISO 8601 en UTC.