API docs by Redocly

Notification API (v1)

Subscription

List subscriptions

Lists all subscriptions in a Coveo organization.

Privilege required

{"owner":"PLATFORM","targetDomain":"SUBSCRIPTION","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

Responses

Create subscription

Creates a subscription

Privilege required

{"owner":"PLATFORM","targetDomain":"SUBSCRIPTION","type":"CREATE","targetId":"*"}
Create a Subscription with the API
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

Request Body schema: application/json
required

The JSON configuration to use for the new subscription.

description
string

A brief description for the subscription.

enabled
boolean

Whether the subscription can send notifications.

frequency
string
Enum: "LIVE" "HOURLY" "DAILY" "WEEKLY"

The frequency at which the subscription sends notifications.
Allowed values:
- LIVE: Send notifications as soon as possible when a matching activity event occurs.
- HOURLY: Send periodical notifications including all matching activity events that occurred within the hour.
- DAILY: Send periodical notifications including all matching activity events that occurred within the day.
- WEEKLY: Send periodical notifications including all matching activity events that occurred within the week.

name
string

The display name for the subscription.

object (SubscriptionParametersModel)

Parameters specifying the notification sent by the subscription.

object (SubscriptionPatternModel)

The subscription configuration specifying which activities trigger notifications.

Organization Notification JSON Filter Reference
type
string
Enum: "EMAIL" "EMAIL_JSON" "WEB_HOOK"

The way the subscription sends notifications.
Allowed values:
- EMAIL: Send user-friendly, HTML formatted emails whose content includes only the most vital activity event information.
- EMAIL_JSON: Send un-formatted emails whose content includes the entire activity event data.
- WEB_HOOK: Send HTTP POST requests to the URL you specify as the serviceUrl property value of the parameters object.

Responses

Request samples

Content type
application/json
{
  • "description": "Sends a POST HTTP request to http://www.example.com/myendpoint when a refresh operation fails on a specific source.",
  • "enabled": true,
  • "frequency": "LIVE",
  • "name": "Refresh Notifications",
  • "parameters": {
    },
  • "pattern": {
    },
  • "type": "EMAIL"
}

List subscriptions for current member

Lists all subscriptions of the current member.
Note: Only OAuth2 token authentication works when working with user notifications. Using API keys will not work as they cannot be traced back to an individual member.

Privilege required

{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
Manage User Notifications
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

Responses

Create subscription for current member

Creates a subscription for the current member
Note: Only OAuth2 token authentication works when working with user notifications. Using API keys will not work as they cannot be traced back to an individual member.

Privilege required

{"owner":"PLATFORM","targetDomain":"ACTIVITIES","type":"VIEW","targetId":"*"}
Creating a Subscription
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

Request Body schema: application/json
required

The JSON configuration to use for the new subscription.

description
string

A brief description for the subscription.

enabled
boolean

Whether the subscription can send notifications.

frequency
string
Enum: "LIVE" "HOURLY" "DAILY" "WEEKLY"

The frequency at which the subscription sends notifications.
Allowed values:
- LIVE: Send notifications as soon as possible when a matching activity event occurs.
- HOURLY: Send periodical notifications including all matching activity events that occurred within the hour.
- DAILY: Send periodical notifications including all matching activity events that occurred within the day.
- WEEKLY: Send periodical notifications including all matching activity events that occurred within the week.

name
string

The display name for the subscription.

object (SubscriptionParametersModel)

Parameters specifying the notification sent by the subscription.

object (SubscriptionPatternModel)

The subscription configuration specifying which activities trigger notifications.

Organization Notification JSON Filter Reference
type
string
Enum: "EMAIL" "EMAIL_JSON" "WEB_HOOK"

The way the subscription sends notifications.
Allowed values:
- EMAIL: Send user-friendly, HTML formatted emails whose content includes only the most vital activity event information.
- EMAIL_JSON: Send un-formatted emails whose content includes the entire activity event data.
- WEB_HOOK: Send HTTP POST requests to the URL you specify as the serviceUrl property value of the parameters object.

Responses

Request samples

Content type
application/json
{
  • "description": "Sends a POST HTTP request to http://www.example.com/myendpoint when a refresh operation fails on a specific source.",
  • "enabled": true,
  • "frequency": "LIVE",
  • "name": "Refresh Notifications",
  • "parameters": {
    },
  • "pattern": {
    },
  • "type": "EMAIL"
}

Delete subscription for current member

Deletes a subscription for the current member
Note: Only OAuth2 token authentication works when working with user notifications. Using API keys will not work as they cannot be traced back to an individual member.

Privilege required

{"owner":"PLATFORM","targetDomain":"ACTIVITIES","type":"VIEW","targetId":"*"}
Deleting a Subscription
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

subscriptionId
required
string
Example: z5zoxmpor75utkwavbyms2ngla

The unique identifier of the user subscription to delete.

Responses

Show subscription for current member

Shows a subscription
Note: Only OAuth2 token authentication works when working with user notifications. Using API keys will not work as they cannot be traced back to an individual member.

Privilege required

{"owner":"PLATFORM","targetDomain":"ORGANIZATION","type":"VIEW","targetId":"*"}
Manage User Notifications
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

subscriptionId
required
string
Example: z5zoxmpor75utkwavbyms2ngla

The unique identifier of the subscription to show.

Responses

Update subscription for current member

Updates a subscription for the current member.
Note: Only OAuth2 token authentication works when working with user notifications. Using API keys will not work as they cannot be traced back to an individual member.

Privilege required

{"owner":"PLATFORM","targetDomain":"ACTIVITIES","type":"VIEW","targetId":"*"}
Manage User Notifications
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

subscriptionId
required
string
Example: z5zoxmpor75utkwavbyms2ngla

The unique identifier of the subscription to update.

Request Body schema: application/json
required

The JSON configuration to update the target subscription to.

description
string

A brief description for the subscription.

enabled
boolean

Whether the subscription can send notifications.

frequency
string
Enum: "LIVE" "HOURLY" "DAILY" "WEEKLY"

The frequency at which the subscription sends notifications.
Allowed values:
- LIVE: Send notifications as soon as possible when a matching activity event occurs.
- HOURLY: Send periodical notifications including all matching activity events that occurred within the hour.
- DAILY: Send periodical notifications including all matching activity events that occurred within the day.
- WEEKLY: Send periodical notifications including all matching activity events that occurred within the week.

name
string

The display name for the subscription.

object (SubscriptionParametersModel)

Parameters specifying the notification sent by the subscription.

object (SubscriptionPatternModel)

The subscription configuration specifying which activities trigger notifications.

Organization Notification JSON Filter Reference
type
string
Enum: "EMAIL" "EMAIL_JSON" "WEB_HOOK"

The way the subscription sends notifications.
Allowed values:
- EMAIL: Send user-friendly, HTML formatted emails whose content includes only the most vital activity event information.
- EMAIL_JSON: Send un-formatted emails whose content includes the entire activity event data.
- WEB_HOOK: Send HTTP POST requests to the URL you specify as the serviceUrl property value of the parameters object.

Responses

Request samples

Content type
application/json
{
  • "description": "Sends a POST HTTP request to http://www.example.com/myendpoint when a refresh operation fails on a specific source.",
  • "enabled": true,
  • "frequency": "LIVE",
  • "name": "Refresh Notifications",
  • "parameters": {
    },
  • "pattern": {
    },
  • "type": "EMAIL"
}

Disable subscription for current member

Disables a subscription from sending notifications for the current member
Note: Only OAuth2 token authentication works when working with user notifications. Using API keys will not work as they cannot be traced back to an individual member.

Privilege required

{"owner":"PLATFORM","targetDomain":"ACTIVITIES","type":"VIEW","targetId":"*"}
Disable or Enable a User Notification
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

subscriptionId
required
string
Example: z5zoxmpor75utkwavbyms2ngla

The unique identifier of the subscription to disable.

Responses

Enable subscription for current member

Enables a subscription to send notifications for the current member
Note: Only OAuth2 token authentication works when working with user notifications. Using API keys will not work as they cannot be traced back to an individual member.

Privilege required

{"owner":"PLATFORM","targetDomain":"ACTIVITIES","type":"VIEW","targetId":"*"}
Disable or Enable a User Notification
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

subscriptionId
required
string
Example: z5zoxmpor75utkwavbyms2ngla

The unique identifier of the subscription to enable.

Responses

Test subscription for current member

Tests a subscription for the current member
Note: Only OAuth2 token authentication works when working with user notifications. Using API keys will not work as they cannot be traced back to an individual member.

Privilege required

{"owner":"PLATFORM","targetDomain":"ACTIVITIES","type":"VIEW","targetId":"*"}
Testing a Subscription
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

subscriptionId
required
string
Example: z5zoxmpor75utkwavbyms2ngla

The unique identifier of the subscription to test.

Responses

Delete subscription

Deletes a subscription in a Coveo organization.

Privilege required

{"owner":"PLATFORM","targetDomain":"SUBSCRIPTION","type":"EDIT","targetId":"{subscriptionId}"}
Deleting a Subscription
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

subscriptionId
required
string
Example: z5zoxmpor75utkwavbyms2ngla

The unique identifier of the user subscription to delete.

Responses

Show subscription

Shows a subscription in a Coveo organization.

Privilege required

{"owner":"PLATFORM","targetDomain":"SUBSCRIPTION","type":"VIEW","targetId":"*"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

subscriptionId
required
string
Example: z5zoxmpor75utkwavbyms2ngla

The unique identifier of the subscription to show.

Responses

Update subscription

Updates a subscription in a Coveo organization.

Privilege required

{"owner":"PLATFORM","targetDomain":"SUBSCRIPTION","type":"EDIT","targetId":"{subscriptionId}"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

subscriptionId
required
string
Example: z5zoxmpor75utkwavbyms2ngla

The unique identifier of the subscription to update.

Request Body schema: application/json
required

The JSON configuration to update the target subscription to.

description
string

A brief description for the subscription.

enabled
boolean

Whether the subscription can send notifications.

frequency
string
Enum: "LIVE" "HOURLY" "DAILY" "WEEKLY"

The frequency at which the subscription sends notifications.
Allowed values:
- LIVE: Send notifications as soon as possible when a matching activity event occurs.
- HOURLY: Send periodical notifications including all matching activity events that occurred within the hour.
- DAILY: Send periodical notifications including all matching activity events that occurred within the day.
- WEEKLY: Send periodical notifications including all matching activity events that occurred within the week.

name
string

The display name for the subscription.

object (SubscriptionParametersModel)

Parameters specifying the notification sent by the subscription.

object (SubscriptionPatternModel)

The subscription configuration specifying which activities trigger notifications.

Organization Notification JSON Filter Reference
type
string
Enum: "EMAIL" "EMAIL_JSON" "WEB_HOOK"

The way the subscription sends notifications.
Allowed values:
- EMAIL: Send user-friendly, HTML formatted emails whose content includes only the most vital activity event information.
- EMAIL_JSON: Send un-formatted emails whose content includes the entire activity event data.
- WEB_HOOK: Send HTTP POST requests to the URL you specify as the serviceUrl property value of the parameters object.

Responses

Request samples

Content type
application/json
{
  • "description": "Sends a POST HTTP request to http://www.example.com/myendpoint when a refresh operation fails on a specific source.",
  • "enabled": true,
  • "frequency": "LIVE",
  • "name": "Refresh Notifications",
  • "parameters": {
    },
  • "pattern": {
    },
  • "type": "EMAIL"
}

Disable subscription

Disables a subscription from sending notifications in a Coveo organization.

Privilege required

{"owner":"PLATFORM","targetDomain":"SUBSCRIPTION","type":"EDIT","targetId":"{subscriptionId}"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

subscriptionId
required
string
Example: z5zoxmpor75utkwavbyms2ngla

The unique identifier of the subscription to disable.

Responses

Enable subscription

Enables a subscription to send notifications in a Coveo organization.

Privilege required

{"owner":"PLATFORM","targetDomain":"SUBSCRIPTION","type":"EDIT","targetId":"{subscriptionId}"}
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

subscriptionId
required
string
Example: z5zoxmpor75utkwavbyms2ngla

The unique identifier of the subscription to enable.

Responses

Test subscription

Tests a subscription in a Coveo organization.

Privilege required

{"owner":"PLATFORM","targetDomain":"SUBSCRIPTION","type":"EDIT","targetId":"{subscriptionId}"}
Testing a Subscription
Authorizations:
oauth2
path Parameters
organizationId
required
string
Example: mycoveocloudv2organizationg8tp8wu3

The unique identifier of the target organization.

subscriptionId
required
string
Example: z5zoxmpor75utkwavbyms2ngla

The unique identifier of the subscription to test.

Responses