1What FoxPlug reads from Framer
These are the exact things it reads, and nothing else.
| What | The details it takes |
|---|---|
| What differs since the last publish | one call to Framer's server API for the project: the list of pages added since the last publish, plus the lists of edited and removed paths; the connection is opened for the call and closed right after |
| The pages that are added but not yet published | their paths, sorted, kept on your connection as the waiting set so the next press can compare against it |
| How many paths were edited and how many removed | only the two counts are kept, not the paths, together with the time of the read |
| The pages published between two presses | pages that were waiting at your last press, are not waiting now and were not removed; those become the one moment |
2Moments it finds, and what each becomes
A moment is one thing that happened in Framer worth a second look. Each one is scored, then it becomes a post, a changelog entry, a thing to fix or an idea to email, or it is skipped.
one new page you added in Framer goes live between two presses of Check for what's new
The moment is titled like this: Published a new page on your Framer site
At your last press the page /pricing was added but not published. You publish the site, then press Check for what's new. FoxPlug writes 'Published a new page on your Framer site' with the line 'New on your site: /pricing.' and it is scored like any other update.
several new pages go live between two presses
The moment is titled like this: Published 5 new pages on your Framer site
Five pages were waiting and you publish them together. The moment reads 'Published 5 new pages on your Framer site' and its line names the first three paths, then 'and 2 more'. It is one moment for the whole set, not five.
you edit the copy of an existing page, or the first time you read the project
The moment is titled like this: no moment
Edited paths are only counted and never become a moment. The very first press records which pages are waiting and makes nothing.
3How the brain uses it
The rules below are the ones that apply to Framer. The same rules, with worked examples, are on the brain page.
- A page that went live is an update; a copy tweak (an edited page) is skipped. Framer is compared between two reads: pages pending last time and published now. How the brain decides
- Reads are read-only and happen when you press Check for what's new, never in the background for someone who is not looking. How the brain decides
- The connect guide says FoxPlug only asks what changed since the last publish and never edits your project. How the brain decides
4Set up Framer in a few steps
Access: a Framer Server API key for one project plus the project address in a second box. What to give it: Server API key for one project (reads what changed since the last publish).
- Open your project in Framer.
- Open Site Settings and go to the General section.
- Generate a new API key there and copy it.
- Copy your project's address from the browser bar (the framer.com/projects/ one).
- Paste the key and the address into FoxPlug and press Connect.
5Limits worth knowing
Where it stops, so nothing surprises you.
- The first press only records a baseline and makes no moment.
- A moment appears only for a page that was waiting at one press and is gone from the waiting set at the next; a page added and published between two presses is never seen as waiting, so it makes no moment.
- A page removed in the meantime is not counted as published.
- One moment per press, listing up to 3 paths and then 'and N more'.
- The project address is required; without it the read stops with 'framer needs the project URL'.
- Framer's Server API is in open beta, as the connect guide says.
6What it never reads
Read only means read only, and the list below is what the code leaves alone.
- The content of your pages: only the paths added, and the counts of edited and removed paths, are used
- Edits to existing pages as moments (a copy tweak never becomes an update)
- Anything written to your Framer project: the reader asks only for the changed paths and then disconnects
7Questions
Does FoxPlug edit my Framer project?
No. The connect guide says it only asks what changed since the last publish and never edits your project. The reader asks for the list of changes and then closes the connection.
Why did nothing happen the first time I connected?
The first press only notes which pages are waiting to be published. A moment appears at a later press, once a page that was waiting has gone live.
Do edits to my pages count?
No. A copy tweak is only counted and never becomes an update; only newly published pages do.
What if I lose the key?
Open Site Settings, General in Framer and generate a new one, then paste it into FoxPlug.
When does it look at Framer?
Only when you press Check for what's new.
FoxPlug reads this tool only when you press Check for what's new, and only to read. Plans and limits are on the pricing page. Questions: support.