List webhook endpoints

GET/v1/webhook-endpoints

Returns the URLs that receive signed event notifications from your account.

Each endpoint chooses its events and can be limited to one business. Signing secrets are never returned; secret_last4 helps you match them. See Webhooks.

Permission: integrations.manage
Type: Read-only. Changes nothing.
Auth: API key, MCP token or signed-in session
Capability: list_webhook_endpoints
CLI: freeinvoiceautomation webhook list
Available: At launch, 1 January 2027

list_webhook_endpoints

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/webhook-endpoints \
  --header 'Authorization: Bearer <api-key>'

{
  "data": [
    {
      "id": "0193f360-1c2d-7e3f-8a4b-5c6d7e8f9a0b",
      "business_id": null,
      "url": "https://hooks.northwind.example/fia",
      "events": [
        "document.sent",
        "document.paid",
        "payment.succeeded",
        "payment.recorded"
      ],
      "secret_last4": "a91F",
      "status": "active",
      "consecutive_failures": 0,
      "created_at": "2027-01-07T10:00:00Z",
      "updated_at": "2027-01-07T10:00:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Authorizations

Authorizationstringrequired

Bearer <api-key>. An API key from Settings > API keys, or an MCP token. See Authentication.

Query Parameters

limitintegerdefault:50

Page size, 1 to 200.

cursorstring

Cursor from the previous page's next_cursor.

Response

200 - application/json

dataobject[]

The endpoints on this page.

next_cursorstring | null

Cursor for the next page, or null on the last page.

has_moreboolean

Whether another page exists.

Suggest edits Raise issue

Revoke an API keyPrevious Create or update a webhook endpointNext

list_webhook_endpoints

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/webhook-endpoints \
  --header 'Authorization: Bearer <api-key>'

{
  "data": [
    {
      "id": "0193f360-1c2d-7e3f-8a4b-5c6d7e8f9a0b",
      "business_id": null,
      "url": "https://hooks.northwind.example/fia",
      "events": [
        "document.sent",
        "document.paid",
        "payment.succeeded",
        "payment.recorded"
      ],
      "secret_last4": "a91F",
      "status": "active",
      "consecutive_failures": 0,
      "created_at": "2027-01-07T10:00:00Z",
      "updated_at": "2027-01-07T10:00:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false
}