Factuarea API
Webhooks

Fer ping al webhook endpoint

Envia un esdeveniment de prova (`webhook.ping`) a l'endpoint per verificar que és accessible i que el handshake de signatura funciona. El lliurament sintètic apareix a `GET /webhook_endpoints/{webhook_endpoint}/deliveries`.

POST
/webhook_endpoints/{webhook_endpoint}/ping

Authorization

AuthorizationBearer <token>

A: header

Paràmetres de ruta

webhook_endpoint*string

Paràmetres de capçalera

Idempotency-Key?string

Clau única generada pel client per garantir la idempotència en els reintents. Et permet reenviar de manera segura la mateixa petició: la primera resposta es cacheja i es retorna sense tornar a executar la mutació. És una cadena opaca per al servidor; qualsevol valor únic de fins a 64 caràcters és vàlid (UUID v7, UUID v4, ULID, nanoid, etc.). Es recomana UUID v7 per coherència amb els identificadors de l'API. La mateixa clau reutilitzada amb un body diferent retorna 409 idempotency_key_reused.

Longitud1 <= length <= 64

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

{
  "data": {
    "success": false,
    "http_status": 503,
    "response_body": "<html><body>503 Service Unavailable</body></html>",
    "error_message": "El endpoint respondió con un código de estado no-2xx (503).",
    "duration_ms": 87
  }
}

{
  "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"
  }
}

Llistar tots els webhook endpoints

Llista els teus webhook endpoints amb paginació per cursor.

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.