diff --git a/docs/nodes/credentials/Phantombuster/README.md b/docs/nodes/credentials/Phantombuster/README.md new file mode 100644 index 000000000..1900eab9d --- /dev/null +++ b/docs/nodes/credentials/Phantombuster/README.md @@ -0,0 +1,23 @@ +--- +permalink: /credentials/phantombuster +description: Learn to configure credentials for the Phantombuster node in n8n +--- + +# Phantombuster + +You can use these credentials to authenticate the following nodes with Phantombuster. +- [Phantombuster](../../nodes-library/nodes/Phantombuster/README.md) + +## Prerequisites + +Create a [Phantombuster](https://www.phantombuster.com/) account. + +## Using API + +1. Access your [Phantombuster](https://phantombuster.com/) dashboard. +2. Click on your name on the top right and select 'Org settings'. +3. Scroll down to the ***Third party API keys*** section. +4. Click on the ***+ Add third party API key*** button. +5. Use this ***API Key*** with your Phantombuster node credentials in n8n. + +![Getting Phantombuster credentials](./using-api.gif) diff --git a/docs/nodes/credentials/Phantombuster/using-api.gif b/docs/nodes/credentials/Phantombuster/using-api.gif new file mode 100644 index 000000000..e0fd64fdb Binary files /dev/null and b/docs/nodes/credentials/Phantombuster/using-api.gif differ diff --git a/docs/nodes/nodes-library/nodes/Phantombuster/Airtable_node.png b/docs/nodes/nodes-library/nodes/Phantombuster/Airtable_node.png new file mode 100644 index 000000000..1cb2ce9b2 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Phantombuster/Airtable_node.png differ diff --git a/docs/nodes/nodes-library/nodes/Phantombuster/Phantombuster_node.png b/docs/nodes/nodes-library/nodes/Phantombuster/Phantombuster_node.png new file mode 100644 index 000000000..ab9701f9e Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Phantombuster/Phantombuster_node.png differ diff --git a/docs/nodes/nodes-library/nodes/Phantombuster/README.md b/docs/nodes/nodes-library/nodes/Phantombuster/README.md new file mode 100644 index 000000000..99146f3b7 --- /dev/null +++ b/docs/nodes/nodes-library/nodes/Phantombuster/README.md @@ -0,0 +1,89 @@ +--- +permalink: /nodes/n8n-nodes-base.phantombuster +description: Learn how to use the Phantombuster node in n8n +--- + +# Phantombuster + +[Phantombuster](https://www.phantombuster.com/) is a scraping platform that allows chain actions and data extraction on the web to generate business leads, marketing audiences, and overall growth. + +::: tip 🔑 Credentials +You can find authentication information for this node [here](../../../credentials/Phantombuster/README.md). +::: + +## Basic Operations + +::: details Agent +- Delete an agent by id +- Get an agent by id +- Get all agents of the current user's organization +- Get the output of the most recent container of an agent +- Add an agent to the launch queue +::: + +## Example Usage + +This workflow allows you to store the output of a phantom in Airtable. You can also find the [workflow](https://n8n.io/workflows/882) on n8n.io. This example usage workflow uses the following nodes. +- [Start](../../core-nodes/Start/README.md) +- [Phantombuster]() +- [Set](../../core-nodes/Set/README.md) +- [Airtable](../../nodes/Airtable/README.md) + +The final workflow should look like the following image. + +![A workflow with the Phantombuster node](./workflow.png) + +### 1. Start node + +The start node exists by default when you create a new workflow. + +### 2. Phantombuster node (getOutput: agent) + +Create and launch the [LinkedIn Profile Scraper](https://phantombuster.com/automations/linkedin/3112/linkedin-profile-scraper) in your Phantombuster account. This node will return the output of this phantom. + +1. First of all, you'll have to enter credentials for the Phantombuster node. You can find out how to do that [here](../../../credentials/Phantombuster/README.md). +2. Select 'Get Output' from the ***Operation*** dropdown list. +3. Select a phantom from the ***Agent*** dropdown list. +4. Click on ***Execute Node*** to run the node. + +In the screenshot below, you will notice that the node returns the output from the LinkedIn Profile Scraper phantom. + +![Using the Phantombuster node to get the output of a phantom](./Phantombuster_node.png) + +### 3. Set node + +We will use the Set node to ensure that only the data that we set in this node gets passed on to the next nodes in the workflow. + +::: v-pre +1. Click on ***Add Value*** and select 'String' from the dropdown list. +2. Enter `Name` in the ***Name*** field. +3. Click on the gears icon next to the ***Value*** field and click on ***Add Expression***. +4. Select the following in the ***Variable Selector*** section: Nodes > Phantombuster > Output Data > JSON > general > fullName. You can also add the following expression: `{{$node["Phantombuster"].json["general"]["fullName"]}}`. +5. Click on ***Add Value*** and select 'String' from the dropdown list. +6. Enter `Email` in the ***Name*** field. +7. Click on the gears icon next to the ***Value*** field and click on ***Add Expression***. +8. Select the following in the ***Variable Selector*** section: Nodes > Phantombuster > Output Data > JSON > details > mail. You can also add the following expression: `{{$node["Phantombuster"].json["details"]["mail"]}}`. +9. Click on ***Add Value*** and select 'String' from the dropdown list. +10. Enter `Company` in the ***Name*** field. +11. Click on the gears icon next to the ***Value*** field and click on ***Add Expression***. +12. Select the following in the ***Variable Selector*** section: Nodes > Phantombuster > Output Data > JSON > jobs> [Item: 0] > companyName. You can also add the following expression: `{{$node["Phantombuster"].json["jobs"][0]["companyName"]}}`. +13. Toggle ***Keep Only Set*** to `true`. We set this option to true to ensure that only the data that we have set in this node get passed on to the next nodes in the workflow. +14. Click on ***Execute Node*** to run the node. +::: +In the screenshot below, you will notice that the node uses the data from the previous node and returns the data that we set for the workflow. + +![Using the Set node to set the data](./Set_node.png) + +## 4. Airtable node (Append) + +This node will append the data that we set in the previous node to a table. Create a table like [this](https://airtable.com/shr6hP774ijrXFput) in your Airtable base. + +1. First of all, you'll have to enter credentials for the Airtable node. You can find out how to do that [here](../../../credentials/Airtable/README.md). +2. Select 'Append' from the ***Operation*** dropdown list. +3. Enter the Base ID in the ***Base ID*** field. For obtaining the Base ID, head over to their [API page](https://airtable.com/api) and select the correct base. You’ll find the Base ID there. +4. Enter the name of your table in the ***Table*** field. +5. Click on ***Execute Node*** to run the node. + +In the screenshot below, you will notice that the node appends the data that we had set in the previous node. + +![Using the Airtable node to insert data into an Airtable table](./Airtable_node.png) diff --git a/docs/nodes/nodes-library/nodes/Phantombuster/Set_node.png b/docs/nodes/nodes-library/nodes/Phantombuster/Set_node.png new file mode 100644 index 000000000..c9696e6cd Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Phantombuster/Set_node.png differ diff --git a/docs/nodes/nodes-library/nodes/Phantombuster/workflow.png b/docs/nodes/nodes-library/nodes/Phantombuster/workflow.png new file mode 100644 index 000000000..823000a59 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Phantombuster/workflow.png differ