Skip to main content

API & Webhooks

Programmatic access to SaaSy is available on the Growth and Scale plans. See hellosaasy.ai/pricing for current pricing, or Why can't I see a feature? for what each plan includes.

Authentication

API requests use a tenant API key. Create one under Settings, then API Keys (/dashboard/settings/api-keys). Keys start with sk_ and are tenant-scoped.

Authorization: Bearer sk_…

You can send the same key as X-API-Key instead. If both headers are present and they disagree, the gateway returns 400.

Keep keys secret. Rotate them from Settings, then API Keys, if one is compromised. You can also sign in with a JWT Bearer token; that is the browser session path, not the machine path.

Base URL

https://api.hellosaasy.ai

All endpoints are prefixed with /api/v1/.

Interactive reference

A full OpenAPI/Swagger reference is available at:

https://api.hellosaasy.ai/docs

The reference is interactive — you can authenticate with your API key and make live requests from the browser.

Inbound webhooks

SaaSy accepts inbound webhooks from Stripe, GitHub, Slack, Discord, Intercom, and Meta Ads. Each provider gets its own endpoint, scoped to your workspace:

POST https://api.hellosaasy.ai/api/v1/webhooks/in/{provider}/{tenant_id}

Your exact URL and a signing secret are shown in the webhook dialog on the provider's card under Integrations. The secret is generated by you, not created automatically on connect — see Integrations for the full walkthrough.

Outbound webhooks

SaaSy POSTs JSON to HTTPS endpoints you register under Developer Tools, then Webhooks. Each delivery is signed. See Developer Tools for the screens, and Connect Zapier or Make if the receiver is a Catch Hook.

POST https://hooks.example.com/saasy
Content-Type: application/json
X-Webhook-Event: invoice.paid
X-Webhook-Id: 33333333-3333-3333-3333-333333333333
X-Webhook-Timestamp: 1700000000
X-Webhook-Signature: v0=…

The body is the inner event payload (data.payload from the CloudEvents envelope). The canonical event name is in X-Webhook-Event.

Rate limits

PlanRequests per minute
Scale300

Exceeding the rate limit returns 429 Too Many Requests with a Retry-After header.

Common endpoints

These are the most frequently used endpoints. See the interactive reference for the full list.

List customers

GET /api/v1/customers
Authorization: Bearer <token>

Returns a paginated list of customers with their current health score and churn risk level.

Get customer health

GET /api/v1/customers/{customer_id}/health
Authorization: Bearer <token>

Returns the full health score breakdown across all five dimensions.

Get churn prediction

GET /api/v1/customers/{customer_id}/churn-prediction
Authorization: Bearer <token>

Returns the latest churn probability, risk level, risk factors, and recommended interventions.

List alerts

GET /api/v1/alerts?status=open&severity=high
Authorization: Bearer <token>

Returns open alerts. Filter by status, severity, alert_type, or customer_id.

SDK support

Official SDKs are on the roadmap for v2. In the meantime, any HTTP client works with the REST API above. The OpenAPI spec at https://api.hellosaasy.ai/docs can be used to generate a client in any language via tools like openapi-generator or fern.