# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Docplanner Integrations API Notification Callbacks API
  version: 1.0.0
extends: openapi/znanylekarz-api-notification-callbacks-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['/{client-endpoint-url}'].post
  update:
    x-apievangelist-phrasing:
      intent: Receive pushed event notifications at my endpoint
      effect: write
      questions:
      - What does the event payload look like when ZnanyLekarz pushes notifications to my endpoint?
      - Will a pushed notification be retried if my endpoint returns a 500?
      instructions:
      - text: Handle real-time event notifications pushed by POST to my callback endpoint {client-endpoint-url}.
        slots:
          client-endpoint-url: path.client-endpoint-url
      - text: Set up my webhook receiver to accept pushed booking event notifications.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: Pull the next pending notification
      effect: read
      questions:
      - How do I fetch the oldest notification I haven't pulled yet?
      - How long do unpulled notifications stay in the queue before they expire?
      instructions:
      - text: Pull the next single notification from the queue.
      - text: Fetch one pending notification, oldest first.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notifications/multiple'].get
  update:
    x-apievangelist-phrasing:
      intent: Pull a batch of pending notifications
      effect: read
      questions:
      - Can I pull up to 100 notifications in one request?
      - Is there a way to see how many notifications are still waiting after a batch pull?
      instructions:
      - text: Pull up to {limit} notifications from the queue at once.
        slots:
          limit: query.limit
      - text: Fetch a batch of pending notifications and report how many remain.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notifications/release'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-dispatch notifications that failed processing
      effect: write
      questions:
      - How can I get pushed notifications that weren't processed correctly sent again?
      - How often am I allowed to trigger a notification release?
      instructions:
      - text: Release and re-dispatch all notifications that were not processed correctly.
      - text: Trigger the hourly re-push of failed event notifications to our endpoint.
      method: generated
      generated: '2026-10-01'