# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal Lifecycle Event Hook API
  version: 1.0.0
extends: openapi/strivacity-lifecycle-event-hook-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: 7
- target: $.paths['/admin/api/v1/eventHooks/function'].get
  update:
    x-apievangelist-phrasing:
      intent: List lifecycle event hooks
      effect: read
      questions:
      - Which lifecycle event hooks are configured in my instance?
      - Can I filter event hooks by hook type and include their status?
      instructions:
      - text: List all lifecycle event hooks.
      - text: Show lifecycle event hooks of type {hook} with status.
        slots:
          hook: query.hook
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/eventHooks/function'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a lifecycle event hook
      effect: write
      questions:
      - How do I run custom code when a user registers or logs in?
      - Can a lifecycle event hook be blocking and use npm packages?
      instructions:
      - text: Create a lifecycle event hook {name} on hook type {hook}.
        slots:
          name: requestBody.name
          hook: requestBody.hook
      - text: Add a blocking event hook named {name} for {hook} with this code {code}.
        slots:
          name: requestBody.name
          hook: requestBody.hook
          code: requestBody.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/eventHooks/function/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lifecycle event hook
      effect: read
      questions:
      - What code and settings does a specific event hook have?
      - Can I read one lifecycle event hook by ID?
      instructions:
      - text: Get lifecycle event hook {id}.
        slots:
          id: path.id
      - text: Show the code of event hook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/eventHooks/function/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a lifecycle event hook
      effect: write
      questions:
      - How do I change the code of an existing event hook?
      - Can I make an event hook non-blocking after creation?
      instructions:
      - text: Update lifecycle event hook {id} with code {code}.
        slots:
          id: path.id
          code: requestBody.code
      - text: Rename event hook {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/eventHooks/function/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lifecycle event hook
      effect: destructive
      questions:
      - How do I remove an event hook I no longer need?
      - Why can't I delete an event hook that is still assigned?
      instructions:
      - text: Delete lifecycle event hook {id}.
        slots:
          id: path.id
      - text: Remove the unassigned event hook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/eventHooks/function/{id}/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a lifecycle event hook
      effect: write
      questions:
      - How do I make my latest event hook code go live?
      - Do I need to deploy an event hook after editing it?
      instructions:
      - text: Deploy lifecycle event hook {id}.
        slots:
          id: path.id
      - text: Push event hook {id} live.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/eventHooks/function/{id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a lifecycle event hook's status
      effect: read
      questions:
      - Has my event hook finished deploying?
      - What is the current status of a lifecycle event hook?
      instructions:
      - text: Get the status of lifecycle event hook {id}.
        slots:
          id: path.id
      - text: Check whether event hook {id} is deployed.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'