Create a Notification Topic

curl --request POST \
  --url https://api.whop.com/api/v5/app/notification_topics \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "name": "<string>",
  "notification_channel_identifiers": [
    "email"
  ],
  "send_once": true,
  "status": "active",
  "topic_identifier": "<string>",
  "topic_type": "company"
}'

{
  "app_id": "<string>",
  "created_at": 123,
  "description": "<string>",
  "name": "<string>",
  "notification_channel_identifiers": [
    "email"
  ],
  "send_once": true,
  "status": "active",
  "topic_identifier": "<string>",
  "topic_type": "company",
  "urgent": true,
  "visibility": "visible"
}

Authorizations

Authorization

string

headerrequired

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

Body

application/json

description

string

The description of the notification topic

name

string

required

The name of the notification topic

notification_channel_identifiers

enum<string>[]

required

Available options:

email,

sms,

in_app,

discord_dm,

mobile

send_once

boolean

Whether or not the notification topic should only be sent once

status

enum<string>

The status of the notification topic

Available options:

active,

inactive

topic_identifier

string

required

The identifier of the notification topic

topic_type

enum<string>

required

The type of the notification topic

Available options:

company,

user

Response

201 - application/json

app_id

string

The ID of the app, which will look like app_*************

created_at

number

required

The date the notification topic was created as a unix timestamp.

description

string

The description of the notification topic

name

string

required

The name of the notification topic

notification_channel_identifiers

enum<string>[]

Available options:

email,

sms,

in_app,

discord_dm,

mobile

send_once

boolean

required

Whether or not the notification topic should only be sent once

status

enum<string>

required

The status of the notification topic

Available options:

active,

inactive

topic_identifier

string

required

The identifier of the notification topic

topic_type

enum<string>

required

The type of the notification topic

Available options:

company,

user

urgent

boolean

required

Whether or not the notification topic is urgent

visibility

enum<string>

required

The visibility of the notification topic

Available options:

visible,

hidden

Was this page helpful?

Send a Notification List Notification Topics

curl --request POST \
  --url https://api.whop.com/api/v5/app/notification_topics \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "name": "<string>",
  "notification_channel_identifiers": [
    "email"
  ],
  "send_once": true,
  "status": "active",
  "topic_identifier": "<string>",
  "topic_type": "company"
}'

{
  "app_id": "<string>",
  "created_at": 123,
  "description": "<string>",
  "name": "<string>",
  "notification_channel_identifiers": [
    "email"
  ],
  "send_once": true,
  "status": "active",
  "topic_identifier": "<string>",
  "topic_type": "company",
  "urgent": true,
  "visibility": "visible"
}