# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Novu Events API
  version: 1.0.0
extends: openapi/novu-events-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: 4
- target: $.paths['/v1/events/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a workflow to send notifications
      effect: write
      questions:
      - How do I send a notification to a subscriber with Novu?
      - How many recipients can a single trigger target?
      - Can I pass a transactionId to avoid sending the same notification twice?
      instructions:
      - text: Trigger workflow {name} for {to}.
        slots:
          name: requestBody.name
          to: requestBody.to
      - text: Trigger workflow {name} to {to} with payload {payload}.
        slots:
          name: requestBody.name
          to: requestBody.to
          payload: requestBody.payload
      - text: Send workflow {name} to {to} using transaction id {transactionId}.
        slots:
          name: requestBody.name
          to: requestBody.to
          transactionId: requestBody.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/events/trigger/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger many events in one request
      effect: write
      questions:
      - Can I trigger several different workflows in a single API call?
      - What's the maximum number of events in one bulk trigger?
      instructions:
      - text: 'Bulk trigger these events: {events}.'
        slots:
          events: requestBody.events
      - text: 'Send this batch of workflow triggers at once: {events}.'
        slots:
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/events/trigger/broadcast'].post
  update:
    x-apievangelist-phrasing:
      intent: Broadcast a notification to all subscribers
      effect: write
      questions:
      - How do I send an announcement to every subscriber at once?
      - Is there a way to broadcast a workflow without listing recipients?
      instructions:
      - text: Broadcast workflow {name} to all subscribers with payload {payload}.
        slots:
          name: requestBody.name
          payload: requestBody.payload
      - text: Send announcement workflow {name} to everyone using payload {payload} and transaction id {transactionId}.
        slots:
          name: requestBody.name
          payload: requestBody.payload
          transactionId: requestBody.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/events/trigger/{transactionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a triggered event
      effect: destructive
      questions:
      - How do I stop a pending digest or delayed notification from going out?
      - Can I cancel a workflow run using the transactionId from the trigger?
      instructions:
      - text: Cancel the triggered event with transaction id {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Stop any pending digests or delays for transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'