Entry Point Links and Referral Parameters (Payload)

Modified on Fri, 2 Aug at 9:07 AM


Entry Points Links are bot links that allow your customers to easily reach your bot. In addition, it will enable you to invoke a specified conversation flow when the link is open and enable you to track the most effective links.


You can use bot links on your website, email newsletters, and more.


In addition to giving you a way to link your customers to your bot, the Entry Point Links also support passing an arbitrary parameter via these links. This can be used for many purposes, such as tracking different links placed in different channels, invoking specific conversation flow when the link is opened, or trying a user to session or account in an external app.



How to create an Entry Point Link


Go to Menu > Marketing > Entry Point Link Links and click the “Add” button.





After you create your Entry Point Link, click 3 dots and click the Get Link option. Depending on the Channel the link will be like below.


Messenger:  https://m.me/FB_PAGE_ID?ref=giveaway  

Instagram:  https://ig.me/m/INSTAGRAM_USERNAME?ref=giveaway 

WhatsApp: https://wa.me/PHONE_NUMBER?text=/giveaway 

Telegram:  https://t.me/BOT_USERNAME?start=giveaway 

WebChat: https://app.chatgptbuilder.io/webchat/?p=CHATBOTBUILDER_ACCOUNT_ID &ref=giveaway



How to save payload data to a custom field


When you create an Entry Point Link, you can specify that your link may contain data that is saved on the user custom field once the link is opened.


Show user_external_identifier

You can append any data to an Entry Point Link and when a user opens your link the data is saved into the user custom field. Append “payload” at the end of the link, where the payload is any data you want to save to a custom field. In the example below, we used a Messenger link, but this is the general concept for all channels.


https://m.https://m.me/FB_PAGE_ID?ref=giveaway--456 


In this link 456 is the payload. When a user opens this link 456 is saved to the customer field user_external_identifier. 



How to pass multiple payloads in an Entry Point Link


You can append as many values as you save them to multiple custom fields.


Ensure that you are NOT using the custom field name as only our built-in system fields will work by name. Instead, simply use the custom field ID.

To find this ID, head over to flows > custom fields > find custom field > click on the three dots to the right > copy the ID


You should pass an array of IDs and values e.g: 

[{id: "email", value:"...@gmail.com"}, {id:000000, value: "value_here"}]





In the example below we used the Messenger link, and this is the general concept for other channels as well.


https://m.me/<FB_PAGE_ID>?ref=giveaway–value1–738–value2–514–value3


Value1 will be saved on the custom field that you choose when you create the Entry Point Link.


In the link above the 738 and 514 are custom field IDs and value1 and value2 are any data you want to save in the custom field 738 and 514 respectively.


id1value1


or


id1value1id2value2


or


–id1–value1–id2–value2–id3–value3 


or

………..


To get a Custom Field ID, go to Menu > Flows > Custom Fieldsclick 3 dots and click Get ID.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article