Ferndesk

Webhooks

Actualizar un endpoint de webhook

Actualiza url, events, description o enabled. Establecer enabled: true vuelve a habilitar un endpoint deshabilitado y restablece su estado de fallos. Requiere el scope webhooks:manage.

Scope requerido: webhooks:manage

PATCH /webhooks/{id}

Actualizar un endpoint de webhook

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

Endpoint actualizado

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 del desarrollador.

    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, dejar de publicar, 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 asignación de scopes tienen scopes nulos = acceso total (modo heredado).

Path Parameters

  • id string obligatorio

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

Request Body

application/json
  • url string

    URL de destino actualizada.

  • events[] string array

    Tipos de eventos a los que se suscribe este endpoint. Usa cadenas de tipo exactas (por ejemplo, article.published) o el comodín * para recibir todos los eventos.

  • description string | null

    Etiqueta actualizada.

  • enabled boolean

    Habilita o deshabilita el endpoint. Establecer enabled: true también restablece el contador de fallos y borra el estado de deshabilitación automática.

Response

application/json
  • id string

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

  • url string

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

  • events[] string array

    Tipos de eventos suscritos (o *).

  • enabled boolean

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

  • description string | null

    Etiqueta legible opcional.

  • 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 deshabilitó automáticamente el endpoint, si corresponde.

  • createdAt string

    Marca de tiempo ISO 8601 en UTC.

  • updatedAt string

    Marca de tiempo ISO 8601 en UTC.