Scarf
E-commerceScarf is a Brazilian all-in-one creator platform with courses, community spaces, memberships and checkout under one club. Agents sell courses and memberships from outside Scarf, grant access, run renewal and dunning pipelines on invoices, and manage members and spaces through the GraphQL API.
What This Integration Enables
Scarf puts the course, the community space, the checkout and the membership on the same object, under one club. That is a product decision, not an implementation detail, and it changes what automation means here. On a stack where billing and community are separate systems, a failed payment is an accounting event that a script can resolve on its own. On Scarf the record carrying a subscription also carries the person's spaces, their posts, their badges and their course progress.
So the useful agent work is the renewal and dunning pipeline, and the risk worth designing around is a billing rule reaching into a community. FlowRunner agents read invoices, pause and resume access grants, move expiry dates, grant course access for purchases made anywhere else, and publish content on a schedule. The operations that end a person's place in the club are where FlowRunner's human-in-the-loop discipline belongs, because on this platform they are social acts wearing financial clothes.
Without FlowRunner
With FlowRunner
Use Case Scenarios
-
The purchase happened somewhere else, the access still lands
A launch page, a webinar platform or a Shopify checkout takes the money. The agent resolves the buyer with Search Members, invites them with Invite Member if they are new, then calls Add Access Group Member with an expiry that matches what they bought. One access group carries the spaces, the courses, the tag and the badge, so the grant is a single move rather than five. When the term renews, Update Access Group Expiration pushes the date out instead of rebuilding the grant. When it lapses, it lapses on its own. The club never learns that its checkout was not involved.
-
The editorial calendar publishes itself
Each morning the agent reads the week's calendar from Notion or a row set in Google Sheets, resolves the destination with List Spaces, and calls Create Post with the body, the cover and a scheduled publication time. Posts land in the space their audience already reads rather than in an email nobody opens. Pin Post floats an announcement for the week and Unpin Post drops it back into the feed afterwards. If a piece belongs somewhere else after the fact, Move Post carries its comment thread with it, which is worth knowing before the destination is a public space.
-
The dunning ladder that stops before the last rung
Failed invoices arrive from List Invoices on a schedule. The agent pauses the access group grant, messages the member, and waits. Most retries succeed and Resume Access Group Member puts the time back with no one involved. The accounts that keep failing reach a person, because the next operation is not another billing step. A digest posts to Slack with the invoice history, what the member has been doing in their spaces, and the fact that removal and cancellation are two separate calls. The manager answers. The agent executes what they decided.
Human-in-Loop Highlight
Scarf hands you the asymmetry directly, and the gate is built on it. Pause Access Group Member suspends a grant without deleting it, so the spaces and courses go quiet and Resume Access Group Member can put the time back. That is the correct answer to a failed payment and the agent should do it unattended, in both directions, all night. Remove Member is a different operation in two ways that both matter. It takes the person's space, course and access group memberships with them, and it is not a subscription cancellation, so an active paid subscription keeps billing after the person is gone unless Cancel Member Subscription runs as well. An agent following a dunning rule to its literal end can therefore evict someone from a community and keep charging them for it. So the pause is free and the removal stops and asks: "Invoice for Marina has failed three cycles. She posted in Lançamentos twice this week and is part way through two courses. Remove her from the club, which also drops her spaces and progress, and cancel the subscription so billing stops? Or hold the pause another cycle?" The manager answers. The agent runs both operations together, or neither.
Agent Capabilities
126 actionsConnection
4- Get Current API Key Returns the key record behind the connection with the club it belongs to. The connection test, because an unauthenticated call to this API answers with nothing rather than an error.
- Create API Key Mints a new key for a club and returns the raw value once. This is how an onboarding flow provisions a working connection without anyone visiting the admin.
- Delete API Key Revokes a key immediately and permanently, including the one the flow is currently using.
- List API Keys Lists a club's keys newest first. The stored value comes back on each record, so treat the response as a secret.
Club
8- Get Club Returns a club's profile, visibility and member count. The slug it returns is the identifier most other operations take.
- Get Club By Domain Finds the club served by a custom hostname. Returns nothing rather than failing when the domain is unclaimed.
- Update Club Changes a club's name, slug, description, visibility or brand images. Changing the slug rewrites every hosted URL the club has published.
- Update Club Configuration Writes a single configuration key and value. Unknown keys are stored rather than refused, so a typo persists quietly.
- List Permissions Returns every permission an admin can hold, with its slug and description. Read it before wiring a flow to a hard coded permission list.
- List Scarf Plans Returns the plans a club can buy from Scarf itself. These are the creator's own subscription, not the products the club sells.
- Get Scarf Plan Returns one Scarf plan with its price and included limits.
- Get Scarf Subscription Returns the club's own subscription to Scarf, read only by design so a flow cannot cancel the creator's account while aiming at a member's.
Domains
8- List Domains Lists a club's custom domains with verification status and the DNS records Scarf expects. Enough for a flow to create those records at a provider automatically.
- Create Domain Registers a custom domain and returns the records that must exist before it will verify. It serves nothing until verification succeeds.
- Verify Domain Asks Scarf to re check a domain's DNS. A fresh record can stay pending while propagation catches up, so retry rather than treating the first answer as failure.
- Set Domain Enabled Takes a verified domain out of service or puts it back without deleting it.
- Delete Domain Detaches a domain from the club. Members reaching it through that hostname lose it at once, and the DNS records stay behind at your provider.
- List Email Domains Lists the domains Scarf may send club email from, with their verification status.
- Create Email Domain Registers a sending domain and returns the records to publish. Until they exist, club email keeps going out on Scarf's own domain rather than failing.
- Delete Email Domain Removes a sending domain. Email keeps working and stops carrying the creator's brand.
Members
15- List Members Lists a club's members with search, status, tag, badge and space filters. Every member listing hangs off a club, so the club slug decides what a flow can see.
- Get Member Returns a member's profile, points and visit counts. It is keyed on the username, so an email driven flow resolves the member first.
- Search Members Runs Scarf's ranked member search. The better choice when a flow holds a partial name or an address a human typed.
- Invite Member Creates an invitation and has Scarf send it. The response carries the code and URL, so a flow can deliver the invite through its own channel instead.
- Add Admin Invites an address as a club admin with a named permission set. Club Admin grants the whole club and Billing Admin reaches the creator's own payment details, so grant narrowly.
- Remove Admin Strips every admin permission while leaving the person in the club as an ordinary member.
- Revoke Permissions Removes specific permissions from an admin and leaves the rest, which is the surgical alternative to demoting them entirely.
- Remove Member Removes a member from the club, taking their spaces, courses and access groups with them. The operation this page's human gate exists for, and not a subscription cancellation.
- Import Members Imports a list of addresses in one call, optionally placing each into spaces, courses and access groups with tags and badges. Scarf reports no per address result, so read the members back to confirm.
- Get Invite Finds an invitation by code or address with its status. A spent or unissued invite comes back empty rather than as an error.
- List Pending Invites Lists unaccepted invitations with whether each has been opened. An invite seen but not accepted deserves different follow up from one never opened.
- Resend Invite Sends an existing invitation again. The invite type has to match the original, because Scarf uses it to decide what the recipient is being invited as.
- Delete Invite Cancels an outstanding invitation so its link stops working. An accepted invitation cannot be withdrawn this way.
- Send All Pending Invites Resends every unaccepted invitation in the club at once, with no per address control and no dry run. Check the pending list first.
- Check Username Reports whether a username is still free. Usernames are global across Scarf rather than per club, so a signup flow checks before collecting anything else.
Tags and Badges
12- List Tags Lists member tags with their counts and any filter attached. A tag carrying a filter is maintained by Scarf, so assigning it by hand fights the rule.
- Create Tag Creates a member tag, optionally with a filter that keeps its membership current automatically.
- Update Tag Renames a tag or changes its filter. Changing the filter re evaluates membership at once, so members gain and lose the tag immediately.
- Delete Tag Deletes a tag and takes it off everyone. Segments and access groups built on it stop matching.
- Assign Member Tag Adds a tag to a member. This fires Scarf's own tag automation, which is the cleanest way for a flow to hand work back to a Scarf workflow.
- Remove Member Tag Takes a tag off a member. A tag maintained by a filter comes back the next time Scarf re evaluates it.
- List Badges Lists a club's badges with colors, counts and any awarding filter. Badges are the visible half of the status system and tags are the quiet half.
- Create Badge Creates a badge with its colors, optionally awarded automatically by a filter.
- Update Badge Changes a badge's label, colors or filter. A new filter can award and withdraw the badge in bulk and fire automation for every member affected.
- Delete Badge Deletes a badge and takes it from everyone who held it. Access groups keyed on that badge stop matching, which withdraws access quietly.
- Assign Member Badge Awards a badge to a member and fires Scarf's badge automation, which makes a badge a practical way to start a Scarf workflow from a flow.
- Unassign Member Badge Takes a badge back and returns the award record that was removed.
Spaces
16- List Spaces Lists every space in a club with its visibility, posting policy and member count, all in one call.
- Get Space Returns one space by slug. Used to resolve a slug into the identifier that space membership and post moves require.
- Create Space Creates a community space inside a space group, with its visibility and posting policy.
- Update Space Changes a space's name, icon, visibility, policies, group or position. Widening the visibility exposes every post already inside it, so a private space made public is not a fresh start.
- Delete Space Deletes a space with every post, comment and event in it, and there is no undo through the API.
- Add Space Member Adds a member to one space, optionally with an expiry. The expiry is how a cohort or a trial is modeled without a paid product behind it.
- Remove Space Member Removes a member from one space and leaves their club membership alone. A space granted by a product or an access group is restored on the next pass.
- List Space Groups Lists the sidebar groups that organize a club's spaces. Every space belongs to a group, so this is the first call a space creating flow makes.
- Create Space Group Creates a sidebar group that spaces can be filed under.
- Update Space Group Renames a space group. Moving and reordering spaces is done on the space itself.
- Delete Space Group Deletes a space group. Move its spaces out first, because every space has to belong to one.
- Create Access Group Creates a bundle of spaces, courses, tags and badges granted and withdrawn as a single unit. The right shape for a cohort, a tier or a purchase made outside Scarf.
- Add Access Group Member Puts a member into an access group with everything it carries, optionally with an expiry. The grant is applied by Scarf's own pass unless the flow asks it to sync immediately.
- Pause Access Group Member Suspends a grant without deleting it, so the spaces and courses go quiet while the record and its expiry survive. The reversible answer to a failed payment.
- Resume Access Group Member Restores a paused grant and optionally pushes the expiry out by the time it spent paused. Scarf wants that choice stated rather than assumed.
- Update Access Group Expiration Sets a new expiry on a member's grant, which is how a renewal extends access without rebuilding it.
Courses
17- List Courses Lists a club's courses with visibility, lesson count and publication state. An inactive course exists and is invisible, which is not the same as private.
- Get Course Returns a course with its sections and lessons. The one call that returns the whole structure a flow needs before editing any part of it.
- Create Course Creates a course with its visibility, access control and covers, and can build the entire section structure in the same call.
- Update Course Changes a course's name, visibility, publication state, covers or access control. Supplying sections replaces the structure rather than merging into it.
- Delete Course Deletes a course with its sections and lessons. Enrolled members lose it immediately and their progress goes too, so unpublish instead if the goal is only to hide it.
- Create Course Section Adds a module to a course, optionally with its lessons in the same call.
- Update Course Section Renames a section, publishes or hides it, or switches it between regular and bonus. Supplying its lesson list rewrites that list.
- Delete Course Section Deletes a section, taking its lessons and the member progress recorded against them.
- Create Course Lesson Adds a lesson with video, notes and attachments. The notify option emails everyone with access the moment it is created, so leave it off until the lesson is finished.
- Update Course Lesson Changes a lesson's content or the section it sits in. Attachments replace the existing list rather than adding to it.
- Delete Course Lesson Deletes a lesson and the completion records against it, which shifts the unlock order for everyone part way through.
- Get Course Lesson Returns one lesson with its neighbors in the course order. Addressed by slug rather than by identifier, unlike the write operations.
- Move Course Lesson Reorders a lesson or moves it into another section. On a progressive course this changes what every part way member can open next.
- Grant Course Access Enrolls a member directly, bypassing any product or access group, optionally with an expiry. What an external purchase flow calls, and the enrollment is marked as granted rather than bought.
- Revoke Course Access Withdraws a direct enrollment. A member who also holds the course through a product or an access group keeps it.
- Update Course Access Expiration Sets a new expiry across one or more courses at once, which is how a renewal extends access without re enrolling anyone.
- Emit Certificate Issues a completion certificate with its signature and issue date. Worth noting that the action list carries no counterpart that takes one back, and the printed name is free text rather than the profile's.
Content
12- List Posts Lists posts across every space the key can see, sorted by date, votes or comments. Pinned posts float to the top unless the flow asks for strict order.
- Get Post Returns one post with its author, space and counts. Read it first when a flow holds an identifier but the edit operation wants a slug.
- Search Posts Runs Scarf's content search across a club's posts. It covers only what the key can see, so private material is absent rather than reported as hidden.
- Create Post Publishes into a space with attachments, a cover, a comment policy and an optional scheduled time. The notify option emails everyone with access to that space.
- Update Post Edits a post's title, body, space, cover, attachments, pinning or schedule. Keyed on the slug, which is the opposite of how deleting and moving work.
- Delete Post Deletes a post and its comments, with no undo through the API.
- Move Post Moves a post into another space and takes its comment thread along. The post inherits the destination's audience, so a move into a public space is a publication.
- Pin Post Pins a post to the top of its space. Scarf answers with the space, because pinning is a property of the ordering rather than the post.
- Unpin Post Removes a pin so the post returns to normal feed order.
- Create Comment Adds a comment to a post, a lesson or an event, optionally as a reply. Exactly one target is expected and a call naming none is refused rather than attached to nothing.
- Get Comment Returns one comment with its author and counts. Its path field says where it sits in the thread without walking the tree.
- Delete Comment Deletes a comment and every reply beneath it, so removing a top level comment removes the thread.
Events
8- List Events Lists events filtered to upcoming, live, past or all, each with times, attendee count and join URL. The upcoming filter plus a schedule is how a reminder pipeline gets built without a webhook.
- Get Event Returns one event with its schedule, host and links. The meeting link and the Scarf page are two different fields, and a reminder usually wants the meeting.
- Create Event Creates a live or in person event with its schedule, host, audience and email settings. The promotion option mails the whole club.
- Update Event Changes an event's schedule, host, meeting link, audience or email settings. Moving the start time does not re prompt people who already confirmed, so announce a reschedule separately.
- Delete Event Deletes an event and its attendee list. Scarf does not tell the people who confirmed, so a cancellation flow tells them first.
- Create Poll Creates a community poll with options, a closing date and vote visibility. Public visibility exposes who voted for what and cannot be reversed afterwards.
- Get Poll Returns a poll with each option's count and whether voting is still open. Acting on the totals is safe once it closes.
- Delete Poll Deletes a poll and every vote cast in it. Read the results first if they matter.
Commerce
12- List Products Lists the products a club sells with their plans, prices and installment settings. It defaults to enabled products, so a catalog reconciliation has to ask for all of them.
- Get Product Returns a product with its plans and the spaces and courses it grants. The lookup a checkout flow starts from, because the plan identifier is what a subscription needs.
- Create Product Creates a sellable product with its pricing plans and the access it grants. Prices are whole numbers in centavos, so the decimal point is yours to place correctly.
- Update Product Changes a product's details, plans or granted access. Spaces and courses replace the existing lists, and disabling a product stops new sales while leaving current subscribers alone.
- Delete Product Deletes a product from the catalog. Prefer disabling it, because deleting something that has been sold breaks the link between existing subscriptions and what they bought.
- Create Member Subscription Subscribes a customer to a plan and charges them by card, Pix or boleto. Pix and boleto settle asynchronously, so read the status back before granting anything.
- Cancel Member Subscription Cancels a member's subscription to a club product, optionally refunding the current cycle. This is the member paying the club, not the club paying Scarf.
- List Member Subscriptions Lists one member's subscriptions filtered by status, product or plan. Subscriptions hang off the member, so a whole club view means iterating members.
- List Invoices Lists member invoices filtered by status, product and date range. It sorts oldest first by default, which is not what a recent activity feed wants.
- Cancel Invoice Cancels a pending or scheduled invoice so it is never charged. The subscription behind it survives and raises the next one.
- Get Installment Plans Returns the Brazilian installment options for a price, with the count and per installment amount. The price is a whole number in centavos and a decimal is rejected outright.
- Get Seller Profile Returns the club's payout profile and whether identity verification is outstanding. A club can create products and take orders while being unable to receive money, which is a failure nothing else surfaces.
Segments
6- List Segments Lists a club's member segments with the filter behind each one. The stored definition and the resolved one are separate fields, which matters when cloning.
- Get Segment Returns one segment with its filter definition.
- Create Segment Creates a segment from a filter, optionally attaching a tag or badge that every match receives. That attachment applies to everyone at once, so size the audience first.
- Update Segment Renames a segment, replaces its filter or changes what it applies. A new filter re evaluates membership immediately and fires automation for every member added and removed.
- Delete Segment Deletes a segment. Courses offered to it and workflows triggered by it stop matching.
- Preview Segment Runs a filter and returns who it would match, changing nothing. The safest building block here, because it turns any audience question into an answer with no side effect and gives the size before a flow acts.
Automation
7- List Workflows Lists a club's own Scarf automations with their trigger, state and node graph. These run inside Scarf and never call outward, which is why this connector carries no trigger.
- Get Workflow Returns one automation with its full node graph. Read it before editing, because updating replaces the graph wholesale.
- Create Workflow Creates a Scarf automation with its trigger and node graph. The run on create option replays it over every member who already matches, which on a large club is a great many actions at once.
- Update Workflow Changes a workflow's name, trigger, graph or active state. Nodes and connections replace rather than merge, so send the whole thing back.
- Delete Workflow Deletes an automation. Switching it off is usually better, because a deleted graph is not recoverable through the API.
- Start Workflow Enqueues a Scarf automation job, which is how a flow hands work back to Scarf's own engine. The answer means accepted rather than finished, and there is no job to poll.
- Get Automation Catalog Returns every trigger and action node the automation engine offers on this club, with the parameters each expects. This is what makes building a Scarf workflow from a flow practical rather than guesswork.
Raw
1- Execute GraphQL Query Sends any query or mutation to Scarf's GraphQL API and returns the result. This is the escape hatch for the parts of the schema this connector does not model, and none of the connector's guardrails apply inside it: no argument checking, no unwrapping of Scarf's odd response shapes, no protection against reaching the club's own billing with the club's own credentials. Introspection is available through the same operation, so the schema can be discovered at runtime.
Frequently Asked Questions
What can FlowRunner do with Scarf?
FlowRunner agents can run Get Current API Key, Create API Key, and Delete API Key in Scarf, plus 123 more actions.
Does connecting Scarf to FlowRunner require OAuth?
No. Scarf connects to FlowRunner with an API key, no OAuth flow required.
Can Scarf trigger a FlowRunner workflow automatically?
Scarf doesn't currently expose triggers in FlowRunner. It connects as an action step inside workflows started by another trigger.
Start building with Scarf
Free plan, no card required. Connect in minutes.