> ## Documentation Index
> Fetch the complete documentation index at: https://www.voiceflow.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect a Voiceflow agent to Messenger

> Connect Facebook Messenger to a Voiceflow text agent. Configure the platform, host the relay, test replies and prepare release.

## Overview

Answer private messages to a Facebook Page with a Voiceflow agent. A developer-hosted HTTPS relay receives Messenger events, runs the agent and returns text to the same Page-scoped customer.

<a id="before-you-begin"></a>

## Before you begin

Collect the agent, account and host access.

| Requirement | Obtain before installation |
| --- | --- |
| Voiceflow owner | An existing agent with a known support answer, a private project API key, project ID and reviewed Environment alias. [Build the agent](/docs/documentation/build/overview) first, then [publish the intended release](/docs/documentation/deploy/environments/publishing). |
| Facebook Page | A Page administrator who can grant the app messaging access; personal-profile messaging is outside this walkthrough. |
| Meta permissions | `pages_messaging` for replies and `pages_manage_metadata` for Page webhook subscriptions. Use `pages_show_list` when discovering the administrator’s Pages. |
| Relay operator | A Node.js host, public HTTPS hostname, private secrets and persistent disk; an operator who can investigate paused conversations. |

The example provides public-policy text support. Keep private Voiceflow and platform credentials on the host; a customer’s messaging identity does not authorize access to orders or account records. Have the agent return text only and provide a support route in its instructions. Buttons, audio and Handoff traces need additional adapters; see [Adapt agent replies](/docs/guides/channels/messaging/adapt-agent-replies).

<a id="create-platform-app"></a>

## Prepare the platform account

Create the exact app or account this relay will use.

### 1. Create the app and select the Page

Create a business app in [Meta for Developers](https://developers.facebook.com/apps) and add the Messenger use case. In its Messenger settings, connect the Facebook Page that customers will message. Have an administrator grant the requested Page permissions and generate its Page access token. Save the Page ID as `META_ACCOUNT_ID` and the token as `META_ACCESS_TOKEN`.

### 2. Prepare app access

Use app-role testers for development. To receive messages from customers without an app role, request Advanced Access for the required permissions through App Review, complete the business verification Meta requests, and put the app in the applicable live state. Supply a privacy policy, data deletion instructions and the review test journey.

Use a durable Page token derived through the supported login flow. Access can be revoked when the administrator, Page permissions or business configuration changes; “long-lived” is not a guarantee against revocation. See [Messenger webhooks and access levels](https://developers.facebook.com/documentation/business-messaging/messenger-platform/webhooks).

<a id="run-relay"></a>

## Run the relay

Configure and host the supplied executable example.

Use the [configuration file](/docs/examples/messaging/facebook-messenger.env.example) for this platform. Every name below is read by the supplied artifact; IDs identify the resources prepared above. `VF_ENVIRONMENT` is the Environment alias, not a version label pasted from another project.

```dotenv
VF_API_KEY=YOUR_PRIVATE_VOICEFLOW_PROJECT_KEY
VF_PROJECT_ID=YOUR_VOICEFLOW_PROJECT_ID
VF_ENVIRONMENT=YOUR_ENVIRONMENT_ALIAS
DATA_DIR=/var/lib/voiceflow-messaging
PORT=8080
PLATFORM=facebook-messenger
META_APP_SECRET=YOUR_META_APP_SECRET
META_VERIFY_TOKEN=YOUR_RANDOM_VERIFY_TOKEN
META_ACCESS_TOKEN=YOUR_PAGE_ACCESS_TOKEN
META_ACCOUNT_ID=YOUR_FACEBOOK_PAGE_ID
META_GRAPH_VERSION=v27.0
```

### 1. Download and configure the relay

On a Linux host you administer, create `/opt/voiceflow-messaging` and extract the [relay archive](/docs/examples/messaging/messaging-relay.zip) there. Use Node.js 22.12 or later. Run `node --test fixtures.test.mjs` first: it generates signed synthetic events and mocks all remote calls, without credentials or live messages. Save the configuration above as `.env`, replacing every `YOUR_` value; restrict it to the service account with `chmod 600 .env`. Set `DATA_DIR` to a private persistent directory that this account can write.

The archive includes `core.mjs`, platform adapters, HTTP/Teams entry points, local fixture tests and a package manifest. Run `node --env-file=.env relay.mjs serve`. The HTTP relay uses only Node built-ins; it does not need `npm install`.

### 2. Expose the HTTPS endpoint

Point your own DNS hostname to the host. Terminate HTTPS with a valid public certificate and proxy to `127.0.0.1:8080`. For example, with [Caddy](https://caddyserver.com/docs/quick-starts/reverse-proxy) installed:

```sh
caddy reverse-proxy --from support.example.com --to 127.0.0.1:8080
```

Replace the example hostname, allow inbound 80/443 for certificate provisioning and keep the relay port private. Use a separate hostname and credentials for testing. Confirm `https://YOUR_HOST/health` returns `ok` before registering `/webhook`.

### 3. Keep one process running

After the foreground check, stop it and create a service using the unit below. Keep one process and one writable data directory per installation. Do not run this file store on ephemeral serverless storage or start multiple replicas.

```ini
# /etc/systemd/system/voiceflow-messaging.service
[Unit]
Description=Voiceflow messaging relay
After=network-online.target

[Service]
User=relay
WorkingDirectory=/opt/voiceflow-messaging
ExecStart=/usr/bin/node --env-file=.env relay.mjs serve
Restart=on-failure
UMask=0077

[Install]
WantedBy=multi-user.target
```

Create the non-login `relay` service user, give it read access to the application and `.env`, and ownership of `/var/lib/voiceflow-messaging`. Confirm `/usr/bin/node --version` is 22.12 or later, or substitute your actual Node path. Then run `sudo systemctl daemon-reload` and `sudo systemctl enable --now voiceflow-messaging`. Expect the service to stay active; keep the HTTPS proxy running through its own service.

The file store is a small single-process starting point. Back it up privately and monitor disk space, queue age and failures. Higher traffic needs a transactional inbox/outbox and per-conversation workers before adding replicas. Session keys and customer text are stored in the data directory; apply your retention and access policy there as well as in Voiceflow.

<a id="register-events"></a>

## Register incoming events

Connect the platform to your hosted endpoint.

Set the **Page** webhook callback to `https://YOUR_HOST/webhook` with `META_VERIFY_TOKEN`, then choose **Verify and save**. Subscribe to **messages**, **message_deliveries** and **message_reads**. In the Messenger app settings, subscribe the selected Page to your app. To make the Page subscription explicitly, save and run:

```js
// subscribe.mjs — node --env-file=.env subscribe.mjs
import { request } from './core.mjs';
const e = process.env;
console.log(await request(
  `https://graph.facebook.com/${e.META_GRAPH_VERSION}/${e.META_ACCOUNT_ID}/subscribed_apps`,
  { headers: { Authorization: `Bearer ${e.META_ACCESS_TOKEN}` },
    body: { subscribed_fields: ['messages', 'message_deliveries', 'message_reads'] } }
));
```

Expect `success: true`. The relay checks each POST’s raw-body HMAC with your app secret, scopes events to your Page and ignores message echoes. Postbacks and persistent menus require a separate action adapter; subscribing to them does not implement their behavior.

<a id="conversation-routing"></a>

## Route conversations and replies

Keep the customer, agent session and reply destination aligned.

| Stage | Mapping in the example |
| --- | --- |
| Customer identity | Page ID + sender’s Page-scoped ID; the sender is not a Facebook login for your customer database. |
| Incoming text | `entry[].messaging[].message.text`, excluding `is_echo` messages. |
| Visible reply | POST `/{page-id}/messages` with `recipient.id`, `message.text` and `messaging_type: RESPONSE`. |
| Duplicate and status | Deduplicate `message.mid`; delivery/read watermarks are receipts, not new messages. |

The relay hashes platform, destination account, customer/thread, project and Environment into a bounded Voiceflow `userID`. It creates a session with the private project key, stores the returned `sessionKey`, launches once, then sends `{ action: { type: "text", payload: text } }` to `/v4/interact`. Text traces become platform replies. Follow-ups reuse the key; starting a session every message would reset the conversation.

Automated standard replies stay within the 24-hour messaging window. The sample refuses stale queued replies; it does not apply human-agent tags or marketing permissions to AI output. See [Messenger’s messaging policy](https://developers.facebook.com/docs/messenger-platform/policy/policy-overview/).

The receive endpoint acknowledges persisted events before running the agent. Meta expects prompt acknowledgment and can redeliver failed notifications; `mid` prevents a second agent turn. This recipe is a private Page conversation, with no Facebook group or public comment support.

<a id="test-conversation"></a>

## Test a customer conversation

Verify the reply in the destination you installed.

### 1. Send a real platform message

From an app-role test account, open the Page in Messenger and send your prepared question. Expect the Page to answer in the same private conversation.

### 2. Check continuity and isolation

Ask a related follow-up, then test with a second authorized customer. Confirm the intended Voiceflow project and exchange in [Transcripts](/docs/documentation/measure/transcripts). Run `node --env-file=.env relay.mjs inspect` while the service is stopped to compare event IDs, conversation keys and completion states without printing session tokens.

### 3. Check this platform’s delivery behavior

Send a second question from a different test account. Its answer must not include the first customer’s context; run the included signed-fixture tests and confirm only one turn.

A saved callback, accepted API request or successful Voiceflow Run does not prove this platform conversation. Keep local signed-fixture tests separate from this authenticated customer test.

<a id="troubleshooting" />

### The callback saves but no reply arrives

Check platform access as well as endpoint connectivity.

Check Page subscription as well as app-level webhook configuration, Page-token validity, the Page ID and Advanced Access. If delivery succeeds only for app admins, resolve app review before inviting customers.

### A conversation is paused or a reply is duplicated

Reconcile remote effects before resuming the saved job.

Inspect the event’s `phase`, `failedDuring`, saved traces and accepted chunks in the private data file. A runtime timeout can occur after a tool action; a send timeout can occur after the platform accepted the message. The sample pauses that conversation and does not retry either effect automatically. Follow [Recover failed messages](/docs/guides/channels/messaging/recover-failed-messages), then repeat the platform test.

<a id="go-live"></a>

## Release and maintain the connection

Promote the tested route and keep recovery available.

### 1. Approve the production destination

Complete App Review and the applicable live configuration, then test with an authorized account that has no app role. Keep the approved Page and privacy/deletion endpoints available.

### 2. Release the reviewed agent

Have the Voiceflow owner publish the tested agent to the intended Environment. Deploy that alias and production credentials to the relay, restart its service and repeat the [customer test](#test-conversation) with a fresh customer/session. Existing session keys are not an automatic migration to a new release. Keep the previous deployment and state backup available for rollback.

### Rotate, update or disconnect

Maintain both the provider registration and the relay state.

Stop the service before changing `.env` or running maintenance commands. Rotate the platform credentials using its administrator controls, update the secret file and restart. If a webhook secret changes, update both sides and check a real event. For a release change, drain or reconcile pending jobs first; do not erase the state file to resolve a delivery problem.

To disconnect, disable/remove this callback or uninstall this app in the provider, stop the relay and revoke its unused credentials. Confirm no new events arrive and retain/delete customer state according to your policy. Keep the registration details needed to reconnect. See [Pause automated replies](/docs/guides/channels/messaging/pause-automated-replies) for a temporary conversation-specific pause.
