Skip to main content
POST
create device

Authorizations

Authorization
string
header
required

API key authentication. Provide your API key as: Authorization: Bearer <api_key>

Body

application/json
name
string

User-friendly device name

webhookUrl
string

Webhook URL for receiving events

webhookEvents
enum<string>[]

Events to send to webhook (defaults to all). See webhook documentation for event payloads.

Available options:
connection.open,
connection.closed,
connection.auth,
connection.timeout,
connection.logout,
message.received,
message.sent,
message.updated,
message.deleted,
call
phoneNumber
string

Phone number for pairing code authentication (alternative to QR code). Must be digits only, include country code, no + or spaces.

Example:

"31612345678"

Response

Device created successfully

device
object
status
object