Skip to main content
Server path: /bugsnag-errors | Type: Application | PCID required: Yes

Tools

ToolDescription
bugsnag_errors_bulk_update_errorsBulk Update Errors
bugsnag_errors_configured_integration_testTest a Configured Integration
bugsnag_errors_configured_integrationsGet a Configured Integration
bugsnag_errors_configured_integrations_deleteDelete a Configured Integration
bugsnag_errors_configured_integrations_updateUpdate a Configured Integration
bugsnag_errors_create_comment_on_errorCreate a Comment on an Error
bugsnag_errors_delete_all_errors_in_projectDelete all Errors in a Project
bugsnag_errors_delete_commentDelete a Comment
bugsnag_errors_delete_error_on_projectDelete an Error
bugsnag_errors_delete_event_by_idDelete an Event
bugsnag_errors_get_bucketed_and_unbucketed_trends_on_errorList the Trends for an Error
bugsnag_errors_get_bucketed_and_unbucketed_trends_on_projectList the Trends for a Project
bugsnag_errors_get_integrationsList the supported Integrations
bugsnag_errors_get_pivot_values_on_an_errorList values of a Pivot on an Error
bugsnag_errors_get_pivot_values_on_aprojectList values of a Pivot on a Project
bugsnag_errors_get_pivots_on_aprojectList Pivots on a Project
bugsnag_errors_integrations_testTest an Integration
bugsnag_errors_list_comments_on_errorList Comments on an Error
bugsnag_errors_list_events_on_errorList the Events on an Error
bugsnag_errors_list_events_on_projectList the Events on a Project
bugsnag_errors_list_organization_integration_connectionsList the Integration Connections for an Organization
bugsnag_errors_list_pivots_on_an_errorList Pivots on an Error
bugsnag_errors_list_project_errorsList the Errors on a Project
bugsnag_errors_project_configured_integration_summariesList Summaries of the Configured Integrations for a Project
bugsnag_errors_project_configured_integrationsConfigure an Integration
bugsnag_errors_update_commentUpdate a Comment
bugsnag_errors_update_configured_integrations_trigger_configUpdate a Configured Integration’s Trigger Config
bugsnag_errors_update_error_on_projectUpdate an Error
bugsnag_errors_view_error_on_projectView an Error
bugsnag_errors_view_event_by_idView an Event
bugsnag_errors_view_latest_event_on_errorView the latest Event on an Error

bugsnag_errors_bulk_update_errors

Bulk Update Errors Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
error_idsstring[]YesError Ids
assigned_collaborator_idstringNoThe Collaborator to assign to the Error. Errors may be assigned only to users who have accepted their Bugsnag invitation and have access to the project.
assigned_team_idstringNoThe Team to assign to the Error. Mutually exclusive with assigned_collaborator_id.
issue_titlestringNoIf the Error has a created_issue, the issue_title request field can be set to update the issue’s title.
issue_urlstringNoSpecifies the HTTP link to an external issue when adding or updating a link.
notification_idstringNoID of the issue tracker to use for create_issue and link_issue operations. The most recent issue tracker is used if the parameter is omitted, and no issue tracker is used even if notification_id is set for link_issue operations if verify_issue_url is false.
operationstringYesThe type of update operation to perform. The can be used to change the Error’s workflow state (e.g. marking the Error as fixed). It must be one of the following: * override_severity Set the Error’s severity to the newly supplied severity parameter. * assign Assign the Error to the Collaborator specified by the assigned_collaborator_id parameter. The error will be unassigned if assigned_collaborator_id is blank, the identified Collaborator has not accepted their invitation, or they do not have access to the Error’s Project. * create_issue Create an issue for the Error. If the issue_title parameter is set, the new issue will be created with this title. * link_issue Link the Error to an existing issue. The url should be provided in the issue_url parameter. verify_issue_url can be set to control whether Bugsnag should attempt to verify the issue URL with any configured issue tracker integration. This is the default behavior if verify_issue_url is not supplied. * unlink_issue Remove the link between the Error and its current linked issue. * open Set the Error’s status to open. * snooze Snooze the error per the reopen_rules parameter. * fix Set the Error’s status to fixed. * ignore Ignore the Error. Errors that are ignored and can only be reopened manually. Events are collected, but no notifications are sent. * delete Delete the Error. The Error and all related Events will be removed from Bugsnag. If the error occurs again, it will appear as a new Error with status Open. * discard Discard future Events for this Error. The Error and all existing Events will remain in Bugsnag, but future occurrences of the Error will not be stored by Bugsnag or count toward Event usage limits. * undiscard Undiscard the Error. Future Events will be stored for this Error. This undoes the discard option.
reopen_rulesobjectNoReopen Rules
severitystringNo- info - can be used in manual Bugsnag.notify calls - warning - the default severity when Bugsnag.notify is called manually - error - the default severity for uncaught exceptions and crashes
verify_issue_urlbooleanNoSetting false will prevent Bugsnag from attempting to verify the issue_url with the configured issue tracker when linking an issue. Defaults to true if the parameter is not supplied. If no configured issue tracker the parameter is ignored.

bugsnag_errors_configured_integration_test

Test a Configured Integration Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
componentstringNoComma separated list of components to create the issue in
customFieldsstringNoAdditional JSON-encoded Jira fields
hoststringNoURL of your Jira instance
ignore_tls_validationbooleanNoWhether to ignore TLS validation when making API calls
issueTypestringNoThe type of issue to be created
passwordstringNoAPI token generated for your Jira account (use your password for Jira Server)
project_keystringNoThe project key for the Jira project
user_namestringNoYour Jira email

bugsnag_errors_configured_integrations

Get a Configured Integration Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

bugsnag_errors_configured_integrations_delete

Delete a Configured Integration Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

bugsnag_errors_configured_integrations_update

Update a Configured Integration Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
configurationobjectYesThe configuration value
disable_release_stagesstring[]NoThe release stages that this notification should not be triggered for. Example: { “disable_release_stages”: [“development”, “staging”] }
disable_severitiesstring[]NoThe severities that this notification should not be triggered for.
disable_unhandled_statesstring[]NoThe kinds of exceptions that this notification should not be triggered for.
integration_connection_idstringNoThe id of the integration connection to base this configured integration off of.
issue_automationobjectNoIssue Automation
labelstringNoA label for use in identifying the issue tracker.

bugsnag_errors_create_comment_on_error

Create a Comment on an Error Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project
error_idstringYesID of the Error
messagestringYesThe message value

bugsnag_errors_delete_all_errors_in_project

Delete all Errors in a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id

bugsnag_errors_delete_comment

Delete a Comment Parameters:
ParameterTypeRequiredDefaultDescription
comment_idstringYesID of the comment

bugsnag_errors_delete_error_on_project

Delete an Error Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
error_idstringYesError Id

bugsnag_errors_delete_event_by_id

Delete an Event Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
event_idstringYesEvent Id

List the Trends for an Error Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project
error_idstringYesID of the error
filtersobjectNoThe filters value
filter_groupsobjectNoA map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details.
filter_groups_joinstringNoSearch filters to restrict the events reported in the trend
buckets_countnumberNoNumber of buckets to group trend data into (max 50)
resolutionstringNoThe trend data will be grouped so that each bucket spans the given time period

List the Trends for a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the project
filtersobjectNoSearch filters to restrict the events reported in the trend
filter_groupsobjectNoA map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details.
filter_groups_joinstringNoThe join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied
buckets_countnumberNoNumber of buckets to group trend data into (max 50)
resolutionstringNoThe trend data will be grouped so that each bucket spans the given time period

bugsnag_errors_get_integrations

List the supported Integrations

bugsnag_errors_get_pivot_values_on_an_error

List values of a Pivot on an Error Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
error_idstringYesError Id
event_field_display_idstringYesEvent Field Display Id
filtersobjectNoThe filters value
filter_groupsobjectNoA map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details.
filter_groups_joinstringNoThe join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied
sortstringNoSort order for results
basestringNoThe base value
per_pagenumberNoNumber of results per page

bugsnag_errors_get_pivot_values_on_aproject

List values of a Pivot on a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
event_field_display_idstringYesEvent Field Display Id
filtersobjectNoThe filters value
filter_groupsobjectNoA map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details.
filter_groups_joinstringNoThe join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied
sortstringNoSort order for results
basestringNoThe base value
per_pagenumberNoNumber of results per page

bugsnag_errors_get_pivots_on_aproject

List Pivots on a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
filtersobjectNoThe filters value
filter_groupsobjectNoA map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details.
filter_groups_joinstringNoThe join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied
summary_sizenumberNoSummary Size
pivotsstring[]NoThe pivots value

bugsnag_errors_integrations_test

Test an Integration Parameters:
ParameterTypeRequiredDefaultDescription
configurationobjectYesThe configuration value
keystringYesThe key of the integration service to test. The supported keys can be obtained from /integrations

bugsnag_errors_list_comments_on_error

List Comments on an Error Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesID of the Project
error_idstringYesID of the Error
sortstringNoComments are only sortable by creation time
directionstringNoWhich direction to sort the results by
per_pagenumberNoHow many results to return per page
offsetnumberNoThe pagination offset. This will not typically need to be set manually, as the link header will contain the full url to the next page of results.

bugsnag_errors_list_events_on_error

List the Events on an Error Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
error_idstringYesError Id
basestringNoThe base value
sortstringNoSort order for results
directionstringNoThe direction value
per_pagenumberNoNumber of results per page
filtersobjectNoThe filters value
filter_groupsobjectNoA map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details.
filter_groups_joinstringNoThe join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied
full_reportsbooleanNoFull Reports

bugsnag_errors_list_events_on_project

List the Events on a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
basestringNoThe base value
sortstringNoSort order for results
directionstringNoThe direction value
per_pagenumberNoNumber of results per page
filtersobjectNoThe filters value
filter_groupsobjectNoA map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details.
filter_groups_joinstringNoThe join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied
full_reportsbooleanNoFull Reports

bugsnag_errors_list_organization_integration_connections

List the Integration Connections for an Organization Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringYesID of the organization the integration connections belongs to.
typestringNoThe external software to communicate with. Currently this can only be ‘jira’ or nil.

bugsnag_errors_list_pivots_on_an_error

List Pivots on an Error Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
error_idstringYesError Id
filtersobjectNoThe filters value
filter_groupsobjectNoA map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details.
filter_groups_joinstringNoThe join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied
summary_sizenumberNoSummary Size
pivotsstring[]NoThe pivots value
per_pagenumberNoNumber of results per page

bugsnag_errors_list_project_errors

List the Errors on a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
basestringNoThe base value
sortstringNoSort order for results
directionstringNoThe direction value
per_pageintegerNoNumber of results per page
filtersobjectNoThe filters value
filter_groupsobjectNoA map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details.
filter_groups_joinstringNoThe join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied
histogramstringNoThe type of histogram to include in the response. Only specific values are accepted. When provided, adds trend data to each error in the response.

bugsnag_errors_project_configured_integration_summaries

List Summaries of the Configured Integrations for a Project Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
per_pagenumberNoNumber of results per page
page_tokennumberNoPage Token
categorystringNoThe category value

bugsnag_errors_project_configured_integrations

Configure an Integration Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
configurationobjectYesThe configuration value
disable_release_stagesstring[]NoThe release stages that this notification should not be triggered for. Example: { “disable_release_stages”: [“development”, “staging”] }
disable_severitiesstring[]NoThe severities that this notification should not be triggered for.
disable_unhandled_statesstring[]NoThe kinds of exceptions that this notification should not be triggered for.
integration_connection_idstringNoThe id of the integration connection to base this configured integration off of.
integration_keystringYesKey to identify the integration service.
issue_automationobjectNoIssue Automation
labelstringNoA label for use in identifying the issue tracker.

bugsnag_errors_update_comment

Update a Comment Parameters:
ParameterTypeRequiredDefaultDescription
comment_idstringYesID of the comment
messagestringYesThe updated content of the Comment

bugsnag_errors_update_configured_integrations_trigger_config

Update a Configured Integration’s Trigger Config Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
trigger_config_keystringYesTrigger Config Key
activebooleanYesThe active value
settingsobject[]Nosettings for the trigger

bugsnag_errors_update_error_on_project

Update an Error Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
error_idstringYesError Id
assigned_collaborator_idstringNoThe Collaborator to assign to the Error. Errors may be assigned only to users who have accepted their Bugsnag invitation and have access to the project.
assigned_team_idstringNoThe Team to assign to the Error. Mutually exclusive with assigned_collaborator_id.
issue_titlestringNoIf the Error has a created_issue, the issue_title request field can be set to update the issue’s title.
issue_urlstringNoSpecifies the HTTP link to an external issue when adding or updating a link.
notification_idstringNoID of the issue tracker to use for create_issue and link_issue operations. The most recent issue tracker is used if the parameter is omitted, and no issue tracker is used even if notification_id is set for link_issue operations if verify_issue_url is false.
operationstringYesThe type of update operation to perform. The can be used to change the Error’s workflow state (e.g. marking the Error as fixed). It must be one of the following: * override_severity Set the Error’s severity to the newly supplied severity parameter. * assign Assign the Error to the Collaborator specified by the assigned_collaborator_id parameter. The error will be unassigned if assigned_collaborator_id is blank, the identified Collaborator has not accepted their invitation, or they do not have access to the Error’s Project. * create_issue Create an issue for the Error. If the issue_title parameter is set, the new issue will be created with this title. * link_issue Link the Error to an existing issue. The url should be provided in the issue_url parameter. verify_issue_url can be set to control whether Bugsnag should attempt to verify the issue URL with any configured issue tracker integration. This is the default behavior if verify_issue_url is not supplied. * unlink_issue Remove the link between the Error and its current linked issue. * open Set the Error’s status to open. * snooze Snooze the error per the reopen_rules parameter. * fix Set the Error’s status to fixed. * ignore Ignore the Error. Errors that are ignored and can only be reopened manually. Events are collected, but no notifications are sent. * delete Delete the Error. The Error and all related Events will be removed from Bugsnag. If the error occurs again, it will appear as a new Error with status Open. * discard Discard future Events for this Error. The Error and all existing Events will remain in Bugsnag, but future occurrences of the Error will not be stored by Bugsnag or count toward Event usage limits. * undiscard Undiscard the Error. Future Events will be stored for this Error. This undoes the discard option.
reopen_rulesobjectNoReopen Rules
severitystringNo- info - can be used in manual Bugsnag.notify calls - warning - the default severity when Bugsnag.notify is called manually - error - the default severity for uncaught exceptions and crashes
verify_issue_urlbooleanNoSetting false will prevent Bugsnag from attempting to verify the issue_url with the configured issue tracker when linking an issue. Defaults to true if the parameter is not supplied. If no configured issue tracker the parameter is ignored.

bugsnag_errors_view_error_on_project

View an Error Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
error_idstringYesError Id
filtersobjectNoThe filters value
filter_groupsobjectNoA map of filter groups, where each group is keyed with a unique identifier for the group e.g: { "0": { ... }, "1": { ... } } See the Advanced Filters documentation for more details.
filter_groups_joinstringNoThe join operator to apply between filter groups. - and - All conditions must be satisfied - or (default) - At least one condition must be satisfied

bugsnag_errors_view_event_by_id

View an Event Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesProject Id
event_idstringYesEvent Id

bugsnag_errors_view_latest_event_on_error

View the latest Event on an Error Parameters:
ParameterTypeRequiredDefaultDescription
error_idstringYesError Id