DEdefaulr
Users

Subscribe to a notification type

Changed on

Enable a specific type of notification for the authenticated user. This controls which events the user receives email and in-app notifications for.

post/users.notificationsSubscribe

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/users.notificationsSubscribe
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

eventType'documents.publish' | 'documents.update' | 'documents.add_user' | 'collections.add_user' | 'revisions.create' | 'collections.create' | 'comments.create' | 'comments.resolve' | 'reactions.create' | 'documents.mentioned' | 'comments.mentioned' | 'documents.group_mentioned' | 'comments.group_mentioned' | 'emails.invite_accepted' | 'emails.onboarding' | 'emails.features' | 'emails.export_completed' | 'access_requests.create'

The notification event type to subscribe to.

Response

OK

Example response

{
  "data": {
    "name": "Jane Doe"
  }
}

Changes