Working with an AI agent? Download the full documentation as a Markdown file to use as context.
Download full .mdA channel is one connected Meta asset — a WhatsApp number, an Instagram account, or a Facebook Page — that you send and receive messages through. This page covers how to connect, manage and reconnect channels.
For the exact request/response schema of every channel endpoint (fields, types, status codes), see the API Reference. This page is the task-level guide; it does not repeat the field tables.
Before connecting any channel — WhatsApp, Instagram or Facebook Messenger — make sure both conditions below are met. They apply equally to the Portal flow and the API flow; if either is missing, Meta stops the OAuth popup before a channel can be created.
Use this to connect your own channels, no code required.
Saving a webhook URL in the Portal does not create a webhook_secret. Set one
explicitly so incoming deliveries are signed — see Webhook secret.
Use this when your application connects channels on behalf of your end users.
Step 1 — Whitelist your redirect URI. For security, the user can only be
redirected back to a URL you have pre-registered for your API key. Register the
URL(s) where users land after OAuth (wildcards are allowed, e.g.
https://*.example.com/callback):
curl -X POST https://fiwano.com/api/v1/redirects \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"uri_pattern": "https://yourapp.com/callback"}'
You manage these with GET /api/v1/redirects and DELETE /api/v1/redirects/{id}.
Step 2 — Request a setup URL. Pass one of your whitelisted redirect URIs. The
URL is valid until the expires_at returned in the response — open it in a
browser or popup for the user:
curl -X POST https://fiwano.com/api/v1/channels/setup-url \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"channel_type": "whatsapp", "redirect_uri": "https://yourapp.com/callback"}'
Step 3 — User completes Meta OAuth. After approval, the user is redirected to
your redirect_uri with a one-time code parameter:
https://yourapp.com/callback?code=abc123...
On failure, the redirect instead carries two query params — branch your logic on
error only:
| Query param | How to use it |
|---|---|
error |
Machine-readable code. Branch on this. access_denied — the user cancelled the Meta dialog. setup_failed — setup could not complete (e.g. no Instagram Business account was accessible with the permissions granted). |
message |
URL-encoded, human-readable English explanation, safe to display to the user. Free-form and may change — never parse or branch on its text. |
Example failure redirect:
https://yourapp.com/callback?error=setup_failed&message=We%20couldn%27t%20access%20any%20Instagram%20Business%20account...
Step 4 — Exchange the code. Within 5 minutes (single-use), exchange the code for the channel. You can configure the webhook in the same call:
curl -X POST https://fiwano.com/api/v1/channels/exchange-code \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"code": "abc123...",
"webhook_url": "https://yourapp.com/webhooks/meta",
"webhook_events": ["message.received", "message.delivered", "message.failed"]
}'
The response returns your channel_id (store it — every other call uses it). When
you set webhook_url and pass no webhook_secret, Fiwano auto-generates one and
returns it here. It is returned only in this response — GET never shows it
again — so store it to verify webhook signatures (Webhook secret).
All fields except code are optional and can be set later via
PATCH /api/v1/channels/{id}.
By default, no events are delivered. You must explicitly set
webhook_events— here or later — to receive any webhooks.
The webhook_secret is the HMAC key Fiwano uses to sign webhook deliveries, so
your endpoint can confirm a request genuinely came from Fiwano and was not altered in
transit. When a channel has a secret, every delivery carries an
X-Webhook-Signature: sha256=<hmac> header — see Webhooks
for the verification snippet. A channel with no secret receives unsigned deliveries.
How a secret first appears differs by how you connect — and this is the one place the Portal and the API deliberately behave differently:
webhook_url and the channel has no secret yet,
Fiwano auto-generates one (64-character hex) and returns it in the
exchange-code / PATCH /api/v1/channels/{id} response — so channels you connect by
API are signed by default. To use a specific value instead, pass your own
webhook_secret in that same call.Reading it back. The value is only returned the moment it is set or changed — in
the Portal's one-time reveal, or in the exchange-code and
PATCH /api/v1/channels/{id} responses. GET /api/v1/channels and
GET /api/v1/channels/{id} never return it; they only report
has_webhook_secret: true | false. Store the value when it is shown — if you
lose it, your only option is to set a new one.
Rotating it. Set a new secret any time by passing a new webhook_secret to
PATCH /api/v1/channels/{id}, or with the Portal's Generate random / Save
actions. Updating only webhook_url/webhook_events leaves the secret untouched. A
change takes effect on the very next delivery — there is no overlap window, so
switch your verifier to the new secret at the same moment, or signatures will mismatch.
Constraints and recommendations.
| Task | Endpoint |
|---|---|
| List all channels (active and inactive), each with its current subscription state | GET /api/v1/channels |
| Inspect one channel | GET /api/v1/channels/{id} |
| Update webhook URL / secret / events | PATCH /api/v1/channels/{id} |
| Deactivate a channel | DELETE /api/v1/channels/{id} |
Each channel carries a subscription block describing its billing state — see
Subscriptions & Billing for what the
combinations mean. Full field lists live in the API Reference.
Deactivation is a soft delete. DELETE stops the channel from sending and
receiving, but does not erase it — its channel_id and history are preserved so
you can reconnect later. Fiwano also unsubscribes the channel's Meta webhook
resource only when it is safe to: a WABA subscription is kept if another active
WhatsApp channel uses the same WABA, and a Page subscription is kept if another
active Instagram/Facebook channel uses the same Page.
A channel goes inactive when it is deactivated (DELETE /api/v1/channels/{id}) or
when its Meta connection can no longer be maintained (for example, the account
owner revoked access in Meta). To bring it back, run the same connection flow
again for the same Meta account (same WhatsApp number, Instagram account, or
Facebook Page):
channel_id, webhook
URL/secret/events and history are preserved. No new channel is created and your
stored channel_id mapping stays valid."already connected to another account").Fiwano API Documentation