Navbar
Logo icon Name

Clients & Libraries

SignalWire has clients in a number of different languages that make using the Relay API simple and easy. The SignalWire team builds and maintains these clients for popular languages, ensuring you get an easy-to-use and supported platform to build your applications upon. This documentation is for all of SignalWire's server side clients.

NodeJS

Install the package using NPM:

npm install @signalwire/node

In order to use the NodeJS client, you must get your host, project, and token from your SignalWire dashboard.

const host = "example.signalwire.com"
const project = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
const token = "PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

Use the SignalWire host, project, and token variables to then set up the Client:

const { RelayClient } = require('@signalwire/node')
const client = new RelayClient({ host, project, token })

You can then use the client to make requests.