Skip to content

API reference

Read your endpoints and events as JSON.

A small read-only REST API for the webhook side, available from the Startup plan. Your key is on the settings page and starts with sf_live_.

Authentication

curl https://saasfoundry.app/api/v1/endpoints/   -H 'Authorization: Bearer sf_live_YOUR_KEY'

A missing or wrong key returns 401. A key belonging to a plan without API access returns 403.

GET /api/v1/endpoints/

{
  "count": 2,
  "results": [
    {
      "id": 1,
      "name": "Stripe production",
      "token": "8f2b91c4a70d5e6b3a1f2c8d",
      "url": "https://saasfoundry.app/i/8f2b91c4a70d5e6b3a1f2c8d",
      "is_active": true,
      "forwarding": "https://api.yourapp.com/webhooks/stripe",
      "verify_scheme": "stripe",
      "events_total": 1284,
      "created_at": "2026-08-01T09:12:44Z"
    }
  ]
}

GET /api/v1/events/

Query parameters: endpoint (id), limit (1–200, default 50), before (ISO-8601, for paging back through time).

GET /api/v1/events/<id>/

The same fields plus headers, body, query_string and the full deliveries list.

Rate limit

120 requests per minute per key. Over that you get 429 with a Retry-After header.