User Guides
Developers
Support Portal
Skedulo Lens API Reference Guide
Search
User Guides
Developers
Support Portal
Skedulo Lens API Reference Guide
Skedulo Documentation
Developer documentation
Getting started with Skedulo
Introduction
Quickstart
Deskless Productivity Cloud fundamentals
Skedulo concepts
The Skedulo core data model
Authentication and authorization
Authentication for Skedulo
Authentication requirements and API tokens
Skedulo API user
Authentication for Skedulo for Salesforce
Authorization
User permissions in Skedulo for Salesforce
Skedulo for Salesforce permission sets
Skedulo permissions and access control (deprecated)
Object and field permissions (deprecated)
Role-based permissions (deprecated)
Insufficient access (deprecated)
Use the Skedulo REST API
Use GraphQL
Get started with GraphQL
Install the GraphiQL web extension
Query the GraphQL schema
Perform multiple actions using GraphQL aliases
Make changes to the schema using GraphQL mutations
Use pagination to access all GraphQL query results
Subscribe to Skedulo objects
Upsert records with GraphQL
Manage and schedule work
Overview
Create and configure work
Overview
Job lifecycle
Job start and end times
Job time constraints
Create a new job or activity with pre-filled data
Manage resource availability
Manage accounts
Use provisioning to create multiple user accounts
Use tags
Use tags for resources and jobs
Add Contact tags to Accounts using GraphQL
Add Resource tags to Jobs using GraphQL
Manage scheduling rules and exceptions
Manage scheduling rules and conflicts on the Skedulo Pulse Platform
Schedule rules and violations (conflicts)
Manually run a job to evaluate pre-existing schedules
Integrate with the Rules service
Implement custom schedule rules
Implement fatigue and time-interval-based rules
Understand the Insufficient travel time rule
Optimize schedules
Overview
Get started with optimization
Create a scheduled optimization
Optimize vs Suggest
Overview
Suggest: Resources and times for a job
Suggest: Times to schedule a job
Optimized scheduling using the Skedulo API
Use and manage location information
Using the Geoservices API
Calculate distance and travel time
Calculate the travel time and distance between multiple locations
Estimate the distance and travel time between locations on a route
Estimate travel times between work items (deprecated)
Address geocoding and autocompletion
Generate a session ID for geoservices requests
Get a location's Place ID
Get a location's details
Get a location's geographic co-ordinates
Get a location's timezone
Geolocation field type and distance comparison
Errors and troubleshooting
Customize and extend Skedulo web app
Create and customize objects, and fields
Introduction to custom objects and fields in Skedulo
Create custom objects and fields in the Skedulo Pulse Platform
Create custom objects and fields with the Skedulo API
Create custom objects and fields in the Skedulo Pulse Platform
Use GraphQL to query custom objects and fields
Understand the Lookup and Has many custom field types
Customize and modify Skedulo picklist values
Overview of Skedulo picklists
Modify picklist items and field dependencies
Create and map custom objects in Salesforce
Create custom objects in Salesforce
Add custom fields to your custom object in Salesforce
Map custom objects and fields
Create and customize pages
Introduction to pages
Manage pages
Create pages
Customize pages
Error codes
Override system-generated pages
Overview
Create an object and add custom fields
Configure the navigation menu
Override the default Create record page
Override the default View record page
Override the default Edit record page
Edit the default columns
Edit the column templates
Override the default List view page
Create and customize list views
Use list views
Sort list views
Filter list views
List view columns
Configure default columns for list views
Save and share list views
Advanced column configuration for list views
Customize list views
Use the Skedulo Software Development Kit (SDK)
Overview
Install and set up Skedulo Packages SDK
Skedulo web extensions
Overview
Build and deploy a standalone web page (formerly known as Connected Pages)
Build and deploy embedded web extensions
Build and deploy multiple pages as a package
Web extensions API services
Customize and extend Skedulo mobile apps
Skedulo v2 mobile extension
Skedulo v2 mobile app extensions for custom forms
Build and deploy Skedulo v2 mobile app extensions
Integration and automation
API Overview
Overview
Skedulo REST API
Use GraphQL
Valid Date and DateTime formats
Make API calls from Salesforce
Overview
Make generic Skedulo API requests using Salesforce
Make Skedulo API Notification requests using Salesforce
Automate responses to changes using webhooks and triggered actions
Overview of triggered actions and webhooks
Error handling and debugging triggered actions and webhooks
Use webhooks
Create a webhook
Schedule or defer a webhook
Manage incoming SMS with webhooks
Use triggered actions
Introduction to triggered actions
Create a triggered action for modified objects
Update a triggered action
Delete a triggered action
Develop and deploy custom code using connected functions
Errors and troubleshooting
Manage and control access
Create and use record access policies
Understand record access policy rules
Manage record access policies via the API
How Record access policies control data access
Best practices: Create record access policies and rules
Create and manage deployments
Create and deploy packages with the SDK
Get started with Skedulo packages
Overview of package components
Create libraries with the SDK
Get started with libraries
Introduction to Skedulo libraries
Use shared components library
Skedulo system status
User guides
Getting started
Getting started with Skedulo platform
Install and setup for Skedulo Pulse Platform
Set up and verify account and team
Confirm web browser compatibility
Complete onboarding wizard
Log into the Skedulo Web App (for Skedulo Pulse Platform customers)
Manage resources and assets in the Skedulo web app
Manage resources
Use resource tags
Manage assets
User settings
Customize scheduling workflow
Getting started with Skedulo for Salesforce
Install and setup for Skedulo for Salesforce
Install and configure the onboarding wizard
Log into the Skedulo web app using Salesforce username
Open In Salesforce™ from within Skedulo web app
Manage regions in Skedulo for Salesforce
Create regions
Manage users in Skedulo for Salesforce
Manage user types
Grant Salesforce user a Skedulo license
Create and edit Salesforce users
Manage user permissions
Add or change a profile image
Deactivate users
Manage resources and assets in Skedulo for Salesforce
Adding new resources
Create resource category
Manage tags (skills)
Enable and manage job products
Quickstart tutorials
Quick-start 1 - The onboarding wizard
Quick-start 2 - How to set up resources
Quick-start 3 - Creating jobs
Quick-start 4 - Dispatching jobs
Glossary
Create and edit work
Create and manage work
Create and manage work in the Skedulo web app
View work
Use the Schedule Calendar view
Use the Work console
Create work
Create a new job type
Create and update work
Use quick job create
Use work cards
View and manage work details
Job details - old version
View, add, and delete attachments
Work custom fields
Apply time constraints to work items
View work status
Manage resource requirements
Allocate and dispatch work
Allocate work
Dispatch work
Manage job dependencies (Beta)
Schedule and manage work offers
Complete, cancel, or reshedule work
Cancel or reschedule a job
Manually complete a job
Restore a canceled job
Add virtual meetings to work
Create and manage work in Skedulo for Salesforce
Create a new job type in Skedulo for Salesforce
Add custom fields to jobs
Create and edit shifts
Create and edit shifts in the Skedulo web app
Create and edit shifts
Display shifts in swimlane views
Create and manage shift offers
Define resource working hours
Create and edit activities
Create and edit activities in the Skedulo web app
Use activities console
Create and manage activities
Manage scheduling and availability
Manage availability and unavailability
Manage availability and unavailability in the Skedulo web app
Access availability console
Create unavailability
Manage availability and unavailability in Skedulo for Salesforce
Manage availability and unavailability types
Create a holiday record
View and manage resource availability
Create and view schedules
View schedules
Scheduling user preferences
Scheduling console
Status panel
Horizontal swimlanes
Vertical swimlanes
Map view
Create schedules
Deallocate and unschedule
Multiple regions
Using search and filters
Filter bar
Global search bar
Create and manage recurring schedules
Create and manage recurring schedules
Change, modify, or delete recurring schedule
Optimization of schedule
Manage and use route optimization
Optimize schedules
Set working hour limits for resources
Optimization recipes
Introduction to optimization recipes
Objective: Preferred resources
Objective: Balanced workload
Objective: Travel time
Objective: Minimize resources
Objective: Work priority
Objective: Soft skills
Create optimization recipes
Best practices for optimization recipes
Scheduled optimization
One-off optimization (Swimlane view)
One-off optimization (Vertical swimlane)
One-off optimization (Map view)
One-off optimization (Schedule calendar view)
Background tasks
Travel time and route optimization
Best practices: Optimizing work with multiple resources (Beta)
Optimization results
Optimization history
Use Suggest feature
Manage schedule conflicts and exceptions
Schedule conflict alerts in the web app
Manage schedule conflicts with the Rules service on the Skedulo Pulse Platform
View schedule rule conflicts on the Skedulo Pulse Platform
Manage schedule rule conflicts on the Skedulo Pulse Platform
Frequently asked questions: Schedule rules and conflicts
Troubleshooting schedule rules and conflicts
Manage exceptions with the Exceptions service (Closed beta)
Administer and configure
Administer and configure Skedulo web app
Configure users and preferences
Manage users
View and configure general settings
View and configure preferences
Configure social integrations
Enable notifications
Configure the navigation menu
Reroute standard Skedulo URLs with page overrides
Create, configure, and manage users (deprecated)
Create and customize work
Customize scheduling workflow
Customize offer workflow
Configure scheduling rules
Create job templates
Create and manage data objects
Manage custom fields
Manage picklists
View and customize tables
Change work card appearance
Understand job start and end times calculations
Enable GraphQL subscriptions for job and allocation updates
Configure Optimization and Suggest
Configure notifications and messaging
Enable and view notifications
Configure and customize push and SMS notifications
Numbers for SMS delivery
View and edit teams
View change history
Extend Skedulo with extensions
Create and manage extensions
Define API user
Create API tokens with developer tools
View authentication information
Enable beta features
Manage configuration variables
Manage packages (Beta)
Permissions and data access control
User roles and permissions
Standard roles
Functional permissions and custom roles
Create custom roles for functional permissions
Manage and delete roles
Permission dependencies
Use record access policies to control data access
Record access policies
Manage record access policies
Manage record access policy rules
Record access policy templates
Role-based customization of the navigation menu
Administer and configure Skedulo for Salesforce
Change inactivity session timeout
Manage Salesforce account and location resource scores
Turn on Salesforce event synchronization
Enable Auto-update Geolocation
Configure and manage geolocation of job allocation status change
View and upgrade Skedulo Managed Packages
Skedulo Managed Package Object Chart
Estimate job allocation object travel time and distance
How to add Skedulo as a trusted network
Delink a user from resource record to prevent the deletion of allocated jobs
Configure and view promoted custom field
How to grant enhanced permissions for Salesforce community users
Configure a Skedulo API token in Salesforce
Create and customize fields
Create custom fields
Configure and view promoted custom field
Errors and troubleshooting
OAuth errors
Invalid request error - ip restricted
Access denied error - Session expired or invalid
Houston we have a problem
Administer and configure the Skedulo mobile app
Set up and manage location tracking
Customize mobile app settings
Customize fields and forms
Customize fields
Customize forms
Customize mobile workflow labels
Customize job workflow
Enable and manage proximity notifications
Set up app linking
Errors and troubleshooting
Mobile sync errors
Condenser script execution error
Skedulo mobile app server errors
Known Skedulo v2 mobile app issue - Crashing on iOS 13.1.2
Administer and configure Skedulo Plus
Set geofencing rules for Skedulo Plus
Load and manage data
Load and migrate data to Skedulo
Import and update data
Bulk import users
Format data type
FAQs
Best practices
Object import order
Migrate data to Skedulo
Best practices for migrating data
View data tables
Export data from Skedulo
Export data
Export data from related objects
Create export templates
Use data export templates
Create a new CRM record
Manage accounts
Manage activities
Manage availability types
Manage contacts
View exclusions
Manage holidays
View inclusions
View and create new job types
Manage locations
Manage regions
Manage resource categories
Manage tags
Single Sign-On (SSO)
Getting started with Single Sign-On
Set up up Single Sign-On
Setting up Single Sign-On
Set up Single Sign-On with Salesforce
Log in with Single Sign-On
Log in with Single Sign-On
Log in with Single Sign-On via Salesforce
Frequently Asked Questions - SSO
Single Sign-On terminology
Analytics and reporting
In Skedulo Pulse Platform
Introduction to Skedulo analytics
Interact with dashboards
Looker explores
In Skedulo for Salesforce
Install and view Skedulo reports and dashboards
Dynamic messaging
Using Dynamic Messaging in Skedulo Platform
Configure dynamic messaging
Mobile user guides
Skedulo mobile app versions and availability
Skedulo v2 mobile app
Install and set up
Confirm device compatibility
Log in to the Skedulo v2 mobile app
Log in using a Salesforce username
Upgrade from Skedulo to the Skedulo Plus mobile app
Getting started with the mobile app
Getting started
Set up profile and preferences
Set up profile
Edit profile
Set preferences in Settings
Set up notifications
Sync calendar to iCal
Manage agenda and availability
View agenda and calendar
Manage activities
Manage availability and unavailability
Manage work
Manage jobs
Job workflow overview
Access job details
The job details page
Jobs at one location
View and complete tasks
Create a follow up job
Add a signature
Add and rename attachments
Manage timestamps
Manage jobs with multiple resources
Add notes
View attendees of a group event
Create new job
Decline or cancel a job
Swap a job
Manage work offers
Manage shifts
View shifts
Enable and receive shift notifications
Manage shifts
Manage shift offers
Communication and messaging
View notifications
Messaging with Dynamic Messaging
Enhance mobile use in the field
Learn about offline syncing
Minimize bandwidth usage
Errors and troubleshooting
Forgot team name
Forgot user password
Fix notification issues
Condenser script execution error
Skedulo mobile app server errors
Known Skedulo Mobile app Issue - Crashing on iOS 13.1.2
Feedback and support
Skedulo Plus mobile app
Introduction
Download and install
Confirm device compatibility
Log in
View agenda and calendar
View work offers
View job details
Accept and start work
Add attachments
Set preferences
Manage availability
Dynamic Messaging for Skedulo Plus
Skedulo Plus troubleshooting
Feedback and support
Help and support
Access help and support via web app
Grant login access to a Skedulo agent via Salesforce
Support requests
Technical support plans and SLAs
Errors and troubleshooting
In Skedulo Pulse Platform
Notification failures
Invalid request error - ip restricted
Access denied error - session expired or invalid
Houston we have a problem
Insufficient permission to access the web app
Skedulo Lens API Reference Guide
Authentication
Authentication
Authorization
Authorization
Communications
Notifications
Virtual meetings
Configuration
Custom fields
Configurations
Onboarding
Data Access
Graphql
Optimization
Optimization
Planr
Scheduling
Availability
Recurring schedules
Resource tracking
Schedule management
Rule violations (conflicts)
Utilities
Change history
Files
Geoservices
iCal
Triggered actions
Webhooks
Not found
Oops! This page doesn't exist. Try going back to our
home page
.