# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Salesforce Events API version: 1.0.0 extends: openapi/salesforce-events-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: 9 - target: $.paths['/data/v64.0/sobjects/{EventApiName}'].post update: x-apievangelist-phrasing: intent: Publish a single platform event effect: write questions: - How do I publish one platform event message over REST? - Can I fire a vehicle platform event with mileage, current vehicle and model year? instructions: - text: Publish a {event} event with annual mileage {mileage}, vehicle {vehicle} and model year {year}. slots: event: path.EventApiName mileage: requestBody.Annual_Mileage__c vehicle: requestBody.Current_Vehicle__c year: requestBody.Model_Year__c - text: Send one {event} platform event for vehicle {vehicle}. slots: event: path.EventApiName vehicle: requestBody.Current_Vehicle__c method: generated generated: '2026-09-26' - target: $.paths['/data/v64.0/tooling/sobjects/EventRelayConfig/{EVENT_RELAY_CONFIG_ID}'].get update: x-apievangelist-phrasing: intent: Get an event relay configuration effect: read questions: - How do I check how one of my event relays is configured? - What state is my event relay in right now? instructions: - text: Get event relay config {relay_id}. slots: relay_id: path.EVENT_RELAY_CONFIG_ID - text: Show the settings and state of event relay {relay_id}. slots: relay_id: path.EVENT_RELAY_CONFIG_ID method: generated generated: '2026-09-26' - target: $.paths['/data/v64.0/query'].get update: x-apievangelist-phrasing: intent: Query event relay feedback records effect: read questions: - Can I list the feedback records for all my event relays with a SOQL query? - Which event relays have reported errors or a paused status? instructions: - text: Query event relay feedback with {soql}. slots: soql: query.q - text: List EventRelayFeedback records using the SOQL {soql}. slots: soql: query.q method: generated generated: '2026-09-26' - target: $.paths['/data/v64.0/sobjects/EventRelayFeedback/{EVENT_RELAY_FEEDBACK_ID}'].get update: x-apievangelist-phrasing: intent: Get one event relay feedback record effect: read questions: - How do I read the feedback record that explains why a relay failed? - What does a single EventRelayFeedback record tell me about relay health? instructions: - text: Get event relay feedback {feedback_id}. slots: feedback_id: path.EVENT_RELAY_FEEDBACK_ID - text: Show the relay error details in feedback record {feedback_id}. slots: feedback_id: path.EVENT_RELAY_FEEDBACK_ID method: generated generated: '2026-09-26' - target: $.paths['/data/v64.0/event/eventSchema/{SCHEMA_ID}'].get update: x-apievangelist-phrasing: intent: Get a platform event schema by schema ID effect: read questions: - How do I fetch a platform event's schema when I only have the schema ID from a message? - Can I decode an event payload by looking up its schema ID? instructions: - text: Get the platform event schema with ID {schema_id}. slots: schema_id: path.SCHEMA_ID - text: Fetch event schema {schema_id} so I can decode its messages. slots: schema_id: path.SCHEMA_ID method: generated generated: '2026-09-26' - target: $.paths['/data/v64.0/sobjects/{EVENT_NAME}/eventSchema'].get update: x-apievangelist-phrasing: intent: Get a platform event schema by event name effect: read questions: - What fields are in the schema of my Order_Event__e platform event? - How do I get the current schema of a platform event by its API name? instructions: - text: Get the event schema for platform event {event_name}. slots: event_name: path.EVENT_NAME - text: Show the schema definition of the {event_name} event. slots: event_name: path.EVENT_NAME method: generated generated: '2026-09-26' - target: $.paths['/data/v64.0/tooling/sobjects/ManagedEventSubscription/{managedEventSubscriptionId}'].get update: x-apievangelist-phrasing: intent: Get a managed event subscription effect: read questions: - How do I check the settings of a managed event subscription? - Which topic and replay state does a managed subscription use? instructions: - text: Get managed event subscription {subscription_id}. slots: subscription_id: path.managedEventSubscriptionId - text: Show the configuration of managed subscription {subscription_id}. slots: subscription_id: path.managedEventSubscriptionId method: generated generated: '2026-09-26' - target: $.paths['/data/v64.0/tooling/sobjects/ManagedEventSubscription/{managedEventSubscriptionId}'].patch update: x-apievangelist-phrasing: intent: Update a managed event subscription effect: write questions: - Can I change or pause a managed event subscription through the Tooling API? - How do I update the metadata of an existing managed subscription? instructions: - text: Update managed subscription {subscription_id} with metadata {metadata}. slots: subscription_id: path.managedEventSubscriptionId metadata: requestBody.Metadata - text: Set managed subscription {subscription_id} full name {full_name} and metadata {metadata}. slots: subscription_id: path.managedEventSubscriptionId full_name: requestBody.FullName metadata: requestBody.Metadata method: generated generated: '2026-09-26' - target: $.paths['/data/v64.0/sobjects/EventLogFile/{id}/LogFile'].get update: x-apievangelist-phrasing: intent: Download an event log file effect: read questions: - How do I download the CSV contents of an event monitoring log file? - Can I get the raw login or API usage log from an EventLogFile record? instructions: - text: Download the log file for EventLogFile {log_id}. slots: log_id: path.id - text: Get the event log CSV from record {log_id}. slots: log_id: path.id method: generated generated: '2026-09-26'