#Partner Guides

5 min read

Use these guides when your organisation manages AiDial clients as a partner. They cover the live partner portal surfaces, direct partner API usage, and the boundaries between partner self-service and AiDial support.

#Start Here

I want to...Read
Understand partner roles and what each role can doPartner Team and Roles & Permissions
View partner-managed clients and understand the provisioning boundaryClients
Create, rotate, or revoke API keysAPI Keys & Partner API
Edit project configuration, runtime-domain settings, and publish changesProjects
Manage outbound campaigns, CSV imports, launch validation, and campaign reportingOutbound Campaigns
Understand webhooks, catalog, RAG/knowledge-base, phone-number, messaging, and plugin integration scopeIntegrations
Review selected-client call performance, usage, and cost estimatesAnalytics & Usage
Monitor calls, analytics and usage, alerts, and status across assigned clientsImplemented Partner Surfaces and Client Guides
Know when to contact AiDial supportEscalation Boundaries

Shared customer-facing guides for Dashboard, Calls, Billing, Settings, Support, Status, and some operational views still live under Client Guides when the same page behaviour applies to partner roles.

#Current Partner Roles

  • partner_admin can manage implemented partner surfaces for assigned clients, including partner-team management, project workspace changes, API-key lifecycle, and supported integration mutations. Client provisioning and partner-user assignment are implemented as partner_admin-only API routes with no portal screen — see Clients.
  • partner_user has read-only partner access where the portal exposes it. Partner users can view assigned operational state but cannot invite team members, create clients, assign users, publish projects, create or revoke API keys, or mutate integrations.

Navigation visibility is not the security boundary. Portal pages and route handlers enforce role, partner-organisation, client, and project scope server-side. Out-of-scope client or project requests are denied without revealing whether another tenant exists.

#Authentication Boundary

The browser uses the AiDial Portal session:

text
Browser -> AiDial Portal server -> AiDial API

Browser code must not send X-API-Key. Portal routes use the signed-in session and forward server-side bearer authentication to the AiDial API.

Direct partner integrations are different: trusted server-side systems authenticate to the AiDial API with API keys. See API Keys & Partner API and API Authentication.

#Implemented Partner Surfaces

The partner shell has no top bar: the sidebar carries navigation, the notification bell, and the account menu. It groups surfaces into Overview, Monitor, Clients, Implementation, Integrations, Organisation, and Billing & Support. partner_admin and partner_user see the same navigation except Billing, which is shown to partner_admin only. Billing and Entitlements are the two partner_admin-only partner routes; partner_user receives a generic not-found on both.

Sidebar visibility is a UX treatment; the route table and each /api/** handler are the security boundary, and partner_user write requests stay server-denied regardless of what the UI renders. Several surfaces also need a confirmed single client or project before they show detail — Calls, Analytics, Projects, Outbound campaigns, Integrations, Knowledge bases, Telephony, Billing, and Entitlements. Until one is confirmed they show a pick-a-client or selection-required state rather than a cross-client aggregate. Audit log is the exception: with no client selected it merges the activity of every assigned client into one list.

Portal surfacePartner adminPartner userNotes
/dashboard (Overview)Assigned-client operational overviewSame viewShared customer surface; see Client Dashboard.
/calls (Monitor)Call log and call detail for assigned scopeSame view, cost fields off-the-wireShared customer surface; see Call Log.
/analytics (Monitor)Selected-client analytics and usageSame view, cost off-the-wireSee Analytics & Usage.
/alerts (Monitor)Alerts overviewSame viewPresentation surface; no rule editing in the current build.
/status (Monitor)Assigned-client status and project-health rollupSame viewShared operational surface.
/capacity (Monitor)Concurrent-call capacity across assigned clientsSame viewAssigned-client rollup; capacity history is fetched for a selected client.
/clientsAssigned-client directory, filter, and bounded client summarySame directory with less contact and billing detailSee Clients. The directory carries no provisioning or assignment controls of its own.
/projects (Implementation)Edit drafts, publish, restore versions, and manage implemented runtime-domain controls where enabledView project workspaceSee Projects. Compliance deep-links into the Projects Govern section.
/outbound-campaigns (Implementation)Create and manage campaigns, imports, validation, launch controls, and reporting for assigned clientsView safe campaign status and reportsSee Outbound Campaigns.
/knowledge-bases (Implementation)Selected-project knowledge-base inventory, read-onlySame inventorySee Integrations. Creating knowledge bases, adding sources, attaching agents, and rebuilding happen in the project workspace, not on this page.
/telephony (Implementation)Selected-project phone-number inventory, read-onlySame inventorySee Integrations. Number purchase, porting, carrier provisioning, and assignment changes are not available from this inventory.
/integrationsManage API keys, webhooks, SSO, and SCIM for the selected clientView the same tabs read-onlySee Integrations. Six tabs: Plugins & tools, API keys, Webhooks, SSO, SCIM, Provider connections. Plugins & tools and Provider connections are coming-soon placeholders.
/partner-team (Organisation)Manage team members and invitations; review each member's assigned clientsView the team roster and own assigned clientsSee Partner Team. Client assignments are shown read-only on this page.
/audit-log (Organisation)Activity log for all assigned clients, or one selected clientSame viewShared customer surface.
/settings (Organisation)Own profile, including multi-factor setup; client and organisation settings are read-only summariesSame viewShared customer surface. Notification preferences and session management are not available to partner roles.
/notificationsOwn notification feedSame viewReached from the sidebar notification bell.
/billing (Billing & Support)Selected-client Usage and Invoices, read-onlyNot availableShown to partner_admin only; the Payment panel is not part of the partner billing shell. See Client Billing.
/settings/entitlementsView and edit the selected client's plan tier, capabilities, and limitsNot availableNo sidebar entry; reached by direct link. See Entitlements.
/support (Billing & Support)Create and view support ticketsCreate and view support ticketsShared customer surface. Ticket attachments are not available to either partner role.

/plugins and /provider-connections are convenience routes that redirect to the matching /integrations tab, and /campaigns redirects to /outbound-campaigns.

#Keep Internal Detail Internal

Partner docs should not include internal host access, secret-management paths, database maintenance, deployment templates, or customer secrets. When a workflow needs those controls, use Escalation Boundaries and provide safe context to AiDial support.