#Partner Guides

4 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 or provision partner-managed clientsClients
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, client provisioning and assignment, project workspace changes, API-key lifecycle, and supported integration mutations.
  • 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 sidebar 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. 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.

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 capacity rollupSame viewShared operational surface (also reachable at /capacity).
/clientsProvision client profiles and assign partner usersView assigned clientsSee Clients. Provisioning controls are reached through Partner team.
/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)Manage selected-project knowledge bases, sources, and attachments where enabledView knowledge-base inventorySee Integrations.
/telephony (Implementation)Manage selected-project phone numbers and registration where enabledView phone-number inventorySee Integrations.
/integrationsManage API keys, webhooks, SSO, SCIM, and provider connections where enabled (Plugins & tools, API keys, Webhooks, SSO, SCIM, Provider connections tabs)View integration inventory and enabled summariesSee Integrations.
/partner-team (Organisation)Manage team members and invitations for provisioned partner organisationsView team and assigned clients where partner bootstrap is completeSee Partner Team.
/audit-log (Organisation)Selected-client activity logSame viewShared customer surface.
/settings (Organisation)Own profile and security; client/organisation data stays read-onlyRead-only client dataShared customer surface.
/billing (Billing & Support)Selected-client billing overview, invoices, and entitlementsNot availableShown to partner_admin only; see Client Billing.
/support (Billing & Support)Create and view support ticketsCreate and view support ticketsShared customer surface.

/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.