Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Webhooks API

3 actions 3 updates phrasing extends openapi/sigma-computing-webhooks-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v2/webhooks/{workbookId}/{sequenceId}'].post

$.paths['/v2/webhooks/{workbookId}/{sequenceId}/schema'].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 Sigma Computing Webhooks API
  version: 1.0.0
extends: openapi/sigma-computing-webhooks-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: 2
- target: $.paths['/v2/webhooks/{workbookId}/{sequenceId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a workbook action via webhook
      effect: write
      questions:
      - How do I send data into a Sigma workbook action sequence from outside?
      - Does the webhook request body need to match a configured specification?
      instructions:
      - text: Post data to the webhook for sequence {sequenceId} in workbook {workbookId}.
        slots:
          sequenceId: path.sequenceId
          workbookId: path.workbookId
      - text: Trigger action sequence {sequenceId} on workbook {workbookId} with a webhook call.
        slots:
          sequenceId: path.sequenceId
          workbookId: path.workbookId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/webhooks/{workbookId}/{sequenceId}/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the expected webhook message schema
      effect: read
      questions:
      - What fields does a workbook webhook expect before I send data?
      - How do I find the schema for a webhook-triggered action sequence?
      instructions:
      - text: Get the webhook schema for sequence {sequenceId} in workbook {workbookId}.
        slots:
          sequenceId: path.sequenceId
          workbookId: path.workbookId
      - text: Show which fields workbook {workbookId} sequence {sequenceId} accepts.
        slots:
          workbookId: path.workbookId
          sequenceId: path.sequenceId
      method: generated
      generated: '2026-09-26'