Engagements

Engagement types and stages

An engagement type is a named kind of client work in a Space, such as grooming, tutoring or repairs, with its own ordered stages. Managers set them up on the Engagements page, and an AI agent with its own key can read and manage them through the API.

How a type works

• The status stays the machine state. Every engagement keeps one of the existing statuses, so payments, emails and the portal behave as before.
• A stage is a labelled step inside a status. Each stage names the status it sits in (status_bucket). Moving to a stage may move the status along an allowed forward step, never backwards. A move the status cannot make is refused with 409.
• Stages must be reachable. Consecutive stages in different buckets must be one allowed step apart: submitted to in_review or awaiting_payment, in_review to filing, then filing, filed, issued, closed one at a time. A list that skips a step is refused with stage_unreachable and the allowed next buckets.
• Stages follow the status order. A type has 1 to 12 stages, and their buckets may not go backwards through draft, submitted, awaiting_payment, in_review, filing, filed, issued, closed.
• Clients see only some stages. A stage with client_visible: false is shown to staff only. The portal returns type and stage with each engagement ({key, label} or null).
• Default items are priced lines in whole cents, checked by the same rules as an engagement's own charges.

Give an agent access

1. Create an agent key. It starts in test mode.
2. The agent asks for read:engagement-types and write:engagement-types with POST /dash/api/v1/agent/access-requests and a reason.
3. The key owner, a manager or admin of the Space, approves each on the key page. If they stop being a manager or admin, the key switches off.
4. To write for real, the owner moves the key to live. In test mode every write is a dry run.

The calls

All calls are under /dash/api/v1 and only see the key's own Space. A type from another Space answers 404.

curl -X POST -H "Authorization: Bearer $BYNEFIT_API_KEY" -H "Content-Type: application/json" \
  -H "Idempotency-Key: grooming-type-1" \
  -d '{"key": "grooming", "label": "Grooming", "stages": [
        {"key": "requested", "label": "Requested", "status_bucket": "submitted"},
        {"key": "booked", "label": "Booked", "status_bucket": "in_review"},
        {"key": "groomed", "label": "Groomed", "status_bucket": "filing"},
        {"key": "ready", "label": "Ready for pickup", "status_bucket": "filed"},
        {"key": "picked-up", "label": "Picked up", "status_bucket": "issued"}
      ], "default_items": [{"label": "Full groom", "kind": "service", "qty": 1, "unit_cents": 7500}]}' \
  https://bynefit.com/dash/api/v1/engagement-types

Limits and safety

• Key. 2 to 40 characters of a-z, 0-9, _ or -, unique in the Space.
• Size. At most 50 types in a Space. Labels are 1 to 80 characters, stage labels 1 to 60.
• No client data. These permissions never read or change an engagement or a client.
• Ceiling. Live writes share the key's daily write budget with forms. A key in test mode, or a call with "dry_run": true, is checked and writes nothing.
• Log. Every live change is recorded in the Space activity log with the key, the type key and the action, never the content.

Errors

What exists and what does not

• 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
• 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
• Client portal APIA signed-in client reads their own engagements, documents and messages; a practice manager runs the pipeline.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
• 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
• 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
• 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