Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Reporting Webhooks API

6 actions 6 updates phrasing extends openapi/customer-io-reporting-webhooks-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Customer.io's API. It is a proposal applied on top of the contract, not a document Customer.io publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/v1/reporting_webhooks'].get
$.paths['/v1/reporting_webhooks'].post
$.paths['/v1/reporting_webhooks/{webhook_id}'].get
$.paths['/v1/reporting_webhooks/{webhook_id}'].put
$.paths['/v1/reporting_webhooks/{webhook_id}'].delete

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 Customer.io App Reporting Webhooks API
  version: 1.0.0
extends: openapi/customer-io-reporting-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: 5
- target: $.paths['/v1/reporting_webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List reporting webhooks
      effect: read
      questions:
      - What reporting webhooks are configured in my workspace?
      - Where are my message event webhooks being sent?
      instructions:
      - text: List my reporting webhooks.
      - text: Show every reporting webhook and its endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reporting_webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reporting webhook
      effect: write
      questions:
      - How do I get message events like opens and clicks sent to my own URL?
      - Can a reporting webhook include the message content?
      instructions:
      - text: Create a reporting webhook {name} sending {events} to {endpoint}.
        slots:
          name: requestBody.name
          events: requestBody.events
          endpoint: requestBody.endpoint
      - text: Set up webhook {name} that posts {events} to {endpoint} with content {with_content}.
        slots:
          name: requestBody.name
          events: requestBody.events
          endpoint: requestBody.endpoint
          with_content: requestBody.with_content
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reporting_webhooks/{webhook_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a reporting webhook
      effect: read
      questions:
      - Which events does a particular reporting webhook send?
      - How do I check if a reporting webhook is disabled?
      instructions:
      - text: Get reporting webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      - text: Show the configuration of webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reporting_webhooks/{webhook_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a reporting webhook
      effect: write
      questions:
      - How do I change the URL a reporting webhook posts to?
      - Can I turn off some events on an existing reporting webhook?
      instructions:
      - text: Update webhook {webhook_id} named {name} to send {events} to {endpoint}.
        slots:
          webhook_id: path.webhook_id
          name: requestBody.name
          events: requestBody.events
          endpoint: requestBody.endpoint
      - text: Disable reporting webhook {webhook_id} ({name}, {endpoint}, {events}) by setting disabled to {disabled}.
        slots:
          webhook_id: path.webhook_id
          name: requestBody.name
          endpoint: requestBody.endpoint
          events: requestBody.events
          disabled: requestBody.disabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reporting_webhooks/{webhook_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a reporting webhook
      effect: destructive
      questions:
      - How do I stop and remove a reporting webhook?
      - Can I delete a webhook configuration I no longer use?
      instructions:
      - text: Delete reporting webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      - text: Remove webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-26'