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 Process Automation API

Work items, flows, triggers

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

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

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

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

13 operations 7 paths 26 schemas 2 DELETE5 GET4 POST2 PUT

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 Process Automation 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 13

Across 7 paths, the API surfaces 13 operations — 2 DELETE, 5 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Process Automation 13

Work items, flows, triggers

POST
/api/v2/processautomation/triggers/topics/{topicName}/test
Test the matching of all organization Triggers on given topic using provided event body
postProcessautomationTriggersTopicTest 2 params → 200400401403404408409413
GET
/api/v2/processautomation/scheduledtriggers/{scheduledTriggerId}
Retrieve a single Scheduled Trigger matching id
getProcessautomationScheduledtrigger 1 param → 200400401403404408409413
PUT
/api/v2/processautomation/scheduledtriggers/{scheduledTriggerId}
Update a Scheduled Trigger
putProcessautomationScheduledtrigger 2 params → 200400401403404408409413
DELETE
/api/v2/processautomation/scheduledtriggers/{scheduledTriggerId}
Delete a Scheduled Trigger
deleteProcessautomationScheduledtrigger 1 param → 204400401403404408409413
GET
/api/v2/processautomation/scheduledtriggers
Retrieves all scheduled triggers, optionally filtered by query parameters.
getProcessautomationScheduledtriggers 4 params → 200400401403404408409413
POST
/api/v2/processautomation/scheduledtriggers
Create a scheduled Trigger
postProcessautomationScheduledtriggers 1 param → 200400401403404408409413
GET
/api/v2/processautomation/triggers/topics
Get topics available for organization
getProcessautomationTriggersTopics 3 params → 200400401403404408409413
GET
/api/v2/processautomation/triggers/{triggerId}
Retrieve a single Trigger matching id
getProcessautomationTrigger 1 param → 200400401403404408409413
PUT
/api/v2/processautomation/triggers/{triggerId}
Update a Trigger
putProcessautomationTrigger 2 params → 200400401403404408409413
DELETE
/api/v2/processautomation/triggers/{triggerId}
Delete a Trigger
deleteProcessautomationTrigger 1 param → 204400401403404408409413
POST
/api/v2/processautomation/triggers/{triggerId}/test
Test the matching of a Trigger based on provided event body
postProcessautomationTriggerTest 2 params → 200400401403404408409413
GET
/api/v2/processautomation/triggers
Retrieves all triggers, optionally filtered by query parameters.
getProcessautomationTriggers 6 params → 200400401403404408409413
POST
/api/v2/processautomation/triggers
Create a Trigger
postProcessautomationTriggers 1 param → 200400401403404408409413

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Trigger (11 properties), ErrorBody (11 properties), UpdateTriggerRequest (9 properties), ScheduledTrigger (8 properties). Each schema is shown below with its type and property counts.

MatchTestResult
object
Information about the results being matched by the expressions
2 properties
UpdateScheduledTriggerRequest
object
6 properties 5 required
UpdateTriggerRequest
object
9 properties 5 required
CreateTriggerRequest
object
8 properties 4 required
TriggerSchedule
object
Schedule configuration for a scheduled trigger
6 properties
TriggerEntityListing
object
4 properties
TestMatchesEventOperation
object
Results from evaluating matching criteria against test input
4 properties
TestSchemaOperation
object
Information about the Trigger test mode schema validation step
4 properties
MatchCriteriaTestResult
object
Results of a matching expression
7 properties
ErrorBody
object
11 properties
Detail
object
4 properties
Trigger
object
Defines a process automation trigger.
11 properties
JsonNode
object
MatchCriteria
object
Defines a simple matching condition
4 properties
TestModeEventResults
object
Information about event test mode execution
2 properties
ScheduledTriggerEntityListing
object
4 properties
TestModeTrigger
object
Basic identifying information about a trigger
4 properties
Limit
object
3 properties
TestModeResults
object
Information about trigger test mode execution
4 properties
ScheduledTrigger
object
Defines a process automation scheduled trigger.
8 properties
TestTargetOperation
object
Information about the Trigger test mode target validation step
4 properties
TopicCursorEntityListing
object
Cursor listing of Topics.
4 properties
WorkflowTargetSettings
object
1 property
TestMatchesOperation
object
Information about the Trigger test mode processing step
4 properties
TriggerTarget
object
The target of a trigger invocation
3 properties
CreateScheduledTriggerRequest
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-process-automation-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 Process Automation 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.