Create live agent integration
Creates a live agent integration and returns it with its server-assigned id and version.
Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required.
Authentication
AuthorizationBearer
JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.
Request
This endpoint expects an object.
version
Document version. On update, send back the num from your last read.
name
Unique key used to refer to this handoff. Must start with a lowercase letter and contain only lowercase letters, digits and underscores. Cannot be changed after creation.
channel
Hands off by routing the user's messages to a channel where agents respond.
api
Hands off through a live agent provider's API, such as Vayusphere or BeyondTrust.
url
Hands off by directing the user to a URL that connects them to an agent.
agent_broker
Hands off by brokering the chat to a live agent provider, such as Amazon Connect, ServiceNow, Genesys or Salesforce.
file_ticket_enabled
If true, a ticket is automatically filed for the user whenever they request a live agent.
ticket_receipt_traits
Additional settings for the ticket filed when a user requests a live agent.
Response
The created live agent integration
id
Unique identifier of the handoff configuration, assigned by the server.
name
Unique key used to refer to this handoff. Must start with a lowercase letter and contain only lowercase letters, digits and underscores. Cannot be changed after creation.
channel
Hands off by routing the user's messages to a channel where agents respond.
api
Hands off through a live agent provider's API, such as Vayusphere or BeyondTrust.
url
Hands off by directing the user to a URL that connects them to an agent.
agent_broker
Hands off by brokering the chat to a live agent provider, such as Amazon Connect, ServiceNow, Genesys or Salesforce.
file_ticket_enabled
If true, a ticket is automatically filed for the user whenever they request a live agent.
ticket_receipt_traits
Additional settings for the ticket filed when a user requests a live agent.
updated_time
When the configuration was last updated.
updated_by
Who last updated the configuration.
version
Document version. On update, send back the num from your last read.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error