Link
GitHub Get Started

Configuration Fields Reference

Integration configuration fields, grouped by integration. Credential fields (password, api_token, access_token, auth_token, publisher_key) are stored encrypted and are masked when an integration is displayed.

Perforce

FieldTypeRequiredDescription
server_urlstringYesServer address (e.g., ssl:server:1666)
portstringNoServer port if separate
workspacestringNoP4 workspace name
project_pathstringNoDepot path to monitor
hidden_depot_pathsarrayNoPaths to exclude from browser (defaults to spec, unload)
selected_depotsarrayNoSpecific depots to sync
swarm_base_urlstringNoHelix Swarm server URL, for deep links
rest_api_enabledbooleanNoEnable the Helix REST API for file previews
rest_api_urlstringNoHelix REST API base URL, when enabled
max_preview_size_mbintegerNoCap on file size fetched for asset preview
usernamestringYesPerforce username
passwordstringYesPerforce password/ticket

Jenkins (and other CI systems on the shared intake)

FieldTypeRequiredDescription
server_urlstringYesJenkins server URL
job_namestringNoDefault job name. Without it a tagged commit produces no build - see Build Configuration
selected_jobsarrayNoJobs available for triggering
build_parametersobjectNoDefault build parameters
webhook_secretstringNoHMAC secret for the X-Jenkins-Signature build-notification callback
allow_insecure_tlsbooleanNoSkip TLS certificate verification on outbound Jenkins requests. Defaults off; only for self-signed internal Jenkins
ci_providerstringNoDisplay label when this integration actually fronts GitHub Actions, TeamCity, etc. rather than Jenkins
usernamestringYesJenkins username
api_tokenstringYesJenkins API token

Buildkite

FieldTypeRequiredDescription
buildkite_organizationstringNoOrganization slug as it appears in a Buildkite URL
buildkite_pipelinestringNoPipeline slug
webhook_secretstringNoBuildkite webhook signing secret. Inbound deliveries are rejected until it is set
api_tokenstringYesBuildkite API access token (scopes read_builds, read_pipelines)

Lore

FieldTypeRequiredDescription
remote_urlstringYesLore server address, lore://host:41337/your-repo
lore_repositorystringNoRepository name (defaults to the path in remote_url)
lore_branchstringNoBranch to monitor
auth_tokenstringNoBearer token, only if your Lore server sets [server.auth]

GitHub

FieldTypeRequiredDescription
github_ownerstringNoOwner or organization
github_repostringNoRepository name
github_default_branchstringNoDefault branch
github_actions_enabledbooleanNoTrack GitHub Actions workflow runs
github_monitor_ci_eventsbooleanNoIngest CI events from this repository
webhook_secretstringNoSecret for X-Hub-Signature-256 verification
access_tokenstringYesGitHub personal access token

Steam

FieldTypeRequiredDescription
steam_app_idstringYesSteam App ID
steam_depot_idstringNoDepot ID
steam_branchstringNoBranch to monitor (default: public)
steam_poll_intervalintegerNoPoll interval in seconds
publisher_keystringNoSteamworks Publisher Key. Optional - without it the integration still tracks builds and deployments; it only enables player-count tracking.

Jira

FieldTypeRequiredDescription
server_urlstringYesJira Cloud URL
project_keystringNoDefault project key
emailstringYesJira account email
api_tokenstringYesJira API token

Discord

FieldTypeRequiredDescription
webhook_urlstringYesDefault webhook URL
builds_channel_webhook_urlstringNoBuild notifications
assets_channel_webhook_urlstringNoAsset notifications
alerts_channel_webhook_urlstringNoAlerts and errors
approvals_channel_webhook_urlstringNoApproval requests

Slack

FieldTypeRequiredDescription
webhook_urlstringYesSlack webhook URL
channelstringNoDefault channel

Linear

FieldTypeRequiredDescription
api_keystringYesLinear API key
workspace_idstringNoWorkspace ID
team_idstringNoTeam to sync

Diversion

FieldTypeRequiredDescription
api_tokenstringYesDiversion API token
repository_urlstringNoRepository URL
workspace_namestringNoWorkspace name
branchstringNoBranch to monitor
watch_pathsarrayNoPaths to watch
file_typesarrayNoFile types to track

Unreal Engine

FieldTypeRequiredDescription
engine_versionstringNoUnreal Engine version
target_platformstringNoPrimary build platform

Copyright © 2026 ButterStack. All rights reserved.

Esc
Type to search the documentation