Defines the schema for activity types within incidents in BigPanda
API Endpoint | https://api.bigpanda.io/resources/v2.0/incidents/{incident_id}/activities |
Supported Methods | 'GET` |
General Parameters
The Activity object includes the following attributes. Many activity types include additional parameters included in the schema.
Parameter | Description | Type | Example |
---|---|---|---|
id | System-generated unique identifier for the activity | String | "id": "60800a8012d7dd0464f1b87d" |
type | The type of activity | String | "type" : "incident_created" |
timestamp | Unix time when the activity occurred in system | Timestamp (in seconds) | "timestamp": 1466416853 |
created_by | User ID of the user who manually took action | String | "created_by":"234234234242892734" |
params | Additional parameters according to the type | Object | "params": { |
Type-Specific Parameters
Each activity type has type-specific parameters included in the schema. These parameters will only be included for the relevant activity types.
Activity Type | Description | Additional Parameters | Example |
---|---|---|---|
incident_assigned | A specific user was assigned responsibility to see the incident through resolution | assignee object: | "assignee": { |
incident_become_flapping | The incident entered or exited the flapping state in which at least one correlated alert is changing states too frequently | flapping (true/false)
| "flapping": true, |
incident_commented | A comment was added to the incident | comment - the comment string added to the incident | "comment": "An Example Comment" |
incident_resolved_ui_manually | The incident was resolved by a user through the BigPanda UI | annotation - an optional comment added to the resolver action | "annotation": "An Example Comment" |
incident_resolved_api | The incident was resolved by an API call | annotation - an optional comment added to the resolver action | "annotation": "An Example Comment" |
incident_alerts_resolved | One or more of the alerts within the incident were manually resolved | annotation - an optional comment added to the resolver action | "annotation": "An Example Comment" |
incident_tag_removed | An incident tag was removed from the incident | tag_id - system-generated unique identifier for the incident tag | "tag_id": "itd_priority_1", |
incident_tag_updated | An incident tag was added to the incident | tag_id - system-generated unique identifier for the incident tag | "tag_id": "itd_priority_1", |
incident_merged_destination | The incident was the destination of a merge action | source_incident_ids - A list of incidents that were merged into this destination incident | "source_incident_ids": [ "5fef495e55f63f465ce39b5a", |
incident_merged_source | The incident was merged into a different incident | targetIncidentId - The destination incident this incident was merged into | "targetIncidentId": "5fef49c829e14c2d52c5623c", |
incident_created | The incident was created in the system | None | |
incident_rcc_update | The relationship between the incident and a potential root cause change match was updated | change object: | "change": { "suggested_by_bigpanda": false |
incident_shared | The incident was shared to an external channel | share_target - the channel or address the incident was sent to | "share_target": "webhook.whtest", |
incident_snoozed | The incident was snoozed | annotation - an optional comment added to the snooze action | "annotation": "An Example Comment" |
incident_splitted_destination | The incident was created from a subset of alerts as part of a split action | alert_ids - a list of the ID of each alert that was moved into this new incident | "alert_ids": [ "60079deb82b0b2418470cacd" |
incident_splitted_source | One or more alerts within the incident were split into a new incident | alert_ids - a list of the ID of each alert that was moved into the new incident | "alert_ids": [ |
incident_unassigned | The user assigned responsibility to see the incident through resolution was removed | unassigned_on_reopen (true/false) - whether the incident was unassigned through the incident reopen process | "unassigned_on_reopen": false |
incident_unsnoozed | The incident had the snooze status removed | None | |
incident_reopened | The incident reopened within BigPanda | None | |
incident_resolved_by_alerts | The incident was resolved automatically by BigPanda when all associated alerts received an 'ok' status | None |