Asana · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Asana Webhooks API

6 actions 6 updates phrasing extends openapi/asana-webhooks-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Asana's API. It is a proposal applied on top of the contract, not a document Asana publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/webhooks'].get

$.paths['/webhooks'].post

$.paths['/webhooks/{webhook_gid}'].get

$.paths['/webhooks/{webhook_gid}'].put

$.paths['/webhooks/{webhook_gid}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Asana Webhooks API
  version: 1.0.0
extends: openapi/asana-webhooks-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['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List my webhooks in a workspace
      effect: read
      questions:
      - Which webhooks has my app registered in a workspace?
      - Can I list only the webhooks on one resource?
      instructions:
      - text: List my webhooks in workspace {workspace}.
        slots:
          workspace: query.workspace
      - text: Show webhooks in workspace {workspace} for resource {resource}.
        slots:
          workspace: query.workspace
          resource: query.resource
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to changes with a webhook
      effect: write
      questions:
      - How do I get notified when tasks in a project change?
      - What is the handshake step when establishing a webhook?
      instructions:
      - text: Create a webhook on resource {resource} posting to {target}.
        slots:
          resource: requestBody.data
          target: requestBody.data
      - text: Establish a webhook with {details}.
        slots:
          details: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{webhook_gid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook's details
      effect: read
      questions:
      - What resource and target does a webhook point at?
      - Can I look up one webhook by its ID?
      instructions:
      - text: Show webhook {webhook}.
        slots:
          webhook: path.webhook_gid
      - text: Fetch the details of webhook {webhook}.
        slots:
          webhook: path.webhook_gid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{webhook_gid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's filters
      effect: write
      questions:
      - Can I change which events a webhook receives?
      - Does updating filters replace the webhook's old filter list?
      instructions:
      - text: Replace the filters on webhook {webhook} with {filters}.
        slots:
          webhook: path.webhook_gid
          filters: requestBody.data
      - text: Update webhook {webhook} to only send {filters}.
        slots:
          webhook: path.webhook_gid
          filters: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webhooks/{webhook_gid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - Can I still receive events right after deleting a webhook?
      - How do I permanently stop a webhook?
      instructions:
      - text: Delete webhook {webhook}.
        slots:
          webhook: path.webhook_gid
      - text: Permanently remove webhook {webhook}.
        slots:
          webhook: path.webhook_gid
      method: generated
      generated: '2026-10-01'