FruxonDocs
IntegrationsCore

Initiates an OAuth flow for application-level (agent-level) integration auth

Used when the agent builder wants to connect an OAuth account during agent setup, so that all users of the agent share the same credentials. After the user authorizes, the OAuth callback stores credentials temporarily. Use `:consumeOAuthCredentials` to finalize and create the auth record.

POST
/v1/tenants/{tenant}/integrations/{integration}:authorize

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

integration*string

The integration ID.

tenant*string

The tenant identifier

Request Body

The auth method to authorize.

integrationAuthMetadataId*string

The auth method to authorize (e.g. "oauth2").

Length1 <= length
configParameters?|null

Optional integration config parameters for URL placeholder resolution (e.g. instance URL for Salesforce OAuth).

scopes?|null

Scopes the admin selected from the auth method's AvailableScopes catalog. When unset or empty, the server uses OAuth2Settings.DefaultScopes instead.

returnUrl?string|null

Relative path (e.g. /tools/123?tab=configs) of the page that initiated the OAuth flow. Forwarded to the success page so it can render a fallback "Return to integration config" link when the popup-and-postMessage flow is unavailable (popup blocker, COOP, in-app browser). Must start with / — absolute URLs are rejected to prevent open redirects to attacker-controlled hosts.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/integrations/string:authorize" \  -H "Content-Type: application/json" \  -d '{    "integrationAuthMetadataId": "string"  }'
{
  "authorizationUrl": "string"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty

Lists asset source types this integration can back.

Catalog metadata, not per-tenant data. Examples: the Jira integration backs the `jira` asset source ("ingest Jira issues matching a JQL query"); Zendesk backs both `zendesk_articles` and `zendesk_tickets`. Integrations with no ingestion path return an empty list. Drives the integration detail page's Assets tab and the "create asset for this integration" affordance.

Lists channel types this integration provides.

Catalog metadata, not per-tenant data. Slack provides `channel`/`im`/`group`; Telegram provides `chat`; integrations that don't deliver messages return an empty list. Drives the participant address picker's input hints and the future integration tab's Channels section.