diff --git a/docs/nodes/credentials/EGoi/README.md b/docs/nodes/credentials/EGoi/README.md new file mode 100644 index 000000000..8966d7ca4 --- /dev/null +++ b/docs/nodes/credentials/EGoi/README.md @@ -0,0 +1,21 @@ +--- +permalink: /credentials/egoi +description: Learn to configure credentials for the e-goi node in n8n +--- + +# E-goi + +You can use these credentials to authenticate the following nodes with E-goi. +- [E-goi](../../nodes-library/nodes/Egoi/README.md) + +## Prerequisites + +Create an [E-goi](https://www.e-goi.com/) account. + +## Using API Key + +1. Access your E-goi dashboard. +2. Click on your name on the top right corner and select 'Integrations'. +3. Copy the ***API key*** that is displayed and use it with your E-goi node credentials in n8n. + +![Getting E-goi API credentials](./using-api.gif) diff --git a/docs/nodes/credentials/EGoi/using-api.gif b/docs/nodes/credentials/EGoi/using-api.gif new file mode 100644 index 000000000..31e6e253e Binary files /dev/null and b/docs/nodes/credentials/EGoi/using-api.gif differ diff --git a/docs/nodes/nodes-library/nodes/Egoi/README.md b/docs/nodes/nodes-library/nodes/Egoi/README.md new file mode 100644 index 000000000..b4f94367b --- /dev/null +++ b/docs/nodes/nodes-library/nodes/Egoi/README.md @@ -0,0 +1,87 @@ +--- +permalink: /nodes/n8n-nodes-base.egoi +description: Learn how to use the e-goi node in n8n +--- + +# E-goi + +[E-goi](https://www.e-goi.com/) is an omnichannel marketing automation platform. + +::: tip 🔑 Credentials +You can find authentication information for this node [here](../../../credentials/Egoi/README.md). +::: + +## Basic Operations + +::: details Contact +- Create a member +- Get a member +- Get all members +- Update a member +::: + +## Example Usage + +This workflow allows you to create, update, and get a contact using the e-goi node. You can also find the [workflow](https://n8n.io/workflows/852) on n8n.io. This example usage workflow uses the following nodes. +- [Start](../../core-nodes/Start/README.md) +- [e-goi]() + +The final workflow should look like the following image. + +![A workflow with the e-goi node](./workflow.png) + +### 1. Start node + +The Start node exists by default when you create a new workflow. + +### 2. e-goi node (create: contact) + +This node will create a new contact in e-goi. We will add the first name of the contact along with their email. + +1. First of all, you'll have to enter credentials for the e-goi node. You can find out how to do that [here](../../../credentials/Egoi/README.md). +2. Select a list from the ***List ID*** field. +3. Enter the email address in the ***Email*** field. +3. Click on the ***Add Field*** button and select 'First Name' from the dropdown list. +4. Enter the name of the contact in the ***First Name*** field. +5. Click on ***Execute Node*** to run the node. + +In the screenshot below, you will notice that the node creates a new contact with their first name and email. + +![Using the e-goi node to create a new contact](./e-goi_node.png) + +### 3. e-goi1 node (update: contact) + +This node will update the information of the contact that we created in the previous node. We will update the first name of the contact using this node. +::: v-pre +1. Select the credentials that you entered in the previous node. +2. Select 'Update' from the ***Operation*** dropdown list. +3. Click on the gears icon next to the ***List ID*** field and click on ***Add Expression***. +4. Select the following in the ***Variable Selector*** section: Nodes > e-goi > Parameters > list. You can also add the following expression: `{{$node["e-goi"].parameter["list"]}}`. +5. Click on the gears icon next to the ***Contact ID*** field and click on ***Add Expression***. +6. Select the following in the ***Variable Selector*** section: Nodes > e-goi > Output Data > JSON > base > contact_id. You can also add the following expression: `{{$node["e-goi"].json["base"]["contact_id"]}}`. +7. Click on the ***Add Field*** button and select 'First Name' from the dropdown list. +8. Enter the first name of the contact in the ***First Name*** field. +9. Click on ***Execute Node*** to run the node. +::: + +In the screenshot below, you will notice that the node updates the information of the contact that we created in the previous node. Here, the node has updated the first name of the contact. + +![Using the e-goi node to update the contact](./e-goi1_node.png) + +### 3. e-goi2 node (get: contact) + +This node will return the information of the contact that we created using the e-goi node. + +::: v-pre +1. Select the credentials that you entered in the previous node. +2. Select 'Get' from the ***Operation*** dropdown list. +3. Click on the gears icon next to the ***List ID*** field and click on ***Add Expression***. +4. Select the following in the ***Variable Selector*** section: Nodes > e-goi1 > Parameters > list. You can also add the following expression: `{{$node["e-goi1"].parameter["list"]}}`. +5. Click on the gears icon next to the ***Contact ID*** field and click on ***Add Expression***. +6. Select the following in the ***Variable Selector*** section: Nodes > e-goi1 > Output Data > JSON > base > contact_id. You can also add the following expression: `{{$node["e-goi"].json["base"]["contact_id"]}}`. +5. Click on ***Execute Node*** to run the node. +::: + +In the screenshot below, you will notice that the node returns the information of the contact that we created using the e-goi node. + +![Using the e-goi node to get the information of the contact](./e-goi2_node.png) diff --git a/docs/nodes/nodes-library/nodes/Egoi/e-goi1_node.png b/docs/nodes/nodes-library/nodes/Egoi/e-goi1_node.png new file mode 100644 index 000000000..376b55d1f Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Egoi/e-goi1_node.png differ diff --git a/docs/nodes/nodes-library/nodes/Egoi/e-goi2_node.png b/docs/nodes/nodes-library/nodes/Egoi/e-goi2_node.png new file mode 100644 index 000000000..8d6ef5c18 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Egoi/e-goi2_node.png differ diff --git a/docs/nodes/nodes-library/nodes/Egoi/e-goi_node.png b/docs/nodes/nodes-library/nodes/Egoi/e-goi_node.png new file mode 100644 index 000000000..ab6b8b582 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Egoi/e-goi_node.png differ diff --git a/docs/nodes/nodes-library/nodes/Egoi/workflow.png b/docs/nodes/nodes-library/nodes/Egoi/workflow.png new file mode 100644 index 000000000..c8027f157 Binary files /dev/null and b/docs/nodes/nodes-library/nodes/Egoi/workflow.png differ