Skip to content
TurnitPass
DevelopersAPI v1Get an API key
Browse documentation

DevelopersNotifications

Route account, billing, and API alerts with clear ownership

Notification settings are treated as an operational surface: low balance, key activity, billing changes, API failures, and product updates should route to the right workspace owner.

REST API v1

Your platform

Overview

workspace
POSTinternal event
account scoped
alert payload shape
internal event
{
  "type": "low_word_balance",
  "workspace_id": "user_workspace",
  "words_remaining": 2858,
  "action_url": "/dashboard#workspace-billing"
}

Review board

01

Low balance

Warn teams before humanizer or detector requests run out of words.

02

Key events

Surface key creation, revocation, and suspicious authentication failures.

03

Product updates

Developer-facing changes are summarized in the public changelog.

Alert model

Notifications should map to real workflow risk

1

Balance changes

Notify account owners when remaining words fall below a threshold that could block production jobs.

2

Key lifecycle

Notify when a new key is created, a key is revoked, or authentication failures spike.

3

Billing events

Route successful upgrades, failed payments, renewal issues, and portal changes to the workspace owner.

4

API compatibility

Use changelog entries for endpoint additions, response fields, and documented limit changes.

Notification channels

What each message should include

Low words
Balance and planInclude remaining words, plan, and a link to billing or pricing.
Key created
Key name and timeInclude key label and timestamp, never the raw token.
Payment issue
Billing actionLink to workspace billing and portal flow after login.
API change
Docs linkPoint to the exact reference or changelog section that changed.
Implementation note. This page documents the notification model and the events that can trigger an email.
Next, make it part of your workflow.Continue reading