Skip to main content
POST
Send a notification

Authorizations

Authorization
string
header
required

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

Body

application/json
title
string

Notification title, up to 200 characters. Optional when target is provided.

body
string

Notification body.

type
string

Notification type, used for grouping and preferences.

target
string

Arg file, folder, chat, or action run URL to open.

users
string[]

Recipients, by "me", user id, or email. Every recipient must be in your organization. Defaults to yourself.

channels
enum<string>[]

Delivery channels. Omit for all channels; recipient preferences still apply.

Available options:
ios,
email,
in-app
metadata
object

Extra data stored with the notification.

Response

Successful response

The response is of type object.