Getting Started
From install to live sync in under 5 minutes
On This Page
Prerequisites #
Before you begin, make sure you have:
- A Salesforce org (Production or Sandbox)
- A ClickUp account (free or paid)
- System Administrator profile in Salesforce (for installation)
Installation #
Step 1: Choose your environment
Click the link for your Salesforce environment to start the installation:
Step 2: Follow the install wizard
Salesforce will prompt you through the installation. When asked, choose one of:
- Install for All Users — everyone gets the Support tab
- Install for Admins Only — restrict initial access to admins
Installation typically takes 1-2 minutes. You'll receive an email from Salesforce when it's complete.
Initial Setup #
After installation completes:
- 1
Navigate to the "Support" tab in your Salesforce org (you may need to find it in the App Launcher)
- 2
On first load, you'll see the setup wizard prompting you to connect a project management tool
- 3
Follow the steps below to connect your ClickUp account
Connecting ClickUp #
SFConduit offers two ways to connect your ClickUp account. Choose whichever works best for you:
Option A: Connect with OAuth
The quickest way to connect — no API token needed.
- 1. In the SFConduit setup wizard, select ClickUp as your provider
- 2. Click "Connect with ClickUp"
- 3. You'll be redirected to ClickUp to authorize SFConduit
- 4. Select your Workspace, Space, and List(s)
- 5. Click Connect
Option B: Connect with API Token
Prefer manual control? You can paste your own API token instead.
Find your API token
- 1. Go to ClickUp → click your avatar (bottom-left)
- 2. Click Settings
- 3. Navigate to Apps in the left sidebar
- 4. Under "API Token", click Generate (or copy if you already have one)
Connect in Salesforce
- 1. In the SFConduit setup wizard, select ClickUp as your provider
- 2. Click "Use API Token instead"
- 3. Paste your API token
- 4. Select your Workspace, Space, and List(s)
- 5. Click Connect
That's it! Tasks from your ClickUp list will begin syncing immediately via webhooks. New tasks, updates, comments, and time entries all flow automatically.
Managing Connections #
You can manage your connections from the Settings tab in the SFConduit component:
- + Add connections: Connect additional ClickUp lists. Each syncs independently.
- × Remove connections: Disconnect a list. This stops syncing but doesn't delete tasks from either system.
- • Connection status: Each connection shows its sync status and last sync time.
Tickets & Tasks #
Task list
The Tickets tab displays all synced tasks in a sortable, filterable table:
- Sortable columns: Subject, Subtasks, Status, Priority, Assignees, Time Tracked, Comments, Date
- Multi-select filters: Provider, Status, Assignee, Priority, and an Archived toggle
- Hidden statuses: Configure which statuses are hidden by default (e.g., "Closed") from Settings
- Pagination: Load more tasks as needed
Subtasks
SFConduit supports one level of subtask hierarchy:
- Parent tasks show a subtask count badge
- Click to expand/collapse subtasks inline
- Create subtasks directly from the task detail modal
- Subtasks sync independently via webhooks
Task detail modal
Click any task to open the detail view where you can:
- Edit the description (rich text)
- Change status, priority, and assignees
- View and add comments and time entries
- View attachments with clickable links
- Set a reminder ("Remind me in X days")
- Open the task directly in ClickUp
Creating tasks
Create new tasks and subtasks directly from Salesforce:
- Click "New Task" to create a top-level task
- From a task detail, click "Add Subtask" to create a child task
- Tasks are created in ClickUp first, then synced back to Salesforce
- All fields (status, priority, assignee, due date) are available at creation
Screenshot uploads
Use the screenshot utility bar to paste or upload images directly into task comments. Images are uploaded as attachments and embedded inline.
Dashboard & Time Tracking #
Dashboard
The Dashboard tab gives you a full overview of your project:
- Budget gauge: Hours spent vs. monthly budget with status text
- Health metrics: Open Tasks, Hours This Month (with trend vs last month), All Time Hours
- Overdue & upcoming: Two-column layout showing tasks that are past due or coming up, with action buttons
- Monthly hours chart: 12-month rolling chart with Bar/Line toggle
- Task breakdown: Click a month to see individual tasks with hours
- Assignee breakdown: Progress bars and percentages per team member
- Status donut chart: Visual breakdown by task status
- Priority breakdown: Chart showing task distribution by priority
Budget settings
Admins can configure a monthly hours budget and max from Settings → Dashboard Settings. The budget gauge on the dashboard updates automatically.
Time tracking
Log time directly from Salesforce — entries sync to ClickUp first, then save locally:
- Manual entry: Select date, duration, description, and team member
- Time log: View all entries per task with start/end time ranges
- Sync-first: Time entries are created in ClickUp first, then stored locally — no orphaned entries
- Overlap detection: Warns if a time entry overlaps with an existing one
Notifications & Reminders #
Email notifications
SFConduit includes a full email notification system. Configure notification jobs from Settings → Notifications:
- Trigger types: New ticket, status change, comment added, time logged, priority change, assignment, description update, archive, due date approaching/passed, budget threshold, stale task, estimate exceeded
- Digest delivery: Hold notifications and send as daily or weekly digests
- Quiet hours: Queue notifications during off-hours and deliver them after (timezone auto-detected)
- Global pause: Disable all notifications at once
- Per-task subscribe: Subscribe to specific tasks for notifications
- Summary reports: Daily digest, weekly summary, and monthly summary emails
Task reminders
Set personal reminders on any task:
- From the task detail modal, click "Remind me in X days"
- Reminders are sent via email at 9 AM on the scheduled day
- View pending reminders and cancel them from the task detail
Permissions #
SFConduit uses a 4-tier permission model controlled via Salesforce permission sets:
| Role | Access |
|---|---|
| Admin | Full access: manage connections, team members, notifications, branding, permissions, data export/reset |
| Client Admin | Manage settings for their org, view all tasks, add comments and time |
| User | View tasks, add comments, log time |
| Viewer | Read-only access to tasks and dashboard |
Assign permission sets from Settings → Permissions. Each Salesforce user's role determines what tabs and actions they see in the SFConduit component.
Team & Scheduling #
Team members
Manage your consulting team from Settings → Team Members:
- Add team members via ClickUp OAuth onboarding
- Each member connects with their own ClickUp token for per-user write enforcement
- Set a primary admin who appears first in team views
- Profile pictures sync from ClickUp automatically
- Deactivate users when they leave the team
Booking & scheduling
The Schedule tab lets clients book meetings with your team:
- Each team member can have a booking URL (Calendly or other provider)
- Clients see cards for each bookable admin with a primary admin badge
- Booking opens in an embedded iframe
Branding & Customization #
Make SFConduit look like your own product. Branding is configured at the consulting org level and automatically pushes to all connected client orgs.
What you can customize
- Logo: Upload your company logo (displayed in the component header)
- Primary color: Sets the accent color for buttons, links, and highlights
- Secondary color: Used for secondary UI elements
- Company website: Linked in the component footer
Where to configure
- From Salesforce: Settings → Branding (Super Admin only)
- From Admin Portal: Organization settings page
Changes propagate to all client orgs automatically — no manual updates needed.
Admin Portal #
The admin portal at api.sfconduit.com/portal/admin gives consulting teams centralized management:
- Organization management: View all connected client orgs, sync status, active connections, and connection health
- User management: Roles (super admin, org admin, member), add/remove users, view-as-user impersonation
- Invoice generation: Export invoices with date range filters, client filtering, payment terms, and hourly rate
- Plan & Billing: View your current plan, upgrade to paid, manage payment methods via Stripe
- Data export: Download data as CSV, SQL, or JSON
- Sync control: Manual "Sync Now" button with cooldown, API usage charts, and error logs
Access the portal at api.sfconduit.com/portal/login. Log in with your ClickUp account — your workspace determines your org, role, and team membership automatically.
Troubleshooting #
Tasks not syncing
- If using an API token, verify it's still valid in ClickUp Settings → Apps
- If using OAuth, try disconnecting and reconnecting
- Check the connection status in the Settings tab
- Webhooks may take a few seconds — try refreshing the page
- Check that the ClickUp list you selected still exists and has tasks
Permission denied error
- Ensure your Salesforce user has the SFConduit permission set assigned
- If installed for Admins Only, non-admin users won't see the Support tab
- Check that the Remote Site Setting for api.sfconduit.com is active
Connection failed
- For API tokens: tokens don't expire, but regenerating one invalidates the old one
- For OAuth: your authorization may have been revoked in ClickUp — reconnect via OAuth
- Remove the connection and re-add with either method
- Make sure your ClickUp workspace hasn't changed plans or disabled API access
Still stuck? Email support@sfconduit.com and we'll help you get connected.
Comments & Attachments #
Bidirectional comments
Comments sync in real time between Salesforce and ClickUp via webhooks:
Attachments
File attachments from ClickUp tasks are displayed as clickable links in the task detail modal. Upload images via paste or the screenshot utility bar.
Shared files
Admins can configure a Google Drive shared folder link in Settings → File Sharing. A "Shared Files" button appears in the task list toolbar, giving users quick access to the shared folder.