LaunchDarkly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LaunchDarkly REST Webhooks API

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

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/webhooks'].get

$.paths['/webhooks'].post

$.paths['/webhooks/{webhookId}'].get

$.paths['/webhooks/{webhookId}'].delete

$.paths['/webhooks/{webhookId}'].patch

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 LaunchDarkly REST Webhooks API
  version: 1.0.0
extends: openapi/launchdarkly-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['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - Which webhooks are configured in our account?
      - How can I see where change notifications are being sent?
      instructions:
      - text: List all webhooks.
      - text: Show every webhook in the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook
      effect: write
      questions:
      - How do I get notified at my own URL when something changes?
      - Can I sign webhook payloads with a secret?
      instructions:
      - text: Create a webhook that posts to {url}.
        slots:
          url: requestBody.url
      - text: Create webhook {name} to {url} signed with secret {secret}.
        slots:
          name: requestBody.name
          url: requestBody.url
          secret: requestBody.secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhookId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one webhook
      effect: read
      questions:
      - How do I look up the settings of a specific webhook?
      - What URL does a given webhook send to?
      instructions:
      - text: Get webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      - text: Show the configuration of webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhookId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I permanently remove a webhook subscription?
      - Can I stop a webhook from sending by deleting it?
      instructions:
      - text: Delete webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      - text: Permanently remove the webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhookId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - How do I change a webhook's URL or turn it off?
      - Can I edit an existing webhook's settings?
      instructions:
      - text: Update webhook {webhookId} with patch {patch}.
        slots:
          webhookId: path.webhookId
          patch: requestBody.patch
      - text: Apply {patch} to webhook {webhookId}, commenting {comment}.
        slots:
          patch: requestBody.patch
          webhookId: path.webhookId
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'