In-app notifications

An installed app can send a notification into its company’s Caraer inbox. Notifications have a title and body, with optional action information. Users can list, mark as read, and dismiss their notifications through the supported API.

Why integrate

Your integration can bring the result of background work back to the people using Caraer. Users can see that something needs attention while working in the platform, rather than relying entirely on checking your external service.

What you could build

After a document-processing job finishes, notify the relevant user with a readable result and a link to the next step. If processing requires a correction, use the message to explain what the user needs to review.

Start integrating

Inspect POST /api/v2/notifications and its request schema in the API reference. Authenticate with an authorized app token and test delivery to an intended sandbox recipient. Background jobs can perform work before sending the result.

Choose the audience explicitly. Omitting the target user addresses the notification to users who have access to the company, so it is not a safe default for a personal message. Keep sensitive details appropriate to that audience. An in-app notification does not by itself establish delivery through email, push, or another channel.