Build for the Lynxbe Marketplace
Create a developer account, build your app with credentials and scopes, submit it for review, and reach every business on Lynxbe.
API reference: public catalog · developer endpoints under /api/public/v1/marketplace/developers · webhook deliveries are HMAC-signed with X-Lynxbe-Signature: sha256=<hex>.
Build your app
App Credentials Production
Use the credentials to access Lynxbe APIs from your app. Make sure to securely store the credentials — do not store them in public repositories.
••••••••••
••••••••••
Webhook deliveries to your app are signed: X-Lynxbe-Signature: sha256=<HMAC-SHA256 of the raw body with your webhook secret>. Verify with a timing-safe comparison.
Basic Information
Provide information about your app.
Businesses' subscribed events are delivered here, signed with your webhook secret.
Developer Contact Information
Provide corporate contacts for announcements including Marketplace/API updates, breaking changes, and other updates that impact your app.
Select how the app is managed
This may affect features, scopes, and permissions to add the app.
Access
These features allow you to access Lynxbe data via APIs and Event Subscriptions, and receive real-time updates on events.
Token
Lynxbe sends this secret token's HMAC signature (X-Lynxbe-Signature) in each event notification we send to your app. Use it to verify notifications.
••••••••••
General Features
Surface
These features dictate where your app can be seen inside Lynxbe. Choose the features you want to enable for your application.
The Home URL lets Lynxbe display your app inside an in-app web view.
URLs added here are accepted by the web view running inside Lynxbe.
Select where to use your app NEW
Select the Lynxbe products this app works in. Users can open and use the app directly from these products.
Embed
These features allow you to embed specific Lynxbe functionality into your own external applications.
Connect
Describe how Lynxbe integrates data with your application.
Custom Form
Create the form your users complete when installing the app. These fields are rendered in the Lynxbe install wizard; secret fields are encrypted and never stored in plain text.
Actions and Triggers
Configure actions users can take within Lynxbe products and triggers that launch app functions based on specific events.
Triggers fire from your Event Subscriptions (Features → Access). Events currently subscribed:
Automations NEW
Every installation of your app gets a no-code rule engine: customers connect triggers (Lynxbe domain events like party.created, your app's inbound webhooks, schedules, or manual runs) to your app's actions. Define recipes here — one-tap automation templates shown in your app's Automations tab.
event — any Lynxbe domain event (party.created, booking.completed, order.paid, …; wildcards like party.* work)
inbound — your app POSTs to its per-install webhook URL; adapters normalize into events such as record_created
schedule — every N minutes (min 5)
manual — a Run button in the app's settings
Action params values may reference the firing context:
{{event.type}}, {{event.data.<field>}} — the triggering event
{{config.<key>}} — the installation's saved settings (e.g. {{config.contacts_table}})
Inbound pings hit POST /api/public/v1/marketplace/webhooks/<your-slug>?token=<install token> and are HMAC-verified.
Automation recipes (templates)
Shown as one-tap chips in the customer's Automations tab. Up to 20.
Monetization NEW (Optional)
Monetization is enabled when you add plans. All apps must have a free plan. You can add up to 4 plans; plans appear on your public listing.
Provide at least an email for customers to contact you with additional questions.
Technical Design
You are required to fill out the Technical Design section before submitting and publishing your app on the Lynxbe Marketplace.
Describe in detail all of the technology, libraries and APIs used by the application.
Link to an architectural diagram including any service that interacts with Lynxbe — databases, servers and third-party applications.
Application Development
Local Test Local only
Preview and validate your app before submitting. The local-test link shows your pre-release listing exactly as businesses will see it, using your Development configuration.
—Webhook deliveries during local testing are signed with your Development secret token (Features → Access, in Development mode).
Beta Test Link only
Share the app with internal or external users using the share URL for validation purposes, before it is published. Anyone with the link can view the pre-release listing.
—Regenerating invalidates previously shared links.
OAuth Information Production
Provide the URLs users are redirected to after authorizing your app. Only URLs on this list are allowed as redirect targets.
OAuth URL
Use the generated authorization URL to direct users to begin the OAuth process.
—Deauthorization Notification
When a business uninstalls your app, Lynxbe POSTs a signed app_deauthorized event here so you can delete that account's data.
App Listing
App Icon
• Square image, https URL (PNG/JPG/SVG).
• Minimum 160×160px (1×1 preferred).
If an icon is not provided, end-users see the default app icon.
Displayed on the Marketplace homepage and the app listing page.
Describe your app's core features in 1–2 sentences. Shows on the app listing card.
Describe the specific features and functionality of your app and your company. Avoid jargon or exaggerated claims. Shows on the app listing page.
An image that uniquely represents your app, shown at the top of the listing. Limited or no text recommended.
Categorize Your App
Select up to 3 categories that best describe your app. Your app shows up when users filter by these categories.
Links
Must clarify how you collect, use, share, retain and otherwise process personal information, and inform users of their data-subject rights.
Users get direct support from your team here.
A Lynxbe-specific guide with detailed instructions on adding, using and removing the app.
Where users configure and manage your app after authorization.
App discoverability
This dictates whether the app is shown in the Lynxbe App Marketplace for all users, or kept private to users with the direct link. Can be updated anytime.
Add Scopes
Scopes define the API methods this app is allowed to call, and thus which information and capabilities are available on Lynxbe. When your app is submitted, we review your request for each scope; after your app is live it can only use scopes that were approved.
| Scopes | Description | Optional |
|---|
Specify how this data is used within the application, and whether or not the data is stored. If stored, please denote how the data is stored (encrypted, plain text).
Publish
Manage your app's availability. Submit it for a functional and security review before it goes live — reviews are handled FIFO.
Release notes for the app reviewer
Include detailed information — what the app does, how to test it step by step, and how each requested scope is used.
Test account and credentials
Provide reviewers a way to exercise your app end to end.