IntegrationOS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for One Webhook Events API

3 actions 3 updates phrasing extends openapi/integration-os-webhook-events-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for IntegrationOS's API. It is a proposal applied on top of the contract, not a document IntegrationOS publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/webhooks/events/organizations/{org_id}'].get
$.paths['/v1/webhooks/events/organizations/{org_id}/projects/{project_id}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for One Webhook Events API
  version: 1.0.0
extends: openapi/integration-os-webhook-events-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/webhooks/events/organizations/{org_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's recent webhook events
      effect: read
      questions:
      - What webhook events were emitted across my whole organization recently?
      - Can I see how each subscription handled the organization's webhook events?
      - Is it possible to filter organization webhook events to one event type within a date range?
      instructions:
      - text: List recent webhook events for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show organization {org_id} webhook events of type {eventType} received after {after}.
        slots:
          org_id: path.org_id
          eventType: query.eventType
          after: query.after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/webhooks/events/organizations/{org_id}/projects/{project_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's recent webhook events
      effect: read
      questions:
      - Which webhook events has a single project emitted lately?
      - Can I narrow a project's webhook event history to a time window?
      instructions:
      - text: List recent webhook events for project {project_id} in organization {org_id}.
        slots:
          project_id: path.project_id
          org_id: path.org_id
      - text: Show project {project_id} webhook events of type {eventType} before {before} in org {org_id}.
        slots:
          project_id: path.project_id
          eventType: query.eventType
          before: query.before
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'