Salla · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Salla Merchant Webhooks API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/webhooks/subscribe'].post
$.paths['/webhooks/subscriptions'].get
$.paths['/webhooks/unsubscribe/{subscription_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 Salla Merchant Webhooks API
  version: 1.0.0
extends: openapi/salla-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: 3
- target: $.paths['/webhooks/subscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to a webhook event
      effect: write
      questions:
      - How do I get notified when a new order is created?
      - Can I add a conditional rule so a webhook only fires for some events?
      instructions:
      - text: Subscribe {url} to event {event} as webhook {name}.
        slots:
          url: requestBody.url
          event: requestBody.event
          name: requestBody.name
      - text: Create webhook {name} for {event} to {url} with rule {rule}.
        slots:
          name: requestBody.name
          event: requestBody.event
          url: requestBody.url
          rule: requestBody.rule
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook subscriptions
      effect: read
      questions:
      - Which webhooks is my app currently subscribed to?
      - Can I see all active webhook subscriptions?
      instructions:
      - text: List my webhook subscriptions.
      - text: Show all webhooks registered for my store.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/unsubscribe/{subscription_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe a webhook
      effect: destructive
      questions:
      - How do I stop receiving a webhook?
      - Can I delete a webhook subscription I no longer need?
      instructions:
      - text: Unsubscribe webhook {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Delete webhook subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'