TechAppForce

Notification API

Send email, SMS, webhook and in-app notifications, configure templates and recipients, and read delivery status.

Service
Notification service
Base path
https://your-notification-host/api
Authentication
Bearer token, or the service key for internal callers.

Most notifications are configured and fired by triggers, approvals and workflows. These endpoints send directly or run a configured notification. Routes include a workspace key that identifies the app context.

POST/api/notification/workspace/{workspaceKey}/send/{notificationId}

Send a configured notification

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/notification/workspace/{workspaceKey}/email

Send an email

Delivered through the tenant's configured email provider (SMTP or Brevo).

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/notification/workspace/{workspaceKey}/sms

Send an SMS

Delivered through Twilio.

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/notification/workspace/{workspaceKey}/in-app

Send an in-app notification

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/notification/workspace/{workspaceKey}/webhook

Call a webhook

Supports Basic and Bearer authentication, with retries.

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/notification/workspace/{workspaceKey}/multi-channel

Send on several channels at once

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/notification/workspace/{workspaceKey}/pushComing soon

Send a push notification

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Coming soon

The route exists, but a push provider is not yet available for delivery.

POST/api/notification/config/upsert

Create or update a notification configuration

Templates use Liquid and can include data from saved queries. Recipients can be addresses, the record owner, a role or a query.

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/status/workspace/{workspaceKey}/{notificationId}

Get a notification's delivery status

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/status/workspace/{workspaceKey}/history/{recipientId}

Get a recipient's notification history

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

WS/ws

In-app notification socket

Clients read notifications, mark them read and clear them over this WebSocket. The access token is sent on the handshake.

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/records/insert

Store a user's channel preferences (a platform entity)

Per-user opt-in and opt-out per channel is stored as a platform record and applied when notifications are sent.

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.