Ferndesk

Webhooks

Enviar una entrega de prueba

Encola un evento webhook.test mediante el flujo de entrega real (firmado de forma idéntica a los eventos de producción). La entrega es asíncrona: consulta GET /webhooks/{id}/deliveries/{delivery_id} para obtener el resultado. Requiere el alcance webhooks:manage.

Alcance requerido: webhooks:manage

POST /webhooks/{id}/test

Enviar una entrega de prueba

curl --request POST \
  --url 'https://api.ferndesk.com/v1/webhooks/{ID}/test' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "delivery_id": "<string>"
}

Entrega de prueba encolada

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 secretas. Puedes generar y administrar claves desde la página de configuración para desarrolladores.

    Las claves pueden restringirse a cualquier subconjunto de estos alcances (cada endpoint indica el alcance 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

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

Path Parameters

  • id string obligatorio

    ID del endpoint de Webhook (whep_...). Ejemplo: whep_01JXY9AZK4KV

Response

application/json
  • delivery_id string

    ID de la entrega de prueba encolada. Consulta GET /webhooks/{id}/deliveries/{delivery_id} para obtener el resultado.