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

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

Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 3 operations across 3 paths, and defines 46 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

3 operations 3 paths 46 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Genesys Events API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Events 3

Events

POST
/api/v2/events/conversations
Publish Conversation Batch Events
postEventsConversations 1 param → 200400401403404408409413
POST
/api/v2/events/users/routingstatus
Publish Agent Routing Status Batch Events
postEventsUsersRoutingstatus 1 param → 200400401403404408409413
POST
/api/v2/events/users/presence
Publish User Presence Status Batch Events
postEventsUsersPresence 1 param → 200400401403404408409413

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are BatchConversationEventRequest (32 properties), UserEstablishedEvent (13 properties), RoutingEstablishedEvent (12 properties), EmailRoutingTransferEvent (11 properties). Each schema is shown below with its type and property counts.

ProgressTransferEvent
object
6 properties 6 required
EndConsultTransferEvent
object
3 properties 3 required
EmailExternalEstablishedEvent
object
8 properties 6 required
EmailCommunicationEndedEvent
object
5 properties 5 required
EmailUserTransferEvent
object
9 properties 9 required
InitialConfiguration
object
6 properties
EmailUserEstablishedEvent
object
9 properties 7 required
EventError
object
3 properties
AudioState
object
2 properties
CommunicationEndedEvent
object
6 properties 5 required
ErrorBody
object
11 properties
EmailHoldUpdatedEvent
object
5 properties 5 required
EmailBeginTransmittingEvent
object
4 properties 4 required
BatchUserRoutingStatusEventRequest
object
A maximum of 100 events are allowed per request
1 property
EmailInitialConfiguration
object
11 properties 2 required
RoutingEstablishedEvent
object
12 properties 7 required
UserEstablishedEvent
object
13 properties 7 required
EmailEndTransferEvent
object
6 properties 6 required
ConsultTransferEvent
object
6 properties 6 required
BatchEventResponse
object
1 property
HoldUpdatedEvent
object
5 properties 5 required
UserPresenceEvent
object
6 properties 4 required
BatchUserPresenceEventRequest
object
A maximum of 100 events are allowed per request
1 property
PhoneTransferEvent
object
9 properties 9 required
EmailCommunicationAnsweredEvent
object
4 properties 4 required
EmailFlowEstablishedEvent
object
6 properties 6 required
BatchConversationEventRequest
object
A maximum of 100 events are allowed per request
32 properties
AudioUpdatedEvent
object
5 properties 5 required
UserTransferEvent
object
9 properties 9 required
UserRoutingStatusEvent
object
5 properties 5 required
EmailCommunicationDispositionAppliedEvent
object
7 properties 4 required
EmailCommunicationSentMessageEvent
object
4 properties 4 required
Limit
object
3 properties
CommunicationDispositionAppliedEvent
object
7 properties 4 required
EndTransferEvent
object
6 properties 6 required
PhoneEstablishedEvent
object
9 properties 6 required
EmailRoutingEstablishedEvent
object
10 properties 7 required
ProgressConsultTransferEvent
object
6 properties 6 required
IvrEstablishedEvent
object
10 properties 6 required
EmailProgressTransferEvent
object
6 properties 6 required
ExternalEstablishedEvent
object
10 properties 6 required
CommunicationAnsweredEvent
object
4 properties 4 required
SourceConfiguration
object
3 properties 2 required
RoutingTransferEvent
object
11 properties 9 required
EmailRoutingTransferEvent
object
11 properties 9 required
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-events-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
Genesys Agent Copilot API
Genesys Agent UI API
Genesys AI Studio API
Genesys Alerting API
Genesys Analytics API
Genesys Architect API
Genesys Assistant Copilot Variations API
Genesys Audit API
Genesys Authorization API
Genesys Background Assistant API
Genesys Billing API
Where this information came from

This is an independent, third-party profile of Genesys 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.