Skip to main content

Managing Integrations

This guide walks through the Resources → Integrations page. For what integrations are, see Integrations.

Create an integration​

  1. Go to Resources → Integrations.

  2. Click + at the top of the Integration Library.

  3. Optionally click the image placeholder (Upload Integration Icon) to add an icon.

  4. Fill in the fields:

    FieldRequiredNotes
    Integration NameYesFor example GitHub (acme-org). Functions and models refer to the integration by this name.
    Tree PathYesWhere it appears in the library tree, for example /connectors/github. Not a URL.
    Allowed URLsNoComma-separated, for example https://api.github.com, https://uploads.github.com. Required before the integration can declare operations.
    TagsNoComma-separated labels.
  5. Under Secrets, click Add Secret and enter a Key and Value for each credential.

  6. Under Environment Variables, click Add Environment Variable for any non-secret settings.

  7. Click Create.

caution

Secret values are masked after saving and can't be displayed again. Keep the originals somewhere secure.

Naming secrets​

Use the name the consumer expects:

ConsumerSecret names
Model config (standard providers, Azure with API key)api_key. Optionally base_url, organization.
Model config, Azure with Client Secret (Entra ID)azure_tenant_id, azure_client_id, azure_client_secret
Model config, Amazon Bedrockaws_bearer_token (API key mode); aws_access_key_id and aws_secret_access_key, optionally aws_session_token (IAM access keys); aws_role_arn and aws_external_id (assume role)
Model config, Google Vertex AIgcp_service_account_json
MCP stdio serverThe environment variable name the server reads, for example GITHUB_PERSONAL_ACCESS_TOKEN
MCP HTTP serverAny name; reference it in a header as {{NAME}}
Brokered operationsapi_key by default. A function can name another with secret=, and an integration's auth scheme can name the secrets it combines.

Edit an integration​

  1. Select the integration in the library.
  2. Open the Details tab and change fields, secrets or environment variables.
    • To replace a secret, type a new value over the mask.
    • To rename a secret, change its key.
    • To remove a secret, delete its row. It's deleted when you save.
  3. Click Update. Cancel discards your edits.

Drag an integration onto a folder in the tree to change its Tree Path.

  1. Open the function under Resources → Functions.
  2. On the Definition tab, under Authority, click Link Integration, select one or more integrations and click Link.
  3. Under Allowed Operations, add the operations the function may call.
  4. Click Update.

See Functions for how each function type uses linked integrations.

  1. Open the model under Resources → Models.
  2. Under API Key Integration, click Link Integration (or Change Integration), choose the integration and click Link.
  3. Click Update.

The model's credential is then read from that integration's secrets at runtime. See Bringing Your Own Model.

Copy an integration​

  1. Select the integration and click Copy.
  2. Enter a New Integration Name and click Copy.

The copy keeps the tree path, allowed URLs, authentication settings, tags, icon and environment variables. Secret values are never copied: re-enter them on the new integration.

Delete an integration​

Select it, click Delete and confirm. Functions and models that depended on it will fail to authenticate until you link another integration.

Check what uses an integration​

Open the Topology tab to see what is connected to it, and Overview for its reach and access grants.

Common setups​

GitHub REST API (brokered)​

FieldValue
Allowed URLshttps://api.github.com
Secret api_keyA fine-grained personal access token or app token

Then declare the operations you need (see Declaring Integration Operations) and use Wrap an integration operation to create functions.

Jira Cloud (brokered, basic auth)​

FieldValue
Allowed URLshttps://your-domain.atlassian.net
Secret JIRA_EMAILThe account email
Secret JIRA_API_TOKENAn Atlassian API token

Set the integration's auth to {"scheme": "basic", "secrets": ["JIRA_EMAIL", "JIRA_API_TOKEN"]} through the API so brokered calls send Basic credentials.

A model provider key​

FieldValue
Secret api_keyYour provider API key