Auth0 · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Auth0 Management Hooks API
10 actions
10 updates
phrasing
extends
openapi/auth0-hooks-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Auth0's API. It is a proposal applied on top of the contract, not a document Auth0 publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/hooks'].get
$.paths['/hooks'].post
$.paths['/hooks/{id}'].get
$.paths['/hooks/{id}'].delete
$.paths['/hooks/{id}'].patch
$.paths['/hooks/{id}/secrets'].get
$.paths['/hooks/{id}/secrets'].post
$.paths['/hooks/{id}/secrets'].delete
$.paths['/hooks/{id}/secrets'].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 Auth0 Management Hooks API
version: 1.0.0
extends: openapi/auth0-hooks-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: 9
- target: $.paths['/hooks'].get
update:
x-apievangelist-phrasing:
intent: List hooks
effect: read
questions:
- Which hooks are configured in my Auth0 tenant?
- Can I list only enabled hooks for a particular trigger?
instructions:
- text: List all my hooks.
- text: List hooks for trigger {triggerId} where enabled is {enabled}.
slots:
triggerId: query.triggerId
enabled: query.enabled
method: generated
generated: '2026-10-01'
- target: $.paths['/hooks'].post
update:
x-apievangelist-phrasing:
intent: Create a hook
effect: write
questions:
- How do I create a hook that runs on a specific extensibility point?
- Can I declare npm dependencies when creating a hook?
instructions:
- text: Create hook {name} for trigger {triggerId} with the script {script}.
slots:
name: requestBody.name
triggerId: requestBody.triggerId
script: requestBody.script
- text: Create hook {name} on trigger {triggerId} running {script} with dependencies {dependencies}.
slots:
name: requestBody.name
triggerId: requestBody.triggerId
script: requestBody.script
dependencies: requestBody.dependencies
method: generated
generated: '2026-10-01'
- target: $.paths['/hooks/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a hook
effect: read
questions:
- What script does a particular hook run?
- Can I fetch one hook's details by its ID?
instructions:
- text: Get hook {id}.
slots:
id: path.id
- text: Show the script and settings of hook {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/hooks/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a hook
effect: destructive
questions:
- Can I delete a hook I no longer use?
- What's the way to permanently remove a hook?
instructions:
- text: Delete hook {id}.
slots:
id: path.id
- text: Permanently remove the hook {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/hooks/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a hook
effect: write
questions:
- How do I disable a hook without deleting it?
- Can I change the script of an existing hook?
instructions:
- text: Set hook {id} enabled to {enabled}.
slots:
id: path.id
enabled: requestBody.enabled
- text: Replace the script of hook {id} with {script}.
slots:
id: path.id
script: requestBody.script
method: generated
generated: '2026-10-01'
- target: $.paths['/hooks/{id}/secrets'].get
update:
x-apievangelist-phrasing:
intent: Get a hook's secrets
effect: read
questions:
- Which secrets are stored on a hook?
- Can I see the secret names configured for one hook?
instructions:
- text: Get the secrets of hook {id}.
slots:
id: path.id
- text: List the secret names on hook {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/hooks/{id}/secrets'].post
update:
x-apievangelist-phrasing:
intent: Add secrets to a hook
effect: write
questions:
- How many secrets can a single hook hold?
- How do I add an API key as a secret to a hook?
instructions:
- text: Add new secrets to hook {id}.
slots:
id: path.id
- text: Store additional key-value secrets on hook {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/hooks/{id}/secrets'].delete
update:
x-apievangelist-phrasing:
intent: Delete secrets from a hook
effect: destructive
questions:
- Can I remove specific secrets from a hook by name?
- What's the way to delete hook secrets I no longer need?
instructions:
- text: Delete secrets from hook {id}.
slots:
id: path.id
- text: Remove the named secrets from hook {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/hooks/{id}/secrets'].patch
update:
x-apievangelist-phrasing:
intent: Update existing hook secrets
effect: write
questions:
- How do I rotate the value of a secret a hook already has?
- Can I change several existing hook secrets at once?
instructions:
- text: Update the existing secrets on hook {id}.
slots:
id: path.id
- text: Change the values of secrets already stored on hook {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'