OAuth
objectDefines the OAuth 2.0 authorization strategy used by an integration.
This schema provides all necessary information for the platform to initiate
and manage OAuth-based authorization flows on behalf of customers.
Allowed values:oauth
A list of field names from the config object (e.g., client_id, authorization_endpoint, etc)
that can be overridden on a per-customer basis. When a field is listed here, the catalog allows
customer-defined values to take precedence over the default configuration provided by the integration.
This supports flexible deployment models, including both SaaS-based and self-hosted OAuth authorization flows.
Allowed values:client_idclient_secretauthorization_endpointtoken_endpoint
Show Child Parameters
MultiKeyAuth
objectDefines an authentication strategy based on one or more API keys passed via HTTP headers.
This strategy supports integrations that require custom headers for credential-based access,
allowing flexibility across providers with different authentication header requirements.
Allowed values:multi_key_auth
Show Child Parameters
GitHubAppInstallationAuth
objectDefines the GitHub App authorization strategy used by the GitHub integration.
This strategy enables secure access to GitHub APIs using app installation tokens.
It supports both API-based interactions and real-time event delivery via GitHub webhooks.
Unlike standard OAuth flows, this strategy leverages GitHub’s custom app installation flow
and token lifecycle, making it ideal for deep, organization-level GitHub integration.
Allowed values:github_app_installation
Show Child Parameters
CatalogIntegrationConfigSchema
Defines the configuration schema for the integration.
StringConfigFieldSchema
objectDefines a string value integration config field.
user-friendly name of the configuration field.
Optional brief description of the configuration field.
Denotes whether the config field is a required value.
Default:false
Defines the condition under which this configuration field is allowed to be modified.
When specified, the platform will restrict updates to this field unless the integration
meets the given condition.
For example, setting mutable_condition: unauthorized means the field can only be
changed while the integration is in an unauthorized state.
Allowed values:unauthorized
The field type of the config value.
Allowed values:string
The default value for the config field.