# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign REST Connect Configurations API
  version: 1.0.0
extends: openapi/docusign-connectconfigurations-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: 6
- target: $.paths['/v2/accounts/{accountId}/connect'].get
  update:
    x-apievangelist-phrasing:
      intent: List Connect webhook configurations
      effect: read
      questions:
      - Which Connect webhook configurations are set up on my account?
      - Can I see every custom Connect definition at once?
      instructions:
      - text: List all Connect configurations for account {account}.
        slots:
          account: path.accountId
      - text: Show me every webhook listener configured in account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/connect'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Connect webhook configuration
      effect: write
      questions:
      - How do I change the URL an existing Connect configuration publishes to?
      - Can I add HMAC signing to a Connect listener I already have?
      instructions:
      - text: Update Connect configuration {connectId} in account {account} to publish to {urlToPublishTo}.
        slots:
          connectId: requestBody.connectId
          account: path.accountId
          urlToPublishTo: requestBody.urlToPublishTo
      - text: Change the envelope events sent by Connect configuration {connectId} to {envelopeEvents}.
        slots:
          connectId: requestBody.connectId
          envelopeEvents: requestBody.envelopeEvents
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/connect'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Connect webhook configuration
      effect: write
      questions:
      - How do I get real-time envelope status updates pushed to my server?
      - Can a new Connect listener include the documents and certificate of completion?
      instructions:
      - text: Create a Connect configuration named {name} in account {account} that posts to {urlToPublishTo}.
        slots:
          name: requestBody.name
          account: path.accountId
          urlToPublishTo: requestBody.urlToPublishTo
      - text: Set up a new webhook in account {account} for all users sending envelope events {envelopeEvents}.
        slots:
          account: path.accountId
          envelopeEvents: requestBody.envelopeEvents
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/connect/{connectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Connect configuration
      effect: read
      questions:
      - What events and URL does a specific Connect configuration use?
      - Is logging enabled on a particular Connect listener?
      instructions:
      - text: Get Connect configuration {connect} in account {account}.
        slots:
          connect: path.connectId
          account: path.accountId
      - text: Show the settings of webhook listener {connect}.
        slots:
          connect: path.connectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/connect/{connectId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Connect configuration
      effect: destructive
      questions:
      - How do I stop a Connect listener from sending updates permanently?
      - Can I remove an old Connect configuration?
      instructions:
      - text: Delete Connect configuration {connect} from account {account}.
        slots:
          connect: path.connectId
          account: path.accountId
      - text: Remove webhook listener {connect}.
        slots:
          connect: path.connectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/connect/{connectId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users covered by a Connect configuration
      effect: read
      questions:
      - Which users are included in a Connect configuration?
      - Can I search Connect users by email or name substring?
      instructions:
      - text: List users for Connect configuration {connect} in account {account}.
        slots:
          connect: path.connectId
          account: path.accountId
      - text: Find users in Connect configuration {connect} whose email contains {email_substring}.
        slots:
          connect: path.connectId
          email_substring: query.email_substring
      method: generated
      generated: '2026-10-01'