# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Convoy API Reference Sources API
  version: 1.0.0
extends: openapi/convoy-sources-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: 5
- target: $.paths['/v1/projects/{projectID}/sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List event sources
      effect: read
      questions:
      - Which sources are ingesting webhooks into my project?
      - Can I filter sources by type, such as http or pub_sub?
      - How do I list only the sources set up for a specific provider like Shopify?
      instructions:
      - text: List sources in project {projectID}.
        slots:
          projectID: path.projectID
      - text: Show sources of type {type}.
        slots:
          type: query.type
      - text: List the sources for provider {provider}.
        slots:
          provider: query.provider
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectID}/sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event source
      effect: write
      questions:
      - How do I set up a source to receive incoming webhooks from a third party?
      - Can I verify incoming webhook signatures on a new source?
      - What does it take to ingest events from a message broker into Convoy?
      instructions:
      - text: Create a source named {name} of type {type} in project {projectID}.
        slots:
          name: requestBody.name
          type: requestBody.type
          projectID: path.projectID
      - text: Create source {name} using verifier {verifier}.
        slots:
          name: requestBody.name
          verifier: requestBody.verifier
      - text: Add a broker source {name} with pub/sub settings {pub_sub}.
        slots:
          name: requestBody.name
          pub_sub: requestBody.pub_sub
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectID}/sources/{sourceID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an event source
      effect: read
      questions:
      - Where can I see the ingest URL and verifier of one source?
      - Can I look up a source by its ID?
      instructions:
      - text: Get source {sourceID} in project {projectID}.
        slots:
          sourceID: path.sourceID
          projectID: path.projectID
      - text: Show me the configuration of source {sourceID}.
        slots:
          sourceID: path.sourceID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectID}/sources/{sourceID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an event source
      effect: write
      questions:
      - How do I disable an existing source temporarily?
      - Can I forward selected headers from incoming requests on a source I already have?
      instructions:
      - text: Rename source {sourceID} in project {projectID} to {name}.
        slots:
          sourceID: path.sourceID
          projectID: path.projectID
          name: requestBody.name
      - text: Set is_disabled to {is_disabled} on existing source {sourceID}.
        slots:
          is_disabled: requestBody.is_disabled
          sourceID: path.sourceID
      - text: Forward headers {forward_headers} from source {sourceID}.
        slots:
          forward_headers: requestBody.forward_headers
          sourceID: path.sourceID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectID}/sources/{sourceID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an event source
      effect: destructive
      questions:
      - How do I permanently remove a source I no longer ingest from?
      - Can I delete a source and stop accepting its webhooks?
      instructions:
      - text: Delete source {sourceID} from project {projectID}.
        slots:
          sourceID: path.sourceID
          projectID: path.projectID
      - text: Remove source {sourceID}.
        slots:
          sourceID: path.sourceID
      method: generated
      generated: '2026-10-01'