Skip to main content
POST
Send a budget alert test notification

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <credential> using either a Clerk session JWT or a Clerk API key (ak_*). API keys may identify a user (user_*) or organization (org_*) principal and are generated in the Clerk Dashboard under API keys.

Body

application/json
notificationChannel
enum<string>
required
Available options:
EMAIL
emails
string<email>[]
required
Minimum array length: 1

Response

Test notification sent

message
enum<string>
required
Available options:
Test notification sent successfully
Last modified on August 10, 2026