Write a setup guide for your Freesbe integration
When your integration is approved for the partner program, its page on freesbe.net links to your setup guide. That guide is how customers turn it on, so it should work for a Freesbe owner or admin who has never seen your product. Here’s what to put in it.
Before you write
Section titled “Before you write”- Try every step yourself in a new, free Freesbe workspace, signed in as an owner.
- Use the names people see on screen, in bold, the way Freesbe’s own guides do: Workspace settings → Integrations & apps → Apps.
- Say which Freesbe plan it needs if it uses a feature that isn’t on Free.
What goes in it
Section titled “What goes in it”- What it does, in two or three sentences, with a picture of a message or card in a channel.
- What you need: an account with your product, and who in Freesbe can set it up (owners and admins make apps and webhooks).
- Set it up, step by step. For an app, the usual steps are:
- In Freesbe, open Workspace settings → Integrations & apps → Apps and click Create app.
- Switch to Manifest, paste the manifest you give them, and click Create app.
- Copy the bot token Freesbe shows once, and paste it in your product’s settings.
- Add the app to the channels it should post in.
- Try it: one thing they can do right away to see it working.
- What it can see: the scopes it asks for and why, in plain words.
- Turn it off: pause or delete the app in Freesbe, and what happens to their data in your product.
- Get help: where to write to you.
- Keep the manifest’s scopes to what you need. Customers read them, and so do we.
- If it connects over MCP, link to Connect Claude or ChatGPT over MCP for the Freesbe side, and say which of your product’s settings to use.
- Use made-up names in pictures (Northwind Traders, Acme Corp), never a real customer’s.
When it’s ready, reply to the email that approved your integration with the link, and we’ll put it on your page.
Answers come from the Freesbe guides and are written by AI, so check the linked guide before relying on one. Please don't include personal details such as emails or passwords.