After adding a Zendesk application connection to an environment, you can tailor the fetch behavior to match your organization’s setup.
How to edit your configuration
Environment Settings → Application Connections
Click the ••• menu next to your Zendesk connection → Edit Configuration File
For more information about changing settings, read the Salto Configuration File article.
Client settings
Fine‑tune retry logic and rate‑limit caps so large fetches don’t hit Zendesk API throttling.
zendesk {
client = {
retry = {
maxAttempts = 5
retryDelay = 5000 # ms
}
rateLimit = {
total = -1 # ‑1 = unlimited shared budget
get = 20 # per‑GET cap
}
maxRequestsPerMinute = 200
delayPerRequestMS = 100
}
}
Zendesk fetch rules
Zendesk supports criteria filters inside include or exclude, letting you target objects by fields such as name or title. These field‑level filters are adapter‑specific and may not exist in other systems.
zendesk {
fetch = {
exclude = [
{ type = "automation" },
{
type = "organization"
criteria = { name = "name.*" }
}
]
}
}
Guide (Help Center) options
Limit Guide content to selected brands or include draft articles when you need to manage help‑center assets.
zendesk {
fetch = {
guide = {
brands = [
"Brand A",
"Brand B",
".*" # regex supported
]
}
}
enableGuideDrafts = true # default is false
}
You can also fetch and manage Guide themes — for more info, see
Optional flags
Flag | Default | Purpose |
includeAuditDetails | false | Add changed_by metadata where available |
handleIdenticalAttachmentConflicts | false | Keep one attachment per identical‑hash group |
extractReferencesFromFreeText | false | Convert IDs in Zendesk links inside text fields to Salto references |
convertJsonIdsToReferences | false | Convert IDs in JSON fields to references |
resolveOrganizationIDs | false | Replace organization IDs with names |
resolveUserIDs | true | Replace user IDs with emails |
omitInactive.default | true | Omit inactive instances globally |
Deploy‑time fallback
Provide a fallback user so deployments succeed even if the original user is missing in the target, it can either use the email of the depoloyer, or a spesfic email every time you deploy, the below is the dynamic option.
zendesk {
deploy = {
defaultMissingUserFallback = "##DEPLOYER##"
}
}