X · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X API v2 Account Activity API

6 actions 6 updates phrasing extends openapi/x-account-activity-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/2/account_activity/subscriptions/count'].get

$.paths['/2/account_activity/webhooks/{webhook_id}/subscriptions/all'].get

$.paths['/2/account_activity/webhooks/{webhook_id}/subscriptions/all'].post

$.paths['/2/account_activity/webhooks/{webhook_id}/subscriptions/all/list'].get

$.paths['/2/account_activity/webhooks/{webhook_id}/subscriptions/{user_id}/all'].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 X API v2 Account Activity API
  version: 1.0.0
extends: openapi/x-account-activity-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: 5
- target: $.paths['/2/account_activity/subscriptions/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count Account Activity subscriptions
      effect: read
      questions:
      - How many Account Activity subscriptions does my app currently have?
      - Am I close to the subscription cap for Account Activity on X?
      instructions:
      - text: Show the total number of Account Activity subscriptions for my app.
      - text: Count how many users are subscribed through Account Activity right now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/account_activity/webhooks/{webhook_id}/subscriptions/all'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a user's Account Activity subscription
      effect: read
      questions:
      - How can I confirm the authenticated user is subscribed to a given Account Activity webhook?
      - Is my user's Account Activity subscription on this webhook still valid?
      instructions:
      - text: Check whether I'm subscribed to Account Activity events on webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      - text: Validate my Account Activity subscription for webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/account_activity/webhooks/{webhook_id}/subscriptions/all'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a user to Account Activity events
      effect: write
      questions:
      - How do I start receiving Account Activity events for a user on my webhook?
      - Can I subscribe the authenticated user's activity to a registered webhook?
      instructions:
      - text: Subscribe my account's activity to webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      - text: Start delivering my Account Activity events to webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/account_activity/webhooks/{webhook_id}/subscriptions/all/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriptions on an Account Activity webhook
      effect: read
      questions:
      - Which users are subscribed to my Account Activity webhook?
      - What subscriptions exist under a particular Account Activity webhook?
      instructions:
      - text: List every Account Activity subscription on webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      - text: Show which user IDs are subscribed to webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/2/account_activity/webhooks/{webhook_id}/subscriptions/{user_id}/all'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user's Account Activity subscription
      effect: destructive
      questions:
      - How do I stop sending a user's Account Activity events to my webhook?
      - Can I unsubscribe one specific user from an Account Activity webhook?
      instructions:
      - text: Unsubscribe user {user_id} from Account Activity webhook {webhook_id}.
        slots:
          user_id: path.user_id
          webhook_id: path.webhook_id
      - text: Delete the Account Activity subscription for {user_id} on webhook {webhook_id}.
        slots:
          user_id: path.user_id
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-26'