JetBrains Space Help

Notifications

Get all notifications

get /api/http/notifications

List all subscription subjects

Request arguments

No arguments

Response

array of EventSubjectInfoDTO

Create channel subscription

post /api/http/notifications/channel-subscriptions

Add subscription for a channel

Required permissions: Update channel subscriptions

Request arguments

object with fields:

Response

SubscriptionDTO

Get all channel subscriptions

get /api/http/notifications/channel-subscriptions

List subscriptions for a channel

Required permissions: View channel info

Request arguments

channel: string in one of the formats

  • id: string

  • name: string

(Query) ( Required )

Response

array of SubscriptionDTO

Request missing rights

post /api/http/notifications/channel-subscriptions/{id}/request-missing-rights

Ensures that all permissions required for this subscription are requested in the corresponding permission role

Required permissions: Update channel subscriptions

Request arguments

id: string (Path) ( Required )

Response

No arguments

Update channel subscription

patch /api/http/notifications/channel-subscriptions/{id}

Update subscription for a channel

Required permissions: Update channel subscriptions

Request arguments

id: string (Path) ( Required )

object with fields:

  • name: string ( Nullable and Optional , defaults to null)

  • enabled: boolean ( Nullable and Optional , defaults to null)

  • subscription: CustomGenericSubscriptionIn ( Nullable and Optional , defaults to null)

Response

SubscriptionDTO

Delete channel subscription

delete /api/http/notifications/channel-subscriptions/{id}

Delete channel subscription

Required permissions: Update channel subscriptions

Request arguments

id: string (Path) ( Required )

Response

No arguments

Create personal custom subscription

post /api/http/notifications/personal-custom-subscriptions

Create personal custom subscription

Required permissions: Update notification settings

Request arguments

object with fields:

Response

SubscriptionDTO

Get all personal custom subscriptions

get /api/http/notifications/personal-custom-subscriptions

List personal custom subscriptions

Required permissions: View notification settings

Request arguments

profile: string in one of the formats

  • externalId: string

  • id: string

  • me

  • username: string

(Query) ( Required )

Response

array of SubscriptionDTO

Update personal custom subscription

patch /api/http/notifications/personal-custom-subscriptions/{id}

Create personal custom subscription

Required permissions: Update notification settings

Request arguments

id: string (Path) ( Required )

object with fields:

  • name: string ( Nullable and Optional , defaults to null)

  • enabled: boolean ( Nullable and Optional , defaults to null)

  • feed: string ( Nullable and Optional , defaults to null)

  • subscription: CustomGenericSubscriptionIn ( Nullable and Optional , defaults to null)

Response

SubscriptionDTO

Delete personal custom subscription

delete /api/http/notifications/personal-custom-subscriptions/{id}

Delete personal custom subscription

Required permissions: Update notification settings

Request arguments

id: string (Path) ( Required )

Response

No arguments

Update personal subscription subject

post /api/http/notifications/personal-subscriptions/update-personal-subscription-subject

Update personal subscription settings for a member

Required permissions: View notification settings

Request arguments

object with fields:

  • profile: ProfileIdentifier ( Required )

  • subjectCode: string ( Required )

  • feed: string ( Required )

  • enabled: boolean ( Required )

Response

No arguments

Update personal subscription target

post /api/http/notifications/personal-subscriptions/update-personal-subscription-target

Update personal subscription settings for a member

Required permissions: View notification settings

Request arguments

object with fields:

  • profile: ProfileIdentifier ( Required )

  • targetCode: string ( Required )

  • feed: string ( Required )

  • eventCodes: array of string ( Required )

Response

No arguments

All personal subscription targets

get /api/http/notifications/personal-subscriptions/all-personal-subscription-targets

List all personal subscription targets

Request arguments

No arguments

Response

array of PersonalSubscriptionTarget

Get personal subscription settings

get /api/http/notifications/personal-subscriptions/personal-subscription-settings

Get personal subscription settings for a member

Required permissions: View notification settings

Request arguments

profile: string in one of the formats

  • externalId: string

  • id: string

  • me

  • username: string

(Query) ( Required )

feed: string (Query) ( Required )

Response

PersonalSubscriptionSettings

Create private feed

post /api/http/notifications/private-feeds

Create personal feed for member

Required permissions: Update notification settings

Request arguments

object with fields:

Response

PrivateFeed

Get all private feeds

get /api/http/notifications/private-feeds

List personal feeds for a member

Required permissions: View notification settings

Request arguments

profile: string in one of the formats

  • externalId: string

  • id: string

  • me

  • username: string

(Query) ( Required )

Response

array of PrivateFeed

Update private feed

patch /api/http/notifications/private-feeds/{id}

Update personal feed for a member

Required permissions: Update notification settings

Request arguments

id: string (Path) ( Required )

object with fields:

  • name: string ( Nullable and Optional , defaults to null)

  • icon: string ( Nullable and Optional , defaults to null)

  • color: PrivateFeedColor ( Nullable and Optional , defaults to null)

Response

PrivateFeed

Delete private feed

delete /api/http/notifications/private-feeds/{id}

Delete personal feed for member

Required permissions: Update notification settings

Request arguments

id: string (Path) ( Required )

Response

No arguments

Last modified: 06 September 2023
HTTP API Model Organization