Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Backend Webhooks API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/webhooks/svix'].post
$.paths['/webhooks/svix'].delete
$.paths['/webhooks/svix_url'].post

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 Clerk Backend Webhooks API
  version: 1.0.0
extends: openapi/clerk-com-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['/webhooks/svix'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable webhooks via a Svix app
      effect: write
      questions:
      - How do I turn on webhooks for my instance by creating a Svix app?
      - Can I associate a new Svix app with the current instance?
      instructions:
      - text: Create a Svix app for this instance.
      - text: Set up webhook delivery by creating the Svix app.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/svix'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the instance's Svix app
      effect: destructive
      questions:
      - How do I disconnect the Svix webhook app from my instance?
      - Can I delete the Svix app to stop webhooks?
      instructions:
      - text: Delete the Svix app for this instance.
      - text: Disassociate and remove the webhook Svix app.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/svix_url'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a Svix dashboard link
      effect: write
      questions:
      - How do I open the Svix dashboard to manage my webhook endpoints?
      - Can I generate a fresh login URL for the webhooks dashboard?
      instructions:
      - text: Generate a Svix dashboard URL for this instance.
      - text: Give me a link to manage webhook endpoints in Svix.
      method: generated
      generated: '2026-09-26'