Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions api/api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -407,6 +407,8 @@ paths:
example:
- read
- write
metadata:
$ref: "#/components/schemas/ProviderAppMetadata"
required: true
responses:
200:
Expand Down Expand Up @@ -508,6 +510,7 @@ paths:
- clientSecret
- provider
- scopes
- metadata
example: ["externalRef", "clientId"]
providerApp:
type: object
Expand Down Expand Up @@ -538,6 +541,8 @@ paths:
example:
- read
- write
metadata:
$ref: "#/components/schemas/ProviderAppMetadata"
description:
The provider app fields to update. (Only include the
fields you'd like to update.)
Expand Down Expand Up @@ -4534,6 +4539,8 @@ components:
- oauth
- offline
- crm.read
metadata:
$ref: "#/components/schemas/ProviderAppMetadata"
createTime:
type: string
description: The time the provider app was created.
Expand All @@ -4542,6 +4549,30 @@ components:
type: string
description: The time the provider app was updated.
format: date-time
ProviderAppMetadata:
title: Provider App Metadata
type: object
description: Provider-specific configuration that extends the standard OAuth flow.
properties:
authQueryParams:
type: object
description: Additional query parameters to include in the OAuth authorization URL (e.g., optional_scope for HubSpot).
additionalProperties:
type: array
items:
type: string
example:
optional_scope:
- automation.sequences.read
providerParams:
type: object
description: Provider-specific string values keyed by names (e.g., packageInstallURL for Salesforce, gcpProjectId and gcpPubSubTopicName for Gmail).
additionalProperties:
type: string
example:
packageInstallURL: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t123456789
gcpProjectId: my-gcp-project
gcpPubSubTopicName: my-topic
Integration:
title: Integration
required:
Expand Down
Loading
Loading