activator_create_trigger
Destructive
Create an alert that triggers when new data appears in a KQL database. Configure the KQL query, alert recipients, and polling frequency to monitor data sources in real time.
Instructions
Use this tool create an alert that will fire when the source generates data.
:param workspace_id: The workspace ID (UUID)
:param trigger_name: Name of the trigger
:param kql_cluster_url: The KQL cluster URL
:param kql_database: The KQL database name
:param kql_query: The KQL query to monitor. The query MUST be appropriate for the schema of the underlying
data, otherwise the alert will not function correctly
:param alert_recipient: Email address of the alert recipient
:param alert_message: Alert message for the trigger
:param alert_headline: Alert headline for the trigger
:param alert_type: Type of alert - "teams" or "email" (defaults to "teams")
:param kql_polling_frequency_minutes: Polling frequency in minutes. Must be one of: 5, 15, 60, 180, 360, 720,
1440 (defaults to 5)
:param artifact_id: If specified, the trigger will be created in the specified Activator artifact.
If left blank, a new Activator artifact will be created.
:return: Created trigger details:
* url: URL back to the trigger in Fabric UI for further management
* id: Artifact ID if a new one was created
* displayName: Name of newly created trigger
Critical:
* This API call will NOT tell the caller if a KQL query is used which does not match the source data schema,
so any KQL query should be double-checked upfront.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kql_query | Yes | ||
| alert_type | No | teams | |
| artifact_id | No | ||
| kql_database | Yes | ||
| trigger_name | Yes | ||
| workspace_id | Yes | ||
| alert_message | Yes | ||
| alert_headline | Yes | ||
| alert_recipient | Yes | ||
| kql_cluster_url | Yes | ||
| kql_polling_frequency_minutes | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||