Qonto · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Qonto Business Webhooks API

4 actions 4 updates phrasing extends openapi/qonto-webhooks-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v2/webhook_subscriptions'].get

$.paths['/v2/webhook_subscriptions'].post

$.paths['/v2/webhook_subscriptions/{id}'].delete

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 Qonto Business Webhooks API
  version: 1.0.0
extends: openapi/qonto-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['/v2/webhook_subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook subscriptions
      effect: read
      questions:
      - Which webhook subscriptions are set up on my account?
      - Can I see what events I'm currently receiving webhooks for?
      instructions:
      - text: List our webhook subscriptions.
      - text: Show me every webhook endpoint we're subscribed with.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhook_subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to webhook events
      effect: write
      questions:
      - Can I get notified by webhook when a transaction happens?
      - Does subscribing to an event need extra OAuth scopes beyond webhook?
      instructions:
      - text: Create a webhook subscription for transaction events.
      - text: Subscribe our endpoint to receive webhook notifications.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhook_subscriptions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook subscription
      effect: destructive
      questions:
      - What's the way to stop receiving a webhook I no longer need?
      - Can I remove an old webhook subscription?
      instructions:
      - text: Delete webhook subscription {id}.
        slots:
          id: path.id
      - text: Unsubscribe and remove webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'