Skip to content

Zapier

The Frameleaf app for Zapier lets your Zaps react to your library and add to it. A Zap can start when a photo is ready, or when something is added to an album. It can then find photos, make albums, add tags, or upload a file from another app into an album you chose.

Zapier runs on the internet, so it needs to reach your server over HTTPS. Use your own HTTPS address, which needs no Frameleaf plan, or Frameleaf’s remote access, which needs a plan that includes it. A server that’s only on your home network can’t be used from Zapier.

The app ships as a Zapier CLI app in the Frameleaf source, in integrations/zapier. Whoever runs your Zapier account adds it once as a private app:

  1. Install Node.js 22.
  2. In a copy of integrations/zapier, run npm ci, then npx zapier-platform register "Frameleaf" and npx zapier-platform push.
  3. In the Zapier developer site, open the app’s Authentication settings and copy its OAuth redirect address. You need it in the next step.

The app shows in English. To use another of Frameleaf’s eleven languages, run node render.cjs fr > index.js (with your language code) before pushing.

Zapier doesn’t register itself. An administrator does this once per server:

  1. Open Settings, then Who can sign in, then Sign-in methods. Under Registered apps, choose Set up an app.
  2. Under Name, choose Zapier.
  3. In Sends you back to, paste the redirect address from Zapier exactly as it’s shown.
  4. Choose Create, then copy the App ID. It isn’t a password, so you can share it with everyone on the server who uses Zapier.
  1. In a Zap, add a Frameleaf step and choose Sign in.
  2. In Frameleaf server URL, enter your server’s HTTPS address, such as https://photos.example.com, with no path and no slash at the end.
  3. In Frameleaf client ID, enter the App ID from your administrator.
  4. Frameleaf opens in a new window. Sign in if asked. The Allow an app page lists what Zapier asks for:
    • see and search your photos, videos and albums;
    • download your original files;
    • add photos to albums and make new albums;
    • add tags to your photos;
    • upload photos and videos to selected Photos albums;
    • save files to selected Boards;
    • read updates from the albums you allow.
  5. Choose the albums Zapier may read, or Read my whole library. Then choose the albums it may write to, and whether it may make new albums in Photos or Boards.
  6. Choose Allow.

Zapier can only use the albums you chose. Like every connected app, it can never open Locked photos, delete anything, share anything or change how you sign in. See Connected apps.

Trigger Starts a Zap when
New Photo or Video A photo or video in an album you allowed is ready
Photo or Video Added to Album A photo or video is added to an album you allowed. Choose an album to watch just that one
Studio Export Completed A Studio export finishes

Each trigger gives the photo or video’s ID, the album, the time and a file. Choose File size for that file: preview and display are smaller copies, thumbnail is the smallest, and original needs original downloads to be allowed on your server. Frameleaf only sends the file when a later step uses it, and checks your permissions again at that moment.

Zapier checks for new events every few minutes. Each check looks at the newest 1,000. If more than 1,000 happen between two checks, Zapier misses the oldest ones.

Search Finds
Find Photo or Video A photo or video by its ID, or by search text, album and type
Find Album An album you allowed, by its exact name
Find or Create Album An album by name, and makes it if it doesn’t exist
Action What it does
Create Album Makes an album in Photos or Boards, in a place you allowed
Add to Album Adds up to 100 photos or videos, by ID, to an album you allowed
Add Tags Adds up to 20 tags to a photo or video
Upload File Adds a new file from an earlier step to an album you allowed

Upload File takes JPEG, PNG and MP4 files up to 100 MB, and PDF files too for Boards. The file has to come from a public HTTPS address, such as a file from another Zapier app. Frameleaf never sends your sign-in to that address. Uploading always adds a new item; it never replaces one.

Create Album and Upload File ask for a Source ID: a value that stays the same for the same item, such as the row ID or message ID from the earlier step. When Zapier retries a step, or two runs handle the same item, the Source ID makes sure you get one album or one file, not copies. Using the same Source ID again with different details stops with an error.

Zapier says What to do
Frameleaf access no longer covers this album or action The album or permission was removed. Change it in Connected apps, or connect again to allow more
Frameleaf connection failed Access was removed or ran out. Reconnect the Frameleaf account in Zapier
Zapier could not reach your Frameleaf server Check that the server is on and reachable from the internet over HTTPS
Frameleaf is updating albums or access Zapier tries again shortly. Nothing to do
This upload can no longer continue Check the album still allows uploads, then use a new Source ID
This Source ID was already used for different details Use a Source ID that belongs to just this item
The file is larger than this connection allows Use a smaller file, or ask your administrator about the upload limit

Removing the Frameleaf account in Zapier doesn’t end Zapier’s access to your library. To end it, open Settings, then Your sign-in & privacy, then Connected apps, and choose Remove next to Zapier. Its Zaps stop working straight away. Files Zapier already sent to other apps stay there.

To change which albums Zapier may use, open Details for Zapier in Connected apps. You can take albums away there; to add albums, connect Zapier again.