lemlist · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lemlist Webhooks API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/hooks'].get
$.paths['/hooks'].post
$.paths['/hooks/{hookId}'].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 Lemlist Webhooks API
  version: 1.0.0
extends: openapi/lemlist-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['/hooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List my webhooks
      effect: read
      questions:
      - Which webhooks are currently registered on my lemlist team?
      - Where can I see every endpoint receiving my activity events?
      instructions:
      - text: List all my webhooks.
      - text: Show the webhook subscriptions on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a webhook for activity events
      effect: write
      questions:
      - How do I get notified at my URL when a lead replies or opens an email?
      - Can I restrict a webhook to one campaign or only the first occurrence of an event?
      instructions:
      - text: Add a webhook that fires only for campaign {campaignId}.
        slots:
          campaignId: query.campaignId
      - text: Create a webhook with isFirst {isFirst} so it triggers only on the first occurrence.
        slots:
          isFirst: query.isFirst
      - text: Register a webhook linked to Zap {zapId}.
        slots:
          zapId: query.zapId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hooks/{hookId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I stop a webhook from sending events?
      - Can I unregister a webhook I created earlier?
      instructions:
      - text: Delete webhook {hookId}.
        slots:
          hookId: path.hookId
      - text: Unregister the webhook {hookId}.
        slots:
          hookId: path.hookId
      method: generated
      generated: '2026-10-01'