SMTP2GO · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SMTP2GO WEBHOOKS API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/webhook/add'].post
$.paths['/webhook/edit'].post
$.paths['/webhook/remove'].post
$.paths['/webhook/view'].post

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 SMTP2GO WEBHOOKS API
  version: 1.0.0
extends: openapi/smtp2go-webhooks-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: 4
- target: $.paths['/webhook/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook
      effect: write
      questions:
      - How do I get notified at my URL when emails bounce or are opened?
      - Can a webhook also receive SMS events?
      instructions:
      - text: Create a webhook posting to {url}.
        slots:
          url: requestBody.url
      - text: Add a webhook at {url} for events {events}.
        slots:
          url: requestBody.url
          events: requestBody.events
      - text: Create a webhook at {url} with auth header {auth_header_type} {auth_header_value}.
        slots:
          url: requestBody.url
          auth_header_type: requestBody.auth_header_type
          auth_header_value: requestBody.auth_header_value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook/edit'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - How do I change the URL an existing webhook posts to?
      - Can I change which events an existing webhook subscribes to?
      instructions:
      - text: Change webhook {id}'s URL to {url}.
        slots:
          id: requestBody.id
          url: requestBody.url
      - text: Update webhook {id} to send events {events}.
        slots:
          id: requestBody.id
          events: requestBody.events
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I stop a webhook from sending events?
      - Can I delete a webhook by its ID?
      instructions:
      - text: Remove webhook {id}.
        slots:
          id: requestBody.id
      - text: Delete webhook {id} on subaccount {subaccount_id}.
        slots:
          id: requestBody.id
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhook/view'].post
  update:
    x-apievangelist-phrasing:
      intent: List configured webhooks
      effect: read
      questions:
      - Which webhooks are configured on my account?
      - Can I see a subaccount's webhooks?
      instructions:
      - text: List my webhooks.
      - text: Show the webhooks for subaccount {subaccount_id}.
        slots:
          subaccount_id: requestBody.subaccount_id
      method: generated
      generated: '2026-10-01'