Skip to main content
POST
/
action
/
send_event
Send event
curl --request POST \
  --url https://api.livechatinc.com/v3.6/agent/action/send_event \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chat_id": "PW94SJTGW6",
  "event": {
    "type": "message",
    "text": "hello world",
    "visibility": "all"
  }
}
'
import requests

url = "https://api.livechatinc.com/v3.6/agent/action/send_event"

payload = {
"chat_id": "PW94SJTGW6",
"event": {
"type": "message",
"text": "hello world",
"visibility": "all"
}
}
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: 'hello world', visibility: 'all'}
})
};

fetch('https://api.livechatinc.com/v3.6/agent/action/send_event', 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.6/agent/action/send_event",
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' => 'hello world',
'visibility' => 'all'
]
]),
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.6/agent/action/send_event"

payload := strings.NewReader("{\n \"chat_id\": \"PW94SJTGW6\",\n \"event\": {\n \"type\": \"message\",\n \"text\": \"hello world\",\n \"visibility\": \"all\"\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.6/agent/action/send_event")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"chat_id\": \"PW94SJTGW6\",\n \"event\": {\n \"type\": \"message\",\n \"text\": \"hello world\",\n \"visibility\": \"all\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.livechatinc.com/v3.6/agent/action/send_event")

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\": \"hello world\",\n \"visibility\": \"all\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "event_id": "Q20N9CKRX2_1"
}
Required scopes: or

Authorizations

Authorization
string
header
required

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

application/json
chat_id
string
required

The ID of the chat to send the event to.

event
object
required

An event object. Does not support the form type in the Text app. For field details, see the Agent Chat API data structures reference.

Response

200 - application/json

Event sent.

event_id
string

The ID of the sent event.