Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Integration Platform Custom Integrations API

5 actions 5 updates phrasing extends openapi/sentry-system-custom-integrations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Sentry's API. It is a proposal applied on top of the contract, not a document Sentry publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/organizations/{organization_id_or_slug}/sentry-apps/'].get

$.paths['/sentry-apps/{sentry_app_id_or_slug}/'].get

$.paths['/sentry-apps/{sentry_app_id_or_slug}/'].put

$.paths['/sentry-apps/{sentry_app_id_or_slug}/'].delete

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 Sentry Integration Platform Custom Integrations API
  version: 1.0.0
extends: openapi/sentry-system-custom-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: 4
- target: $.paths['/organizations/{organization_id_or_slug}/sentry-apps/'].get
  update:
    x-apievangelist-phrasing:
      intent: List an org's custom integrations
      effect: read
      questions:
      - Which custom integrations (Sentry Apps) has my organization built?
      - Can I see all internal and public integrations we created?
      instructions:
      - text: List the custom integrations built by organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show every Sentry App that {org} owns.
        slots:
          org: path.organization_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sentry-apps/{sentry_app_id_or_slug}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom integration's details
      effect: read
      questions:
      - What scopes and webhook URL does a given Sentry App use?
      - How can I look up one custom integration by its slug?
      instructions:
      - text: Show custom integration {app}.
        slots:
          app: path.sentry_app_id_or_slug
      - text: Fetch the configuration of Sentry App {app}.
        slots:
          app: path.sentry_app_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sentry-apps/{sentry_app_id_or_slug}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom integration
      effect: write
      questions:
      - Can I change the webhook URL of my Sentry App?
      - How do I update the permission scopes a custom integration requests?
      instructions:
      - text: Set the webhook URL of custom integration {app} to {webhookUrl}.
        slots:
          app: path.sentry_app_id_or_slug
          webhookUrl: requestBody.webhookUrl
      - text: Update Sentry App {app} to request scopes {scopes}.
        slots:
          app: path.sentry_app_id_or_slug
          scopes: requestBody.scopes
      - text: Change the redirect URL of integration {app} to {redirectUrl}.
        slots:
          app: path.sentry_app_id_or_slug
          redirectUrl: requestBody.redirectUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sentry-apps/{sentry_app_id_or_slug}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom integration
      effect: destructive
      questions:
      - How do I remove a Sentry App we no longer use?
      - Is deleting a custom integration reversible?
      instructions:
      - text: Delete custom integration {app}.
        slots:
          app: path.sentry_app_id_or_slug
      - text: Remove the Sentry App {app} permanently.
        slots:
          app: path.sentry_app_id_or_slug
      method: generated
      generated: '2026-09-26'