Interactions Webhook
From Genesys Documentation
This topic is part of the manual Genesys Multicloud CX Web-based API Reference for version Current of Developer.
Contents
Base path: /nexus/v3
POST
|
/some/interactions/webhook/path
Send interaction state change events
|
Send interaction state change events to the third-party system. Events are sent when an interaction is STARTED, which means it was created in Universal Contact Server and submitted in an interaction queue, or FINISHED, which means processing was stopped by Agent Desktop or the workflow.
Parameters
Name | Default | Description | Parameter Type | Data Type | Required | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
X-Hub-Signature | The request signature, for example sha1=hash. The hash is built using the body of the message and secret for the channel. | header | string | true | |||||||||||||||||||||||||||||
X-B3-TraceId | A unique trace ID for the request. | header | string | ||||||||||||||||||||||||||||||
events | The events payload. | body | true | ||||||||||||||||||||||||||||||
|
Responses
Code | Reason | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
200 | Operation was successful | ||||||||||||||||||||||
| |||||||||||||||||||||||
500 | Internal Server Error |
Usage
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"
-d '{
"operationId": "f6c49d91-926b-4473-b2f3-8d8fd295c968",
"data": {
"entities": [
{
}
]
}
}'
"https://api-demo.com/nexus/v3/some/interactions/webhook/path?"
Comments or questions about this documentation? Contact us for support!