SaaSFlow
DevelopersAPIReferencenotifications

Create notification

Create a notification and return the created row. Most notifications are raised by SaaSFlow itself; use this when your own workflow needs to put something in a user's bell menu. `recipientUserId` is required, and addressing anyone other than the calling user needs cross-user rights, otherwise the request is refused with 403.

Authentication

You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow sf_… API key in the bearerAuth field below.
POST
/companies/{companyId}/notifications

Authorization

Authorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

In: header

Path Parameters

companyId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/companies/string/notifications" \  -H "Content-Type: application/json" \  -d '{    "type": "string",    "recipientUserId": "string"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "type": "string",  "recipientUserId": "string",  "readTime": "2019-08-24T14:15:22Z",  "payload": {    "property1": null,    "property2": null  },  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

List notifications

List a company's notifications, newest first, paginated. Notifications are what the app shows in its bell menu: bank connection failures, subscription changes, balance mismatches, and similar events. With no `recipientUserId` the result spans every recipient in the company. Passing another user's id requires `users:manage`; without it the response is an empty page rather than a 403. Filter with `types`, and narrow subscription-change rows further with `eventType`. `totalCount` is the unpaginated total for the active filter. `earliestCreatedTime` deliberately ignores the filter so a date picker can anchor to the real start of history, and it is only computed on the first page (`offset=0`), returning null on later pages.

Batch delete

Delete several notifications in one call by passing their ids. Without cross-user rights a caller only deletes notifications addressed to themselves; ids outside that scope, or belonging to another company, are skipped instead of failing the batch, so a success response does not guarantee every id was removed. Deletion is permanent. To clear the unread badge while keeping the history, use `read-all`.