Farcaster Frames
Generate custom campaign links for a Farcaster frames flow
This page explains how to create a campaign for Farcaster Frames and the modifications you have to apply to your frames to make sure Safary collects the visitors' interactions with your frames.
1) Create a new campaign for Farcaster Frames on Safary
Click on the "Launch campaigns" menu, then under "Farcaster Frames" click on "+ New Campaign".
You will be asked to insert:
Campaign name: Add a meaningful name that the campaign will be assigned to in Safary's dashboards.
First frame URL: Enter the full URL of your first frame. This is the link you typically paste into some client like Warpcast, and it gives the first frame that a user will see.
After filling those two fields and clicking "Next →", you will receive a link similar to:
In the section below we explain how to use this link in your frames.
2) Frames setup
2.1) Add meaningful titles to the frames
We will use the safary.link generated in the previous step to make sure Safary collects the interactions happening on your frames.
However, before that, to make sure your data is easy to understand, your frames need to have meaningful titles.
Make sure to add a different title to each frame you want to consider different!
We consider a frame to be unique if they have the same title and image url.
Therefore, if you want to see a specific frame's interactions separate from other frames, make sure it has a unique title and image url.
Similarly, if you want two different frames to be seen as the same, add the same title and image url to both of them.
2.2) Add the safary.link of your campaign to target and post urls
To allow Safary to collect interactions within your frame, every URL and/or path that is added to a target or post_url property needs to start with the safary.link provided in the campaign creation.
For example, consider you followed the first step in this page to create a campaign and received the following link as a result:
If your frame has a post_urlproperty, you should add the safary.link above before the URL in the property. For example
Before adding safary.link:
After adding safary.link:
For button actions with target or post_url, the approach is the same. For example:
Before adding safary.link:
After adding safary.link:
Add the safary.link to all target and post_url of buttons with actions of any type.
What to do if the frame has a transaction?
If the button action type is tx (transaction), you can still add a safary.link, and we will collect only the wallet address.
Add a post_url in the frame with a transaction (and also add a safary.link to it).
This property defines the next frame to go after the transaction.
Adding it and including a safary.link makes sure we collect the transaction confirmation.
What if the button action type is a link?
Please also add the safary.link before that. For example:
Before adding safary.link:
After adding safary.link:
In this case we collect the click action.
What if the frame shows an error to the user?
If the action in a frame does not return a successful next frame (or next action) for any reason (such as timeout or server error), we collect the error and show in our analytics.
This way you will know if users are having issues and where exactly that is happening.
Last updated