honeycomb_trigger_create
Generate alerts for dataset changes by creating triggers with customizable thresholds, schedules, and notification settings using a specified query or query ID.
Instructions
Create a new trigger for a dataset
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| alert_type | No | Alert firing behavior: on_change (only when crossing threshold) or on_true (every check while threshold is met) | on_change |
| datasetSlug | Yes | Dataset slug to create trigger for | |
| description | No | Description of the trigger (max 1023 chars) | |
| disabled | No | If true, the trigger will not be evaluated or send alerts | |
| evaluation_schedule | No | Schedule configuration when evaluation_schedule_type is 'window' | |
| evaluation_schedule_type | No | The schedule type: frequency (always run) or window (only run during specific times) | |
| frequency | No | Interval in seconds to check results (60-86400, must be multiple of 60) | |
| name | Yes | Name of the trigger (max 120 chars) | |
| query | No | Inline query specification (use either query or query_id, not both) | |
| query_id | No | Query ID to associate with the trigger (use either query_id or query, not both) | |
| recipient_ids | No | Recipient IDs to notify when the trigger fires | |
| threshold | No | Threshold configuration for the trigger |
Input Schema (JSON Schema)
{
"oneOf": [
{
"required": [
"query_id"
]
},
{
"required": [
"query"
]
}
],
"properties": {
"alert_type": {
"default": "on_change",
"description": "Alert firing behavior: on_change (only when crossing threshold) or on_true (every check while threshold is met)",
"enum": [
"on_change",
"on_true"
],
"type": "string"
},
"datasetSlug": {
"description": "Dataset slug to create trigger for",
"type": "string"
},
"description": {
"description": "Description of the trigger (max 1023 chars)",
"type": "string"
},
"disabled": {
"default": false,
"description": "If true, the trigger will not be evaluated or send alerts",
"type": "boolean"
},
"evaluation_schedule": {
"description": "Schedule configuration when evaluation_schedule_type is 'window'",
"type": "object"
},
"evaluation_schedule_type": {
"description": "The schedule type: frequency (always run) or window (only run during specific times)",
"enum": [
"frequency",
"window"
],
"type": "string"
},
"frequency": {
"description": "Interval in seconds to check results (60-86400, must be multiple of 60)",
"maximum": 86400,
"minimum": 60,
"type": "integer"
},
"name": {
"description": "Name of the trigger (max 120 chars)",
"type": "string"
},
"query": {
"description": "Inline query specification (use either query or query_id, not both)",
"type": "object"
},
"query_id": {
"description": "Query ID to associate with the trigger (use either query_id or query, not both)",
"type": "string"
},
"recipient_ids": {
"description": "Recipient IDs to notify when the trigger fires",
"items": {
"type": "string"
},
"type": "array"
},
"threshold": {
"description": "Threshold configuration for the trigger",
"properties": {
"exceeded_limit": {
"description": "Number of times threshold must be met before alerting (1-5)",
"maximum": 5,
"minimum": 1,
"type": "integer"
},
"op": {
"description": "Comparison operator for the threshold",
"enum": [
">",
">=",
"<",
"<="
],
"type": "string"
},
"value": {
"description": "Numeric threshold value",
"type": "number"
}
},
"required": [
"op",
"value"
],
"type": "object"
}
},
"required": [
"datasetSlug",
"name"
],
"type": "object"
}