Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Webhooks API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/v1/webhooks'].get
$.paths['/api/v1/webhooks/logs'].get
$.paths['/api/v1/webhooks/logs/{log_id}'].get

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 Bindbee Webhooks API
  version: 1.0.0
extends: openapi/bindbee-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: 3
- target: $.paths['/api/v1/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List configured webhooks
      effect: read
      questions:
      - Which webhooks are configured for my organization?
      - Can I list only active webhooks?
      instructions:
      - text: List webhooks where active is {is_active}.
        slots:
          is_active: query.is_active
      - text: Show all webhooks set up for my org.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook delivery attempts
      effect: read
      questions:
      - Which webhook deliveries failed recently?
      - Can I filter delivery logs by webhook, connector or response code?
      instructions:
      - text: List delivery attempts for webhook {webhook_id}.
        slots:
          webhook_id: query.webhook_id
      - text: Show only failed webhook deliveries for connector {connector_id}, errors only {errors_only}.
        slots:
          connector_id: query.connector_id
          errors_only: query.errors_only
      - text: Find webhook deliveries that returned {response_code} between {created_at_from} and {created_at_to}.
        slots:
          response_code: query.response_code
          created_at_from: query.created_at_from
          created_at_to: query.created_at_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/logs/{log_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one webhook delivery's detail
      effect: read
      questions:
      - What exact request and response did one webhook delivery produce?
      - Can I inspect the full payload of a single delivery attempt?
      instructions:
      - text: Get webhook log {log_id}.
        slots:
          log_id: path.log_id
      - text: Show the full request and response for delivery {log_id}.
        slots:
          log_id: path.log_id
      method: generated
      generated: '2026-09-26'