SDKS

Official SDKs for v2.

Typed clients with retries, idempotency keys and webhook signature checks built in. Every SDK targets API v2.

Node.js

v2.4.0

API v2

Requires Node 18+. Placeholder package name, replace with yours.

Install

$npm install @fernway/node

Quickstart →

Python

v2.4.0

API v2

Requires Python 3.9+. Placeholder package name, replace with yours.

Install

$pip install fernway

Quickstart →

Go

v2.3.1

API v2

Requires Go 1.21+. Placeholder package name, replace with yours.

Install

$go get github.com/fernway-example/fernway-go

Quickstart →

Ruby

v2.2.0

API v2

Requires Ruby 3.1+. Placeholder package name, replace with yours.

Install

$gem install fernway

Quickstart →

FOR AI CODING AGENTS

Agent instructions

Paste this into your AGENTS.md, Cursor rules or system prompt so coding assistants call the current API instead of v1. Copy it with the button.

AGENTS.md

1# Fernway API (placeholder)
2- Base URL: https://api.fernway.example/v2
3- Auth: header `Authorization: Bearer $FERNWAY_KEY`; never put keys in client code.
4- Use POST /v2/messages with `channel` = sms | email | push.
5- Always send an `Idempotency-Key` header on POST.
6- Do not use /v1 endpoints or the `sender` field (use `from`).
7- Paginate with `cursor`; verify webhooks with the `Fernway-Signature` header.
8- Docs: /docs  Changelog: /changelog

Keep it in sync

Update this block whenever you ship a breaking change so agents and humans read the same rules.

See the changelog →