Skip to main content

setWebhook

The method sets the webhook where events will be routed to be processed by Tovie Platform. For instance, it can be a message processed by the agent or the chat closed.

Request

Request:

POST {apiUrl}/setWebhook

Request body:

{
"url": "https://example.com/webhooks/{ApiKey}",
}

Request parameters:

ParameterTypeDescription
apiUrlstringAPI URL where Operator API requests will be routed to.
urlstringThe webhook set by the setWebhook method. It will later be used to accept events routed to Tovie Platform.
ApiKeystringChannel ID.

Response

Response format:

200 (OK)    // request successfully completed