Sync message history to Chatwoot
curl --request POST \
--url http://localhost:3000/chatwoot/sync \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"device_id": "<string>",
"days_limit": 3,
"include_media": true,
"include_groups": true
}
'import requests
url = "http://localhost:3000/chatwoot/sync"
payload = {
"device_id": "<string>",
"days_limit": 3,
"include_media": True,
"include_groups": True
}
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({
device_id: '<string>',
days_limit: 3,
include_media: true,
include_groups: true
})
};
fetch('http://localhost:3000/chatwoot/sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/chatwoot/sync",
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([
'device_id' => '<string>',
'days_limit' => 3,
'include_media' => true,
'include_groups' => true
]),
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 := "http://localhost:3000/chatwoot/sync"
payload := strings.NewReader("{\n \"device_id\": \"<string>\",\n \"days_limit\": 3,\n \"include_media\": true,\n \"include_groups\": true\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("http://localhost:3000/chatwoot/sync")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"device_id\": \"<string>\",\n \"days_limit\": 3,\n \"include_media\": true,\n \"include_groups\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/chatwoot/sync")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"device_id\": \"<string>\",\n \"days_limit\": 3,\n \"include_media\": true,\n \"include_groups\": true\n}"
response = http.request(request)
puts response.read_body{
"status": 200,
"code": "SYNC_STARTED",
"message": "History sync initiated in background",
"results": {
"device_id": "my-device-id",
"days_limit": 3,
"include_media": true,
"include_groups": true
}
}{
"code": 400,
"message": "field cannot be blank",
"results": null
}{
"status": 409,
"code": "SYNC_ALREADY_RUNNING",
"message": "A sync is already in progress for this device",
"results": {
"progress": "<unknown>"
}
}chatwoot
Sync message history to Chatwoot
Initiates a background sync of WhatsApp message history to Chatwoot. Messages from the configured number of days will be imported. This endpoint requires CHATWOOT_ENABLED=true in configuration.
POST
/
chatwoot
/
sync
Sync message history to Chatwoot
curl --request POST \
--url http://localhost:3000/chatwoot/sync \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"device_id": "<string>",
"days_limit": 3,
"include_media": true,
"include_groups": true
}
'import requests
url = "http://localhost:3000/chatwoot/sync"
payload = {
"device_id": "<string>",
"days_limit": 3,
"include_media": True,
"include_groups": True
}
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({
device_id: '<string>',
days_limit: 3,
include_media: true,
include_groups: true
})
};
fetch('http://localhost:3000/chatwoot/sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/chatwoot/sync",
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([
'device_id' => '<string>',
'days_limit' => 3,
'include_media' => true,
'include_groups' => true
]),
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 := "http://localhost:3000/chatwoot/sync"
payload := strings.NewReader("{\n \"device_id\": \"<string>\",\n \"days_limit\": 3,\n \"include_media\": true,\n \"include_groups\": true\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("http://localhost:3000/chatwoot/sync")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"device_id\": \"<string>\",\n \"days_limit\": 3,\n \"include_media\": true,\n \"include_groups\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/chatwoot/sync")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"device_id\": \"<string>\",\n \"days_limit\": 3,\n \"include_media\": true,\n \"include_groups\": true\n}"
response = http.request(request)
puts response.read_body{
"status": 200,
"code": "SYNC_STARTED",
"message": "History sync initiated in background",
"results": {
"device_id": "my-device-id",
"days_limit": 3,
"include_media": true,
"include_groups": true
}
}{
"code": 400,
"message": "field cannot be blank",
"results": null
}{
"status": 409,
"code": "SYNC_ALREADY_RUNNING",
"message": "A sync is already in progress for this device",
"results": {
"progress": "<unknown>"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json