Webhooks

Get an HTTPS callback for every message status change, signed so you can verify it came from us.

Applies to

verify-signature.js

1// Placeholder: Fernway is a fictional API.
2import { verifyWebhook } from "@fernway/node"
3 
4export async function POST(req) {
5  const event = verifyWebhook(
6    await req.text(),
7    req.headers.get("fernway-signature"),
8    process.env.FERNWAY_WEBHOOK_SECRET,
9  )
10  if (event.type === "message.delivered") {
11    // mark the message as delivered
12  }
13  return new Response(null, { status: 204 })
14}

Create an endpoint

Add an HTTPS URL in the dashboard or with POST /v2/webhook_endpoints and pick the events you want, such as message.delivered and message.failed. Fernway sends a JSON event to that URL each time one happens.

Verify signatures

Every event carries a fernway-signature header. Verify it with your endpoint's signing secret before you trust the payload, and reject events older than five minutes to block replays.

Retries

Return any 2xx status within 10 seconds. Otherwise Fernway retries with exponential backoff for up to 24 hours. Make your handler idempotent by storing the event id.

Placeholder API

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

← Message statuses

Webhook signatures →