Tooling API

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introducing Tooling API
SOAP Calls
Tooling API Objects and Namespaces
Tooling API Objects
ActivationPlatform
AdvAcctFrcstDisplayGroup
AdvAccountForecastSet
AdvAcctForecastMeasureDef
AIApplication
AIApplicationConfig
AnimationRule
ApexClass
ApexClassMember
ApexCodeCoverage
ApexCodeCoverageAggregate
ApexComponent
ApexComponentMember
ApexEmailNotification
ApexExecutionOverlayAction
ApexExecutionOverlayResult
ApexLog
ApexOrgWideCoverage
ApexPage
ApexPageInfo
ApexPageMember
ApexResult
ApexTestQueueItem
ApexTestResult
ApexTestResultLimits
ApexTestRunResult
ApexTestSuite
ApexTrigger
ApexTriggerMember
AssignmentRule
AuraDefinition
AuraDefinitionBundle
AuthorizedEmailDomain
AutoResponseRule
BrandingSet
BrandingSetProperty
BriefcaseDefinition
BusinessProcess
BusinessProcessDefinition
BusinessProcessFeedback
BusinessProcessGroup
BusProcessFeedbackConfig
Certificate
CleanDataService
CleanRule
ColorDefinition
CommunityWorkspacesNode
CompactLayout
CompactLayoutInfo
CompactLayoutItemInfo
ConnectedApplication
ContactCenterChannel
ContainerAsyncRequest
ConversationChannelDefinition
ConversationVendorInfo
CspTrustedSite
CustomApplication
CustomField
CustomFieldDisplay
CustomFieldMember
CustomHelpMenuSection
CustomHttpHeader
CustomNotificationType
CustomObject
CustomTab
DataAssessmentConfigItem
DataIntegrationRecordPurchasePermission
DataSourceBundleDefinition
DataType
DebugLevel
DelegateGroup
DelegateGroupGrant
DelegateGroupMember
DeployDetails
DeployRequest
Document
DomainProvision
DuplicateJobDefinition
DuplicateJobMatchingRuleDefinition
EmailTemplate
EmbeddedServiceBranding
EmbeddedServiceConfig
EmbeddedServiceCustomComponent
EmbeddedServiceCustomization
EmbeddedServiceCustomLabel
EmbeddedServiceFieldService
EmbeddedServiceFlow
EmbeddedServiceFlowConfig
EmbeddedServiceLiveAgent
EmbeddedServiceMenuItem
EmbeddedServiceMenuSettings
EmbeddedServiceQuickAction
EmbeddedServiceResource
EnrichedField
EntityDefinition
EntityLimit
EntityParticle
EventDelivery
EventRelayConfig
EventSubscription
ExternalAuthIdentityProvider
ExternalClientAppSettings
ExternalCredential
ExternalDataSource
ExternalDataSrcDescriptor
ExternalServiceRegistration
ExternalString
ExternalDataTransportFieldTemplate
ExternalDataTransportObjectTemplate
ExternalStringLocalization
FieldDefinition
FieldMapping
FieldMappingField
FieldMappingRow
FieldRestrictionRule
FieldSet
FlexiPage
Flow
FlowDefinition
FlowElementTestCoverage
FlowTest
FlowTestCoverage
ForecastingDisplayedFamily
ForecastingFilter
ForecastingFilterCondition
ForecastingSourceDefinition
ForecastingType
ForecastingTypeSource
FormulaFunction
FormulaFunctionAllowedType
FormulaOperator
GenAiFunctionDefinition
GenAiPlannerDefinition
GlobalValueSet
Group
GtwyProvPaymentMethodType
HeapDump
HistoryRetentionJob
HomePageComponent
HomePageLayout
IconDefinition
InboundNetworkConnection
InboundNetworkConnProperty
Index
IndexField
InstalledSubscriberPackage
InstalledSubscriberPackageVersion
IPAddressRange
KeywordList
Layout
LightningComponentBundle
LightningComponentResource
LookupFilter
ManagedContentNodeType
ManagedContentType
ManagedEventSubscription (Beta)
MarketingAppExtension
MarketingAppExtAssignment
MarketingAppExtActivity
MarketingAppExtAction
MatchingRule
MenuItem
MetadataComponentDependency (Beta)
MetadataContainer
MetadataPackage
MetadataPackageVersion
MLDataDefinition
MLField
MLFilter
MLPredictionDefinition
ModerationRule
NamedCredential
ObjectHierarchyRelationship
OmniSupervisorConfig
OperationLog
OpportunitySplitType
OrgDomainLog
OutboundNetworkConnection
OutboundNetworkConnProperty
OwnerChangeOptionInfo
PackageInstallRequest
PackageUploadRequest
PackageVersionUninstallRequestError
PathAssistant
Package2
Package2Member
Package2Version
Package2VersionCreateRequest
Package2VersionCreateRequestError
PardotTenant
PathAssistantStepInfo
PathAssistantStepItem
PaymentGatewayProvider
PermissionDependency
PermissionSet
PermissionSetAssignment
PermissionSetGroup
PermissionSetGroupComponent
PermissionSetTabSetting
PipelineInspMetricConfig
PlatformEventChannel
PlatformEventChannelMember
PlatformEventSubscriberConfig
PostTemplate
ProcessFlowMigration
ProductAttributeSet
Profile
ProfileLayout
Publisher
QueryResult
QuickActionDefinition
QuickActionList
QuickActionListItem
RecentlyViewed
RecommendationStrategy
RecordActionDeployment
RecordType
RegisteredExternalService
RelatedListColumnDefinition
RelatedListDefinition
RelationshipDomain
RelationshipInfo
ReleaseUpdate
ReleaseUpdateStep
RemoteProxy
RestrictionRule
SandboxInfo
SandboxProcess
SchedulingObjective
SchedulingRule
SearchLayout
SecurityHealthCheck
SecurityHealthCheckRisks
ServiceFieldDataType
Scontrol
ShiftSegmentType
SiteDetail
SOQLResult
SourceMember
SourceMemberDeployRequest
StandardAction
StaticResource
SubscriberPackage
SubscriberPackageVersion
SubscriberPackageVersionUninstallRequest
SvcCatalogCategory
SvcCatalogCategoryItem
SvcCatalogFulfillFlowItem
SvcCatalogFulfillmentFlow
SvcCatalogItemDef
SymbolTable
TabDefinition
Territory2SupportedObject
TestSuiteMembership
TimeSheetTemplate
TimeSheetTemplateAssignment
TraceFlag
TransactionSecurityPolicy
User
UserAccessPolicy
UserAccessPolicyAction
UserAccessPolicyFilter
UserCriteria
UserEntityAccess
UserFieldAccess
ValidationRule
VirtualVisitConfig
WebLink
WebStoreTemplate
WorkflowAlert
WorkflowFieldUpdate
WorkflowOutboundMessage
WorkflowRule
WorkflowTask
WorkSkillRouting
WorkSkillRoutingAttribute
SOAP Headers for Tooling API
REST Headers for Tooling API
PDF

EmbeddedServiceCustomComponent

Represents a custom component created for an Embedded Service feature. The custom components can be an Aura or Lightning Web Component. This object is available in API version 44.0 and later.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

This type is available only if Salesforce Experiences and Salesforce Sites are enabled in your org. To access this type, you need the Customize Application user permission.

Fields

Field Details
CustomComponentId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The unique ID of the LightningComponentBundle or AuraDefinitionBundle component to be used in the Embedded Service.
CustomComponentType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The embedded component type associated with the chosen Feature that you want to customize. The possible values are:
EmbeddedServiceConfigId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The unique ID of the EmbeddedServiceConfig object that this custom component is associated with.
Feature
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The Embedded Service feature that uses the custom component. The possible values are:
  • Base
  • ChannelMenu
  • FieldService
  • Flows
  • LiveAgent
  • NotInUse

Usage

Each Embedded Service feature has a defined set of components that can be customized. You can customize the feature using your own Lightning Web Components or Aura Components. Right now, you can only customize components of the Embedded Service Chat feature. For example, you can customize the prechat form, minimized state, chat bubble, and chat header of a Chat widget.

To customize a component, link the Lightning Web Component or Aura Component to an Embedded Service Custom Component object. Then link an Embedded Service Configuration to this object. The Embedded Service Configuration represents the Chat widget that you want to customize.