Notifications

Send a notification

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.

post/api/v1/notifications

Request

  • Base URL: https://platform.labric.co
  • URL: https://platform.labric.co/api/v1/notifications
  • Auth: HTTP bearer

Request body

titlestring required
bodystring
action_urlstring

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

dedupe_keystring required

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

dataobject nullable

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

Response

OK

idstring uuid nullable

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

status'delivered' | 'deduplicated' | 'muted' required

Changes

No recorded changes to this operation across all 1 revision of this API.