Add a new device
curl --request POST \
--url http://localhost:3000/devices \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"device_id": "my-custom-device-id",
"webhook_url": "https://device-webhook.example.com/handler",
"webhook_secret": "super-secret-key",
"webhook_events": "message,message.ack",
"webhook_insecure_skip_verify": false
}
'import requests
url = "http://localhost:3000/devices"
payload = {
"device_id": "my-custom-device-id",
"webhook_url": "https://device-webhook.example.com/handler",
"webhook_secret": "super-secret-key",
"webhook_events": "message,message.ack",
"webhook_insecure_skip_verify": False
}
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: 'my-custom-device-id',
webhook_url: 'https://device-webhook.example.com/handler',
webhook_secret: 'super-secret-key',
webhook_events: 'message,message.ack',
webhook_insecure_skip_verify: false
})
};
fetch('http://localhost:3000/devices', 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/devices",
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' => 'my-custom-device-id',
'webhook_url' => 'https://device-webhook.example.com/handler',
'webhook_secret' => 'super-secret-key',
'webhook_events' => 'message,message.ack',
'webhook_insecure_skip_verify' => false
]),
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/devices"
payload := strings.NewReader("{\n \"device_id\": \"my-custom-device-id\",\n \"webhook_url\": \"https://device-webhook.example.com/handler\",\n \"webhook_secret\": \"super-secret-key\",\n \"webhook_events\": \"message,message.ack\",\n \"webhook_insecure_skip_verify\": false\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/devices")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"device_id\": \"my-custom-device-id\",\n \"webhook_url\": \"https://device-webhook.example.com/handler\",\n \"webhook_secret\": \"super-secret-key\",\n \"webhook_events\": \"message,message.ack\",\n \"webhook_insecure_skip_verify\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/devices")
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\": \"my-custom-device-id\",\n \"webhook_url\": \"https://device-webhook.example.com/handler\",\n \"webhook_secret\": \"super-secret-key\",\n \"webhook_events\": \"message,message.ack\",\n \"webhook_insecure_skip_verify\": false\n}"
response = http.request(request)
puts response.read_body{
"code": "SUCCESS",
"message": "Device added",
"status": 200,
"results": {
"id": "my-device-id",
"display_name": "John Doe",
"state": "disconnected",
"jid": "628123456789@s.whatsapp.net",
"created_at": "2024-01-01T00:00:00Z",
"webhook_url": "https://device-webhook.example.com/handler",
"webhook_secret": "super-secret-key",
"webhook_events": "message,message.ack",
"webhook_insecure_skip_verify": false
}
}{
"code": 400,
"message": "field cannot be blank",
"results": null
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "you are not loggin",
"results": null
}device
Add a new device
Create a new device slot for multi-device management
POST
/
devices
Add a new device
curl --request POST \
--url http://localhost:3000/devices \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"device_id": "my-custom-device-id",
"webhook_url": "https://device-webhook.example.com/handler",
"webhook_secret": "super-secret-key",
"webhook_events": "message,message.ack",
"webhook_insecure_skip_verify": false
}
'import requests
url = "http://localhost:3000/devices"
payload = {
"device_id": "my-custom-device-id",
"webhook_url": "https://device-webhook.example.com/handler",
"webhook_secret": "super-secret-key",
"webhook_events": "message,message.ack",
"webhook_insecure_skip_verify": False
}
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: 'my-custom-device-id',
webhook_url: 'https://device-webhook.example.com/handler',
webhook_secret: 'super-secret-key',
webhook_events: 'message,message.ack',
webhook_insecure_skip_verify: false
})
};
fetch('http://localhost:3000/devices', 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/devices",
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' => 'my-custom-device-id',
'webhook_url' => 'https://device-webhook.example.com/handler',
'webhook_secret' => 'super-secret-key',
'webhook_events' => 'message,message.ack',
'webhook_insecure_skip_verify' => false
]),
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/devices"
payload := strings.NewReader("{\n \"device_id\": \"my-custom-device-id\",\n \"webhook_url\": \"https://device-webhook.example.com/handler\",\n \"webhook_secret\": \"super-secret-key\",\n \"webhook_events\": \"message,message.ack\",\n \"webhook_insecure_skip_verify\": false\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/devices")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"device_id\": \"my-custom-device-id\",\n \"webhook_url\": \"https://device-webhook.example.com/handler\",\n \"webhook_secret\": \"super-secret-key\",\n \"webhook_events\": \"message,message.ack\",\n \"webhook_insecure_skip_verify\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/devices")
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\": \"my-custom-device-id\",\n \"webhook_url\": \"https://device-webhook.example.com/handler\",\n \"webhook_secret\": \"super-secret-key\",\n \"webhook_events\": \"message,message.ack\",\n \"webhook_insecure_skip_verify\": false\n}"
response = http.request(request)
puts response.read_body{
"code": "SUCCESS",
"message": "Device added",
"status": 200,
"results": {
"id": "my-device-id",
"display_name": "John Doe",
"state": "disconnected",
"jid": "628123456789@s.whatsapp.net",
"created_at": "2024-01-01T00:00:00Z",
"webhook_url": "https://device-webhook.example.com/handler",
"webhook_secret": "super-secret-key",
"webhook_events": "message,message.ack",
"webhook_insecure_skip_verify": false
}
}{
"code": 400,
"message": "field cannot be blank",
"results": null
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "you are not loggin",
"results": null
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Optional custom device ID. If not provided, one will be generated.
Example:
"my-custom-device-id"
Optional device-specific webhook URL. If set, events for this device will be sent here instead of the global webhook.
Example:
"https://device-webhook.example.com/handler"
Optional secret used to sign device-specific webhook payloads (HMAC).
Example:
"super-secret-key"
Optional comma-separated list of event names to forward to the device-specific webhook. Empty means all events.
Example:
"message,message.ack"
Optional. Skip TLS certificate verification when delivering to the device-specific webhook.
Example:
false