Skip to main content
POST
Create a notification subscription

Authorizations

session
string
cookie
required

Session cookie obtained from POST /api/auth/login.

Body

application/json
name
string
required
Example:

"Slack — new presentation"

eventType
string
required
Example:

"presentation.opened"

channel
enum<string>
required
Available options:
webhook,
email,
console
channelConfig
object
required

Channel-specific config. Webhook: { url }. Email: { toEmails: ["a@b.com"] }.

deckId
string<uuid>

Scope to a specific deck (optional)

isActive
boolean
default:true

Response

Subscription created

id
string<uuid>
required
organizationId
string<uuid>
required
name
string
required
eventType
string
required
channel
enum<string>
required
Available options:
webhook,
email,
console
channelConfig
object
required

Channel-specific configuration (e.g. URL for webhook, toEmails for email)

isActive
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
deckId
string<uuid> | null