/

Getting started

Quickstart

Create an API key, install an SDK and send your first message in about five minutes.

Applies to

v2

send-first-message.js
// Placeholder: Fernway is a fictional API.
import { Fernway } from "@fernway/node"
 
const fernway = new Fernway(process.env.FERNWAY_API_KEY)
 
const message = await fernway.messages.create({
to: "+15555550123",
channel: "sms",
body: "Your code is 482913",
})
 
console.log(message.id) // msg_01J9ZK4T7Q

Before you start

You need a Fernway account and a test API key. Test keys start with fw_test_ and never send real messages, so you can try every endpoint without charges. Copy your key from the dashboard and keep it on your server, never in browser code.

Send a message

Install the Node SDK with npm install @fernway/node, then run the snippet on this page. The API answers with a message object in the queued state. Delivery happens in the background and Fernway reports each status change to your webhook endpoint.

Next steps

  • Read Authentication to learn how keys and scopes work.

  • Set up Webhooks so you hear about delivered and failed messages.

  • Browse the API reference for every endpoint and field.

i

Placeholder API

Fernway is a fictional product used to show how this template works. Replace these docs with your own in the CMS.

Create a free website with Framer, the website builder loved by startups, designers and agencies.