Organization Notification JSON Filter Reference

When creating a configuration on the Notifications page, you must provide a JSON configuration indicating of which activities you want to be notified.

All values must appear between quotation marks (") and be separated by a comma (,).

Content Object

Leave the content object empty, unless you want your notification to target one or more specific resources, such as sources, query pipelines, and machine learning models.

You want to target only a certain source. In such a case, use the sourceId property.

With the following configuration, you will be notified of successful refreshes of source besttechsz5jzmj5-uno7vnbrvgd5fruo5i3rl3cjea.

{
  "content":{
    "sourceId":"besttechsz5jzmj5-uno7vnbrvgd5fruo5i3rl3cjea"
  },
  "operations":[
    "REFRESH"
  ],
  "resourceTypes":[
    "SOURCE"
  ],
  "resultTypes":[
    "SUCCESS"
  ]
}

Operations Array

An activity operation identifies the action performed on the Coveo Platform module (i.e., resource type) from which an event originates.

In the operations array, enter the operations of which you want to be notified when they apply to the target resources (see ResourceTypes Array).

The following table lists all possible activity operations along with their corresponding name in the Coveo Cloud Administration Console, and the activity resource types they’re typically performed on.

Operation Name in the Coveo Cloud Administration Console Typically performed on
* All Anything
BACKUP Backup ORGANIZATION resource type.
CHANGE_ONLINE Change online Internal Coveo resource types.
CHANGE_READ_ONLY Read/write status switch ORGANIZATION resource type.
COMMIT Commit Internal Coveo resource types.
CONFIG_CHANGE Configuration edit SECURITY_PROVIDER and SOURCE resource types.
CONFIG_CREATE Initial configuration Internal Coveo resource types.
CREATE Addition Most resource types.
DELETE Deletion Most resource types.
DISABLE Deactivation API_KEY resource type.
DUPLICATE Duplication ORGANIZATION resource type.
ENABLE Enable API_KEY resource type.
ENABLE_DISABLED_ENTITIES Enable disabled entities SECURITY_CACHE resource type.
FULL_REFRESH Rescan SOURCE resource type.
IDLE Idle Internal Coveo resource types.
IMPORT Import Internal Coveo resource types.
INCREMENTAL_REFRESH Refresh SOURCE resource type.
LIMIT_REACHED Limit reached Most resource types.
ORG_PROVISIONING_CHECK Provisioning wait SOURCE resource type.
PAUSE Pause SOURCE resource type.
PAUSE_ON_ERROR Pause on error SOURCE resource type.
REBUILD Initial build SOURCE resource type.
REFRESH Refresh SECURITY_CACHE and SECURITY_PROVIDER resource types.
REFRESH_CANCEL Refresh cancellation SOURCE resource type.
REFRESH_ENTITY Security identity refresh SECURITY_PROVIDER resource type.
REFRESH_ENTITIES_IN_ERROR Refresh SECURITY_CACHE resource type.
RESIZE Resize Internal Coveo resource types.
RESTORE Restore Internal Coveo resource types.
RESUME Resume SOURCE resource type.
SCHEDULE_CHANGE Schedule edit SECURITY_CACHE and SOURCE resource types.
SCHEDULE_CREATE Schedule addition SECURITY_CACHE and SOURCE resource types.
SCHEDULE_DELETE Schedule deletion SECURITY_CACHE and SOURCE resource types.
START Start Internal Coveo resource types.
STOP Stop Internal Coveo resource types.
SYNCHRONIZE Synchronization FIELD resource type.
TEST Test EXTENSION resource type.
UPDATE Update Most resource types.
UPGRADE Upgrade Internal Coveo resource types.

With the following configuration, you receive a notification for any source failing to update (see Refresh VS Rescan VS Rebuild).

{
  "content":{},
  "operations":[
    "REFRESH", "FULL_REFRESH", "REBUILD"
  ],
  "resourceTypes":[
    "SOURCE"
  ],
  "resultTypes":[
    "ERROR"
  ]
}

If you attempt to pass an invalid operation, the Notifications API returns an error code along with a message containing the accepted operations. Access this message by opening your web browser developer tools and inspecting the Notification API response.

errorCode: "INVALID_SUBSCRIPTION"
message: "A subscription must specify valid 'operations'. The following are invalid : '[myInvalidActivity]'. Accepted operations are: '[REFRESH_CANCEL, CREATE, REFRESH, REFRESH_ENTITY, PAUSE_ON_ERROR, RESUME, CHANGE_ONLINE, PAUSE, BACKUP, IMPORT, DELETE, SYNCHRONIZE, DUPLICATE, SCHEDULE_CREATE, SEARCH_CERTIFICATE_UPDATE, RESIZE, RESTORE, UPDATE, REFRESH_ENTITIES_NOT_UPDATED, DISABLE, CHANGE_READ_ONLY, COMMIT, STOP, REFRESH_ENTITIES_IN_ERROR, FULL_REFRESH, CONFIG_CREATE, INCREMENTAL_REFRESH, ORG_PROVISIONING_CHECK, ENABLE, SCHEDULE_DELETE, SCHEDULE_CHANGE, LIMIT_REACHED, ENABLE_DISABLED_ENTITIES, TEST, IDLE, UPGRADE, START, CONFIG_CHANGE, REBUILD]' or '*' for all values."
requestID: "6h625j3c-ge34-7352-7d32-sd65dlvoedn3"

ResourceTypes Array

An activity resource type identifies the Coveo Platform module from which an event originates.

In the resourceTypes array, enter the resources affected by the operations you selected (see Operations Array).

The following table lists the most common activity resource types along with their corresponding name in the Coveo Cloud Administration Console, a short description, and the activity operations they’re typically associated with.

Resource type Name in the Coveo Cloud Administration Console Resource description Typical operations
* All All resources.
  • Anything.
API_KEY Api access An API key in a Coveo organization.
  • CREATE
  • DELETE
  • ENABLE
  • DISABLE
  • LIMIT_REACHED
  • UPDATE
CATALOG Catalog A Coveo commerce catalog in a Coveo organization.
  • CREATE
  • DELETE
  • UPDATE
CONDITION Condition A condition on a query pipeline in a Coveo organization.
  • CREATE
  • DELETE
  • UPDATE
CRAWLING_MODULE Crawling Module A Crawling Module component in a Coveo organization.
  • CREATE
  • DELETE
  • UPDATE
CUSTOM_DIMENSIONS Custom dimensions The custom Coveo Usage Analytics (Coveo UA) dimensions in a Coveo organization.
  • CREATE
  • DELETE
  • LIMIT_REACHED
  • UPDATE
EXPORTS Exports The Coveo UA exports in a Coveo organization.
  • CREATE
  • DELETE
  • LIMIT_REACHED
  • UPDATE
EXPORT_SCHEDULES Export schedules The Coveo UA export schedules in a Coveo organization.
  • CREATE
  • DELETE
  • LIMIT_REACHED
  • UPDATE
EXTENSION Extension An indexing pipeline extension (IPE) in a Coveo organization.
  • CREATE
  • DELETE
  • LIMIT_REACHED
  • TEST
  • UPDATE
FIELD Field A field in the index of a Coveo organization.
  • CREATE
  • DELETE
  • UPDATE
  • SYNCHRONIZE
GROUP Group A group of users with certain privileges in a Coveo organization.
  • CREATE
  • DELETE
  • LIMIT_REACHED
  • UPDATE
IN PRODUCT EXPERIENCE In-Product Experience An In-Product Experience (IPX) interface in a Coveo organization.
  • CREATE
  • DELETE
  • UPDATE
LICENSE License The license of a Coveo organization.
  • UPDATE
MAPPING Mapping A mapping on a source in a Coveo organization.
  • LIMIT_REACHED
  • UPDATE
MODEL Model A Coveo Machine Learning (Coveo ML) model in a Coveo organization.
  • CREATE
  • DELETE
  • UPDATE
NAMED_FILTERS Named filters The Coveo UA named filters in a Coveo organization.
  • CREATE
  • DELETE
  • LIMIT_REACHED
  • UPDATE
ORGANIZATION Organization A Coveo organization.
  • BACKUP
  • CHANGE_READ_ONLY
  • CREATE
  • DELETE
  • DUPLICATE
  • UPDATE
PERMISSION_FILTERS Permission filters The Coveo UA permission filters in a Coveo organization.
  • CREATE
  • DELETE
  • LIMIT_REACHED
  • UPDATE
PIPELINE Pipeline A query pipeline in a Coveo organization.
  • CREATE
  • DELETE
  • UPDATE
REPORTS Reports The Coveo UA reports in a Coveo organization.
  • CREATE
  • DELETE
  • LIMIT_REACHED
  • UPDATE
RULE Rule A query pipeline statement in a Coveo organization.
  • CREATE
  • DELETE
  • UPDATE
SAML_IDENTITY_PROVIDER SSO identity providers A SAML 2.0 single sign-on provider in a Coveo organization.
  • CREATE
  • DELETE
  • UPDATE
SEARCH_PAGE Search page A hosted search page in a Coveo organization.
  • CREATE
  • DELETE
  • UPDATE
SECURITY_CACHE Security identities The security identity cache of a Coveo organization.
  • REFRESH
  • REFRESH_ENTITIES_IN_ERROR
  • SCHEDULE_CREATE
  • SCHEDULE_DELETE
SECURITY_PROVIDER Identity provider A security identity provider in a Coveo organization.
  • CONFIG_CHANGE
  • CREATE
  • DELETE
  • LIMIT_REACHED
  • REFRESH
  • REFRESH_ENTITY
  • UPDATE
SOURCE Source A source in a Coveo organization.
  • CONFIG_CHANGE
  • CREATE
  • DELETE
  • FULL_REFRESH
  • INCREMENTAL_REFRESH
  • LIMIT_REACHED
  • ORG_PROVISIONING_CHECK
  • PAUSE
  • PAUSE_ON_ERROR
  • REBUILD
  • REFRESH_CANCEL
  • RESUME
  • SCHEDULE_CHANGE
  • SCHEDULE_CREATE
  • SCHEDULE_DELETE
  • UPDATE
SUBSCRIPTION Subscription A subscription to certain activities in a Coveo organization.
  • CREATE
  • DELETE
  • LIMIT_REACHED
  • UPDATE
TEMPORARY_ACCESS Temporary access A temporary access granted in a Coveo organization.
  • CREATE
  • DEACTIVATE
TEMPORARY_ACCESS_REQUEST Temporary access request A temporary access request in a Coveo organization.
  • CREATE
  • UPDATE

With the following configuration, you will be notified of any field or mapping deletion attempt, regardless of whether it’s successful, aborted, or resulting in an error.

{
  "content":{},
  "operations":[
    "DELETE"
  ],
  "resourceTypes":[
    "FIELD", "MAPPING"
  ],
  "resultTypes":[
    "*"
  ]
}

To get the exhaustive list of resources available in your organization, you can access the user notification panel, which provides a drop-down menu containing this information (see Add or Edit a User Notification).

Alternatively, assuming you have developer skills, you can use the Activity API GET /rest/organizations/{organizationId}/activities/resourcetypes endpoint. Ensure that you’re using an access token with the Organization - Activities - View privilege.

Requesting a List of All Available Resources in an Organization

POST https://platform.cloud.coveo.com/rest/organizations/myOrganizationId/activities/resourcetypes HTTP/1.1
 
Authorization: Bearer **********-****-****-****-************

Successful response - 200

[
  "SECURITY_PROVIDER",
  "EXTENSION",
  "ORGANIZATION",
  "AGENT",
  "GROUP",
  "SEARCHAPI_ORGANIZATION",
  "API_KEY",
  "REPORTS",
  "MAPPING",
  "RULE",
  "PIPELINE",
  "EXPORTS",
  "INDEX",
  "CLUSTER",
  "LICENSE",
  "ENDPOINT_REFRESH",
  "FIELD",
  "NODE",
  "SUBSCRIPTION",
  "SECURITY_CACHE",
  "MODEL",
  "SWAP_PIPELINE",
  "SEARCH_PAGE",
  "SOURCE",
  "CONDITION"
]

ResultTypes Array

In the resultTypes array, enter the operation results of which you want to be notified (see Operations Array).

The possible values are the following:

Result type Description
* All
ABORT Aborted
ERROR Failed
SUCCESS Successful

With the following configuration, you receive a notification for any non successful source update (see Refresh VS Rescan VS Rebuild).

{
  "content":{},
  "operations":[
    "REFRESH", "FULL_REFRESH", "REBUILD"
  ],
  "resourceTypes":[
    "SOURCE"
  ],
  "resultTypes":[
    "ABORT", "ERROR"
  ]
}
Recommended Articles