Triggers let you receive notifications when your data in Honeycomb crosses the thresholds that you configure.
The graph on which to alert is as flexible as a Honeycomb query, which helps reduce false positives due to known errors.Triggers fire
This API allows you to list, create, update, and delete Triggers.
The API key must have the Manage Triggers permission. Learn more about API keys here.
List all triggers on the provided dataset.
OK
Unauthorized
Forbidden
Not Found
Error
[- {
- "id": "string",
- "name": "string",
- "description": "string",
- "threshold": {
- "op": ">",
- "value": 0,
- "exceeded_limit": 1
}, - "frequency": 0,
- "alert_type": "on_change",
- "disabled": false,
- "triggered": true,
- "recipients": [
- {
- "id": "string",
- "type": "pagerduty",
- "target": "string",
- "details": {
- "pagerduty_severity": "string"
}
}
], - "evaluation_schedule_type": "frequency",
- "evaluation_schedule": {
- "window": {
- "days_of_week": [
- "sunday"
], - "start_time": "14:00",
- "end_time": "21:00"
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "query": { },
- "query_id": "string"
}
]
Create a trigger on the provided dataset.
Success - trigger created
The provided request body was invalid. Most APIs will return a DetailedError for this condition, explaining what went wrong, but some older APIs only return a GenericError.
Unauthorized
Not Found
The provided request body was over the maximum allowed size.
Invalid request
{- "name": "string",
- "description": "string",
- "threshold": {
- "op": ">",
- "value": 0,
- "exceeded_limit": 1
}, - "frequency": 0,
- "alert_type": "on_change",
- "disabled": false,
- "recipients": [
- {
- "type": "pagerduty",
- "target": "string",
- "details": {
- "pagerduty_severity": "string"
}
}
], - "evaluation_schedule_type": "frequency",
- "evaluation_schedule": {
- "window": {
- "days_of_week": [
- "sunday"
], - "start_time": "14:00",
- "end_time": "21:00"
}
}, - "query": { }
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "threshold": {
- "op": ">",
- "value": 0,
- "exceeded_limit": 1
}, - "frequency": 0,
- "alert_type": "on_change",
- "disabled": false,
- "triggered": true,
- "recipients": [
- {
- "id": "string",
- "type": "pagerduty",
- "target": "string",
- "details": {
- "pagerduty_severity": "string"
}
}
], - "evaluation_schedule_type": "frequency",
- "evaluation_schedule": {
- "window": {
- "days_of_week": [
- "sunday"
], - "start_time": "14:00",
- "end_time": "21:00"
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "query": { },
- "query_id": "string"
}
Fetch details for a single Trigger by Trigger ID.
Success
Unauthorized
Not Found
{- "id": "string",
- "name": "string",
- "description": "string",
- "threshold": {
- "op": ">",
- "value": 0,
- "exceeded_limit": 1
}, - "frequency": 0,
- "alert_type": "on_change",
- "disabled": false,
- "triggered": true,
- "recipients": [
- {
- "id": "string",
- "type": "pagerduty",
- "target": "string",
- "details": {
- "pagerduty_severity": "string"
}
}
], - "evaluation_schedule_type": "frequency",
- "evaluation_schedule": {
- "window": {
- "days_of_week": [
- "sunday"
], - "start_time": "14:00",
- "end_time": "21:00"
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "query": { },
- "query_id": "string"
}
Update a trigger by specifying the trigger ID and the same fields used when creating a new trigger.
Success
Error
Unauthorized
Not Found
Invalid request
{- "name": "string",
- "description": "string",
- "threshold": {
- "op": ">",
- "value": 0,
- "exceeded_limit": 1
}, - "frequency": 0,
- "alert_type": "on_change",
- "disabled": false,
- "recipients": [
- {
- "type": "pagerduty",
- "target": "string",
- "details": {
- "pagerduty_severity": "string"
}
}
], - "evaluation_schedule_type": "frequency",
- "evaluation_schedule": {
- "window": {
- "days_of_week": [
- "sunday"
], - "start_time": "14:00",
- "end_time": "21:00"
}
}, - "query": { },
- "query_id": "string"
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "threshold": {
- "op": ">",
- "value": 0,
- "exceeded_limit": 1
}, - "frequency": 0,
- "alert_type": "on_change",
- "disabled": false,
- "triggered": true,
- "recipients": [
- {
- "id": "string",
- "type": "pagerduty",
- "target": "string",
- "details": {
- "pagerduty_severity": "string"
}
}
], - "evaluation_schedule_type": "frequency",
- "evaluation_schedule": {
- "window": {
- "days_of_week": [
- "sunday"
], - "start_time": "14:00",
- "end_time": "21:00"
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "query": { },
- "query_id": "string"
}
Delete a trigger by specifying the trigger ID. The body of the DELETE request should be empty.
Success - no content
Unauthorized
Not Found
{- "error": "unknown API key - check your credentials"
}
List all triggers that will alert a given Recipient. Important: This request will return all Triggers associated with the specific Recipient across your entire Honeycomb team rather than being scoped to a dataset or environment.
Success
Unauthorized
Not Found
Error
{- "id": "string",
- "name": "string",
- "description": "string",
- "threshold": {
- "op": ">",
- "value": 0,
- "exceeded_limit": 1
}, - "frequency": 0,
- "alert_type": "on_change",
- "disabled": false,
- "triggered": true,
- "recipients": [
- {
- "id": "string",
- "type": "pagerduty",
- "target": "string",
- "details": {
- "pagerduty_severity": "string"
}
}
], - "evaluation_schedule_type": "frequency",
- "evaluation_schedule": {
- "window": {
- "days_of_week": [
- "sunday"
], - "start_time": "14:00",
- "end_time": "21:00"
}
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "query": { },
- "query_id": "string"
}