Repository navigation
docs: add provider integration setup guides #3663
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| title: "Set up GitHub" | ||
| description: "Connect a GitHub account to Veryfront for repository, issue, and pull-request tools." | ||
| order: 51 | ||
| --- | ||
|
|
||
| Use GitHub OAuth when an agent needs repository, issue, or pull-request tools. | ||
|
|
||
| ## Connect a GitHub user | ||
|
|
||
| 1. In Veryfront, open the project that needs GitHub tools. | ||
| 2. Start the GitHub connection from the integration prompt or project integration settings. | ||
| 3. Sign in to GitHub and approve the requested access. | ||
| 4. Run a read-only GitHub tool, such as listing repositories, to verify the connection. | ||
|
|
||
| Managed GitHub OAuth works without project credentials. Set project credentials | ||
| only when the project must use its own GitHub OAuth app for custom consent | ||
| branding, verification, or scope requirements. | ||
|
|
||
| ## Use your own GitHub OAuth app | ||
|
|
||
| 1. In [GitHub Developer Settings](https://github.com/settings/developers), create an OAuth App. | ||
| 2. Add the Veryfront callback URL for the target environment. | ||
| 3. Set the OAuth app client ID and client secret as project environment variables: | ||
|
|
||
| | Variable | Value | | ||
| | ---------------------- | ------------------------------ | | ||
| | `GITHUB_CLIENT_ID` | GitHub OAuth App client ID | | ||
| | `GITHUB_CLIENT_SECRET` | GitHub OAuth App client secret | | ||
|
|
||
| Keep the secret in your approved secret manager. Never place it in agent | ||
| prompts, project files, tickets, or client-side environment variables. | ||
|
|
||
| ## Verify it worked | ||
|
|
||
| 1. Start a new agent run that uses a read-only GitHub tool. | ||
| 2. Confirm the tool returns the connected user's GitHub data. | ||
|
|
||
| ## Next | ||
|
|
||
| - [Integrations](../integrations.md): Declare GitHub tools and apply source or project policy. | ||
| - [Set up Jira](./jira.md): Connect a Jira provider. | ||
| - [Set up Salesforce](./salesforce.md): Connect a Salesforce provider. | ||
|
|
||
| ## Related | ||
|
|
||
| - [veryfront/integrations](../../api-reference/veryfront/integrations.md): Connector catalog and helper API. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| title: "Set up Jira" | ||
| description: "Connect an Atlassian account to Veryfront for Jira project and issue tools." | ||
| order: 52 | ||
| --- | ||
|
|
||
| Use Jira OAuth when an agent needs to read or update Jira projects and issues. | ||
|
|
||
| ## Connect a Jira user | ||
|
|
||
| 1. In Veryfront, open the project that needs Jira tools. | ||
| 2. Start the Jira connection from the integration prompt or project integration settings. | ||
| 3. Sign in to Atlassian and approve the requested access. | ||
| 4. Run a read-only Jira tool, such as listing accessible sites or projects, to verify the connection. | ||
|
|
||
| Managed Atlassian OAuth works without project credentials. Set project | ||
| credentials only when the project must use its own Atlassian OAuth app. | ||
|
|
||
| ## Use your own Atlassian OAuth app | ||
|
|
||
| 1. In the [Atlassian developer console](https://developer.atlassian.com/console/myapps/), create an OAuth 2.0 app. | ||
| 2. Add the Veryfront callback URL for the target environment. | ||
| 3. Grant the Jira scopes required by the project: `read:jira-work`, `write:jira-work`, `read:jira-user`, and `offline_access`. | ||
|
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||
| 4. Set the OAuth app client ID and client secret as project environment variables: | ||
|
|
||
| | Variable | Value | | ||
| | ------------------------- | ----------------------------- | | ||
| | `ATLASSIAN_CLIENT_ID` | Atlassian OAuth client ID | | ||
| | `ATLASSIAN_CLIENT_SECRET` | Atlassian OAuth client secret | | ||
|
|
||
| Set `JIRA_CLOUD_ID` when the connected user has access to more than one | ||
| Atlassian site. Obtain the site ID from the list-sites tool result. | ||
|
|
||
| Keep the secret in your approved secret manager. Never place it in agent | ||
| prompts, project files, tickets, or client-side environment variables. | ||
|
|
||
| ## Verify it worked | ||
|
|
||
| 1. Start a new agent run that uses a read-only Jira tool. | ||
| 2. Confirm the tool returns the expected Atlassian site or Jira project data. | ||
|
|
||
| ## Next | ||
|
|
||
| - [Integrations](../integrations.md): Declare Jira tools and apply source or project policy. | ||
| - [Set up GitHub](./github.md): Connect a GitHub provider. | ||
| - [Set up Salesforce](./salesforce.md): Connect a Salesforce provider. | ||
|
|
||
| ## Related | ||
|
|
||
| - [veryfront/integrations](../../api-reference/veryfront/integrations.md): Connector catalog and helper API. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| --- | ||
| title: "Set up Salesforce" | ||
| description: "Install and connect the Veryfront Salesforce integration with per-user OAuth or a service account." | ||
| order: 50 | ||
| --- | ||
|
|
||
| Use this guide to connect a Salesforce org to Veryfront. Choose per-user OAuth | ||
| when each action must use an individual's Salesforce access. Choose a service | ||
| account for scheduled or project-owned automation. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A Salesforce administrator for the target org. | ||
| - A Veryfront project with Salesforce tools declared in an agent. | ||
| - Salesforce enabled for the target Veryfront environment. Salesforce is currently feature-gated. Set `VERYFRONT_EXPERIMENTAL_INTEGRATIONS=salesforce` where the integration catalog is configured. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
When a reader follows this prerequisite, Salesforce remains hidden because AGENTS.md reference: AGENTS.md:L13-L13 Useful? React with 👍 / 👎. |
||
|
|
||
| ## Connect a Salesforce user | ||
|
|
||
| Install the **Veryfront Salesforce Integration** package in each Salesforce | ||
| org that users connect to Veryfront. Salesforce External Client Apps are scoped | ||
| to an org. Without the installed package, Salesforce rejects a cross-org | ||
| authorization request. | ||
|
|
||
| 1. Sign in to the Salesforce org as an administrator. | ||
| 2. Open the [Veryfront Salesforce Integration beta installation page](https://login.salesforce.com/packaging/installPackage.apexp?p0=04tfj000000RX37AAG). | ||
| 3. Select **Install for Admins Only** and acknowledge that the application is not distributed through AppExchange. | ||
| 4. Wait for the installation to complete. | ||
| 5. In Salesforce Setup, open **External Client App Manager** and select **Veryfront**. | ||
| 6. Confirm that the app is **Packaged (Installed)** and **Enabled**. | ||
| 7. Under **Policies**, select the permitted-users policy. The beta package permits all users to self-authorize. Restrict access to the required profile or permission set when the org uses a tighter access policy. | ||
|
|
||
| Install the beta package in a sandbox or test org before installing it in a | ||
| production Salesforce org. | ||
|
|
||
| In Veryfront, open the project and start the Salesforce connection from the | ||
| integration prompt or project integration settings. Sign in to the Salesforce | ||
| org where the package is installed, approve consent, then run a read-only | ||
| Salesforce tool to verify access. | ||
|
|
||
| Never paste a Salesforce consumer secret into an agent prompt, project file, | ||
| ticket, or client-side environment variable. | ||
|
|
||
| ## Use a service account | ||
|
|
||
| Use a service account when a run needs non-interactive access. Veryfront uses | ||
| Salesforce OAuth client credentials and executes as the Connected App's | ||
| dedicated **Run As** integration user. It does not open browser consent or use | ||
| a user's personal OAuth token. | ||
|
|
||
| In the target Salesforce org: | ||
|
|
||
| 1. Create a dedicated integration user with the minimum object, field, and API permissions required by the project. | ||
| 2. Create or configure a Salesforce Connected App for the client-credentials flow. | ||
| 3. Set the integration user as the Connected App's **Run As** user. | ||
| 4. Record the Connected App consumer key and consumer secret in your approved secret manager. | ||
|
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||
|
|
||
| Set all three values as project environment variables in the matching | ||
| Veryfront environment: | ||
|
|
||
| | Variable | Value | | ||
| | ------------------------------------------ | ------------------------------ | | ||
| | `SALESFORCE_SERVICE_ACCOUNT_CLIENT_ID` | Connected App consumer key | | ||
| | `SALESFORCE_SERVICE_ACCOUNT_CLIENT_SECRET` | Connected App consumer secret | | ||
| | `SALESFORCE_SERVICE_ACCOUNT_LOGIN_URL` | `https://login.salesforce.com` | | ||
|
|
||
| For a Salesforce sandbox, set `SALESFORCE_SERVICE_ACCOUNT_LOGIN_URL` to | ||
| `https://test.salesforce.com`. Use the Salesforce login endpoint, not the | ||
| instance URL returned after authentication. | ||
|
|
||
| All three variables are required. If any service-account variable is missing, | ||
| Veryfront fails closed and does not fall back to a human OAuth connection for | ||
| non-interactive runs. Rotate the consumer secret in Salesforce and update the | ||
| project environment variable through the approved secret-management workflow. | ||
|
|
||
| ## Verify it worked | ||
|
|
||
| 1. Start a new agent run that uses a read-only Salesforce tool, such as account or case lookup. | ||
| 2. Confirm the tool returns data from the target Salesforce org. | ||
| 3. For a service account, confirm the Salesforce audit trail attributes the request to the configured integration user. | ||
|
|
||
| ## Next | ||
|
|
||
| - [Integrations](../integrations.md): Declare Salesforce tools and apply source or project policy. | ||
| - [Set up GitHub](./github.md): Connect a GitHub provider. | ||
| - [Set up Jira](./jira.md): Connect a Jira provider. | ||
|
|
||
| ## Related | ||
|
|
||
| - [veryfront/integrations](../../api-reference/veryfront/integrations.md): Connector catalog and helper API. | ||
| - [Salesforce integration](../../concepts/salesforce-integration.md): Why Veryfront uses a governed Salesforce integration layer. | ||
Uh oh!
There was an error while loading. Please reload this page.