# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio SendGrid Webhook Configuration Parse Webhook API
  version: 1.0.0
extends: openapi/sendgrid-parse-webhook-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v3/user/webhooks/parse/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List inbound parse settings
      effect: read
      questions:
      - Which hostnames have inbound email parsing set up?
      - Where is each inbound parse hostname posting its emails?
      instructions:
      - text: List all my inbound parse settings.
      - text: Show every hostname configured for inbound parse and its destination URL.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/parse/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up inbound email parsing for a hostname
      effect: write
      questions:
      - How do I receive incoming emails as POSTs to my app?
      - Does the inbound parse hostname have to be an authenticated domain?
      - Can I get the raw MIME message instead of parsed fields?
      instructions:
      - text: Create an inbound parse setting for {hostname} posting to {url}.
        slots:
          hostname: requestBody.hostname
          url: requestBody.url
      - text: Parse incoming mail for {hostname} to {url} with spam check {spam_check} and raw {send_raw}.
        slots:
          hostname: requestBody.hostname
          url: requestBody.url
          spam_check: requestBody.spam_check
          send_raw: requestBody.send_raw
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/parse/settings/{hostname}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one hostname's inbound parse setting
      effect: read
      questions:
      - Where does inbound mail for a particular hostname get posted?
      - Is spam checking on for a given parse hostname?
      instructions:
      - text: Show the inbound parse setting for {hostname}.
        slots:
          hostname: path.hostname
      - text: Get the parse destination URL configured for {hostname}.
        slots:
          hostname: path.hostname
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/parse/settings/{hostname}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop parsing inbound mail for a hostname
      effect: destructive
      questions:
      - Can I turn off inbound parsing for one hostname?
      - What removes an inbound parse configuration?
      instructions:
      - text: Delete the inbound parse setting for {hostname}.
        slots:
          hostname: path.hostname
      - text: Stop forwarding parsed inbound mail for {hostname}.
        slots:
          hostname: path.hostname
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/parse/settings/{hostname}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing inbound parse setting
      effect: write
      questions:
      - Can I point an existing inbound parse hostname at a new webhook URL?
      - Is it possible to toggle spam checking on a parse setting I already have?
      instructions:
      - text: Point inbound parse for {hostname} at {url}.
        slots:
          hostname: path.hostname
          url: requestBody.url
      - text: Set spam check to {spam_check} on the existing parse setting for {hostname}.
        slots:
          spam_check: requestBody.spam_check
          hostname: path.hostname
      method: generated
      generated: '2026-09-24'
- target: $.paths['/v3/user/webhooks/parse/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get inbound parse usage statistics
      effect: read
      questions:
      - How many inbound emails has the parse webhook processed?
      - Can I see inbound parse volume grouped by day, week or month?
      instructions:
      - text: Show inbound parse stats from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Get parse webhook usage since {start_date} aggregated by {aggregated_by}.
        slots:
          start_date: query.start_date
          aggregated_by: query.aggregated_by
      method: generated
      generated: '2026-09-24'