Bugsnag · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for BugSnag - Data Access Integrations API
11 actions
11 updates
phrasing
extends
openapi/bugsnag-integrations-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Bugsnag's API. It is a proposal applied on top of the contract, not a document Bugsnag publishes.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/integrations'].get
$.paths['/integrations/test'].post
$.paths['/configured_integrations/{id}'].get
$.paths['/configured_integrations/{id}'].delete
$.paths['/configured_integrations/{id}'].patch
$.paths['/configured_integrations/{id}/trigger_configs/{trigger_config_key}'].patch
$.paths['/configured_integrations/{id}/test'].post
$.paths['/projects/{project_id}/configured_integrations'].post
$.paths['/projects/{project_id}/configured_integration_summaries'].get
$.paths['/organizations/{organization_id}/integration_connections'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for BugSnag - Data Access Integrations API
version: 1.0.0
extends: openapi/bugsnag-integrations-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 10
- target: $.paths['/integrations'].get
update:
x-apievangelist-phrasing:
intent: List supported integration types
effect: read
questions:
- Which integrations does BugSnag support?
- What fields do I need to fill in to set up a given integration type?
instructions:
- text: List every integration BugSnag supports and its setup fields.
- text: Show the catalog of available integrations.
method: generated
generated: '2026-09-26'
- target: $.paths['/integrations/test'].post
update:
x-apievangelist-phrasing:
intent: Test integration settings before saving
effect: write
questions:
- Can I try out integration credentials before I actually configure them?
- Will testing an unsaved issue-tracker setup create a test issue?
instructions:
- text: Test the {key} integration with configuration {configuration} without saving it.
slots:
key: requestBody.key
configuration: requestBody.configuration
- text: Dry-run a {key} integration using settings {configuration}.
slots:
key: requestBody.key
configuration: requestBody.configuration
method: generated
generated: '2026-09-26'
- target: $.paths['/configured_integrations/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a configured integration
effect: read
questions:
- What are the full settings of an integration already set up on a project?
- How do I view one configured integration in detail?
instructions:
- text: Show configured integration {id}.
slots:
id: path.id
- text: Get the full configuration of integration {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/configured_integrations/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a configured integration
effect: destructive
questions:
- How do I disconnect an integration from a project?
- Can I remove a configured integration entirely?
instructions:
- text: Delete configured integration {id}.
slots:
id: path.id
- text: Remove the integration configuration {id} from its project.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/configured_integrations/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a configured integration
effect: write
questions:
- Can I change the settings of an integration I already set up?
- How do I stop an existing integration from firing for certain severities or release stages?
instructions:
- text: Update configured integration {id} with configuration {configuration}.
slots:
id: path.id
configuration: requestBody.configuration
- text: Relabel configured integration {id} as {label} using configuration {configuration}.
slots:
id: path.id
label: requestBody.label
configuration: requestBody.configuration
method: generated
generated: '2026-09-26'
- target: $.paths['/configured_integrations/{id}/trigger_configs/{trigger_config_key}'].patch
update:
x-apievangelist-phrasing:
intent: Set an integration's automatic trigger
effect: write
questions:
- Can I make an integration act automatically when a certain condition is met?
- How do I turn a specific trigger on or off for a configured integration?
instructions:
- text: 'Turn trigger {trigger_config_key} on integration {id} active: {active}.'
slots:
trigger_config_key: path.trigger_config_key
id: path.id
active: requestBody.active
- text: Configure trigger {trigger_config_key} on integration {id} with settings {settings} and active {active}.
slots:
trigger_config_key: path.trigger_config_key
id: path.id
settings: requestBody.settings
active: requestBody.active
method: generated
generated: '2026-09-26'
- target: $.paths['/configured_integrations/{id}/test'].post
update:
x-apievangelist-phrasing:
intent: Send a test through a saved integration
effect: write
questions:
- How do I check that an integration I already configured is working?
- Will testing a saved team-notification or on-call integration send a test notification?
instructions:
- text: Run a test on configured integration {id}.
slots:
id: path.id
- text: Test saved integration {id} by creating a test issue of type {issueType}.
slots:
id: path.id
issueType: requestBody.issueType
method: generated
generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/configured_integrations'].post
update:
x-apievangelist-phrasing:
intent: Add an integration to a project
effect: write
questions:
- How do I connect an issue tracker to my project?
- Can a project have more than one issue-tracker integration?
instructions:
- text: Configure the {integration_key} integration on project {project_id} with {configuration}.
slots:
integration_key: requestBody.integration_key
project_id: path.project_id
configuration: requestBody.configuration
- text: Set up {integration_key} on project {project_id} with settings {configuration}, labelled {label}.
slots:
integration_key: requestBody.integration_key
project_id: path.project_id
configuration: requestBody.configuration
label: requestBody.label
method: generated
generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/configured_integration_summaries'].get
update:
x-apievangelist-phrasing:
intent: List a project's configured integrations
effect: read
questions:
- Which integrations are currently set up on my project?
- Can I list only a project's issue-tracker integrations?
instructions:
- text: List configured integrations on project {project_id}.
slots:
project_id: path.project_id
- text: Show project {project_id}'s integrations in category {category}.
slots:
project_id: path.project_id
category: query.category
method: generated
generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/integration_connections'].get
update:
x-apievangelist-phrasing:
intent: List an organization's integration connections
effect: read
questions:
- What integration connections does my organization have authorized?
- Can I filter an organization's integration connections by type?
instructions:
- text: List integration connections for organization {organization_id}.
slots:
organization_id: path.organization_id
- text: Show organization {organization_id}'s {type} integration connections.
slots:
organization_id: path.organization_id
type: query.type
method: generated
generated: '2026-09-26'