Inbox Notifications

Create notifications

post/inbox-notifications

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/inbox-notifications
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Request body

audience_type'all_users' | 'workspace' | 'user' required

Define the audience type for the inbox-notification (all_users, workspace, user)

audience_roles'admin' | 'owner' | 'creator' | 'member' | 'guest'

Specify with roles users must have in order to create inbox-notifications for them, only needed if audience_type is workspace

user_idsstring

List of user_ids to create inbox-notifications for

workspace_idstring

Specific Workspace to create inbox-notifications for

action_urlstring required

The endpoint for inbox notification action

messagestring required

Message that will be visible to the users

category'workspace' | 'mentions' | 'carbonVoice' | 'security' | 'general'

Category to group the inbox-notifications, defaults to General

type'general.new.update' | 'general.new.article' required

Type of Notification

send_push_notificationboolean

Send push notification to users

push_titlestring

Push title

push_subtitlestring

Push subtitle

Changes

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