Factuarea API
Esdeveniments

Llistar tipus d'esdeveniment

Llista el catàleg tancat de tipus d'esdeveniment que Factuarea pot emetre als webhook endpoints. Fes-lo servir per poblar una UI de subscripció en lloc de hardcodejar els noms d'esdeveniment. Cada entrada exposa el seu `name`, `category` (derivada del prefix `<category>.*`), una `description` en castellà i un `status`: `available` significa que el tipus s'emet avui i pot subscriure's via `enabled_events`; `coming_soon` significa que el tipus està reservat per a una versió futura — es llista per descobrir-lo però NO és encara subscriptible (passar-lo en `enabled_events` retorna 422). El conjunt de tipus actualment emesos (`available`) és la font de veritat tancada `EventName::CATALOG`.

GET
/event-catalog

Authorization

AuthorizationBearer <token>

A: header

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

{
  "data": [
    {
      "name": "string",
      "category": "string",
      "description": "string",
      "status": "string"
    }
  ]
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "No se ha proporcionado una API key válida en el header Authorization.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta API key no tiene el scope requerido para esta operación.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
  }
}

Actualitzar un webhook endpoint

Actualitza un webhook endpoint (URL, descripció, esdeveniments habilitats, estat, llista d'accés d'IP).

Llistar tots els esdeveniments

Llista els esdeveniments del teu registre d'esdeveniments amb paginació per cursor. Cada esdeveniment registra alguna cosa que va passar al teu compte (es va pagar una factura, es va acceptar un pressupost, …) i és el mateix objecte que es lliura als teus webhook endpoints. Admet filtratge per `type[in]` i `created[gte|lte]`.