Notifications

Send a notification

View as Markdown
Send a message to your own inbox, and to your email if you have enabled email for the Message category in your notification preferences. Sends are capped per hour and per organization per day; a 429 response carries a Retry-After header. Messages sent with an API key are attributed to it, so the recipient can tell where they came from. Requires an API key with the `write` scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
titlestringRequired1-255 characters
dedupe_keystringRequired1-200 characters

Idempotency key; a repeat send with the same key is dropped

bodystringOptional<=2000 charactersDefaults to
action_urlstringOptionalformat: "^(/([^/\\\x00-\x1f\x7f][^\x00-\x1f\x7f]*)?)?$"<=1024 charactersDefaults to

Platform path the notification opens, such as /jobs/<id>

datamap from strings to any or nullOptional

Structured context stored with the notification. The keys sender and api_key_id are reserved for sender attribution.

Response

OK
statusenum
idstring or nullOptionalformat: "uuid"

Inbox row id; null when the send was deduplicated or muted

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error