Skip to content
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

update: add salesforce #158

Merged
merged 2 commits into from
Feb 20, 2024
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
49 changes: 49 additions & 0 deletions docs/tools/salesforce.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Salesforce

The Salesforce tool for Superface allows you to quickly add the following capabilities:

- List all the opportunities.
- List all opportunities owned by you.
- Retrieve opportunity detail
- List all leads
- List accounts

## Requirements

You will need a [Salesforce](https://www.salesforce.com/) account to authenticate with Superface.

## Authentication

You must provide the domain name for your Salesforce instance as well as connecting your personal Salesforce account.

![The Salesforce authentication in Superface](/img/tools/tools-salesforce-auth.png)

### Identifying your domain

When logged into Salesforce, take a look at the address bar of your browser. The URL should look something like `https://superface-dev-ed.develop.lightning.force.com`. The domain you need for Superface is everything that comes after `https://` and before `.lightning.force.com`.

In the example above, the domain would be `superface-dev-ed.develop`.

### Salesforce authentication

Next, you need to connect your Salesforce account by clicking _Sign in with Salesforce_. If you are already signed in you will be redirected to the authentication flow below. If not, you may be asked to log in first.

![The Salesforce authentication flow](/img/tools/tools-salesforce-authallow.png)

Check that you are happy with the level of permissions and click on _Allow_.

If the connection is successful you will be redirected back to the Superface tool hub.

:::note Import your schema

Remember to re-import the schema in your GPT to update it with the new capabilities added by this tool.

:::

## Example prompts

To test that everything is working as it should be, from your GPT or the Superface Agent you can try asking:

- List all the open opportunities
- Get more details about the `<company name>` opportunity
- Show me my leads
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ module.exports = {
'tools/pipedrive',
'tools/posthog',
'tools/resend',
'tools/salesforce',
'tools/slack',
'tools/weather-api',
'tools/world-time-api',
Expand Down
Binary file added static/img/tools/tools-salesforce-auth.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/tools/tools-salesforce-authallow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading