Skip to content
Using the older ?key= endpoint, an employee token, or a widget key? The ?key= endpoint and employee tokens were switched off on 11 October 2026, and older widget keys were switched off on 20 October 2026. Move to a current key. See how to switch.

Learn it. Build on it.

Read community data, sign people in with Bynefit, get events pushed to your tools, or embed a directory on your site. Pick how you want to build it.

I run a group

Step-by-step help for members, events, billing and your site. No code needed.

Open the help center
I write the code

Make a key, make a call. Five languages, examples you can copy, errors explained.

cURLJavaScriptPythonPHPSwift
Developer quickstart
My AI agent builds it

Give your agent one link and its own key. It reads our docs as Markdown, reads only what you tick, and asks you before anything more.

Agent keys: new Markdown pages: new llms.txt: new OpenAPI: new
Hand it to your agent
No code

Send Bynefit events to Make, n8n or Zapier with a webhook.

No-code guide

What you can build

  • Read community resourcesList and filter community resources with a developer key. JSON, cursor paging.Available
  • Submit a resource for reviewPropose a new entry. A moderator reviews it before it goes live.Available
  • Manage your directoryAdd, edit and remove your own entries. Try it straight away with a test key; a live key needs a review first.By approval
  • Signed webhooksGet an HTTPS call when something happens in your Space. Each delivery is signed.Available
  • Sign in with BynefitOpenID Connect with PKCE for your own site or app.Available
  • Custom app links for sign-inA native app can return through its own reverse-domain scheme once Bynefit approves that scheme for your partner account.By approval
  • Embed widgetShow your directory on any website with one script tag.Available
  • Partner eventsPartners send their own product events from a page, a server or an app, and read the totals back. Bynefit turns it on per partner.By approval
  • Hosted sites runtimeEvents, resources, media, forms and page views for a hosted site, with no key.Available
  • Read and edit hosted site filesAn agent key lists a Space's sites and reads, replaces and deletes their files, with versions, secret scanning and a daily write ceiling. The key owner approves the permission.Available
  • Create and manage formsAn agent key creates forms for a Space, changes their settings and fields, pauses them and deletes unanswered ones, with a daily write ceiling and a test mode. Registration forms and submissions stay out of reach. The key owner approves the permission.Available
  • Engagement types and stagesA Space defines its own kinds of client work with ordered stages inside the existing statuses. Managers edit them on the Engagements page, and an agent key reads and manages them with a daily write budget and a test mode. The key owner approves the permissions.Available
  • Secrets and secure requests for hosted sitesStore a site's keys encrypted, use them in secure requests and form webhooks, and stop them being published in a page.Available
  • Client portal APIA signed-in client reads their own engagements, documents and messages; a practice manager runs the pipeline.Available
  • Client portal kit for hosted sitesTwo HTML elements give a hosted site a client portal and a staff pipeline, drawn from the Space's engagement types, stages and forms, with no code of your own.Available
  • Site host APIA WordPress site reports a connection test, visit counts and daily health with a signed site key.Available
  • Engagements through an API key or a webhookRead engagements from your own server, or hear about a change, without a person signed in.Planned
  • Shop, products and orders API for hosted sitesA documented, key-based way to read and update a hosted site's shop.Planned
  • Every docs page as MarkdownAdd ?format=md to any docs page, or send Accept: text/markdown.Available
  • llms.txt indexA short index of the docs for tools that read llms.txt, at /docs?format=llms.Available
  • OpenAPI specAn OpenAPI 3.1 description of the v1 API, with the error envelope and security schemes, at /docs?format=openapi.Available
  • Agent skill and integration briefAn installable SKILL.md and a paste-in brief, generated from the same code as the spec.Available
  • Agent keysA key made for an AI agent: read-only to start, short-lived, test mode first, every call logged, and the owner approves anything more.Available
  • Webhook test eventOne button sends a signed sample event to your URL, so your tool can learn the fields before anything real happens.Available
  • Replay a past webhook deliveryA Space admin sends a logged delivery to the endpoint again, freshly signed and marked as a replay.Available
  • Request id and docs link on every errorEvery error body carries an id to quote to support and a link to the page that explains it.Planned
  • Guide for Make, n8n and ZapierOne walkthrough for catching a Bynefit webhook in each tool, with a test event to learn the fields from.Available
  • Test keys and a sandboxKeys that only touch sample data, ready at once with no review, so a first attempt cannot break anything.Available
  • Idempotency-Key on writesRetry a v1 write without doing it twice: the first answer is replayed for 24 hours, per key.Available
  • Status pageLive state, 90-day uptime and incident history for the API, sign-in, webhook delivery, the widget, hosted sites and email. Atom and JSON feeds.Available
  • Docs MCP serverRead-only search of these docs from an AI tool.Available

Need a person?

Stuck on an integration?

Tell support what you were calling and what came back. Say which docs page you were on.

Contact support
Status and changes

Planned A status page is planned.

Changelog · API changes feed