Concepts
Every Dexby term in one table, and where to find each value you fill in.
Terms
| Term | What it is |
|---|---|
| Project | Your workspace for one product: its API keys, auth configs, users, logs and webhooks. |
| User | One of your end users, known to Dexby only by the user id you pass. |
| Connector | An app, such as slack. See Connectors. |
| Tool | One thing a connector can do, such as slack_post_message. |
| Auth config | How a connector signs in for your project: Dexby's OAuth app, your own, or an API key form. See Auth configs. |
| Connection | One user's account in one app, with its encrypted credential. A user can have several per app. |
| Connect link | A single-use link to Dexby's hosted page where a user connects their own accounts. See Connect accounts. |
| Session | What one agent may find and run for one user. See Sessions. |
| Meta tools | The few tools a session gives the model to search tools, run them and manage accounts. |
| MCP endpoint | A fixed, named MCP server URL with a chosen set of tools. See MCP. |
| Trigger | A subscription to an app event for one connection. See Triggers. |
Where to find each value
Dashboard pages are named as they appear in the dashboard sidebar, group first.
| Value | Looks like | Where to get it |
|---|---|---|
| API key | dx_ + 64 hex characters | Configure → API keys → create. Shown once. The key decides the project, so you never pass a project id with it. |
| User id | user_123 | Your own id for the user, such as their database id. Use a stable id: an email address or phone number is refused with 400 VALIDATION_ERROR. Users then appear under Operate → Users. |
| Connector id | slack | Build → Catalog, or the public connectors page. |
| Tool id | slack_post_message | A connector's page in Build → Catalog, or Build → Playground. |
| Auth config key | slack, then slack-2 | Build → Auth configs, the Auth config column. |
| Session id, session MCP URL | session.id, session.mcpUrl | Returned when you create a session. Also listed under Operate → Sessions. |
| MCP endpoint slug | support-agent | You choose it when you create an endpoint in Distribute → MCP endpoints. The endpoint's page shows the full URL. |
| Connection id | con_01j9x2f4… | Operate → Connections, open the account, Connection ID. Or GET /v1/connections?userId=user_123. |
| Trigger event id | app_mention | The event list when you create a trigger in Operate → Triggers, or triggers[].id from GET /catalog/:connectorId. |
| Webhook signing secret | whsec_... | Configure → Webhooks → add an endpoint. Shown once. |
API URL (DEXBY_API_URL) | https://api.harryy.ai | This deployment's API, shown in every example. The SDK reads DEXBY_API_URL and falls back to Dexby Cloud. |
Every ID Dexby creates starts with three letters that name its type, such as con_ for a connection,
ags_ for a session or trg_ for a trigger, followed by 26 lowercase letters and digits. IDs sort by
creation time.
Keep the API key on your server. It can use any project user's connected accounts, and the /v1
API does not answer browser requests.
Links to the dashboard
Dashboard links in these docs put ~ where your organization and project IDs go, so they work for
every reader. You can use the same form in your own runbooks and alerts.
| Link | Opens |
|---|---|
/orgs/~/projects/~/<page>, such as /orgs/~/projects/~/keys | That page in your project. With more than one project you choose which one, and the project you opened last is listed first. |
/orgs/~/projects/~/triggers/trg_… or /orgs/~/projects/~/logs/req_… | That trigger or log, in the project it belongs to. |
/orgs/~/projects/~/connections?account=con_… | That account's details, in the project it belongs to. |
/orgs/~/projects/~/connectors?config=cfg_… | That auth config's panel. Add &account=con_… for one of its accounts. |
/orgs/~/projects/~/webhooks?endpoint=whk_… | That webhook endpoint's deliveries. |
/orgs/~/<page>, such as /orgs/~/team or /orgs/~/settings/billing | That page of your organization. With more than one organization you choose which one. |
A link that names an ID you cannot see opens as if it named none. The query and the # part of a
link are kept. Signed out, you sign in first and then land on the page.