Flodesk
Manage Flodesk subscribers, segments, workflows, custom fields and webhooks via the Flodesk API v1.
About
Flodesk ships in the w6w first-party pack. It declares 22 actions, 2 health checks, and the host runs its code in a sandbox that never sees the credential.
- App id
io.w6w.flodesk- Version
- 0.1.3
- Author
- w6w
- Licence
- MIT
- Categories
- Marketing · Email
Overview
Flodesk is an email marketing platform built around visually designed campaigns and workflows, and this app manages the subscriber side of it: subscribers, segments, custom fields and webhooks, over the Flodesk API.
It covers the everyday subscriber lifecycle — creating or updating a subscriber individually or in a batch, adding or removing segment membership, moving someone into or out of a workflow, and unsubscribing them — plus managing the webhooks a workflow can use to react to a new subscriber or a segment change. Custom fields let a workflow enrich a subscriber record with data from wherever it originated.
Flodesk’s API is deliberately narrow by the vendor’s own design: it has no endpoints for creating, sending or reporting on a campaign, and no way to build or edit a workflow’s own steps. This app covers everything the API actually offers rather than reaching past it. A live quota check tracks Flodesk’s published rate limits, since Flodesk publishes no general status page for the service itself.
Build with Flodesk
Three routes to the same 22 actions. The Workflow tab is generated from Flodesk's own manifest and carries its real ids, so it is copy-pasteable; the Code and CLI examples are the same call for any action on any app, so every app-specific value in them is a blank you fill in.
Add Subscriber to Segments
add-subscriber-to-segments Add an existing subscriber to one or more segments. The subscriber must already exist — this does not create one.
Add Subscriber to Workflow
add-subscriber-to-workflow Enrol a subscriber into a workflow by email or id. Not marked idempotent: Flodesk documents no dedupe, so a retry may re-enter the subscriber and resend the sequence.
Batch Create or Update Subscribers
batch-create-or-update-subscribers Upsert up to 50 subscribers in one call. Partially successful by design — inspect `failures` as well as `successes`. Rate-limited to 20 requests/minute, separately from the rest of the API.
Create Custom Field
create-custom-field Create a custom field from a display label. Flodesk generates the `key` and returns it. Not idempotent, and Flodesk publishes no way to update or delete a custom field afterwards.
Create or Update Subscriber
create-or-update-subscriber Upsert a subscriber by email or id. An existing subscriber is updated in place rather than duplicated. Optionally add them to segments in the same call.
Create Segment
create-segment Create a segment. Flodesk does not enforce unique names, so a repeated call creates a second segment.
Create Webhook
create-webhook Subscribe a URL to Flodesk subscriber events. Not idempotent — a repeated call creates a second subscription and your endpoint will receive each event twice.
Delete Webhook
delete-webhook Delete a webhook subscription. Answers 204 with no body. This is the only delete endpoint Flodesk publishes.
Get Segment
get-segment Return one segment by id: name, colour, creation date and its current active-subscriber count.
Get Subscriber
get-subscriber Return one subscriber by Flodesk id or by email address: status, name, source, custom field values and segment membership.
Get Webhook
get-webhook Return one webhook subscription by id: its post URL, subscribed events and creation date.
List All Custom Fields
list-all-custom-fields Return every custom field in one call, as a bare array of `{ key, label }` with no pagination. Use the `key` values when writing a subscriber's `custom_fields`.
List Custom Fields
list-custom-fields List custom fields one page at a time, as `{ meta, data }`. Each field carries its `key` (what you write to) and its `label` (what the UI shows). For the whole set in one call, use List All Custom Fields.
List Segment Colors
list-segment-colors Return the hex colours Flodesk accepts for a segment, as a bare array of strings. Not paginated and carries no `meta` envelope.
List Segments
list-segments List segments one page at a time. Each carries `id`, `name`, `color` and `total_active_subscribers`. Returns `{ meta, data }`.
List Subscribers
list-subscribers List subscribers one page at a time. Optionally narrow to a single status, or to the members of one segment. Returns `{ meta, data }`.
List Webhooks
list-webhooks List webhook subscriptions one page at a time. Each carries `id`, `post_url`, `events` and `created_at`. Returns `{ meta, data }`.
List Workflows
list-workflows List workflows, optionally filtered by status. Each carries `id` and `name` only — Flodesk publishes no other workflow fields and no way to create or modify one.
Remove Subscriber from Segments
remove-subscriber-from-segments Remove a subscriber from one or more segments. Affects segment membership only — it neither unsubscribes nor deletes the subscriber.
Remove Subscriber from Workflow
remove-subscriber-from-workflow Remove a subscriber from a workflow by id or email, halting the remaining steps of that automation for them.
Unsubscribe Subscriber
unsubscribe-subscriber Unsubscribe a subscriber from ALL mailings, setting their status to `unsubscribed`. Not reversible through the API — Flodesk publishes no re-subscribe endpoint.
Update Webhook
update-webhook Update a webhook's name, post URL or subscribed events. Only the properties you supply are sent — Flodesk marks none of them required on update.
A workflow step names the app and the action, and the editor fills in the
connection when you pick one. This is the Step shape from the
workflow spec, carrying Flodesk's real ids.
{
"manifestVersion": "2",
"name": "flodesk-example",
"steps": [
{
"id": "add-subscriber-to-segments",
"uses": {
"app": "io.w6w.flodesk",
"action": "add-subscriber-to-segments",
"connection": "conn_YOUR_CONNECTION_ID"
},
"with": {
"idOrEmail": "<idOrEmail>",
"segmentIds": "<segmentIds>"
}
}
]
}Here are some of the things you can do
-
Add Subscriber to Segments
performadd-subscriber-to-segments -
Add Subscriber to Workflow
performadd-subscriber-to-workflow -
Batch Create or Update Subscribers
performbatch-create-or-update-subscribers -
Create Custom Field
performcreate-custom-field -
Create or Update Subscriber
performcreate-or-update-subscriber
+17 more actions available
Every app-specific value here is a blank you have to fill in. An
app action is reached through the connection that authenticates it, so the
address is a connection id, not the app id — and connections belong to your account,
so a public page cannot know yours. Create one for Flodesk, then fill in
the three blanks: conn_YOUR_CONNECTION_ID, the action key, and the
parameters that action declares. The call itself is real — the shape is transcribed
from the studio's own snippet builder, which prints the same kind of blanks — but
nothing in it is specific to Flodesk. The Workflow tab is where this app's
real ids are.
npm install @w6w/sdkyarn add @w6w/sdkpnpm add @w6w/sdkdeno add npm:@w6w/sdkimport { W6wClient, isActionRun } from "@w6w/sdk";
// Reads W6W_BASE_URL and W6W_TOKEN from the environment when omitted.
const client = new W6wClient();
const envelope = await client.run({
urn: "conn_YOUR_CONNECTION_ID",
action: "create-or-update-subscriber",
payload: {
// email: "<value>",
// id: "<value>",
// firstName: "<value>",
// lastName: "<value>",
// segmentIds: "<value>",
// customFields: "<value>",
// doubleOptin: "<value>",
// optinIp: "<value>",
// optinTimestamp: "<value>",
},
});
if (isActionRun(envelope)) console.log(envelope.value);npm install -g @w6w/cliw6w run conn_YOUR_CONNECTION_ID --action create-or-update-subscriber --payload '{}'Give an AI agent Flodesk — without giving it Flodesk's credentials. One MCP endpoint exposes every app, function and workflow the caller is entitled to, as tools it can discover and run. Access is granted per team while we onboard.
One tool call{
"name": "w6w_invoke",
"arguments": {
"ref": "app:io.w6w.flodesk#add-subscriber-to-segments",
"input": {
"idOrEmail": "<idOrEmail>",
"segmentIds": "<segmentIds>"
}
}
}
Every tool names its target with a single ref. The
app: form above doesn't name a connection at all — the
host resolves which of the caller's Flodesk connections to sign
with, and refuses rather than guesses when the answer is ambiguous.
What the agent gets
Credentials it can't read
The token is attached host-side, at the moment of the call. It is never a tool argument, never in the model's context, and never in a transcript — so a prompt injection has nothing to exfiltrate.
A tool surface scoped to the caller
Tools are derived per end user from what that person has actually connected and is entitled to — not one shared bot identity carrying the union of everyone's access.
A durable workflow in one call
Multi-step work runs on the workflow engine and returns a run handle the agent can poll — retries, branching and state survive the conversation that started them.
Health-aware discovery
Flodesk's declared health checks are on the surface too, so an agent can tell "the vendor is down" from "your credential expired" before it burns a retry on either.
The MCP surface is part of the hosted platform. Flodesk itself is MIT, and the runtime that executes it is source-available (FSL).
Health checks
Flodesk declares its own checks, so its health is a property of the app rather than something the host guesses at.
Flodesk platform status
API rate-limit headroom
Requests left in the current rate-limit window, read from the X-Fd-RateLimit-* headers on a GET /v1/segments/colors call. Flodesk allows 100 requests/minute by default.