Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Lifecycle Event Hook Log API

3 actions 3 updates phrasing extends openapi/strivacity-lifecycle-event-hook-log-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Strivacity's API. It is a proposal applied on top of the contract, not a document Strivacity publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/admin/api/v1/eventHooks/logs'].get
$.paths['/admin/api/v1/eventHooks/logs/{id}'].get

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 Admin Portal Lifecycle Event Hook Log API
  version: 1.0.0
extends: openapi/strivacity-lifecycle-event-hook-log-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: 2
- target: $.paths['/admin/api/v1/eventHooks/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List event hook logs
      effect: read
      questions:
      - Why did a lifecycle event hook fail for a user, and where are its logs?
      - Can I filter event hook logs by hook type, client, account or date range?
      instructions:
      - text: List event hook logs.
      - text: List {logLevels} event hook logs for hook {hookName} since {startDate}.
        slots:
          logLevels: query.logLevels
          hookName: query.hookName
          startDate: query.startDate
      - text: Show event hook logs for account {accountIds}.
        slots:
          accountIds: query.accountIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/eventHooks/logs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event hook log
      effect: read
      questions:
      - Can I open the full details of one event hook log entry?
      - What did a specific event hook run output?
      instructions:
      - text: Get event hook log {id}.
        slots:
          id: path.id
      - text: Show the details of hook log entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'