curl --request POST \
--url https://api.livechatinc.com/v3.7/agent/action/send_event_preview \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"chat_id": "PW94SJTGW6",
"event": {
"type": "message",
"text": "Preview of a longer response...",
"visibility": "all",
"custom_id": "31-0C-1C-07-DB-16"
}
}
'import requests
url = "https://api.livechatinc.com/v3.7/agent/action/send_event_preview"
payload = {
"chat_id": "PW94SJTGW6",
"event": {
"type": "message",
"text": "Preview of a longer response...",
"visibility": "all",
"custom_id": "31-0C-1C-07-DB-16"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
chat_id: 'PW94SJTGW6',
event: {
type: 'message',
text: 'Preview of a longer response...',
visibility: 'all',
custom_id: '31-0C-1C-07-DB-16'
}
})
};
fetch('https://api.livechatinc.com/v3.7/agent/action/send_event_preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.livechatinc.com/v3.7/agent/action/send_event_preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chat_id' => 'PW94SJTGW6',
'event' => [
'type' => 'message',
'text' => 'Preview of a longer response...',
'visibility' => 'all',
'custom_id' => '31-0C-1C-07-DB-16'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.livechatinc.com/v3.7/agent/action/send_event_preview"
payload := strings.NewReader("{\n \"chat_id\": \"PW94SJTGW6\",\n \"event\": {\n \"type\": \"message\",\n \"text\": \"Preview of a longer response...\",\n \"visibility\": \"all\",\n \"custom_id\": \"31-0C-1C-07-DB-16\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.livechatinc.com/v3.7/agent/action/send_event_preview")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"chat_id\": \"PW94SJTGW6\",\n \"event\": {\n \"type\": \"message\",\n \"text\": \"Preview of a longer response...\",\n \"visibility\": \"all\",\n \"custom_id\": \"31-0C-1C-07-DB-16\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.7/agent/action/send_event_preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chat_id\": \"PW94SJTGW6\",\n \"event\": {\n \"type\": \"message\",\n \"text\": \"Preview of a longer response...\",\n \"visibility\": \"all\",\n \"custom_id\": \"31-0C-1C-07-DB-16\"\n }\n}"
response = http.request(request)
puts response.read_bodySend event preview
Sends an event that isn’t saved in the chat. Use this method when you’re preparing a longer response and want to send a partial update before sending the final message with Send Event.
Only the message type is supported. Visibility must be set to all or skipped. The user must be added to the chat before they can send an event.
curl --request POST \
--url https://api.livechatinc.com/v3.7/agent/action/send_event_preview \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"chat_id": "PW94SJTGW6",
"event": {
"type": "message",
"text": "Preview of a longer response...",
"visibility": "all",
"custom_id": "31-0C-1C-07-DB-16"
}
}
'import requests
url = "https://api.livechatinc.com/v3.7/agent/action/send_event_preview"
payload = {
"chat_id": "PW94SJTGW6",
"event": {
"type": "message",
"text": "Preview of a longer response...",
"visibility": "all",
"custom_id": "31-0C-1C-07-DB-16"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
chat_id: 'PW94SJTGW6',
event: {
type: 'message',
text: 'Preview of a longer response...',
visibility: 'all',
custom_id: '31-0C-1C-07-DB-16'
}
})
};
fetch('https://api.livechatinc.com/v3.7/agent/action/send_event_preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.livechatinc.com/v3.7/agent/action/send_event_preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'chat_id' => 'PW94SJTGW6',
'event' => [
'type' => 'message',
'text' => 'Preview of a longer response...',
'visibility' => 'all',
'custom_id' => '31-0C-1C-07-DB-16'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.livechatinc.com/v3.7/agent/action/send_event_preview"
payload := strings.NewReader("{\n \"chat_id\": \"PW94SJTGW6\",\n \"event\": {\n \"type\": \"message\",\n \"text\": \"Preview of a longer response...\",\n \"visibility\": \"all\",\n \"custom_id\": \"31-0C-1C-07-DB-16\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.livechatinc.com/v3.7/agent/action/send_event_preview")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"chat_id\": \"PW94SJTGW6\",\n \"event\": {\n \"type\": \"message\",\n \"text\": \"Preview of a longer response...\",\n \"visibility\": \"all\",\n \"custom_id\": \"31-0C-1C-07-DB-16\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.livechatinc.com/v3.7/agent/action/send_event_preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"chat_id\": \"PW94SJTGW6\",\n \"event\": {\n \"type\": \"message\",\n \"text\": \"Preview of a longer response...\",\n \"visibility\": \"all\",\n \"custom_id\": \"31-0C-1C-07-DB-16\"\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.
Body
The ID of the chat to send the preview to.
An event object. Only the message type is supported. For field details, see the Agent Chat API data structures reference.
Show child attributes
Show child attributes
Response
Event preview sent.
Was this page helpful?