OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenMercantil Webhooks API

6 actions 6 updates phrasing extends openapi/openmercantil-webhooks-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/v1/user/webhooks'].get

$.paths['/api/v1/user/webhooks'].post

$.paths['/api/v1/user/webhooks/{id}'].delete

$.paths['/api/v1/user/webhooks/{id}'].patch

$.paths['/api/v1/user/webhooks/{id}/rotate'].post

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 OpenMercantil Webhooks API
  version: 1.0.0
extends: openapi/openmercantil-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['/api/v1/user/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List my outbound webhooks
      effect: read
      questions:
      - Which webhooks have I set up on my account?
      - What event types can a webhook subscribe to?
      instructions:
      - text: List my webhooks.
      - text: Show my webhook endpoints and delivery worker health.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/user/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an outbound webhook
      effect: write
      questions:
      - How do I get notified at my own URL when registry events happen?
      - Does my webhook destination have to be HTTPS?
      instructions:
      - text: Create a webhook to {url} for events {events}.
        slots:
          url: requestBody.url
          events: requestBody.events
      - text: Subscribe {url} to webhook notifications.
        slots:
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/user/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an outbound webhook
      effect: destructive
      questions:
      - How do I remove a webhook I no longer need?
      - Can I stop a webhook from receiving events permanently?
      instructions:
      - text: Delete webhook {webhook}.
        slots:
          webhook: path.id
      - text: Remove the outbound webhook {webhook} from my account.
        slots:
          webhook: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/user/webhooks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an outbound webhook
      effect: write
      questions:
      - Can I change the URL or events of an existing webhook?
      - How do I pause a webhook without deleting it?
      instructions:
      - text: Change webhook {webhook} to point at {url}.
        slots:
          webhook: path.id
          url: requestBody.url
      - text: Set webhook {webhook} active to {active}.
        slots:
          webhook: path.id
          active: requestBody.active
      - text: Update the events on webhook {webhook} to {events}.
        slots:
          webhook: path.id
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/user/webhooks/{id}/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a webhook signing secret
      effect: destructive
      questions:
      - How do I rotate the signing secret of a webhook?
      - What happens to pending deliveries signed with the old secret?
      instructions:
      - text: Rotate the signing secret for webhook {webhook}.
        slots:
          webhook: path.id
      - text: Issue a new signing key for {webhook}.
        slots:
          webhook: path.id
      method: generated
      generated: '2026-09-26'