Explore documentation
Reporting
Incident logs integration
The Incident Log integration allows you to send detailed audit logs of various events related to your monitors, heartbeats, and incidents to an external logging service via webhooks. Each event is formatted as a JSON payload, providing comprehensive information about what happened, when, and to which resource.
Each payload includes common fields:
| Field | Type | Description |
|---|---|---|
dt |
String | ISO 8601 formatted timestamp of when the event occurred. |
event |
String | The type of event (e.g., monitor.created, incident.started). |
message |
String | A human-readable message describing the event. |
organization_id |
String | The Better Stack ID of the organization the event originated from. |
team_id |
String | The Better Stack ID of the team the event originated from. |
Monitor Events
Events related to your uptime monitors.
'monitor.checked'
Triggered when a monitor performs a check.
| Field | Type | Description |
|---|---|---|
monitor_id |
Integer | The ID of the monitor. |
monitor_url |
String | The URL being monitored. |
monitor_name |
String | The name of the monitor. |
monitor_type |
String | The type of monitor (e.g., status, keyword, ping). |
region |
String | The region from which the check was performed (e.g., eu-central-1). |
response_time |
Float | The response time of the check in seconds. |
response_code |
Integer | The HTTP response code received (if applicable). |
success |
Boolean | true if the check was successful, false otherwise. |
cause |
String | The cause of failure if the check was unsuccessful. |
monitor.created
Triggered when a monitor is created.
| Field | Type | Description |
|---|---|---|
monitor_id |
Integer | The ID of the monitor. |
monitor_url |
String | The URL being monitored. |
monitor_name |
String | The name of the monitor. |
monitor_type |
String | The type of monitor (e.g., status, keyword, ping). |
monitor.destroyed
Triggered when a monitor is deleted.
| Field | Type | Description |
|---|---|---|
monitor_id |
Integer | The ID of the monitor. |
monitor_url |
String | The URL being monitored. |
monitor_name |
String | The name of the monitor. |
monitor_type |
String | The type of monitor (e.g., status, keyword, ping). |
monitor.down
Triggered when a monitor goes down.
| Field | Type | Description |
|---|---|---|
monitor_id |
Integer | The ID of the monitor. |
monitor_url |
String | The URL being monitored. |
monitor_name |
String | The name of the monitor. |
monitor_type |
String | The type of monitor (e.g., status, keyword, ping). |
cause |
String | The cause of the downtime. |
regions |
Array | An array of regions reporting the downtime. |
monitor.paused
Triggered when a monitor is paused.
| Field | Type | Description |
|---|---|---|
monitor_id |
Integer | The ID of the monitor. |
monitor_url |
String | The URL being monitored. |
monitor_name |
String | The name of the monitor. |
monitor_type |
String | The type of monitor (e.g., status, keyword, ping). |
monitor.unpaused
Triggered when a monitor is unpaused.
| Field | Type | Description |
|---|---|---|
monitor_id |
Integer | The ID of the monitor. |
monitor_url |
String | The URL being monitored. |
monitor_name |
String | The name of the monitor. |
monitor_type |
String | The type of monitor (e.g., status, keyword, ping). |
monitor.verifying_recovery
Triggered when a monitor is verifying recovery.
| Field | Type | Description |
|---|---|---|
monitor_id |
Integer | The ID of the monitor. |
monitor_url |
String | The URL being monitored. |
monitor_name |
String | The name of the monitor. |
monitor_type |
String | The type of monitor (e.g., status, keyword, ping). |
Heartbeat Events
Events related to your heartbeats.
heartbeat.checked
Triggered when a heartbeat checks in.
| Field | Type | Description |
|---|---|---|
heartbeat_id |
Integer | The ID of the heartbeat. |
heartbeat_name |
String | The name of the heartbeat. |
success |
Boolean | true if the check-in was successful, false otherwise. |
fail_code |
String | The failure code if the check-in was unsuccessful. |
heartbeat.created
Triggered when a heartbeat is created.
| Field | Type | Description |
|---|---|---|
heartbeat_id |
Integer | The ID of the heartbeat. |
heartbeat_name |
String | The name of the heartbeat. |
heartbeat.destroyed
Triggered when a heartbeat is deleted.
| Field | Type | Description |
|---|---|---|
heartbeat_id |
Integer | The ID of the heartbeat. |
heartbeat_name |
String | The name of the heartbeat. |
heartbeat.down
Triggered when a heartbeat goes down (missed).
| Field | Type | Description |
|---|---|---|
heartbeat_id |
Integer | The ID of the heartbeat. |
heartbeat_name |
String | The name of the heartbeat. |
heartbeat.paused
Triggered when a heartbeat is paused.
| Field | Type | Description |
|---|---|---|
heartbeat_id |
Integer | The ID of the heartbeat. |
heartbeat_name |
String | The name of the heartbeat. |
heartbeat.unpaused
Triggered when a heartbeat is unpaused.
| Field | Type | Description |
|---|---|---|
heartbeat_id |
Integer | The ID of the heartbeat. |
heartbeat_name |
String | The name of the heartbeat. |
heartbeat.up
Triggered when a heartbeat comes back up.
| Field | Type | Description |
|---|---|---|
heartbeat_id |
Integer | The ID of the heartbeat. |
heartbeat_name |
String | The name of the heartbeat. |
Incident Events
Events related to incidents.
incident.acknowledged
Triggered when an incident is acknowledged.
| Field | Type | Description |
|---|---|---|
incident_id |
Integer | The ID of the incident. |
incident_name |
String | The name of the incident. |
resource_type |
String | The type of resource causing the incident (e.g., monitor, heartbeat). |
resource_id |
Integer | The ID of the resource causing the incident. |
resource_name |
String | The name of the resource causing the incident. |
user_email |
String | The email of the user who acknowledged the incident (if applicable). |
user_name |
String | The name of the user who acknowledged the incident (if applicable). |
integration_name |
String | The name of the integration that acknowledged the incident (if applicable). |
integration_type |
String | The type of integration that acknowledged the incident (if applicable). |
incident.destroyed
Triggered when an incident is deleted.
| Field | Type | Description |
|---|---|---|
incident_id |
Integer | The ID of the incident. |
incident_name |
String | The name of the incident. |
resource_type |
String | The type of resource causing the incident. |
resource_id |
Integer | The ID of the resource causing the incident. |
resource_name |
String | The name of the resource causing the incident. |
incident.escalated
Triggered when an incident is escalated.
| Field | Type | Description |
|---|---|---|
incident_id |
Integer | The ID of the incident. |
incident_name |
String | The name of the incident. |
resource_type |
String | The type of resource causing the incident. |
resource_id |
Integer | The ID of the resource causing the incident. |
resource_name |
String | The name of the resource causing the incident. |
escalation_targets |
Array | An array of objects, each describing an escalation target. Each object has type (e.g., user, team), id, and name. |
incident.grouped
Triggered when an incident is grouped.
| Field | Type | Description |
|---|---|---|
incident_id |
Integer | The ID of the incident. |
incident_name |
String | The name of the incident. |
resource_type |
String | The type of resource causing the incident. |
resource_id |
Integer | The ID of the resource causing the incident. |
resource_name |
String | The name of the resource causing the incident. |
incident_group_id |
Integer | The ID of the incident group the incident was added to. |
incident.reopened
Triggered when an incident is reopened.
| Field | Type | Description |
|---|---|---|
incident_id |
Integer | The ID of the incident. |
incident_name |
String | The name of the incident. |
resource_type |
String | The type of resource causing the incident. |
resource_id |
Integer | The ID of the resource causing the incident. |
resource_name |
String | The name of the resource causing the incident. |
user_email |
String | The email of the user who reopened the incident (if applicable). |
user_name |
String | The name of the user who reopened the incident (if applicable). |
integration_name |
String | The name of the integration that reopened the incident (if applicable). |
integration_type |
String | The type of integration that reopened the incident (if applicable). |
incident.resolved
Triggered when an incident is resolved.
| Field | Type | Description |
|---|---|---|
incident_id |
Integer | The ID of the incident. |
incident_name |
String | The name of the incident. |
resource_type |
String | The type of resource causing the incident. |
resource_id |
Integer | The ID of the resource causing the incident. |
resource_name |
String | The name of the resource causing the incident. |
user_email |
String | The email of the user who resolved the incident (if applicable). |
user_name |
String | The name of the user who resolved the incident (if applicable). |
integration_name |
String | The name of the integration that resolved the incident (if applicable). |
integration_type |
String | The type of integration that resolved the incident (if applicable). |
incident.started
Triggered when an incident starts.
| Field | Type | Description |
|---|---|---|
incident_id |
Integer | The ID of the incident. |
incident_name |
String | The name of the incident. |
resource_type |
String | The type of resource causing the incident. |
resource_id |
Integer | The ID of the resource causing the incident. |
resource_name |
String | The name of the resource causing the incident. |
incident_cause |
String | The cause of the incident. |
regions |
Array | An array of regions reporting the incident. |
escalation_policy_id |
Integer | The ID of the escalation policy triggered by the incident. |