Webhooks

List all webhook endpoints

List your webhook endpoints with cursor-based pagination.

get/companies/{company}/webhook-endpoints

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/webhook-endpoints
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Query parameters

limitinteger

Number of objects to return, between 1 and 100 (default 25).

starting_afterstring uuid

Cursor for forward pagination: pass the id of the last object on the previous page (the next_cursor of the previous response).

ending_beforestring uuid

Cursor for backward pagination: pass the id of the first object on the current page.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

has_moreboolean required

Whether more pages are available after this one.

next_cursorstring nullable required

Opaque cursor for the next page, or null when has_more is false. The example below shows the shape used by most listings; others return a different one, so pass the value back verbatim instead of validating it.

Example response

{
  "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": "active",
      "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-10-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"
    }
  ],
  "has_more": true,
  "next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c"
}

Changes

No recorded changes to this operation across all 1 revision of this API.