Crear un endpoint de webhook

Registra un endpoint HTTPS para recibir entregas de eventos. El secreto de firma se devuelve aquí una sola vez y nunca más.

POST /v1/webhooks

Token Bearer ámbito webhooks:manage

curl 'https://api.ferndesk.com/v1/webhooks' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://example.com/hooks/ferndesk",
  "events": [
    "article.published",
    "article.updated"
  ],
  "description": "Prod sync worker"
}'

{
  "id": "whep_01JXY9AZK4KV",
  "url": "https://example.com/hooks/ferndesk",
  "events": [
    "article.published"
  ],
  "enabled": true,
  "description": "Prod sync worker",
  "failureCount": 0,
  "lastSuccessAt": "2026-01-01T12:00:00Z",
  "lastFailureAt": "2026-01-01T12:00:00Z",
  "disabledAt": "2026-01-15T18:25:43.511Z",
  "createdAt": "2026-01-15T18:25:43.511Z",
  "updatedAt": "2026-01-15T18:25:43.511Z",
  "secret": "whsec_Zm9vYmFyYmF6cXV4"
}

Endpoint creado, incluido su secreto de firma

Cuerpo

obligatorio application/json

url string · min length: 1· max length: 2048 obligatorio

URL de destino; http:// se acepta únicamente para localhost.

events array of string · min items: 1 obligatorio

Tipos de eventos a los que suscribirse, o * para todos los eventos.

description string | null

Etiqueta que se muestra en el panel.

Cuerpo

Respuestas