How to Start Call via URL Parameter (UTM) – Face2Face.io

Enable visitors to request an agent as soon as they join the site via link by adding requestAgent=workflowId to your website's URL. This functionality seamlessly integrates with the F2F SDK, automatically initiating the requestAgent function when the page loads.

Overview

By appending the requestAgent=workflowId parameter to your website's URL, you can allow visitors to trigger the F2FSDK.requestAgent() function without additional user interaction.

Prerequisites

Popup Workflow ID: Obtain the unique ID of your popup workflow from the F2F dashboard under the Workflows section.

💡

Where to find your workflowId ? - Navigate to workflows - Click on the 3 dots next to the workflow you’d like to trigger (TYPE must be “popup”) - Click “Copy Workflow ID” - Paste workflowID in your url like so https://face2face.io?requestAgent=workflowId

F2F SDK Integration: Ensure the F2F SDK is properly integrated into your website.

How It Works

When the URL contains the requestAgent=workflowId parameter:

The F2F SDK detects the parameter.

The F2FSDK.requestAgent("workflowId") function is automatically invoked using the value of the parameter.

For example:

https://yourwebsite.com/?requestAgent=your_workflow_id

This will call F2FSDK.requestAgent("your_workflow_id") when the page loads.

Example Use Case

Suppose you are running a marketing campaign where visitors can request assistance as soon as they land on a specific page. You can create and share the following link:

https://yourwebsite.com/product?requestAgent=12345

When visitors click the link, the F2F SDK automatically triggers the popup workflow associated with the workflow ID 12345 and all your agents will receive call request.

Notes

If you haven't already, make sure to read the documentation for the requestAgent function.

Ensure the workflowId corresponds to a valid popup workflow in the F2F dashboard.

This feature works alongside other URL parameters, such as f2f-userId, for tracking and identification:

https://yourwebsite.com/?f2f-joined_from_new_link=true&requestAgent=12345