Rota el secret del webhook

Rota el secret de signatura d'un webhook endpoint.

El nou secret es retorna una sola vegada en aquesta resposta.
El secret anterior continua sent vàlid durant un període de gràcia de 24 hores (vegeu previous_secret_valid_until) per permetre una rotació sense temps d'inactivitat.

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que permet reintents segurs: la primera resposta s'emmagatzema i es reprodueix en les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 409 idempotency_key_reused. Consulta la guia d'idempotència. Obligatòria en aquesta operació: repetir-la produeix un efecte irreversible (un correu enviat, un fitxer generat, una crida a un tercer o un càrrec), per la qual cosa una petició sense aquesta capçalera es rebutja amb 422 idempotency_key_required abans d'executar lògica de negoci.

Longitud1 <= length <= 255

Factuarea-Version?string

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate

X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la resposta

`application/json`

Exemple de petició

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/webhook_endpoints/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/rotate_secret", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Idempotency-Key":"erp-2026-public-api-v1-webhook_endpoints-rotate_secret"} },});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Exemple de resposta

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0b",
    "object": "webhook_endpoint",
    "url": "https://example.com/webhooks/factuarea",
    "description": "Webhook principal de producción.",
    "enabled_events": [
      "invoice.created",
      "invoice.paid",
      "quote.approved"
    ],
    "status": "enabled",
    "ip_allowlist": [
      "203.0.113.10",
      "198.51.100.0/24"
    ],
    "delivery_success_rate_24h": 99.5,
    "last_delivery_at": "2026-01-25T18:00:00Z",
    "last_failure_at": "2026-01-20T09:14:33Z",
    "previous_secret_valid_until": "2026-01-26T18:00:00Z",
    "created_at": "2025-12-15T12:00:00Z",
    "updated_at": "2026-01-25T18:00:00Z",
    "api_version": "2026-05-01",
    "metadata": {
      "erp_code": "IVA-GEN",
      "ledger_account": "477000"
    },
    "custom_headers": {
      "Authorization": "Bearer integration-token",
      "X-Custom-Auth": "tenant-a"
    },
    "timeout_seconds": 10,
    "degraded_since": "2026-01-24T07:30:00Z",
    "secret": "whsec_01HKQS5N8VR7QXJ9K3T6BWPMZA9876543210ABCDEF"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_6a23198ada7f56a7a516205bdb"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'webhooks:write'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_ee1f936a8fa58e2ca9854e1707"
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "webhook_endpoint_not_found",
    "message": "Endpoint webhook no encontrado.",
    "doc_url": "https://docs.factuarea.com/guides/errors#webhook_endpoint_not_found",
    "request_id": "req_d032ff2f9668d93e62b7473462"
  }
}

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "Esa `Idempotency-Key` ya se usó con un payload distinto. La clave identifica una operación concreta, así que reutilizarla para otra vaciaría de sentido el replay.",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_368040ea0d34a1ca032df0212a"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_format",
    "message": "La Idempotency-Key debe tener entre 1 y 255 caracteres ASCII printable.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_format",
    "request_id": "req_74680149590a2bd1e709e4fd6a"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_e9d91cddfe76014cdb73ccc798"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_510a7a01e6faf1db1c145c3b5f"
  }
}

Rota el secret del webhook

Authorization

Paràmetres de ruta

Headers

Cos de la resposta

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Rota el secret del webhook

Authorization

Paràmetres de ruta

Headers

Cos de la resposta

200application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`