How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Salesforce Events API

The Events API from Salesforce — 16 operation(s) for events.

Salesforce Events API is one of 294 APIs that Salesforce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and 1 JSON Schema.

This API exposes 21 operations across 16 paths, and defines 33 schemas. It is described by OpenAPI 3.1.0, at version v63.0.

Requests are made against a single base URL, https://{instance}.salesforce.com/services/data/v{version}/jobs.

21 operations 16 paths 33 schemas 3 DELETE12 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v63.0
Base URL
https://{instance}.salesforce.com/services/data
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Salesforce Events API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {accesstoken}".

Paths & Operations 21

Across 16 paths, the API surfaces 21 operations — 3 DELETE, 12 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Events 21
GET
/data/v64.0/tooling/sobjects/PlatformEventChannel/{PLATFORM_EVENT_CHANNEL_ID}
Salesforce Get Event Channel
Geteventchannel 1 param → 200
DELETE
/data/v64.0/tooling/sobjects/PlatformEventChannel/{PLATFORM_EVENT_CHANNEL_ID}
Salesforce Delete Event Channel
Deleteeventchannel 1 param → 204
GET
/data/v64.0/tooling/sobjects/PlatformEventChannel/describe
Salesforce Describe Event Channel
Describeeventchannel → 200
POST
/data/v64.0/sobjects/{EventApiName}
Salesforce Publish Single Event
Publishsingleevent 1 param body → 201
POST
/Soap/u/64.0
Salesforce Publish Multiple Events With Soap Call
PublishmultipleeventswithSOAPcall 4 params body → 200
GET
/data/v64.0/tooling/sobjects/EventRelayConfig/describe
Salesforce Describe Event Relay
Describeeventrelay → 200
POST
/data/v64.0/tooling/sobjects/EventRelayConfig
Salesforce Create Event Relay
Createeventrelay body → 200
DELETE
/data/v64.0/tooling/sobjects/EventRelayConfig/{EVENT_RELAY_CONFIG_ID}
Salesforce Delete Event Relay
Deleteeventrelay 1 param → 200
GET
/data/v64.0/tooling/sobjects/EventRelayConfig/{EVENT_RELAY_CONFIG_ID}
Salesforce Get Event Relay
Geteventrelay 1 param → 200
PATCH
/data/v64.0/tooling/sobjects/EventRelayConfig/{EVENT_RELAY_CONFIG_ID}
Salesforce Change Event Relay State
Changeeventrelaystate 3 params body → 200
GET
/data/v64.0/query
Salesforce List Event Relay Feedback Items
Listeventrelayfeedbackitems 1 param → 200
GET
/data/v64.0/sobjects/EventRelayFeedback/{EVENT_RELAY_FEEDBACK_ID}
Salesforce Get Event Relay Feedback
Geteventrelayfeedback 1 param → 200
GET
/data/v64.0/sobjects/EventRelayFeedback/describe
Salesforce Describe Event Felay Feedback
Describeeventfelayfeedback → 200
GET
/data/v64.0/event/eventSchema/{SCHEMA_ID}
Salesforce Platform Event Schema by Schema Id
PlatformEventSchemabySchemaID 2 params → 200
GET
/data/v64.0/sobjects/{EVENT_NAME}/eventSchema
Salesforce Platform Event Schema by Event Name
PlatformEventSchemabyEventName 2 params → 200
POST
/data/v64.0/tooling/sobjects/ManagedEventSubscription
Salesforce Create Managed Event Subscription
Createmanagedeventsubscription body → 200
GET
/data/v64.0/tooling/sobjects/ManagedEventSubscription/{managedEventSubscriptionId}
Salesforce Get Managed Event Subscription by Id
GetmanagedeventsubscriptionbyID 1 param → 200
PATCH
/data/v64.0/tooling/sobjects/ManagedEventSubscription/{managedEventSubscriptionId}
Salesforce Update Managed Event Subscription
Updatemanagedeventsubscription 1 param body → 200
DELETE
/data/v64.0/tooling/sobjects/ManagedEventSubscription/{managedEventSubscriptionId}
Salesforce Delete Managed Event Subscription
Deletemanagedeventsubscription 1 param → 200
GET
/data/v64.0/tooling/sobjects/ManagedEventSubscription/describe
Salesforce Describe Managed Event Subscription
Describemanagedeventsubscription → 200
GET
/data/v64.0/sobjects/EventLogFile/{id}/LogFile
Salesforce Get Event Log File
Geteventlogfile 1 param → 200

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are Field1 (57 properties), Describeeventchannel (45 properties), Geteventchannel (16 properties), PicklistValue (5 properties). Each schema is shown below with its type and property counts.

Type
object
4 properties
Field3
object
2 properties 2 required
Field2
object
2 properties 2 required
Body16
object
1 property 1 required
Envelope
object
2 properties 2 required
Publishsingleevent
object
3 properties 3 required
ChangeeventrelaystateRequest
object
1 property 1 required
PublishsingleeventRequest
object
3 properties 3 required
Errors7
object
3 properties 3 required
Urls2
object
3 properties 3 required
SupportedScope
object
2 properties 2 required
UpdatemanagedeventsubscriptionRequest
object
2 properties 2 required
Field5
object
4 properties 2 required
Metadata1
object
3 properties 3 required
Metadata15
object
5 properties 5 required
Header4
object
1 property 1 required
Metadata12
object
4 properties 4 required
Field1
object
57 properties 57 required
sObjects
object
4 properties 4 required
Type11
object
4 properties 4 required
PicklistValue
object
5 properties
Describeeventchannel
object
45 properties 45 required
Metadata13
object
1 property 1 required
SessionHeader
object
1 property 1 required
Type1
object
4 properties
PlatformEventSchemabyEventName
object
4 properties 4 required
create
object
1 property 1 required
PicklistValue1
object
5 properties 5 required
Field4
object
4 properties 3 required
Geteventchannel
object
16 properties 16 required
CreateeventrelayRequest
object
2 properties 2 required
CreatemanagedeventsubscriptionRequest
object
2 properties 2 required
Attributes4
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

salesforce-events-api-openapi.yml Raw ↑

Other APIs Salesforce publishes across the network.

Salesforce REST API
Salesforce SOAP API
Salesforce Bulk API
Salesforce Streaming API
Salesforce Metadata API
Salesforce Tooling API
Salesforce Connect API (Chatter)
Salesforce Analytics REST API
Salesforce Reports and Dashboards REST API
Salesforce Einstein Platform Services API
Salesforce Einstein Prediction Service API
Salesforce GraphQL API
Where this information came from

This is an independent, third-party profile of Salesforce Events API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.