Alerts
An alert in the Collate UI is an event subscription in the API. Use these endpoints to create, update, and delete alerts as code, and to inspect what an alert has delivered.Create an Alert
Create an alert, or create or update it by name, with a source, filters, triggers, and destinations.
List and Retrieve Alerts
List alerts, read one, look up available filters and triggers, and inspect delivery status.
Update an Alert
Change an alert with JSON Patch or by sending the full definition again.
Delete an Alert
Delete an alert and its delivery records.
Endpoints
Base path:/v1/events/subscriptions
Permissions
Creating an alert requires Create permission on theEventSubscription entity. Deleting requires Delete, and reading delivery status requires view access to all alerts. See Roles and Policies.
Alert Types
SetalertType to one of the following when you create an alert:
The values
ActivityFeed, GovernanceWorkflowChangeEvent, and Custom are used by system subscriptions. Don’t create alerts with them.
Request Schema
The request body for create and create-or-update is aCreateEventSubscription object.
Observability or Notification. See Alert Types.The alert sources, for example
["testCase"] or ["pipeline", "ingestionPipeline"]. Provide at least one value. Use lowercase all to match every source on a Notification alert. To check which sources you can combine and what they support, see Available Sources, Filters, and Triggers.Where to deliver the alert. See Destination.
Stored with each failed event record. Collate doesn’t use it to redeliver. See Webhook Payloads and Delivery.
Entity reference to a user-created notification template. Applies to Slack, Teams, Google Chat, and Email destinations.
Argument Input
Each filter and trigger is an object with these fields:Name of the filter or trigger, for example
filterByFqn or GetTestCaseStatusUpdates. Valid names depend on the sources. To look them up, see Available Sources, Filters, and Triggers.Values for the filter or trigger. Each item is
{ "name": "<argument name>", "input": ["<value>", ...] }. Every argument the filter or trigger defines must have at least one value.400 error when:
- You provide no source.
- You combine
allwith other sources. - You combine sources of different kinds, such as
tableandconversation. - A filter isn’t supported by every source, or a trigger isn’t supported by any source.
- A required argument is empty.
Destination
Each item indestinations has these fields:
Who receives the alert:
External, Admins, Owners, Followers, Assignees, Mentions, Users, or Teams.Alerts that the API returns also include read-only fields such as
id, version, filteringRules (the filters and triggers expanded into conditions), and statusDetails on each destination.