Skip to content

Commit

Permalink
Merge pull request #157 from superfaceai/update/new-tools
Browse files Browse the repository at this point in the history
update: new tools
  • Loading branch information
martyndavies authored Feb 9, 2024
2 parents 4cba4b6 + 8006415 commit b62111d
Show file tree
Hide file tree
Showing 7 changed files with 96 additions and 2 deletions.
39 changes: 39 additions & 0 deletions docs/tools/affinity.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Affinity

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

- Fetches all opportunities from Affinity meeting search criteria from the team's data.
- Finds and retrieves organizations from Affinity's database.
- Fetches all persons from Affinity meeting the search criteria.
- Retrieve all fields and their values from Affinity for a specific organization, person or list entry.
- Retrieve a specific list from Affinity by its name and obtain field values for its list entries.
- Fetches a specific person from Affinity based on person ID.

## Requirements

You will need:

- An [Affinity](https://www.affinity.co/) CRM account

## Authentication

This tool uses Basic Authentication.

![The authentication for Affinity in Superface](/img/tools/tools-affinity-auth.png)

Enter your personal username and password. This will authenticate the tool as you so it can take the same actions as you would within the CRM.

Click on _Save Changes_ and the Affinity tool is ready to use.

:::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:

- Show me the details for the organization `<organization name>`
- List all open opportunities from the past 7 days
33 changes: 33 additions & 0 deletions docs/tools/greenhouse.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Greenhouse

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

- Retrieve all jobs using the board ID, returning a list of jobs.
- Retrieve specific job detail using the job ID.

## Requirements

You will need a [Greenhouse](https://www.greenhouse.com/) board or job ID. This can be found in the URL of a job board.

For example:

- The board ID in `https://boards.greenhouse.io/prefect/` is `prefect`
- The job ID in `https://boards.greenhouse.io/techstars57/jobs/7117490002` is `7117490002`

## Authentication

This tool uses data for publicly available job boards powered by Greenhouse and does not require any authentication.

:::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:

- Show me all the jobs for board `<board id>`.
- List all the jobs from board `<board id>` that are older than 60 days.
- Show me the details for `<job id>` on from `<board id`.
16 changes: 16 additions & 0 deletions docs/tools/notion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

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

- Create a new page in a specified database or as a child of an existing page.
- Retrieve a specific database's details.
- Retrieve a specific property of a page in Notion using the 'page_id' and 'property_id'. Returns the property detail.
- Retrieve a specific page's details.
- Retrieve user data.
- List users in a Notion workspace
- Search for pages and databases with a specific title.

## Requirements

Expand All @@ -19,6 +25,16 @@ Now your integration is setup, you can copy the _Internal Integration Token_ fro

![Notion's My Integrations section](/img/tools/tools-notion-secret.png)

## Connections

In Notion, your pages and databases need to be connected to your integration in order to make them available to it.

In each top level section you want to use with Superface, click on the page settings menu bar in the top right of the page and find your integration in the _Connections_ section.

![The Connection section of the main Notion settings](/img/tools/tools-notion-connection.png)

There you can either add a connection to an integration or modify the settings for one that is already connected.

## Authentication

In Superface, click on the Config button for the Notion tool and set the following values:
Expand Down
2 changes: 2 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -125,12 +125,14 @@ module.exports = {
link: {type: 'doc', id: 'tools/available-tools'},
collapsed: true,
items: [
'tools/affinity',
'tools/github',
'tools/google-calendar',
'tools/google-drive',
'tools/google-mail',
'tools/google-search',
'tools/google-sheets',
'tools/greenhouse',
'tools/hubspot',
'tools/ibm-nlu',
'tools/infobip',
Expand Down
8 changes: 6 additions & 2 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -274,9 +274,9 @@ aside.docSidebarContainer_node_modules-\@docusaurus-theme-classic-lib-next-theme
color: #000;
}

.row .col a {
/* .row .col a {
text-decoration: none;
}
} */

.row .col p a {
text-decoration: underline;
Expand All @@ -286,3 +286,7 @@ aside.docSidebarContainer_node_modules-\@docusaurus-theme-classic-lib-next-theme
text-decoration: underline;
}

article ul li a {
text-decoration: underline;
}

Binary file added static/img/tools/tools-affinity-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-notion-connection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b62111d

Please sign in to comment.