diff --git a/docs/tools/affinity.mdx b/docs/tools/affinity.mdx new file mode 100644 index 00000000..6a967257 --- /dev/null +++ b/docs/tools/affinity.mdx @@ -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 `` +- List all open opportunities from the past 7 days diff --git a/docs/tools/greenhouse.mdx b/docs/tools/greenhouse.mdx new file mode 100644 index 00000000..0a0ed3db --- /dev/null +++ b/docs/tools/greenhouse.mdx @@ -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 ``. +- List all the jobs from board `` that are older than 60 days. +- Show me the details for `` on from `