Genesys Web Deployments API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Web Deployments. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes
21 operations
across 14 paths,
and defines 143 schemas.
It is described by OpenAPI 3.2.0, at version v2.
Requests are made against a single base URL, https://api.mypurecloud.com.
The identity and technical contract details declared by the specification.
WebDeploymentsOAuthRequestParameters
object
7 properties
1 required
LocalizedLabels
object
Contains localized labels used in messenger apps
2 properties
JourneyCustomer
object
2 properties
2 required
WebDeploymentConfigurationVersion
object
Details about the configuration version of a Web Deployment
23 properties
1 required
JourneyActionMap
object
2 properties
2 required
AddressableEntityRef
object
2 properties
WritableStarrableDivision
object
3 properties
PresenceDefinition
object
3 properties
MediaTypes
object
Media types
1 property
PauseCriteria
object
2 properties
CobrowseWebMessagingSession
object
7 properties
DomainEntityRef
object
3 properties
OutOfOffice
object
8 properties
CustomI18nLabels
object
The localization settings for homescreen and push notification
2 properties
JourneyCustomerSession
object
2 properties
2 required
SupportCenterCategory
object
3 properties
BotMessengerProfile
object
2 properties
UserVideoSettings
object
The settings for User Video
3 properties
Detail
object
4 properties
EmployerInfo
object
4 properties
LocationImage
object
2 properties
UserStations
object
4 properties
User
object
39 properties
1 required
AdditionalLanguagesSynonyms
object
1 property
LauncherButtonSettings
object
The settings for the launcher button
3 properties
Location
object
5 properties
SupportCenterHeroStyle
object
3 properties
2 required
SupportCenterImage
object
1 property
1 required
ExpandableWebDeploymentEntityListing
object
5 properties
SupportCenterGlobalStyle
object
6 properties
6 required
NamedEntityAnnotation
object
1 property
1 required
RoutingStatus
object
3 properties
NluDomainVersionReference
object
4 properties
NamedEntityTypeMechanismExample
object
2 properties
2 required
GroupContact
object
5 properties
3 required
LocationEmergencyNumber
object
3 properties
SupportCenterImageSource
object
1 property
1 required
SupportCenterDetailedCategoryModuleTemplate
object
2 properties
2 required
ConversationClearSettings
object
1 property
UserConversationSummary
object
8 properties
SupportCenterModuleSetting
object
4 properties
2 required
Biography
object
5 properties
UserRoutingLanguage
object
Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
6 properties
WebDeploymentsRefreshJWTRequest
object
2 properties
2 required
WebDeploymentsOAuthExchangeRequest
object
3 properties
1 required
Humanize
object
2 properties
SupportCenterFeedbackSettings
object
1 property
1 required
SupportCenterSettings
object
Settings concerning knowledge portal (previously support center)
9 properties
5 required
SupportCenterLabelFilter
object
1 property
LocationAddressVerificationDetails
object
4 properties
WritableDivision
object
3 properties
SupportCenterCustomMessage
object
2 properties
2 required
SupportCenterCompactCategoryModuleTemplate
object
1 property
1 required
Education
object
5 properties
FileUploadMode
object
2 properties
DeploymentIdentityResolutionConfig
object
5 properties
1 required
IntentDefinition
object
7 properties
2 required
UserRoutingSkill
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
6 properties
NamedEntityTypeBinding
object
2 properties
2 required
IpFilter
object
Configuration for filtering tracking based on IP addresses.
2 properties
ScrollPercentageEventTrigger
object
Details about a scroll percentage event trigger
2 properties
2 required
WebDeploymentHeadlessMode
object
1 property
WebDeploymentsJourneyContext
object
3 properties
NluDomainVersion
object
16 properties
1 required
ErrorBody
object
11 properties
MediaTypeAccess
object
Media type access definitions
2 properties
MediaType
object
Media type definition
1 property
ConversationDisconnectSettings
object
2 properties
WebDeploymentActiveConfigurationOnDeployment
object
Details about the active configuration on a deployment
2 properties
BackgroundImageSettings
object
The settings to Agent Video background image
1 property
WorkPlanBidRanks
object
4 properties
Intent
object
2 properties
MessengerSettings
object
Settings concerning messenger
7 properties
NotificationsSettings
object
Notification settings that handles messenger notifications
2 properties
UserAuthorization
object
4 properties
AuthenticationSettings
object
Settings for authenticated webdeployments.
3 properties
2 required
AdditionalLanguagesIntent
object
2 properties
PushIntegration
object
2 properties
IdentityResolutionAutomergeConfig
object
2 properties
SupportCenterDetailedCategoryModuleSidebar
object
1 property
1 required
NamedEntityTypeDefinition
object
3 properties
2 required
SupportedContentReference
object
4 properties
1 required
JourneyAction
object
2 properties
2 required
UserPresence
object
10 properties
WebDeploymentConfigurationVersionEntityListing
object
5 properties
LocationDefinition
object
16 properties
WebDeploymentsAuthorizationResponse
object
2 properties
WebDeploymentConfigurationVersionResponse
object
Details about the configuration version of a Web Deployment
23 properties
1 required
WebDeploymentFlowEntityRef
object
5 properties
1 required
JourneyEventsSettings
object
Settings concerning journey events
11 properties
TrackingSettings
object
Settings that control how tracking data is collected and filtered.
4 properties
PositionSettings
object
Settings concerning position
3 properties
NluUtteranceSegment
object
2 properties
1 required
MessengerStyles
object
1 property
Division
object
3 properties
LocationAddress
object
7 properties
Limit
object
3 properties
WebDeployment
object
Details about a Web Deployment
15 properties
2 required
AgentVideoSettings
object
The settings for Agent Video
5 properties
FlowVersion
object
24 properties
NluInfo
object
5 properties
Knowledge
object
2 properties
NamedEntityDefinition
object
2 properties
2 required
WebDeploymentConfigurationVersionEntityRef
object
4 properties
2 required
VideoSettings
object
The settings to enable video chat
4 properties
NluUtterance
object
3 properties
1 required
FileUploadSettings
object
File upload settings for messenger
2 properties
MessengerApps
object
The apps embedded in the messenger
2 properties
Icon
object
The icon for the launcher button
1 property
MessengerHomeScreen
object
2 properties
SignedData
object
1 property
MediaSummary
object
2 properties
UserStation
object
8 properties
NluDomain
object
9 properties
1 required
JsonSchemaDocument
object
A JSON Schema document.
8 properties
SupportedLanguage
object
2 properties
Geolocation
object
11 properties
Contact
object
7 properties
ConversationAppSettings
object
Conversation settings that handles chats within the messenger
10 properties
SelectorEventTrigger
object
Details about a selector event trigger
2 properties
2 required
Team
object
8 properties
1 required
CobrowseSettings
object
Settings concerning cobrowse
8 properties
SupportCenterStyleSetting
object
2 properties
2 required
ExpandableWebDeployment
object
Details about a Web Deployment
15 properties
2 required
ResourcePermissionPolicy
object
11 properties
Image
object
2 properties
ResourceConditionNode
object
5 properties
NamedEntityTypeMechanism
object
8 properties
2 required
FormsTrackTrigger
object
Details about a forms tracking event trigger
4 properties
4 required
IntentReference
object
2 properties
1 required
ResourceConditionValue
object
2 properties
OAuthLastTokenIssued
object
1 property
AutoStart
object
1 property
DomainRole
object
2 properties
IdleEventTrigger
object
Details about an idle event trigger
2 properties
1 required
IdentityResolutionExternalSource
object
2 properties
MediaSummaryDetail
object
2 properties
SupportCenterScreen
object
2 properties
2 required
NamedEntityTypeItem
object
3 properties
1 required
Group
object
17 properties
4 required
Markdown
object
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Genesys publishes across the network.
