mirrors/n8n-docs
2
0
Fork 0
mirror of https://github.com/n8n-io/n8n-docs.git synced 2025-11-20 17:48:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

temp delete because of filename stupidity

Browse Source
This commit is contained in:
Deborah Barnard 2022-10-12 11:55:42 +01:00
parent 6f64e52ad3
commit 371c213020
232 changed files with 0 additions and 6292 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/integrations/builtin/credentials/actionNetwork.md
View File

@ -1,23 +0,0 @@
# Action Network
You can use these credentials to authenticate the following nodes:
- [Action Network](/integrations/builtin/app-nodes/n8n-nodes-base.actionNetwork/)
## Prerequisites
- Create an [Action Network](https://actionnetwork.org/) account.
- [Contact](https://actionnetwork.org/contact) Action Network to become a partner and enable API access.
## Using API key
After becoming an Action Network partner:
1. Open your Action Network dashboard.
2. From the **Start Organizing** menu navigate to **Details** > **API & Sync**.
3. Use the dropdown to select the list you want to generate a key for, your personal list or that of any groups you are an administrator of.
4. From the **Your API Key** section, generate a new API key:
![API & Sync Page](/_images/integrations/builtin/credentials/actionnetwork/action_network_api_key.png)
5. Copy your new key and use it with your Action Network node credentials in n8n.

22
docs/integrations/builtin/credentials/activeCampaign.md
View File

@ -1,22 +0,0 @@
# ActiveCampaign
You can use these credentials to authenticate the following nodes with ActiveCampaign.
- [ActiveCampaign](/integrations/builtin/app-nodes/n8n-nodes-base.activeCampaign/)
- [Active Campaign Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.activeCampaignTrigger/)
## Prerequisites
Create an [ActiveCampaign](https://www.activecampaign.com/) account.
## Using Access Token
1. Open your ActiveCampaign dashboard.
2. Click on the gears icon on the bottom left to open the Settings.
3. Click on the Developer option under the Settings panel.
4. In the Developer Settings, copy the 'Key' and 'URL' under the ‘API Access' panel.
5. Use these credentials with your ActiveCampaign node credentials in n8n.
![Getting ActiveCampaign credentials](/_images/integrations/builtin/credentials/activecampaign/using-access-token.gif)

39
docs/integrations/builtin/credentials/acuityScheduling.md
View File

@ -1,39 +0,0 @@
# Acuity Scheduling
You can use these credentials to authenticate the following nodes with Acuity Scheduling.
- [Acuity Scheduling Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.acuitySchedulingTrigger/)
## Prerequisites
Create an [Acuity Scheduling](https://acuityscheduling.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Acuity Scheduling account to n8n.
1. Visit the [Acuity OAuth2 Account Registration page](https://acuityscheduling.com/oauth2/register).
2. Enter a name in the ***Account Name*** field.
3. Enter your email address in the ***Email Address*** field.
4. Enter your URL in the ***Website*** field.
5. Enter a description in the ***Application Description*** field.
6. Copy your OAuth Callback URL from the 'Create New Credentials' screen in n8n and paste in the ***Callback URIs*** section.
7. Click on the ***Register*** button.
8. Use the provided ***Client ID*** and the ***Client Secret*** with your Acuity Scheduling OAuth2 API credentials in n8n.
9. Click on the circle button in the OAuth section to connect your Acuity Scheduling account to n8n.
10. Click the ***Save*** button to save your credentials.
![Getting Acuity Scheduling OAuth2 credentials](/_images/integrations/builtin/credentials/acuityscheduling/using-oauth.gif)
## Using Access Token
1. Open your Acuity Scheduling dashboard.
2. Click on 'Integrations' in the left sidebar.
3. Scroll down and click on 'view credentials' under the API section.
4. Copy the ***User ID*** and ***API Key*** from the pop-up that is displayed.
5. Use these credentials with your Acuity Scheduling node credentials in n8n.
![Getting Acuity Scheduling credentials](/_images/integrations/builtin/credentials/acuityscheduling/using-access-token.gif)

19
docs/integrations/builtin/credentials/adalo.md
View File

@ -1,19 +0,0 @@
# Adalo
You can use these credentials to authenticate the following nodes with Adalo:
* [Adalo node](/integrations/builtin/app-nodes/n8n-nodes-base.adalo/)
## Prerequisites
* An Adalo account
* An API key. Follow [Adalo's API documentation](https://help.adalo.com/integrations/the-adalo-api/collections){:target=_blank .external-link} to get your key.
* Your Adalo app ID.
## API key
--8<-- "_snippets/integrations/builtin/credentials/open-credential-modal-list.md"
1. Copy the API key from Adalo into **API Key**.
1. Copy the App ID for your Adalo app into **App ID**.
1. Select **Save**. n8n tests your credentials and confirms that they work.

24
docs/integrations/builtin/credentials/affinity.md
View File

@ -1,24 +0,0 @@
# Affinity
You can use these credentials to authenticate the following nodes with Affinity.
- [Affinity](/integrations/builtin/app-nodes/n8n-nodes-base.affinity/)
- [Affinity Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.affinityTrigger/)
## Prerequisites
Create an [Affinity](https://www.affinity.co/) account.
## Using Access Token
1. Open your Affinity dashboard.
2. Open hamburger menu on the top left.
3. Click on Settings.
4. Click on API.
5. Click on 'Generate an API Key' button.
6. Use the API key with your Affinity node credentials in n8n.
![Getting Affinity credentials](/_images/integrations/builtin/credentials/affinity/using-access-token.gif)

21
docs/integrations/builtin/credentials/agileCrm.md
View File

@ -1,21 +0,0 @@
# Agile CRM
You can use these credentials to authenticate the following nodes with Agile CRM.
- [Agile CRM](/integrations/builtin/app-nodes/n8n-nodes-base.agileCrm/)
## Prerequisites
Create an [Agile CRM](https://www.agilecrm.com/) account.
## Using Access Token
1. Open your Agile CRM dashboard.
2. Click on your user icon in the top right of the window.
3. Click on the Admin Settings button.
4. Click on the 'Developers & Api' button in the bottom left.
5. Use the REST API key, your registered email and your Agile CRM subdomain (for instance, n8n) with your Agile CRM node credentials in n8n.
![Getting AgileCrm credentials](/_images/integrations/builtin/credentials/agilecrm/using-access-token.gif)

27
docs/integrations/builtin/credentials/airtable.md
View File

@ -1,27 +0,0 @@
# Airtable
You can use these credentials to authenticate the following nodes with Airtable.
- [Airtable](/integrations/builtin/app-nodes/n8n-nodes-base.airtable/)
- [Airtable Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.airtableTrigger/)
## Prerequisites
Create an [Airtable](https://airtable.com/) account.
## Using API Key
1. Open your Airtable [dashboard](https://airtable.com/).
2. Click on the user icon on the top right and select 'Account' from the dropdown list.
3. Under the ***API*** section, click on the ***Generate API key*** button.
4. Copy the displayed API key.
5. Enter a name for your credentials in the ***Credentials Name*** field in the 'Airtable API' credentials in n8n.
6. Paste the API key in the ***API Key*** field in the 'Airtable API' credentials in n8n.
7. Click on the ***Create*** button to create the credentials.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/yPP3ZnynNck" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

16
docs/integrations/builtin/credentials/amqp.md
View File

@ -1,16 +0,0 @@
# AMQP
You can use these credentials to authenticate the following nodes with AMQP.
- [AMQP Sender](/integrations/builtin/app-nodes/n8n-nodes-base.amqp/)
- [AMQP Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.amqpTrigger/)
## Prerequisites
You need to have a AMQP 1.0 compatible message broker installed.
## Using ActiveMQ connection
Use your Hostname, Port, User, and Password as the AMQP Sender credential data in n8n.
**Note:** The default username for ActiveMQ is `admin` and the default password is `admin`.

25
docs/integrations/builtin/credentials/apiTemplateIo.md
View File

@ -1,25 +0,0 @@
# APITemplate.io
You can use these credentials to authenticate the following nodes with APITemplate.io.
- [APITemplate.io](/integrations/builtin/app-nodes/n8n-nodes-base.apiTemplateIo/)
## Prerequisites
Create an [APITemplate.io](https://apitemplate.io/) account.
## Using API Key
1. Open your APITemplate.io [dashboard](https://app.apitemplate.io).
2. Click on ***API Integration*** on the left sidebar.
3. Click on the ***Copy text*** button to copy the API key.
4. Enter a name for your credentials in the ***Credentials Name*** field in the 'APITemplate.io API' credentials in n8n.
5. Paste the API key in the ***API Key*** field in the 'APITemplate.io API' credentials in n8n.
6. Click on the ***Create*** button to create the credentials.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/NUAkybjCGa8" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

45
docs/integrations/builtin/credentials/asana.md
View File

@ -1,45 +0,0 @@
# Asana
You can use these credentials to authenticate the following nodes with Asana.
- [Asana](/integrations/builtin/app-nodes/n8n-nodes-base.asana/)
- [Asana Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.asanaTrigger/)
## Prerequisites
Create an [Asana](https://www.Asana.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Asana account to n8n.
1. Open your Asana dashboard.
2. Click on your user icon in the top right.
3. Click on ***My Profile Settings...***
4. Click on the ***Apps*** tab.
5. Click on ***Manage Developer Apps***.
6. Click on ***New App***.
7. Enter a name, accept the *API terms and conditions*, and click on ***Create app***.
8. Copy the ***OAuth Callback URL*** from n8n and paste it in the ***Redirect URLs*** field and click ***Add***.
9. Use the provided ***Client ID*** and ***Client secret*** with your Asana OAuth2 API credentials in n8n.
10. Click on the circle button in the OAuth section to connect an Asana account to n8n.
11. Click the ***Save*** button to save your credentials in n8n.
![Getting Asana credentials](/_images/integrations/builtin/credentials/asana/using-oauth.gif)
## Using Access Token
1. Open your Asana dashboard.
2. Click on your user icon in the top right of the window.
3. Click on ***My Profile Settings***.
4. Click on the ***Apps*** tab.
5. Click on ***Manage Developer Apps***.
6. Click on ***New access token*** under the ***Personal access tokens*** section.
7. Enter a name for the access token and agree to the API terms and conditions.
8. Click on the ***Create token*** button.
9. Copy the token and use it with your Asana node credentials in n8n.
![Getting Asana credentials](/_images/integrations/builtin/credentials/asana/using-access-token.gif)

17
docs/integrations/builtin/credentials/automizy.md
View File

@ -1,17 +0,0 @@
# Automizy
You can use these credentials to authenticate the following nodes with Automizy.
- [Automizy](/integrations/builtin/app-nodes/n8n-nodes-base.automizy/)
## Prerequisites
Create an [Automizy](https://automizy.com/) account.
## Using API Token
1. Access the [Automizy dashboard](https://app.automizy.com/dashboard).
2. Click on ***Settings*** in the bottom left corner and select 'API Token'.
3. Click on the ***CREATE TOKEN*** button.
4. Click on the ***COPY & CLOSE*** button to copy the API token.
5. Use this API token with your Auotmizy node credentials in n8n.

27
docs/integrations/builtin/credentials/autopilot.md
View File

@ -1,27 +0,0 @@
# Autopilot
You can use these credentials to authenticate the following nodes with Autopilot.
- [Autopilot](/integrations/builtin/app-nodes/n8n-nodes-base.autopilot/)
- [Autopilot Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.autopilotTrigger/)
## Prerequisites
Create an [Autopilot](https://app.autopilothq.com) account.
## Using API Key
1. Open your Autopilot [dashboard](https://app.autopilothq.com).
2. Click on the gears icon on the left sidebar to open the ***Settings*** menu.
3. Click on ***Autopilot API***.
4. Click on the ***Generate*** button to create the API key.
5. Copy the displayed API key.
6. Enter a name for your credentials in the ***Credentials Name*** field in the 'Autopilot API' credentials in n8n.
7. Paste the API key in the ***API Key*** field in the 'Autopilot API' credentials in n8n.
8. Click on the ***Create*** button to create the credentials.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/zy8uVHpwVHM" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

41
docs/integrations/builtin/credentials/aws.md
View File

@ -1,41 +0,0 @@
# AWS
You can use these credentials to authenticate the following nodes with AWS.
- [AWS Certificate Manager](/integrations/builtin/app-nodes/n8n-nodes-base.awsCertificateManager/)
- [AWS DynamoDB](/integrations/builtin/app-nodes/n8n-nodes-base.awsDynamoDb/)
- [AWS Elastic Load Balancing](/integrations/builtin/app-nodes/n8n-nodes-base.awsElb/)
- [AWS Lambda](/integrations/builtin/app-nodes/n8n-nodes-base.awsLambda/)
- [AWS Rekognition](/integrations/builtin/app-nodes/n8n-nodes-base.awsRekognition/)
- [AWS S3](/integrations/builtin/app-nodes/n8n-nodes-base.awsS3/)
- [AWS SES](/integrations/builtin/app-nodes/n8n-nodes-base.awsSes/)
- [AWS SNS](/integrations/builtin/app-nodes/n8n-nodes-base.awsSns/)
- [AWS SNS Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.awsSnsTrigger/)
- [AWS SQS](/integrations/builtin/app-nodes/n8n-nodes-base.awsSqs/)
- [AWS Textract](/integrations/builtin/app-nodes/n8n-nodes-base.awsTextract/)
- [AWS Transcribe](/integrations/builtin/app-nodes/n8n-nodes-base.awsTranscribe/)
## Prerequisites
Create an [AWS](https://aws.amazon.com/){:target=_blank .external-link} account.
## Using Access Token
1. Open your [AWS Management Console](https://console.aws.amazon.com){:target=_blank .external-link}.
2. Click on your name on the top right and select 'My Security Credentials' from the dropdown.
3. Click on the **Create New Access Key** button, under the **Access keys (access key ID and secret access key)** section
4. Click on the **Show Access Key** button.
5. Copy the displayed Access Key ID.
6. Enter the name for your credentials in the **Credentials Name** field in the 'AWS' credentials in n8n.
7. Paste the Access Key ID in the **Access Key ID** field in the 'AWS' credentials in n8n.
8. Copy the secret access key from your AWS console.
9. Paste the secret access key in the **Secret Access Key** field in the 'AWS' credentials in n8n.
10. Click the **Create** button to save your credentials in n8n.
**Note:** If you're running your AWS instance in a different region, please update the **Region** field accordingly.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/zJgHOSSwC4A" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

18
docs/integrations/builtin/credentials/bambooHr.md
View File

@ -1,18 +0,0 @@
# BambooHR
You can use these credentials to authenticate the following nodes with BambooHR.
- [BambooHR](/integrations/builtin/app-nodes/n8n-nodes-base.bambooHr/)
## Prerequisites
Create a [BambooHR](https://www.bamboohr.com/) account.
## Using Access Token
1. Log into your BambooHR account and click on the profile image in the upper right corner.
2. Click on *API Keys*.
3. Click on *Add New Key*, enter any name for your new key and hit *Generate Key*.
4. Copy the key provided by BambooHR into the *API Key* field of n8n's credentials modal.
5. Enter your subdomain (the part between `https://` and `.bamboohr.com`) in the *Subdomain* field of n8n's credentials modal.
6. Click on *Save*.

22
docs/integrations/builtin/credentials/bannerbear.md
View File

@ -1,22 +0,0 @@
# Bannerbear
You can use these credentials to authenticate the following nodes with Bannerbear.
- [Bannerbear](/integrations/builtin/app-nodes/n8n-nodes-base.bannerbear/)
## Prerequisites
Create a [BannerBear](https://www.BannerBear.com/) account.
## Using Access Token
1. Open your BannerBear dashboard.
2. Click on "Create New Project".
3. Enter Project name and save.
4. Click on Projects tab and enter the newly creatted project.
5. Click on "Settings / API Key".
6. Use API key in your Bannerbear node credentials in n8n.
![Getting Bannerbear credentials](/_images/integrations/builtin/credentials/bannerbear/using-access-token.gif)

21
docs/integrations/builtin/credentials/baserow.md
View File

@ -1,21 +0,0 @@
# Baserow
You can use these credentials to authenticate the following node:
- [Baserow](/integrations/builtin/app-nodes/n8n-nodes-base.baserow/)
## Prerequisites
Create a [Baserow](https://baserow.io/) account on any hosted Baserow instance
or a self hosted instance.
## Using User Account
1. In n8n, open the **Credentials** menu item and click on **New**
2. In the **Add new credential** dialogue, select **Baserow API** and click on the **Continue** button
3. If using the online version of Baserow, leave the **Host** as `https://api/baserow.io`, otherwise set it to your self-hosted instance API URL.
4. Enter your Baserow username in the **Username** field
5. Enter your Baserow password in the **Password** field
6. Click on the **Save** button
You can now use this credential in your Baserow nodes.

27
docs/integrations/builtin/credentials/beeminder.md
View File

@ -1,27 +0,0 @@
# Beeminder
You can use these credentials to authenticate the following nodes with Beeminder.
- [Beeminder](/integrations/builtin/app-nodes/n8n-nodes-base.beeminder/)
## Prerequisites
Create a [Beeminder](https://Beeminder.io/account) account.
## Using API Key
1. Open your [Beeminder dashboard](https://beeminder.com/home).
2. Click on your avatar at the top-right corner.
3. Select 'ACCOUNT SETTINGS' from the dropdown list.
4. Scroll up and click on the ***APPS & API*** tab.
5. Copy the ***Auth Token*** displayed in the ***API*** section.
6. Enter the name for your credentials in the ***Credentials Name*** field in the 'Beeminder API' credentials in n8n.
7. Enter your username in the ***User*** field.
8. Paste the Auth Token in the ***Auth Token*** field.
9. Click on the ***Save*** button to save your credentials.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/nBrZAyBx9mA" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

14
docs/integrations/builtin/credentials/bitbucket.md
View File

@ -1,14 +0,0 @@
# Bitbucket
You can use these credentials to authenticate the following nodes with Bitbucket.
- [Bitbucket Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.bitbucketTrigger/)
## Prerequisites
Create an [Bitbucket](https://www.Bitbucket.com/) account.
## Using Username and Password
Use the username and application password.

38
docs/integrations/builtin/credentials/bitly.md
View File

@ -1,38 +0,0 @@
# Bitly
You can use these credentials to authenticate the following nodes with Bitly.
- [Bitly](/integrations/builtin/app-nodes/n8n-nodes-base.bitly/)
## Prerequisites
Create a [Bitly](https://www.bitly.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Bitly account to n8n.
1. Open your Bitly dashboard.
2. Click on your account button in the top right.
3. Click on "Profile Settings".
4. Click on "Registered OAuth Applications".
5. Click on "GET REGISTRATION CODE".
6. Use Client Secret and Client ID in your Bitly node credentials in n8n.
7. Enter n8n provided redirect URL. Redirect URL Explanation [here](/).
![Getting Bitly credentials](/_images/integrations/builtin/credentials/bitly/using-oauth.gif)
## Using Access Token
1. Open your Bitly dashboard.
2. Click on your account button in the top right.
3. Click on "Profile Settings".
4. Click on "Generate Access Token".
5. Enter password.
6. Use the access token in your Bitly node credentials in n8n.
![Getting Bitly credentials](/_images/integrations/builtin/credentials/bitly/using-access-token.gif)

32
docs/integrations/builtin/credentials/bitwarden.md
View File

@ -1,32 +0,0 @@
# Bitwarden
You can use these credentials to authenticate the following nodes with Bitwarden.
- [Bitwarden](/integrations/builtin/app-nodes/n8n-nodes-base.bitwarden/)
## Prerequisites
Create a [Bitwarden](https://vault.bitwarden.com/#/register?org=teams) organisation account.
## Using API Key
1. Open your Bitwarden [vault](https://vault.bitwarden.com/).
2. Click on your organisation under the ***ORGANISATIONS*** section.
3. Click on the ***Settings*** tab.
4. Click on the ***View API key*** button under the ***API key*** section.
5. Enter your master password in the ***Master password*** field.
6. Click on the ***View API key*** button.
7. Copy the displayed client id.
8. Enter the name for your credentials in the ***Credentials Name*** field in the 'Bitwarden API' credentials in n8n.
9. Paste the client id in the ***Client ID*** field in the 'Bitwarden API' credentials in n8n.
10. Copy the client secret from Bitwarden.
11. Paste the client secret in the ***Client Secret*** field in the 'Bitwarden API' credentials in n8n.
12. Click on the ***Create*** button to create your credentials.
**Note:** If you're hosting Bitwarden on your server, select 'Self-hosted' from the ***Environment*** dropdown list. You also need to enter the domain of your hosted instance in the ***Self-hosted domain*** field.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/lK-XdhKDSkk" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

28
docs/integrations/builtin/credentials/box.md
View File

@ -1,28 +0,0 @@
# Box
You can use these credentials to authenticate the following nodes with Box.
- [Box](/integrations/builtin/app-nodes/n8n-nodes-base.box/)
- [Box Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.boxTrigger/)
## Prerequisites
Create a [Box](https://www.box.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Box account to n8n.
1. Access the [Box Developers Console](https://app.box.com/developers/console).
2. Click on the *Create New App* button.
3. Select 'Custom App' and click *Next*.
4. Select 'Standard OAuth 2.0 (User Authentication)'and click *Next*.
5. Enter any other necessary information and click on the *Create App* button.
6. Copy the 'OAuth Callback URL' provided in the Box OAuth2 API credentials in n8n and paste it in the 'Redirect URI' field in the Box app page.
7. Click the *Save Changes* button and use the displayed 'Client ID' and the 'Client Secret' with your Box OAuth2 API credentials in n8n.
10. Click on the circle button in the OAuth section to connect a Box account to n8n.
11. Click the *Save* button to save your credentials in n8n.
![Getting Box credentials](/_images/integrations/builtin/credentials/box/using-oauth.gif)

18
docs/integrations/builtin/credentials/brandfetch.md
View File

@ -1,18 +0,0 @@
# Brandfetch
You can use these credentials to authenticate the following nodes with Brandfetch.
- [Brandfetch](/integrations/builtin/app-nodes/n8n-nodes-base.Brandfetch/)
## Prerequisites
Create a [Brandfetch](https://brandfetch.io/account) account.
## Using API Key
1. Access your [Brandfetch dashboard](https://brandfetch.io/dashboard).
2. Click on ***API*** on the left sidebar.
3. Select a plan and click on the ***Get API Key*** button.
4. Use the ***App Key*** with your Brandfetch API credentials in n8n.
![Getting Brandfetch credentials](/_images/integrations/builtin/credentials/brandfetch/using-api.gif)

34
docs/integrations/builtin/credentials/bubble.md
View File

@ -1,34 +0,0 @@
# Bubble
You can use these credentials to authenticate the following nodes with Bubble.
- [Bubble](/integrations/builtin/app-nodes/n8n-nodes-base.bubble/)
## Prerequisites
Create a [Bubble](https://bubble.io) account.
**Note:** You need a Personal or a higher plan to get access to the Bubble API.
## Using API Key
1. Open your Bubble [dashboard](https://bubble.io/home) page.
2. Select an app under the ***My apps*** section to open the app.
3. Click on ***Settings*** on the left-sidebar.
4. Click on the ***API*** tab.
5. Click on the ***Generate a new API token*** button.
6. Enter a token name in the ***API Token Label*** field.
7. Copy the displayed Private Key.
8. Enter the name for your credentials in the ***Credentials Name*** field in the 'Bubble API' credentials in n8n.
9. Paste the Private Key in the ***API Token*** field in the 'Bubble API' credentials in n8n.
10. Enter the app name in the ***APP Name*** field.
11. Select 'Development' from the ***Environment*** dropdown list. If you want to use the 'Live' environment, select 'Live' instead.
12. Click on the ***Create*** button to create your credentials.
**Note:** If you're self-hosting your Bubble app, select 'Self-hosted' from the ***Hosting*** dropdown list. You will also need to enter the domain of your hosted instance in the ***Domain*** field.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/ZK3YDchpb1U" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

21
docs/integrations/builtin/credentials/cal.md
View File

@ -1,21 +0,0 @@
# Cal
You can use these credentials to authenticate the following nodes with Cal.
- [Cal Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.calTrigger/)
## Prerequisites
Create a [Cal](https://www.cal.com/) pro account.
## Using API keys
Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.
1. Log into your Cal account.
2. Click on **Settings**.
3. There you will find the API keys section which allows you to generate a key for use. More information on this can be found on the [Cal Authentication](https://developer.cal.com/api/authentication){:target=_blank} page.
4. Use API key in your Cal trigger node credentials in n8n.
![Getting Cal credentials](/_images/integrations/builtin/credentials/cal/getting-api-key.gif)

18
docs/integrations/builtin/credentials/calendly.md
View File

@ -1,18 +0,0 @@
# Calendly
You can use these credentials to authenticate the following nodes with Calendly.
- [Calendly Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.calendlyTrigger/)
## Prerequisites
Create a [Calendly](https://www.calendly.com/) premium account.
## Using Access Token
1. Open your Calendly dashboard.
2. Click on "Integrations".
3. Use API key in your Calendly node credentials in n8n.
![Getting Calendly credentials](/_images/integrations/builtin/credentials/calendly/using-access-token.gif)

21
docs/integrations/builtin/credentials/chargebee.md
View File

@ -1,21 +0,0 @@
# Chargebee
You can use these credentials to authenticate the following nodes with Chargebee.
- [Chargebee](/integrations/builtin/app-nodes/n8n-nodes-base.chargebee/)
- [Chargebee Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.chargebeeTrigger/)
## Prerequisites
Create a [Chargebee](https://www.chargebee.com/) account.
## Using Access Token
1. Open your Chargebee dashboard.
2. Click on "Settings".
3. Click on "Configure Chargebee".
4. Scroll down and click on "API Keys".
5. Use selected API key and Account name in your Chargebee node credentials in n8n.
![Getting Chargebee credentials](/_images/integrations/builtin/credentials/chargebee/using-access-token.gif)

20
docs/integrations/builtin/credentials/circleCi.md
View File

@ -1,20 +0,0 @@
# CircleCI
You can use these credentials to authenticate the following nodes with CircleCI.
- [CircleCI](/integrations/builtin/app-nodes/n8n-nodes-base.circleCi/)
## Prerequisites
Create a [CircleCI](https://circleci.com/) account.
## Using Access Token
1. Access your CircleCI User Settings.
2. Visit the [Personal API Tokens](https://app.circleci.com/settings/user/tokens) section.
3. Click on the *Create New Token* button.
4. Type in a name for your token and click on the *Add API Token* button.
5. Copy the generated API Token and use it with your CircleCI API node credentials in n8n.
![Getting CircleCI credentials](/_images/integrations/builtin/credentials/circleci/using-access-token.gif)

42
docs/integrations/builtin/credentials/ciscoWebex.md
View File

@ -1,42 +0,0 @@
# Webex by Cisco
You can use these credentials to authenticate the following nodes:
- [Webex by Cisco](/integrations/builtin/app-nodes/n8n-nodes-base.ciscoWebex/)
- [Webex by Cisco Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.ciscoWebexTrigger/)
## Prerequisites
Create a [Webex by Cisco](https://www.webex.com/) account.
## Using OAuth
1. Navigate to [Webex for Developers](https://developer.webex.com/) and sign in using your Webex by Cisco account.
2. From the user menu select **My Webex Apps**, then **Create a New App**.
3. From the ***Create a New App*** page select **Create an Integration**.
4. Complete the following required fields for your new integration:
* ***Integration Name***: Provide a name for your Webex app.
* ***Contact Email***: Enter your email address.
* ***Icon***: Provide an icon for your app or select one of the available defaults.
* ***Description***: Enter a brief description of your app.
* ***Redirect URIs***: Enter the **OAuth Callback URL** from the n8n credentials modal.
* ***Scopes***: Enable the following scopes:
* `spark:rooms_read`
* `spark:messages_write`
* `spark:messages_read`
* `spark:membership_read`
* `spark_membership_write`
* `meeting:recordings_write`
* `meeting:recordings_read`
* `meeting:preferences_read`
* `meeting:schedules_write`
* `meeting:schedules_read`
5. Click **Add Integration** to create your app.
6. Copy the ***Client ID*** and ***Client Secret*** for this new app.
From n8n:
7. Enter a descriptive ***Credentials Name***.
8. Under ***Credential Data***, enter the ***Client ID*** and ***Client Secret*** obtained above.
9. Under ***OAuth***, click the circle button to initiate authentication. A popup may appear prompting you to login to your Webex by Cisco account.
10. After authentication is complete, click **Create** to save your new credentials.

11
docs/integrations/builtin/credentials/citrixAdc.md
View File

@ -1,11 +0,0 @@
# Citrix ADC
You can use these credentials to authenticate the following nodes with Citrix ADC:
* [Citrix ADC node](/integrations/builtin/app-nodes/n8n-nodes-base.citrixAdc/)
Enter the following information in the **Citrix ADC account** credentials modal:
* The URL of your Citrix ADC instance
* Username
* Password

21
docs/integrations/builtin/credentials/clearbit.md
View File

@ -1,21 +0,0 @@
# Clearbit
You can use these credentials to authenticate the following nodes with Clearbit.
- [Clearbit](/integrations/builtin/app-nodes/n8n-nodes-base.clearbit/)
## Prerequisites
Create a [Clearbit](https://www.clearbit.com/) account.
## Using Access Token
1. Open your Clearbit dashboard.
2. Click on "API".
3. Click on "Configure Chargebee".
4. Use selected API key in your Clearbit node credentials in n8n.
![Getting Clearbit credentials](/_images/integrations/builtin/credentials/clearbit/using-access-token.gif)

60
docs/integrations/builtin/credentials/clickUp.md
View File

@ -1,60 +0,0 @@
# ClickUp
You can use these credentials to authenticate the following nodes with ClickUp.
- [ClickUp](/integrations/builtin/app-nodes/n8n-nodes-base.clickUp/)
- [ClickUp Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.clickUpTrigger/)
## Prerequisites
Create a [ClickUp](https://www.clickup.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your ClickUp account to n8n.
1. Open your ClickUp [dashboard](https://app.clickup.com).
2. Click on your profile icon in the bottom left.
3. Click on **Integrations** under your workspace profile.
4. Click on **ClickUp API**.
5. Click on the **+ Create an App** button under the **ClickUp API** section.
6. Enter the name of your app in the **App Name** field.
7. Copy the 'OAuth Callback URL' provided in the 'ClickUp OAuth2 API' credentials in n8n.
8. Paste it in the **Redirect URL(s)** field.
9. Click on the **Create App** button.
10. Copy the displayed client ID.
11. Enter a name for your credentials in the **Credentials Name** field in the 'ClickUp OAuth2 API' credentials in n8n.
12. Paste the client ID in the **Client ID** field in the 'ClickUp OAuth2 API' credentials in n8n.
13. Copy the client secret from ClickUp.
14. Paste the client secret in the **Client Secret** field in the 'ClickUp OAuth2 API' credentials in n8n.
15. Click on the circle button in the OAuth section to connect a ClickUp account to n8n.
16. Click the **Save** button to save your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/jPD0p8n-Ddk" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
The following video demonstrates the steps to authenticate the ClickUp node on [n8n.cloud](https://n8n.cloud).
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/1CjF_cPNSzM" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Using Access Token
1. Open the ClickUp [dashboard](https://app.clickup.com).
2. Click on your profile icon in the bottom left.
3. Click on ***Apps*** under your user profile.
4. Click on the ***Generate*** button under the ***API Token*** section.
5. Click on the ***Copy*** button to copy the token.
6. Enter a name for your credentials in the ***Credentials Name*** field in the 'ClickUp API' credentials in n8n.
7. Paste the token in the ***Access Token*** field in the 'ClickUp API' credentials in n8n.
8. Click on the ***Create*** button to create the credentials.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/FMc8uiFT-Eo" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

21
docs/integrations/builtin/credentials/clockify.md
View File

@ -1,21 +0,0 @@
# Clockify
You can use these credentials to authenticate the following nodes with Clockify.
- [Clockify](/integrations/builtin/app-nodes/n8n-nodes-base.clockify/)
- [Clockify Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.clockifyTrigger/)
## Prerequisites
Create a [Clockify](https://www.clockify.com/) account.
## Using Access Token
1. Open your Clockify dashboard.
2. Click on your profile.
3. Click on "Profile Settings".
4. Scroll down and click on "Generate" under API.
5. Use selected API key in your Clockify node credentials in n8n.
![Getting Clockify credentials](/_images/integrations/builtin/credentials/clockify/using-access-token.gif)

9
docs/integrations/builtin/credentials/cloudflare.md
View File

@ -1,9 +0,0 @@
# Cloudflare
You can use these credentials to authenticate the following nodes with Cloudflare:
* [Cloudflare node](/integrations/builtin/app-nodes/n8n-nodes-base.cloudflare/)
Follow the [Cloudflare documentation to create an API token](https://developers.cloudflare.com/api/get-started/create-token/){:target=_blank .external-link}.
Enter your token in the **Cloudflare account** credentials modal.

20
docs/integrations/builtin/credentials/cockpit.md
View File

@ -1,20 +0,0 @@
# Cockpit
You can use these credentials to authenticate the following nodes with Cockpit.
- [Cockpit](/integrations/builtin/app-nodes/n8n-nodes-base.cockpit/)
## Prerequisites
Create a [Cockpit](https://www.getcockpit.com/) account.
## Using Access Token
1. Open your Cockpit dashboard.
2. Click on your profile in the top right.
3. Click on "Account".
4. Scroll down and copy API key.
5. Use selected API key and your Cockpit URL in your Cockpit node credentials in n8n.
![Getting Cockpit credentials](/_images/integrations/builtin/credentials/cockpit/using-access-token.gif)

20
docs/integrations/builtin/credentials/coda.md
View File

@ -1,20 +0,0 @@
# Coda
You can use these credentials to authenticate the following nodes with Coda.
- [Coda](/integrations/builtin/app-nodes/n8n-nodes-base.coda/)
## Prerequisites
Create a [Coda](https://www.coda.com/) account.
## Using Access Token
1. Open your Coda dashboard.
2. Click on your profile in the top right.
3. Click on the 3 dots and then Account settings..
4. Scroll down and click on "Generate" under API.
5. Use selected API access token in your Coda node credentials in n8n.
![Getting Coda credentials](/_images/integrations/builtin/credentials/coda/using-access-token.gif)

21
docs/integrations/builtin/credentials/contentful.md
View File

@ -1,21 +0,0 @@
# Contentful
You can use these credentials to authenticate the following nodes with Contentful.
- [Contentful](/integrations/builtin/app-nodes/n8n-nodes-base.contentful/)
## Prerequisites
Create a [Contentful](https://www.contentful.com/) account.
## Using Access Token
1. Open your Contentful dashboard.
2. Open the 'Settings' dropdown list on the top bar.
3. Click on ***API keys***.
4. Click on the ***Add API key*** button in the top right.
5. Enter a name for the API key in the ***Name*** field and click ***Save***.
6. Use the displayed ***Space ID***, ***Content Delivery API - access token***, and ***Content Preview API - access token*** with your Contentful node API credentials in n8n.
7. Click on the ***Save*** button to save your credentials.
![Getting Contentful credentials](/_images/integrations/builtin/credentials/contentful/using-api-key.gif)

20
docs/integrations/builtin/credentials/convertKit.md
View File

@ -1,20 +0,0 @@
# ConvertKit
You can use these credentials to authenticate the following nodes with ConvertKit.
- [ConvertKit](/integrations/builtin/app-nodes/n8n-nodes-base.convertKit/)
- [ConvertKit Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.convertKitTrigger/)
## Prerequisites
Create a [ConvertKit](https://convertkit.com/) account.
## Using Access Token
1. Access your ConvertKit dashboard.
2. Click on the user icon in the top right and select ***Account settings***.
3. Click on ***Show*** in the ***API Secret*** section to reveal the access token.
4. Use the access token in the ***API Secret*** section with your ConvertKit API credentials in n8n.
5. Click on the ***Save*** button to save your credentials.
![Getting ConvertKit access token](/_images/integrations/builtin/credentials/convertkit/using-access-token.gif)

28
docs/integrations/builtin/credentials/copper.md
View File

@ -1,28 +0,0 @@
# Copper
You can use these credentials to authenticate the following nodes with Copper.
- [Copper](/integrations/builtin/app-nodes/n8n-nodes-base.copper/)
- [Copper Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.copperTrigger/)
## Prerequisites
Create a [Copper](https://www.copper.com/) account.
## Using Access Token
1. Open your Copper dashboard.
2. Click on the ***Settings*** tab on the left-sidebar.
3. Click on ***Integrations*** and select ***API Keys***.
4. Click on the ***GENERATE API KEY*** button.
5. Copy the displayed API key.
6. Enter the name for your credentials in the ***Credentials Name*** field in the 'Copper API' credentials in n8n.
7. Paste the API key in the ***API Key*** field in the 'Copper API' credentials in n8n.
8. Enter the email address in the ***Email*** field in the 'Copper API' credentials in n8n.
9. Click the ***Create*** button to create your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/4yV9GI3UF_o" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

17
docs/integrations/builtin/credentials/cortex.md
View File

@ -1,17 +0,0 @@
You can use these credentials to authenticate the following nodes with Cortex.
- [Cortex](/integrations/builtin/app-nodes/n8n-nodes-base.cortex/)
## Prerequisites
Install [Cortex](https://github.com/TheHive-Project/CortexDocs/blob/master/installation/install-guide.md) on your server.
## Using API Key
1. Access your Cortex dashboard.
2. Click on your user icon on the top right corner and select 'Settings'.
3. Scroll down to the ***API Key*** section and click on the ***Reveal*** button.
4. Use the ***API Key*** and your ***Cortex instance URL*** with your Cortex node credentials in n8n.
![Getting Cortex credentials](/_images/integrations/builtin/credentials/cortex/using-api.gif)

14
docs/integrations/builtin/credentials/crateDb.md
View File

@ -1,14 +0,0 @@
# CrateDB
You can use these credentials to authenticate the following nodes with CrateDB.
- [CrateDB](/integrations/builtin/app-nodes/n8n-nodes-base.crateDb/)
## Prerequisites
An available instance of CrateDB.
## Using Database Connection
1. Retrieve your CrateDB credentials and connection parameters.
2. Use the credentials and connection parameters with your CrateDB node credentials in n8n.

45
docs/integrations/builtin/credentials/customerIo.md
View File

@ -1,45 +0,0 @@
# Customer.io
You can use these credentials to authenticate the following nodes with Customer.io.
- [Customer.io](/integrations/builtin/app-nodes/n8n-nodes-base.customerIo/)
- [Customer.io Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.customerIoTrigger/)
## Prerequisites
Create a [Customer.io](https://customer.io/) account.
## Using Access Token
1. Open your Customer.io [dashboard](https://fly.customer.io).
2. Click on the user icon in the top right and select ***Account settings***.
3. Click on ***API Credentials***.
4. Click on the ***Create Tracking API Key*** button.
5. Enter a name for the Tracking API Key in the ***Name***.
6. Select a workspace from the ***Workspace*** dropdown list.
7. Click on the ***Create Tracking API Key*** button.
8. Copy the displayed 'Site ID'.
9. Enter the name for your credentials in the ***Credentials Name*** field in the 'Customer.io API' credentials in n8n.
10. Paste the Site ID in the ***Tracking Site ID*** field in the 'Customer.io API' credentials in n8n.
11. Copy the 'API Key' from the Manage API Credentials page.
12. Paste the API key in the ***Tracking API Key*** field in the 'Customer.io API' credentials in n8n.
13. Click on the ***App API Keys*** tab on the Manage API Credentials page.
14. Click on the ***Create App API Key*** button.
15. Enter a name for the App API Key in the ***Name*** field.
16. Select a workspace from the ***Workspace*** dropdown list.
17. Click on the ***Create App API Key*** button.
18. Copy the displayed API key.
19. Paste the API key in the ***App API Key*** field in the 'Customer.io API' credentials in n8n.
20. Click on the ***Create*** button to create your credentials.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/LAFExR62-VA" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## FAQs
### Why do I need the Tracking API Key and the App API Key?
Customer.io uses different API Keys for different endpoints. Based on the operation you want to perform, n8n uses the correct API key to connect to your Customer.io account.

25
docs/integrations/builtin/credentials/deepL.md
View File

@ -1,25 +0,0 @@
# DeepL
You can use these credentials to authenticate the following nodes with DeepL.
- [DeepL](/integrations/builtin/app-nodes/n8n-nodes-base.deepL/)
## Prerequisites
Create a DeepL [developer](https://www.deepl.com/pro/change-plan#developer) account.
## Using API Key
1. Open your DeepL [account](https://www.deepl.com/pro-account) page.
2. Scroll down to the ***Authentication Key for DeepL API*** section.
3. Copy the displayed 'API Key'.
4. Enter the name for your credentials in the ***Credentials Name*** field in the 'DeepL API' credentials in n8n.
5. Paste the API key in the ***API Key*** field in the 'DeepL API' credentials in n8n.
6. Click on the ***Create*** button to create your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/y-yjqXBzCqc" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

29
docs/integrations/builtin/credentials/demio.md
View File

@ -1,29 +0,0 @@
# Demio
You can use these credentials to authenticate the following nodes with Demio.
- [Demio](/integrations/builtin/app-nodes/n8n-nodes-base.demio/)
## Prerequisites
Create a [Demio](https://demio.com/) account.
## Using API Key
1. Open your Demio [dashboard](https://my.demio.com/manage/dashboard).
2. Click on your user icon in the top right.
3. Click on ***Settings***.
4. Click on the ***API*** tab.
5. Copy the displayed 'API Key'.
6. Enter the name for your credentials in the ***Credentials Name*** field in the 'Demio API' credentials in n8n.
7. Paste the API key in the ***API Key*** field in the 'Demio API' credentials in n8n.
8. Copy the 'API Secret' from Demio.
9. Paste the API secret in the ***API Secret*** field in the 'Demio API' credentials in n8n.
10. Click the ***Create*** button to save your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/qcl8mZAmK2I" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

20
docs/integrations/builtin/credentials/dhl.md
View File

@ -1,20 +0,0 @@
# DHL
You can use these credentials to authenticate the following nodes with DHL.
- [DHL](/integrations/builtin/app-nodes/n8n-nodes-base.dhl/)
## Prerequisites
- Create a [DHL Developer](https://developer.dhl.com/user/register) account.
## Using Access Token
1. Navigate to the apps page of the [DHL Developer](https://developer.dhl.com/user/apps) portal.
2. Click the ***+ Create App*** button.
3. Enter a descriptive name in the ***App name*** field.
4. In the ***Select APIs*** section, search for `Shipment Tracking - Unified` in the ***API's name*** field.
5. Below ***Add API to app***, click the ***Plus (+)*** button next to the entry for `Shipment Tracking - Unified`.
6. Click on the ***Add app*** button.
7. Back on the apps page, click on your newly created app.
8. Click the ***Show key*** link to reveal your access token. Use the token with your DHL credentials in n8n.

30
docs/integrations/builtin/credentials/discord.md
View File

@ -1,30 +0,0 @@
# Discord
You can follow these instructions to create a webhook in Discord to use with the following nodes.
- [Discord](/integrations/builtin/app-nodes/n8n-nodes-base.discord/)
## Prerequisites
Create a [Discord](https://www.discord.com/) account.
## Creating a webhook in Discord
1. To create a webhook in Discord that sends content to your channel, go to the settings of your channel.
2. Select 'Integrations' from the sidebar.
3. Click on the ***Create Webhook*** button.
4. Name your bot, and click on the ***Copy Webhook URL*** button to copy the webhook URL.
5. Back in n8n, use the copied webhook URL in your Discord node.
![How to create a webhook in Discord](/_images/integrations/builtin/credentials/discord/create-webhook.gif)
<!-- ## Using OAuth
1. Access this [Discord Developer Portal](https://discord.com/developers/applications).
2. Click on "New Application".
3. Enter the name and click "Create".
4. Use Client Secret and Client ID in your Discord node credentials in n8n.
5. Enter n8n provided redirect URL in the configuration. ![Redirect URL Explanation here](/).
![Getting Discord credentials](/_images/integrations/builtin/credentials/discord/using-oauth.gif) -->

35
docs/integrations/builtin/credentials/discourse.md
View File

@ -1,35 +0,0 @@
# Discourse
You can use these credentials to authenticate the following nodes with Discourse.
- [Discourse](/integrations/builtin/app-nodes/n8n-nodes-base.discourse/)
## Prerequisites
- Host an instance of [Discourse](https://discourse.org/)
- Create an account on your hosted instance and make sure that you are an admin
## Using API Key
1. Open your Discourse dashboard.
2. Click on the ***API*** tab.
3. Click on the ***+ New API Key*** button.
4. Enter a description in the ***Description*** field.
5. Based on your use-case, do one of the following:
- If you want to create the API key for a single user, select 'Single User' from the ***User Level*** dropdown list. Enter the username in the ***User*** field and select the user from the dropdown list.
- If you want to create the API key for all your users, select 'All Users' from the ***User Level*** dropdown list.
6. If you want to select all the scopes, check the ***Global Key (allowed all actions)*** checkbox. Otherwise, select scopes individually under the ***Scopes*** section.
7. Click on the ***Save*** button.
8. Copy the displayed API key.
9. Enter the name for your credentials in the ***Credentials Name*** field in the 'Discourse API' credentials in n8n.
10. Enter the URL of your Discourse instance in the ***URL*** field in the 'Discourse API' credentials in n8n. For example, `https://community.n8n.io`.
11. Paste the API key in the ***API Key*** field in the 'Discourse API' credentials in n8n.
12. Enter your Discourse username in the ***Username*** field in the 'Discourse API' credentials in n8n.
13. Click the ***Create*** button to create your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/rLdceGB5zoo" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

17
docs/integrations/builtin/credentials/disqus.md
View File

@ -1,17 +0,0 @@
# Disqus
You can use these credentials to authenticate the following nodes with Disqus.
- [Disqus](/integrations/builtin/app-nodes/n8n-nodes-base.disqus/)
## Prerequisites
Create a [Disqus](https://www.disqus.com/) account.
## Using Access Token
1. Access the [Disqus Application Registration Page](https://disqus.com/api/applications/register/).
2. Fill out the application information and click on ***Register my application***.
3. Click on ***Details*** at the top and use the provided 'API Key' with your Disqus node credentials in n8n.
![Getting Disqus credentials](/_images/integrations/builtin/credentials/disqus/using-access-token.gif)

38
docs/integrations/builtin/credentials/drift.md
View File

@ -1,38 +0,0 @@
# Drift
You can use these credentials to authenticate the following nodes with Drift.
- [Drift](/integrations/builtin/app-nodes/n8n-nodes-base.drift/)
## Prerequisites
Create a [Drift](https://www.drift.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Drift account to n8n.
1. Access your [Drift apps](https://dev.drift.com/apps) page.
2. Click on the ***Build Your App*** button. You can also select an existing app if you already have one.
3. Enter a name in the ***App name*** field.
4. Click on 'Oauth & Scopes' in the sidebar.
5. Copy your OAuth Callback URL from the 'Create New Credentials' screen in n8n, paste in the ***Add Redirect URL*** field, and click on the ***Add*** button.
6. Click on 'App Credentials' in the sidebar.
7. Use the ***Client ID*** and ***Secret ID*** with your Drift OAuth2 API node credentials in n8n.
8. Click on the circle button in the OAuth section to connect your Drift account to n8n.
9. Click the ***Save*** button to save your credentials.
![Getting Drift OAuth credentials](/_images/integrations/builtin/credentials/drift/using-oauth.gif)
## Using Access Token
1. Access [your Drift apps](https://dev.drift.com/apps).
2. Select your App (or create a new one).
3. Click on "Manage".
4. Click on "Installing to Drift".
5. Use token with your Drift Node credentials in n8n.
![Getting Drift credentials](/_images/integrations/builtin/credentials/drift/using-access-token.gif)

47
docs/integrations/builtin/credentials/dropbox.md
View File

@ -1,47 +0,0 @@
# Dropbox
You can use these credentials to authenticate the following nodes with Dropbox.
- [Dropbox](/integrations/builtin/app-nodes/n8n-nodes-base.dropbox/)
## Prerequisites
Create a [Dropbox](https://www.dropbox.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Dropbox account to n8n.
1. Access the [Dropbox app creation](https://www.dropbox.com/developers/apps/create) page.
2. Select 'Scoped access' under the ***Choose an API*** section.
3. Select an access type under the ***Choose the type of access you need***. You can read more about the access type [here](https://www.dropbox.com/developers/reference/developer-guide).
4. In the ***Name your app*** section, enter a name for your app.
5. Click on the ***Create app*** button.
6. Click on the ***Permissions*** tab and give all the permissions under the ***Files and folders*** section.
7. Click on the ***Submit*** button.
8. Click on the ***Settings*** tab.
9. Copy your OAuth Callback URL from the 'Create New Credentials' screen in n8n and paste in the ***Redirect URIs*** field under the ***OAuth 2*** section.
10. Click on the ***Add*** button.
11. Enter the provided ***App key*** and the ***App secret*** in the ***Client ID*** and ***Client Secret*** field, respectively, in your Dropbox OAuth2 API credentials in n8n.
12. Click on the circle button in the OAuth section to connect your Dropbox account to n8n.
13. Click on the ***Save*** button to save your credentials.
![Getting Dropbox credentials](/_images/integrations/builtin/credentials/dropbox/using-oauth.gif)
## Using Access Token
1. Access the [Dropbox app creation](https://www.dropbox.com/developers/apps/create) page.
2. Select 'Scoped access' under the ***Choose an API*** section.
3. Select an access type under the ***Choose the type of access you need***. You can read more about the access type [here](https://www.dropbox.com/developers/reference/developer-guide).
4. In the ***Name your app*** section, enter a name for your app.
5. Click on the ***Create app*** button.
6. Click on the ***Permissions*** tab and give all the permissions under the ***Files and folders*** section.
7. Click on the ***Submit*** button.
8. Click on the ***Settings*** tab.
9. Scroll down to the ***OAuth 2*** section and select 'No expiration' from the ***Access token expiration*** dropdown list.
10. Click on the ***Generate*** button.
11. Use the displayed ***Generated access token*** with your Dropbox credentials in n8n.
![Getting Dropbox credentials](/_images/integrations/builtin/credentials/dropbox/using-access-token.gif)

19
docs/integrations/builtin/credentials/dropcontact.md
View File

@ -1,19 +0,0 @@
# Dropcontact
You can use these credentials to authenticate the following nodes with Dropcontact.
- [Dropcontact](/integrations/builtin/app-nodes/n8n-nodes-base.dropcontact/)
## Prerequisites
Create an account on a [Dropcontact](https://www.dropcontact.com/) app.
## Using API Key
1. Open your Dropcontact [dashboard](https://app.dropcontact.io/app/).
2. Select ***API*** from the left sidebar.
3. Click on the ***Copy*** button to copy the API key.
4. Paste the API key in the ***API Key*** field in the 'Credential for Dropcontact API' fields in n8n.
5. Click on the ***Save*** button to create your credentials.
![Getting Dropcontact API credentials](/_images/integrations/builtin/credentials/dropcontact/apikeydropcontact.png)

17
docs/integrations/builtin/credentials/egoi.md
View File

@ -1,17 +0,0 @@
# E-goi
You can use these credentials to authenticate the following nodes with E-goi.
- [E-goi](/integrations/builtin/app-nodes/n8n-nodes-base.egoi/)
## 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](/_images/integrations/builtin/credentials/egoi/using-api.gif)

25
docs/integrations/builtin/credentials/elasticSecurity.md
View File

@ -1,25 +0,0 @@
# Elastic Security
You can use these credentials to authenticate the following nodes:
- [Elastic Security](/integrations/builtin/app-nodes/n8n-nodes-base.elasticSecurity/)
## Prerequisites
- Create an [Elastic Security](https://www.elastic.co/security) account.
- [Deploy](https://www.elastic.co/guide/en/cloud/current/ec-create-deployment.html) an application.
## Using Basic Auth
**From Elastic Security**:
1. Navigate to your ***Dashboard*** > ***Deployments*** section and open the dashboard for the desired deployment.
2. From the ***Applications*** section, copy the endpoint of your application.
**From n8n**:
1. In the ***Credential Data*** section, enter your:
* Username
* Password
* Base URL: The application endpoint obtained above.
2. Click ***Save*** to save your credentials.

26
docs/integrations/builtin/credentials/elasticsearch.md
View File

@ -1,26 +0,0 @@
# Elasticsearch
You can use these credentials to authenticate the following nodes:
- [Elasticsearch](/integrations/builtin/app-nodes/n8n-nodes-base.elasticsearch/)
## Prerequisites
- Create an [Elasticsearch](https://www.elastic.co/) account.
- [Deploy](https://www.elastic.co/guide/en/cloud/current/ec-create-deployment.html) an application.
## Using Basic Auth
**From Elasticsearch**:
1. Navigate to your ***Dashboard*** > ***Deployments*** section and open the dashboard for the desired deployment.
2. From the ***Applications*** section, copy the endpoint of the Elasticsearch application.
**From n8n**:
1. Enter a descriptive ***Credentials Name***.
2. In the ***Credential Data*** section, enter your:
* Username
* Password
* Base URL: The Elasticsearch application endpoint obtained above.
3. Click ***Create*** to save your credentials.

26
docs/integrations/builtin/credentials/emelia.md
View File

@ -1,26 +0,0 @@
# Emelia
You can use these credentials to authenticate the following nodes with Emelia.
- [Emelia](/integrations/builtin/app-nodes/n8n-nodes-base.emelia/)
- [Emelia Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.emeliaTrigger/)
## Prerequisites
Create a [Emelia](https://emelia.io) account.
## Using API Key
1. Open the Emelia [dashboard](https://app.emelia.io/) page.
2. Click on the avatar on the top-right and select 'API Keys'.
3. Click on the ***Generate new API key*** button.
4. Click on the menu icon and select 'Copy API Key' from the dropdown list.
5. Enter a name for your credentials in the ***Credentials Name*** field in the 'Emelia API' credentials in n8n.
6. Paste the API key in the ***API Key*** field in the 'Emelia API' credentials in n8n.
7. Click the ***Create*** button to create your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/XZ4wP1AI9eM" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

36
docs/integrations/builtin/credentials/erpnext.md
View File

@ -1,36 +0,0 @@
# ERPNext
You can use these credentials to authenticate the following nodes with Emelia.
- [ERPNext](/integrations/builtin/app-nodes/n8n-nodes-base.erpNext/)
## Prerequisites
- Create a [ERPNext](https://erpnext.com) account.
## Using API Key
1. Open your ERPNext dashboard page.
2. Click on ***Settings*** on the top and select 'My Settings'.
3. Scroll down to the bottom of the page and click on ***API Access***.
4. Click on the ***Generate Keys*** button.
5. Copy the displayed API Secret.
6. Enter a name for your credentials in the ***Credentials Name*** field in the 'ERPNext API' credentials in n8n.
7. Paste the API Secret in the ***API Secret*** field in the 'ERPNext API' credentials in n8n.
8. Copy the API Key from ERPNext.
**Note:** You might have to refresh the ERPNext window to view the API Key.
9. Paste the API Key in the ***API Key*** field in the 'ERPNext API' credentials in n8n.
10. Enter the subdomain of your ERPNext account in the ***Subdomain*** field in the 'ERPNext API' credentials in n8n. Refer to the [FAQs](#how-to-find-the-subdomain-of-an-erpnext-account) to learn how to get your subdomain.
11. Click on the ***Create*** button to create your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/Q12DmHS3FL4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## FAQs
### How to find the subdomain of an ERPNext account?
In the address bar of your browser, you can find the subdomain. The string between `https://` and `.erpnext.com` is your subdomain. For example, if the URL in the address bar is `https://n8n.erpnext.com`, the subdomain will be `n8n`.

38
docs/integrations/builtin/credentials/eventbrite.md
View File

@ -1,38 +0,0 @@
# Eventbrite
You can use these credentials to authenticate the following nodes with Eventbrite.
- [Eventbrite Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.eventbriteTrigger/)
## Prerequisites
Create a [Eventbrite](https://www.eventbrite.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Eventbrite account to n8n.
1. Log in to your Eventbrite account.
2. Click on the user icon in the top right.
3. Select Account Settings in the drop down menu.
4. Click on Developer links > API keys in the sidebar.
5. Click on the *Create API Key* button.
6. Copy the 'OAuth Callback URL' provided in the Eventbrite OAuth API credentials in n8n and paste it in the 'OAuth Redirect URI' field in the Eventbrite API creation page.
7. Fill out any other information that is necessary and click 'Create Key'.
8. Find your API key in the 'API Keys' page and click on 'Show API key, client secret and tokens'.
9. Click on 'Show API key, client secret and tokens' and use the 'API key' and the 'Client secret' with your Eventbrite OAuth API credentials in n8n.
10. Click on the circle button in the OAuth section to connect an Eventbrite account to n8n.
11. Click the *Save* button to save your credentials.
![Getting Eventbrite OAuth credentials](/_images/integrations/builtin/credentials/eventbrite/using-oauth.gif)
## Using Access Token
1. Log in to your Eventbrite account.
2. Visit [your API keys page](https://www.eventbrite.com/platform/api-keys).
3. Copy your private token.
4. Use provided key with your Eventbrite node credentials in n8n.
![Getting Eventbrite credentials](/_images/integrations/builtin/credentials/eventbrite/using-access-token.gif)

27
docs/integrations/builtin/credentials/facebookApp.md
View File

@ -1,27 +0,0 @@
# Facebook App
You can use these credentials to authenticate the following nodes with Facebook.
- [Facebook Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebookTrigger/)
**Note:** If you want to create credentials for the [Facebook Graph API](/integrations/builtin/app-nodes/n8n-nodes-base.facebookGraphAPI/) node, follow the instructions mentioned in the [Facebook Graph API](/integrations/builtin/credentials/facebookGraph/) credentials documentation.
## Prerequisites
Create a [Facebook](https://www.facebook.com/) account.
## Using App Access Token
1. Access the [Facebook for Developers portal](https://developers.facebook.com/).
2. Click on ***My Apps*** on the top right corner.
3. Access your app. Create an app if you don't already have one.
4. Add the ***Webhooks*** product from the ***Add a Product*** section on the dashboard.
5. Click on ***Settings*** in the left sidebar and select 'Basic'.
6. Click on the ***Show*** button and login with your Facebook account.
7. Copy the App Secret displayed on the page.
8. Access the [Facebook Graph API Explorer](https://developers.facebook.com/tools/explorer/).
9. Select your app from the ***Facebook App*** dropdown list on the right sidebar.
10. Select 'Get App Token' from the ***User or Page*** dropdown list on the right sidebar.
11. Use the app secret and the generated access token with your Facebook node credentials in n8n.
![Getting Facebook App credentials](/_images/integrations/builtin/credentials/facebookapp/using-app-access-token.gif)

23
docs/integrations/builtin/credentials/facebookGraph.md
View File

@ -1,23 +0,0 @@
# Facebook Graph API
You can use these credentials to authenticate the following nodes with Facebook.
- [Facebook Graph API](/integrations/builtin/app-nodes/n8n-nodes-base.facebookGraphAPI/)
**Note:** If you want to create credentials for the [Facebook Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.facebookTrigger/) node, follow the instructions mentioned in the [Facebook App](/integrations/builtin/credentials/facebookApp/) credentials documentation.
## Prerequisites
Create a [Facebook](https://www.facebook.com/) account.
## Using Access Token
1. Access [Facebook for Developers portal](https://developers.facebook.com/).
2. Click on "My Apps".
3. Access your app. Create an app if you don't already have one.
4. Access the [Facebook Graph API Explorer](https://developers.facebook.com/tools/explorer/).
5. Select your app under the *Facebook App* dropdown list on the right sidebar.
6. Click on the 'Generate Access Token' button and login with your facebook account.
6. Use generated access token with your Facebook node credentials in n8n.
![Getting Facebook credentials](/_images/integrations/builtin/credentials/facebookgraphapi/using-access-token.gif)

18
docs/integrations/builtin/credentials/figma.md
View File

@ -1,18 +0,0 @@
# Figma
You can use these credentials to authenticate the following nodes:
- [Figma Trigger (Beta)](/integrations/builtin/trigger-nodes/n8n-nodes-base.figmaTrigger/)
## Prerequisites
Create a [Figma](https://www.figma.com/) account.
## Using API Key
1. Log in to [Figma](https://www.figma.com/).
2. Click on the avatar on the top-right and select **Settings**.
3. Scroll down to **Personal access tokens**, enter a name for your token in the input field and confirm by pressing Enter.
4. Click on **Copy this token**.
6. Paste the API key in the **Access Token** field of the **Figma API** credentials screen in n8n.
7. Click the **Save** button to save your credentials in n8n.

15
docs/integrations/builtin/credentials/fileMaker.md
View File

@ -1,15 +0,0 @@
# FileMaker
You can use these credentials to authenticate the following nodes with FileMaker.
- [FileMaker](/integrations/builtin/app-nodes/n8n-nodes-base.filemaker/)
## Prerequisites
Create an user account on a FileMaker server.
## Using Database Connection
1. Retrieve your FileMaker credentials and connection parameters.
2. Use the credentials and connection parameters with your FileMaker node credentials in n8n.
3. Click on the ***Save*** button to save your credentials.

21
docs/integrations/builtin/credentials/flow.md
View File

@ -1,21 +0,0 @@
# Flow
You can use these credentials to authenticate the following nodes with Flow.
- [Flow](/integrations/builtin/app-nodes/n8n-nodes-base.flow/)
- [Flow Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.flowTrigger/)
## Prerequisites
Create a [Flow](https://www.getflow.com/) account.
## Using Access Token
1. Access your Flow dashboard.
2. Click on your Organisation icon in the top left.
3. Click on Account Preferences.
4. Click on the *Create a Personal Access Token* button.
5. As you generate your access token, you will also receive an organisation ID.
6. Use provided access token and organisation ID with your Flow node credentials in n8n.
![Getting Flow credentials](/_images/integrations/builtin/credentials/flow/using-access-token.gif)

19
docs/integrations/builtin/credentials/formIoTrigger.md
View File

@ -1,19 +0,0 @@
# Form.io Trigger
You can use these credentials to authenticate the following nodes:
- [Form.io Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.formIoTrigger/)
## Prerequisites
Create a [Form.io](https://www.form.io/) account.
## Using Basic auth
After creating your Form.io account, from n8n:
1. Enter a descriptive ***Credentials Name***.
2. Select whether your ***Environment*** is **Cloud-hosted** or **Self-hosted**.
3. Enter your Form.io account ***Email***.
4. Enter your Form.io account ***Password***.
5. Click **Create** to save your new credentials.

53
docs/integrations/builtin/credentials/formstackTrigger.md
View File

@ -1,53 +0,0 @@
# Formstack Trigger
You can use these credentials to authenticate the following nodes:
- [Formstack Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.formstackTrigger/)
## Prerequisites
Create a [Formstack](https://www.formstack.com/) account.
## Using Access token
After creating your Formstack account:
1. From the user menu select **API**.
2. Select **New Application**.
3. In the *Create Application* window enter the following:
* *Application Name*: Provide a descriptive name.
* *Redirect URI*: Enter the OAuth callback URL for your n8n instance in the format `http://<n8n_url>/rest/oauth2-credential/callback`. For example `http://localhost:5678/rest/oauth2-credential/callback`.
* *Description*: Enter a brief description.
* *Platform*: Select **Website**.
4. Click **Create Application**.
5. Copy the *Access Token* for your new application.
From n8n:
6. Enter a descriptive ***Credentials Name***.
7. Enter your Formstack ***Access Token***.
8. Click **Create** to save your new credentials.
## Using OAuth2
After creating your Formstack account:
1. From the user menu select **API**.
2. Select **New Application**.
3. In the *Create Application* window enter the following:
* *Application Name*: Provide a descriptive name.
* *Redirect URI*: Enter the OAuth callback URL for your n8n instance in the format `http://<n8n_url>/rest/oauth2-credential/callback`. For example `http://localhost:5678/rest/oauth2-credential/callback`.
* *Description*: Enter a brief description.
* *Platform*: Select **Website**.
4. Click **Create Application**.
5. Select your new application to view the *Application Details*.
6. Copy the *Client ID* and *Client Secret*.
From n8n:
7. Enter a descriptive ***Credentials Name***.
8. Enter your Formstack ***Client ID***.
9. Enter your Formstack ***Client Secret***.
10. Click the circle button to initiate the OAuth2 flow.
11. In the modal window select **Authorize**.
12. Click **Create** to save your new credentials.

19
docs/integrations/builtin/credentials/freshdesk.md
View File

@ -1,19 +0,0 @@
# Freshdesk
You can use these credentials to authenticate the following nodes with Freshdesk.
- [Freshdesk](/integrations/builtin/app-nodes/n8n-nodes-base.freshdesk/)
## Prerequisites
Create a [Freshdesk](https://freshdesk.com/) account.
## Using Access Token
1. Access your Freshdesk dashboard.
2. Click on your Organisation icon in the top right.
3. Click on Profile Settings.
4. Find your API key on the right panel.
5. Use provided API key and your subdomain (i.e n8n) with your Freshdesk node credentials in n8n.
![Getting Freshdesk credentials](/_images/integrations/builtin/credentials/freshdesk/using-access-token.gif)

25
docs/integrations/builtin/credentials/freshservice.md
View File

@ -1,25 +0,0 @@
# Freshservice
You can use these credentials to authenticate the following nodes:
- [Freshservice](/integrations/builtin/app-nodes/n8n-nodes-base.freshservice/)
## Prerequisites
Create a [Freshservice](https://freshservice.com/) account.
## Using API Key
From Freshservice:
1. Access your Freshservice dashboard.
2. Click on your User icon in the top right and select **Settings**.
3. Click on **API Settings**.
4. Copy your API key.
From n8n:
5. Enter a descriptive ***Credentials Name***.
6. Under ***Credential Data***, enter the API Key obtained above in the corresponding field.
7. In the ***Domain*** field enter the subdomain of your Freshservice account. This is part of the URL, for example `https://<subdomain>.freshservice.com/`.
8. Click **Save** to create your new credentials.

25
docs/integrations/builtin/credentials/freshworksCrm.md
View File

@ -1,25 +0,0 @@
# Freshworks CRM
You can use these credentials to authenticate the following nodes:
- [Freshworks CRM](/integrations/builtin/app-nodes/n8n-nodes-base.freshworksCrm/)
## Prerequisites
Create a [Freshworks CRM](https://www.freshworks.com/freshsales-crm/) account.
## Using API Key
From Freshworks CRM:
1. Access your Freshworks CRM dashboard.
2. Click on your User icon in the top right and select **Settings**.
3. Click on **API Settings**.
4. Copy your API key.
From n8n:
5. Enter a descriptive ***Credentials Name***.
6. Under ***Credential Data***, enter the API Key obtained above in the corresponding field.
7. In the ***Domain*** field enter the subdomain of your Freshworks CRM account. This is part of the URL, for example `https://<subdomain>.myfreshworks.com/`.
8. Click **Save** to create your new credentials.

15
docs/integrations/builtin/credentials/ftp.md
View File

@ -1,15 +0,0 @@
# FTP
You can use these credentials to authenticate the following nodes with FTP.
- [FTP](/integrations/builtin/core-nodes/n8n-nodes-base.ftp/)
## Prerequisites
Create an account on an FTP server.
## Using FTP/SFTP
1. Retrieve your login credentials, FTP/SFTP host, and port parameters.
2. Use the login credentials, FTP/SFTP host, and port parameters with your FTP node credentials in n8n.
3. Click on the ***Save*** button to save your credentials.

77
docs/integrations/builtin/credentials/getResponse.md
View File

@ -1,77 +0,0 @@
# GetResponse
You can use these credentials to authenticate the following nodes with GetResponse.
- [GetResponse](/integrations/builtin/app-nodes/n8n-nodes-base.getResponse/)
- [GetResponse Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.getResponseTrigger/)
## Prerequisites
Create a [GetResponse](https://www.getresponse.com/) account.
## Using OAuth
!!! note "Callback URL with GetResponse"
**Note:** The Redirect URL should be a URL in your domain. For example, `https://mytemplatemaker.example.com/gr_callback`. GetResponse doesn't accept the localhost callback URL. Refer to the [FAQs](#_1-how-to-configure-the-oauth-credentials-for-the-local-environment) to learn to configure the credentials for the local environment.
1. Open your [GetResponse dashboard](https://app.getresponse.com/dashboard).
2. Click on ***Menu*** and select 'Integrations and API'.
3. Click on the ***Custom apps*** tab.
4. Click on the ***Register your app*** button.
5. Enter all the necessary information.
6. Copy your OAuth Callback URL from the 'Create New Credentials' screen in n8n and paste it in the ***Redirect URL*** field.
7. Click on the ***Add*** button.
8. Click on the app you created to get the ***Client ID*** and the ***Client Secret***.
9. Copy the displayed ***Client ID***.
10. Enter a name for your credentials in the ***Credentials Name*** field in the 'GetResponse OAuth2 API' credentials in n8n.
11. Paste the Client ID in the ***Client ID*** field in the 'GetResponse OAuth2 API' credentials in n8n.
12. Copy the ***Client secret key*** from GetResponse.
13. Paste it in the ***Client Secret*** field in the 'GetResponse OAuth2 API' credentials in n8n.
14. Click on the circle button in the OAuth section to connect a GetResponse account to n8n.
15. Click on the ***Save*** button to save your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/UFMpTJyPY4w" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Using API Key
1. Open your [GetResponse dashboard](https://app.getresponse.com/dashboard).
2. Click on ***Menu*** and select 'Integrations and API'.
3. Click on the ***API*** tab.
4. Click on the ***Generate API key*** button.
5. Enter a name for your key.
6. Click on the ***Generate*** button.
7. Copy the displayed ***API key***.
8. Enter a name for your credentials in the ***Credentials Name*** field in the 'GetResponse API' credentials in n8n.
9. Paste the API key in the ***API Key*** field in the 'GetResponse API' credentials in n8n.
10. Click the ***Create*** button to create your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/hs7nwmpQujk" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## FAQs
### How to configure the OAuth credentials for the local environment?
GetResponse doesn't accept the localhost callback URL. However, you can follow the steps mentioned below to configure the OAuth credentials for the local environment:
1. We will use [ngrok](https://ngrok.com/) to expose the local server running on port `5678` to the internet. In your terminal, run the following command:
```sh
ngrok http 5678
```
2. Run the following command in a new terminal. Replace `<YOUR-NGROK-URL>` with the URL that you get from the previous step.
```sh
export WEBHOOK_URL=<YOUR-NGROK-URL>
```
3. Start your n8n instance.
4. Follow the instructions mentioned in the [Using OAuth](#using-oauth) section to configure your credentials.
## Further Reference
- [OAuth 2.0 - Authorization Code](https://apidocs.getresponse.com/v3/case-study/oauth2-authorization-code)
- [Authentication - API key](https://apireference.getresponse.com/#section/Authentication)

29
docs/integrations/builtin/credentials/ghost.md
View File

@ -1,29 +0,0 @@
# Ghost
You can use these credentials to authenticate the following nodes with Ghost.
- [Ghost](/integrations/builtin/app-nodes/n8n-nodes-base.ghost/)
## Prerequisites
Create a [Ghost](https://ghost.org/) account.
## Using Admin API
1. Access your Ghost Admin dashboard.
2. Click on ***Integrations*** in the left sidebar.
3. Click on ***+ Add custom integration*** under the ***CUSTOM INTEGRATIONS*** section.
4. Enter a name for the integration in the ***Name*** field.
5. Click on the ***Create*** button.
6. Use this ***URL*** and ***Admin API Key*** with your Ghost node credentials in n8n.
## Using Content API
1. Access your Ghost Admin dashboard.
2. Click on ***Integrations*** in the left sidebar.
3. Click on ***+ Add custom integration*** under the ***CUSTOM INTEGRATIONS*** section.
4. Enter a name for the integration in the ***Name*** field.
5. Click on the ***Create*** button.
6. Use this ***URL*** and ***Content API Key*** with your Ghost node credentials in n8n.
![Getting Ghost credentials](/_images/integrations/builtin/credentials/ghost/using-api.gif)

22
docs/integrations/builtin/credentials/git.md
View File

@ -1,22 +0,0 @@
# Git
You can use these credentials to authenticate the following nodes with Git.
- [Git](/integrations/builtin/core-nodes/n8n-nodes-base.git/)
## Prerequisites
Create an account on [GitHub](https://github.com), [GitLab](https://about.gitlab.com/), or similar platforms.
## Using Username and Password
1. Enter a name for your credentials in the ***Credentials Name*** field in the 'Git' credentials in n8n.
2. Enter your GitHub, GitLab (or similar platforms) username in the ***Username*** field in the 'Git' credentials in n8n.
3. Enter your GitHub, GitLab (or similar platforms) password in the ***Password*** field in the 'Git' credentials in n8n.
4. Click the ***Create*** button to create your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/RHyW--ZLstE" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

70
docs/integrations/builtin/credentials/github.md
View File

@ -1,70 +0,0 @@
# GitHub
You can use these credentials to authenticate the following nodes with GitHub.
- [GitHub](/integrations/builtin/app-nodes/n8n-nodes-base.github/)
- [GitHub Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.githubTrigger/)
## Prerequisites
Create a [GitHub](https://github.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your GitHub account to n8n.
1. Open your GitHub [dashboard](https://github.com).
2. Click on your user icon in the top right.
3. Click on ***Settings***.
4. Click on ***Developer settings***.
5. Select ***OAuth Apps***.
6. Click on the ***Register a new application*** button.
7. Enter the ***Application name*** and ***Homepage URL***.
8. Copy the ***OAuth Callback URL*** from n8n and paste it in the ***Authorization callback URL*** field.
9. Click on the ***Register application*** button.
10. Copy the displayed 'Client ID'.
11. Enter the name for your credentials in the ***Credentials Name*** field in the 'Github OAuth2 API' credentials in n8n.
12. Paste the client ID in the ***Client ID*** field in the 'Github OAuth2 API' credentials in n8n.
13. On your application page, click on the ***Generate a new client secret*** button.
14. Copy the displayed 'Client Secret'.
15. Paste the client secret in the ***Client Secret*** field in the 'Github OAuth2 API' credentials in n8n.
16. Click on the circle button in the OAuth section to connect a GitHub account to n8n.
17. Click the ***Save*** button to save your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/O1kEes6mQcs" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
The following video demonstrates the steps to authenticate the GitHub node on [n8n Cloud](https://n8n.io/cloud/){:target=_blank .external-link}.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/WtjRxIVVCIg" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Using Access Token
1. Open your GitHub [dashboard](https://github.com).
2. Click on your user icon in the top right.
3. Click on ***Settings***.
4. Click on ***Developer settings***.
5. Select ***Personal access tokens***.
6. Click on ***Generate new token***.
7. Enter a note in the ***Note*** field.
8. Select the relevant scopes from the ***Select scopes*** section.
9. Scroll down to the bottom and click on the ***Generate token*** button.
10. Copy the displayed 'Personal access token'.
11. Enter the name for your credentials in the ***Credentials Name*** field in the 'Github API' credentials in n8n.
12. Enter your GitHub username in the ***User*** field in the 'Github API' credentials in n8n.
13. Paste the access token in the ***Access Token*** field in the 'Github API' credentials in n8n.
14. Click the ***Create*** button to save your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/zookYdMldt4" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

44
docs/integrations/builtin/credentials/gitlab.md
View File

@ -1,44 +0,0 @@
# GitLab
You can use these credentials to authenticate the following nodes with GitLab.
- [GitLab](/integrations/builtin/app-nodes/n8n-nodes-base.gitlab/)
- [GitLab Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.gitlabTrigger/)
## Prerequisites
Create a [GitLab](https://gitlab.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your GitLab account to n8n.
1. Access your GitLab dashboard.
2. Click on your user icon in the top right.
3. Click on 'Settings'.
4. Click on 'Applications' in the sidebar.
5. Enter a name in the ***Name*** field.
6. Copy the 'OAuth Callback URL' provided in the 'Gitlab OAuth2 API' credentials in n8n and paste it in the ***Redirect URI*** field in the GitLab app creation page.
7. Select any scopes you plan to use and then click on ***Save application***.
8. Use the ***Application ID*** and ***Secret*** with your GitLab OAuth2 API credentials in n8n.
9. Click on the circle button in the OAuth section to connect a GitLab account to n8n.
10. Click on the ***Save*** button to save your credentials.
![Getting GitLab OAuth credentials](/_images/integrations/builtin/credentials/gitlab/using-oauth.gif)
## Using Access Token
1. Access your GitLab dashboard.
2. Click on your user icon in the top right.
3. Click on 'Settings'.
4. Click on 'Access Tokens' in the sidebar.
5. Enter a name in the ***Name*** field.
6. Fill out the required information to receive the access token.
7. Select any scopes you plan to use and then click on ***Create personal access token***.
8. Use the generated access token with your GitLab node credentials in n8n.
9. Click on the ***Save*** button to save your credentials.
![Getting GitLab access token](/_images/integrations/builtin/credentials/gitlab/using-access-token.gif)

38
docs/integrations/builtin/credentials/goToWebinar.md
View File

@ -1,38 +0,0 @@
# GoToWebinar
You can use these credentials to authenticate the following nodes with GoToWebinar.
- [GoToWebinar](/integrations/builtin/app-nodes/n8n-nodes-base.goToWebinar/)
## Prerequisites
Create a [GoToWebinar](https://gotowebinar.com/) account.
## Using OAuth
<!-- !!! tip Note for n8n Cloud users
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your GoToWebinar account to n8n.
-->
1. Sign in to the [GoTo Developer Center](https://developer.goto.com/) page.
2. Click on the ***OAuth Clients*** tab.
3. Click on the ***Create a client*** button.
4. Enter a name in the ***Client name*** field.
5. Copy the 'OAuth Callback URL' provided in the 'GoToWebinar OAuth2 API' credentials in n8n.
6. Paste the URL in the ***Redirect URIs*** field and click on the ***Next*** button.
7. Based on your use-case, select the required scopes.
8. Click on the ***Save*** button.
9. Copy the displayed ***Client ID***.
10. Enter a name for your credentials in the ***Credentials Name*** field in the 'GoToWebinar OAuth2 API' credentials in n8n.
11. Paste the client ID in the ***Client ID*** field in the 'GoToWebinar OAuth2 API' credentials in n8n.
12. Copy the displayed ***Client secret*** from the GoTo Client Management Portal.
13. Accept the ***I have stored the client secret*** option and click on the ***Done*** button.
14. Paste the client secret in the ***Client Secret*** field in the 'GoToWebinar OAuth2 API' credentials in n8n.
15. Click on the circle button in the OAuth section to connect a GoToWebinar account to n8n.
16. Click the ***Save*** button to save your credentials in n8n.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/tpauUQ2zTkk" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>

53
docs/integrations/builtin/credentials/google/index.md
View File

@ -1,53 +0,0 @@
# Google
This section contains:
* [OAuth2 single service](/integrations/builtin/credentials/google/oauth-single-service/): create an OAuth2 credential for a specific service node, such as the Gmail node.
* [OAuth2 generic](/integrations/builtin/credentials/google/oauth-generic/): create an OAuth2 credential for use with [custom operations](/integrations/custom-operations/).
* [Service Account](/integrations/builtin/credentials/google/service-account/): create a Service Account credential.
## OAuth2 and Service Account
There are two authentication methods available for Google services nodes, [OAuth2](https://developers.google.com/identity/protocols/oauth2){:target=_blank .external-link} and [Service Account](https://cloud.google.com/iam/docs/understanding-service-accounts){:target=_blank .external-link}. Usually, n8n recommends using OAuth. It's more widely available, and easier to set up. Refer to the [Google documentation: Understanding service accounts](https://cloud.google.com/iam/docs/understanding-service-accounts){:target=_blank .external-link} for guidance on when you need service account.
## Compatible nodes
Once configured, you can use your credentials to authenticate the following nodes. Most nodes are compatible with OAuth2 authentication. Support for Service Account authentication is limited.
??? Details "Compatibility"
| Node | OAuth | Service Account |
| :--- | :---: | :-------------: |
| [G Suite Admin](/integrations/builtin/app-nodes/n8n-nodes-base.gSuiteAdmin/) | :white_check_mark: | :x: |
| [Google Ads](/integrations/builtin/app-nodes/n8n-nodes-base.googleAds/) | :white_check_mark: | :x: |
| [Gmail](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/) | :white_check_mark: | :white_check_mark: |
| [Google Analytics](/integrations/builtin/app-nodes/n8n-nodes-base.googleAnalytics/) | :white_check_mark: | :x: |
| [Google BigQuery](/integrations/builtin/app-nodes/n8n-nodes-base.googleBigQuery/) | :white_check_mark: | :x: |
| [Google Books](/integrations/builtin/app-nodes/n8n-nodes-base.googleBooks/) | :white_check_mark: | :white_check_mark: |
| [Google Calendar](/integrations/builtin/app-nodes/n8n-nodes-base.googleCalendar/) | :white_check_mark: | :x: |
| [Google Chat](/integrations/builtin/app-nodes/n8n-nodes-base.googleChat/) | :x: | :white_check_mark: |
| [Google Cloud Storage](/integrations/builtin/app-nodes/n8n-nodes-base.googleCloudStorage/) | :white_check_mark: | :x: |
| [Google Contacts](/integrations/builtin/app-nodes/n8n-nodes-base.googleContacts/) | :white_check_mark: | :x: |
| [Google Cloud Firestore](/integrations/builtin/app-nodes/n8n-nodes-base.googleCloudFirestore/) | :white_check_mark: | :x: |
| [Google Cloud Natural Language](/integrations/builtin/app-nodes/n8n-nodes-base.googleCloudNaturalLanguage/) | :white_check_mark: | :x: |
| [Google Cloud Realtime Database](/integrations/builtin/app-nodes/n8n-nodes-base.googleCloudRealtimeDatabase/) | :white_check_mark: | :x: |
| [Google Docs](/integrations/builtin/app-nodes/n8n-nodes-base.googleDocs/) | :white_check_mark: | :white_check_mark: |
| [Google Drive](/integrations/builtin/app-nodes/n8n-nodes-base.googleDrive/) | :white_check_mark: | :white_check_mark: |
| [Google Drive Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.googleDriveTrigger/) | :white_check_mark: | :white_check_mark: |
| [Google Perspective](/integrations/builtin/app-nodes/n8n-nodes-base.googlePerspective/) | :white_check_mark: | :x: |
| [Google Sheets](/integrations/builtin/app-nodes/n8n-nodes-base.googleSheets/) | :white_check_mark: | :white_check_mark: |
| [Google Slides](/integrations/builtin/app-nodes/n8n-nodes-base.googleSlides/) | :white_check_mark: | :white_check_mark: |
| [Google Tasks](/integrations/builtin/app-nodes/n8n-nodes-base.googleTasks/) | :white_check_mark: | :x: |
| [Google Translate](/integrations/builtin/app-nodes/n8n-nodes-base.googleTranslate/) | :white_check_mark: | :white_check_mark: |
| [YouTube](/integrations/builtin/app-nodes/n8n-nodes-base.youTube/) | :white_check_mark: | :x: |
!!! note "Note for n8n Cloud users"
For the following nodes, you can authenticate by entering the **Credentials Name** and selecting **Sign in with Google** in the OAuth section to connect your Google account to n8n:
* [Google Calendar](/integrations/builtin/app-nodes/n8n-nodes-base.googleCalendar/)
* [Google Contacts](/integrations/builtin/app-nodes/n8n-nodes-base.googleContacts/)
* [Google Sheets](/integrations/builtin/app-nodes/n8n-nodes-base.googleSheets/)
* [Google Tasks](/integrations/builtin/app-nodes/n8n-nodes-base.googleTasks/)

82
docs/integrations/builtin/credentials/google/oauth-generic.md
View File

@ -1,82 +0,0 @@
# Google: OAuth2 generic
This document contains instructions for creating a generic OAuth2 Google credential for use with [custom operations](/integrations/custom-operations/).
## Prerequisites
* [Google Cloud](https://cloud.google.com/){:targe=_blank .external-link} account
* [Google Cloud Platform project](https://developers.google.com/workspace/marketplace/create-gcp-project){:targe=_blank .external-link}
* If using Google Perspective: [Request API Access](https://developers.perspectiveapi.com/s/docs-get-started){:targe=_blank .external-link}
* If using Google Ads: [Developer Token](https://developers.google.com/google-ads/api/docs/first-call/dev-token){:targe=_blank .external-link}
## Set up OAuth
### Create a new credential in n8n
1. Follow the steps to [Create a credential](/credentials/add-edit-credentials/). If you create a credential by selecting **Create new** in the credentials dropdown in a node, n8n automatically creates the correct credential type for that node. If you select **Credentials > New**, you must browse for the credential type. To create a credential for a [custom API call](/integrations/custom-operations/), select **Google OAuth2 API**. This allows you to create a generic credential, then set its scopes.
2. Note the **OAuth Redirect URL** from the node credential modal. You'll need this in the next section.
![OAuth Callback URL](/_images/integrations/builtin/credentials/google/oauth_callback.png)
3. You must provide the scopes for this credential. Refer to [Scopes](#scopes) for more information.
### Set up OAuth in Google Cloud
1. Go to [Google Cloud Console](https://console.cloud.google.com/apis/credentials){:target=_blank .external-link} and make sure you're in the project you want to use.
2. Select **+ CREATE CREDENTIALS > OAuth client ID**. If you're creating OAuth credentials for the first time, you must [configure the consent screen](https://support.google.com/cloud/answer/10311615?hl=en&ref_topic=3473162){:target=_blank .external-link}.
3. In the **Application type** dropdown, select **Web application**. Google automatically generates a name.
4. In Google Cloud, select **+ ADD URI**. Paste in the OAuth redirect URL from the previous step.
5. Select **CREATE**.
6. Enable each Google service API that you want to use:
--8<-- "_snippets/integrations/builtin/credentials/google/enable-apis.md"
### Create and test your connection
In n8n:
1. Enter your new **Client ID** and **Client Secret** from Google Cloud Console in the credentials modal.
2. Select **Sign in with Google** to complete your Google authentication.
3. **Save** your new credentials.
The following video demonstrates the steps described above:
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/gZ6N2H3_vys" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Scopes
Many Google services have multiple possible access scopes. A scope limits what a user can do. Refer to [OAuth 2.0 Scopes for Google APIs](https://developers.google.com/identity/protocols/oauth2/scopes){:target=_blank .external-link} for a list of scopes for all services.
n8n doesn't support all scopes. When creating a generic Google OAuth2 API credential, you can enter scopes from the list. If you enter a scope that n8n doesn't already support, it won't work.
??? Details "Supported scopes"
| Service | Available scopes |
| ------- | ---------------- |
| Gmail | https://www.googleapis.com/auth/gmail.labels <br /> https://www.googleapis.com/auth/gmail.addons.current.action.compose <br /> https://www.googleapis.com/auth/gmail.addons.current.message.action <br /> https://mail.google.com/ <br /> https://www.googleapis.com/auth/gmail.modify <br /> https://www.googleapis.com/auth/gmail.compose |
| Google Ads | https://www.googleapis.com/auth/adwords |
| Google Analytics | https://www.googleapis.com/auth/analytics <br /> https://www.googleapis.com/auth/analytics.readonly |
| Google Big Query | https://www.googleapis.com/auth/bigquery |
| Google Books | https://www.googleapis.com/auth/books |
| Google Calendar | https://www.googleapis.com/auth/calendar <br /> https://www.googleapis.com/auth/calendar.events |
| Google Cloud Natural Language | https://www.googleapis.com/auth/cloud-language <br /> https://www.googleapis.com/auth/cloud-platform |
| Google Cloud Storage | https://www.googleapis.com/auth/cloud-platform <br /> https://www.googleapis.com/auth/cloud-platform.read-only <br /> https://www.googleapis.com/auth/devstorage.full_control <br /> https://www.googleapis.com/auth/devstorage.read_only <br /> https://www.googleapis.com/auth/devstorage.read_write |
| Google Contacts | https://www.googleapis.com/auth/contacts |
| Google Docs | https://www.googleapis.com/auth/documents <br /> https://www.googleapis.com/auth/drive <br /> https://www.googleapis.com/auth/drive.file |
| Google Drive | https://www.googleapis.com/auth/drive <br /> https://www.googleapis.com/auth/drive.appdata <br /> https://www.googleapis.com/auth/drive.photos.readonly |
| Google Firebase Cloud Firestore | https://www.googleapis.com/auth/datastore <br /> https://www.googleapis.com/auth/firebase |
| Google Firebase Realtime Database | https://www.googleapis.com/auth/userinfo.email <br /> https://www.googleapis.com/auth/firebase.database <br /> https://www.googleapis.com/auth/firebase |
| Google Perspective | https://www.googleapis.com/auth/userinfo.email |
| Google Sheets | https://www.googleapis.com/auth/drive.file <br /> https://www.googleapis.com/auth/spreadsheets |
| Google Slide | https://www.googleapis.com/auth/drive.file <br /> https://www.googleapis.com/auth/presentations |
| Google Tasks | https://www.googleapis.com/auth/tasks |
| Google Translate | https://www.googleapis.com/auth/cloud-translation |
| GSuite Admin | https://www.googleapis.com/auth/admin.directory.group <br /> https://www.googleapis.com/auth/admin.directory.user <br /> https://www.googleapis.com/auth/admin.directory.domain.readonly <br /> https://www.googleapis.com/auth/admin.directory.userschema.readonly |
## Troubleshooting
### Google hasn't verified this app
If using the OAuth authentication method, you might see the warning **Google hasn't verified this app**. To avoid this, you can create OAuth credentials from the same account you want to authenticate. However, if you're using credentials that were generated by another account (by a developer or another third party), do the following in Google Cloud:
1. Select**Advanced**.
2. Select **Go to CREDENTIALS_NAME (unsafe)**. `CREDENTIALS_NAME` is the name of the credentials created by the third party.
3. Grant the requested permissions.

55
docs/integrations/builtin/credentials/google/oauth-single-service.md
View File

@ -1,55 +0,0 @@
# Google: OAuth2 single service
This document contains instructions for creating a Google credential for a single service.
## Prerequisites
* [Google Cloud](https://cloud.google.com/){:targe=_blank .external-link} account
* [Google Cloud Platform project](https://developers.google.com/workspace/marketplace/create-gcp-project){:targe=_blank .external-link}
* If using Google Perspective: [Request API Access](https://developers.perspectiveapi.com/s/docs-get-started){:targe=_blank .external-link}
* If using Google Ads: [Developer Token](https://developers.google.com/google-ads/api/docs/first-call/dev-token){:targe=_blank .external-link}
## Set up OAuth
### Create a new credential in n8n
1. Follow the steps to [Create a credential](/credentials/add-edit-credentials/). If you create a credential by selecting **Create new** in the credentials dropdown in a node, n8n automatically creates the correct credential type for that node. If you select **Credentials > New**, you must browse for the credential type. To connect with a specific service, using resources and operations supported by n8n, choose that service. For example, to create a credential for use in the Gmail node, search for `Gmail`.
2. Note the **OAuth Redirect URL** from the node credential modal. You'll need this in the next section.
![OAuth Callback URL](/_images/integrations/builtin/credentials/google/oauth_callback.png)
### Set up OAuth in Google Cloud
1. Go to [Google Cloud Console](https://console.cloud.google.com/apis/credentials){:target=_blank .external-link} and make sure you're in the project you want to use.
![Google project dropdown](/_images/integrations/builtin/credentials/google/check-google-project.png)
2. Select **+ CREATE CREDENTIALS > OAuth client ID**. If you're creating OAuth credentials for the first time, you must [configure the consent screen](https://support.google.com/cloud/answer/10311615?hl=en&ref_topic=3473162){:target=_blank .external-link}.
![Create credentials](/_images/integrations/builtin/credentials/google/create-credentials.png)
3. In the **Application type** dropdown, select **Web application**. Google automatically generates a name.
4. In Google Cloud, select **+ ADD URI**. Paste in the OAuth redirect URL from the previous step.
5. Select **CREATE**.
6. Enable each Google service API that you want to use:
--8<-- "_snippets/integrations/builtin/credentials/google/enable-apis.md"
### Create and test your connection
In n8n:
1. Enter your new **Client ID** and **Client Secret** from Google Cloud Console in the credentials modal.
2. Select **Sign in with Google** to complete your Google authentication.
3. **Save** your new credentials.
The following video demonstrates the steps described above:
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/gZ6N2H3_vys" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Troubleshooting
### Google hasn't verified this app
If using the OAuth authentication method, you might see the warning **Google hasn't verified this app**. To avoid this, you can create OAuth credentials from the same account you want to authenticate. However, if you're using credentials that were generated by another account (by a developer or another third party), do the following in Google Cloud:
1. Select**Advanced**.
2. Select **Go to CREDENTIALS_NAME (unsafe)**. `CREDENTIALS_NAME` is the name of the credentials created by the third party.
3. Grant the requested permissions.

70
docs/integrations/builtin/credentials/google/service-account.md
View File

@ -1,70 +0,0 @@
# Google: Service Account
Using service accounts is more complex than OAuth2. Before you begin:
* Check if your node is [compatible](/integrations/builtin/credentials/google/#compatible-nodes) with Service Account.
* Make sure you really need to use service account. For most use cases, OAuth2 is a better option.
* Read the Google documentation on [Creating and managing service accounts](https://cloud.google.com/iam/docs/creating-managing-service-accounts){:target=_blank .external-link}.
## Prerequisites
* [Google Cloud](https://cloud.google.com/){:targe=_blank .external-link} account
* [Google Cloud Platform project](https://developers.google.com/workspace/marketplace/create-gcp-project){:targe=_blank .external-link}
## Set up Service Account
### Create a new credential in n8n
1. Follow the steps to [Create a credential](/credentials/add-edit-credentials/).
!!! note "Generic and specific credentials"
If you create a credential by selecting **Create new** in the credentials dropdown in a node, n8n automatically creates the correct credential type for that node. If you select **Credentials > New**, you must browse for the credential type:
* To connect with a specific service, using resources and operations supported by n8n, choose that service. For example, to create a credential for use in the Gmail node, search for `Gmail`.
* To create a credential for a [custom API call](/integrations/custom-operations/), select **Google API**.
2. Note the **Private Key** from the node credential modal. You'll need this in the next section.
### Set up service account in Google Cloud
In your [Google Cloud Console](https://console.cloud.google.com){:target=_blank .external-link} dashboard:
1. Select the hamburger menu **> APIs & Services > Credentials**. Google takes you to your **Credentials** page.
2. Select **+ CREATE CREDENTIALS > Service account**.
3. Enter a name in **Service account name**, and an ID in **Service account ID**. Refer to [Creating a service account](https://cloud.google.com/iam/docs/creating-managing-service-accounts?hl=en#creating){:target=_blank .external-link} for more information.
4. Select **CREATE AND CONTINUE**.
5. Based on your use-case, you may want to **Select a role** and **Grant users access to this service account** using the corresponding sections.
6. Select **DONE**.
7. Select your newly created service account under the **Service Accounts** section. Open the **KEYS** tab.
8. Select **ADD KEY > Create new key**.
9. In the modal that appears, select **JSON**, then select **CREATE**. Google saves the file to your computer.
10. Enable each Google service API that you want to use:
--8<-- "_snippets/integrations/builtin/credentials/google/enable-apis.md"
### Create and test your connection
In n8n:
1. In the **Service Account Email** field, enter the email associated with your new Service Account (you can find this in the **Details** tab in Google Cloud).
2. Enter the **Private Key** from the downloaded JSON file. If you're running an n8n version older than 0.156.0: replace all instances of `\n` in the JSON file with new lines.
3. **Optional**: Click the toggle to enable [**Impersonate a User**](https://developers.google.com/identity/protocols/oauth2/service-account#delegatingauthority){:target=_blank .external-link} and enter the email.
4. **Save** your credentials.
The following video demonstrates the steps described above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/ArXVlpo3y1k" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Troubleshooting
### Service Account cannot access Google Drive files
A Service Account can't access Google Drive files and folders that weren't shared with its associated user email.
1. Access your [Google Cloud Console](https://console.cloud.google.com){:target=_blank .external-link} and copy your Service Account email.
2. Access your [Google Drive](https://drive.google.com){:target=_blank .external-link} and go to the designated file or folder.
3. Right-click on the file or folder and select **Share**.
4. Paste your Service Account email into **Add People and groups**.
5. Select **Editor** for read-write access or **Viewer** for read-only access.

27
docs/integrations/builtin/credentials/gotify.md
View File

@ -1,27 +0,0 @@
# Gotify
You can use these credentials to authenticate the following nodes with Gotify.
- [Gotify](/integrations/builtin/app-nodes/n8n-nodes-base.gotify/)
## Prerequisites
Install [Gotify](https://gotify.net/docs/install) on your server.
## Using API Token
***Note:*** To create a message, the ***App API Token*** is required. To delete or retrieve all messages, you need the ***Client API Token***.
1. Access your Gotify dashboard.
2. Click on ***APPS*** in the navigation menu.
3. Click on the ***CREATE APPLICATION*** button.
4. Enter an application name in the ***Name*** field.
5. Click on the ***CREATE*** button.
6. Click on ***CLIENTS*** in the navigation menu.
7. Click on the ***CREATE CLIENT*** button.
8. Enter a name for the client in the ***Name*** field.
9. Click on the ***CREATE*** button.
10. Use the App Token, Client Token, and the Host URL with your Gotify API credentials in n8n.
11. Click the ***Save*** button to save your credentials in n8n.
![Getting Gotify credentials](/_images/integrations/builtin/credentials/gotify/using-api.gif)

17
docs/integrations/builtin/credentials/grafana.md
View File

@ -1,17 +0,0 @@
# Grafana
You can use these credentials to authenticate the following nodes with Grafana.
- [Grafana](/integrations/builtin/app-nodes/n8n-nodes-base.grafana/)
## Prerequisites
- Create a [Grafana](https://grafana.com/) account.
## Using Access Token
1. In Grafana, click the gears icon in the sidebar on the left and select the ***API Keys*** option.
2. Click the "Add API key" button and enter any ***Key name***.
3. Click ***Add*** and copy the key shown.
4. Use the key with your Grafana credentials in n8n.
5. Enter the base URL of your instance (e.g. `https://n8n.grafana.net`) in n8n.

24
docs/integrations/builtin/credentials/grist.md
View File

@ -1,24 +0,0 @@
# Grist
You can use these credentials to authenticate the following nodes:
* [Grist](/integrations/builtin/app-nodes/n8n-nodes-base.grist/).
## Prerequisites
Create a [Grist](https://getgrist.com/) account.
## API key
From Grist:
1. Navigate to your **Profile Settings**.
2. In the *Api key* section click **Create**.
3. Copy the generated API key for use in n8n.
From n8n:
3. Enter the **API Key** obtained above.
4. Use the dropdown to select if your are using a *Free* or *Paid* plan.
5. For *Paid* plans, enter your **Custom Subdomain** (e.g. `<subdomain>.getgrist.com`).
6. Click on the ***Create*** button to create the credentials.

21
docs/integrations/builtin/credentials/gumroad.md
View File

@ -1,21 +0,0 @@
# Gumroad
You can use these credentials to authenticate the following nodes with Gumroad.
- [Gumroad Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.gumroadTrigger/)
## Prerequisites
Create a [Gumroad](https://gumroad.com/) account.
## Using Access Token
1. Access your Gumroad dashboard.
2. Click on your user icon on the top right.
3. Click on Settings.
4. Click on the Advanced tab.
5. Scroll down and fill out the required fields and create a new application..
6. From here, you have access the ability to generate an access token.
7. Use provided access token with your Gumroad node credentials in n8n.
![Getting Gumroad credentials](/_images/integrations/builtin/credentials/gumroad/using-access-token.gif)

29
docs/integrations/builtin/credentials/haloPSA.md
View File

@ -1,29 +0,0 @@
# HaloPSA
You can use these credentials to authenticate the following nodes with HaloPSA.
- [HaloPSA](/integrations/builtin/app-nodes/n8n-nodes-base.haloPSA/)
## Prerequisites
Create a [HaloPSA](https://halopsa.com/) account.
## Allow your application to use the API:
1. Access your HaloPSA dashboard.
2. Click on the **Configuration** link in the left panel.
3. Under the **Integrations** menu entry, click on **HaloPSA API**.
4. In the **API Details** section you find the values **Resource Server**, **Authorisation Server**, and **Tenant**.
5. In the **Applications** section click on the **View Applications** button.
6. Click on the **New** button to register a new application or click on an existing one and then the **Edit** button to edit it.
7. Enter a name for your application (for example `n8n`).
8. Choose `Client ID and Secret (Services)` as the **Authentication Method**.
9. Make a note of both the **Client ID** and the **Client Secret**. The Client Secret will only be shown once and you will need to generate a new one when lost.
10. Select `Agent` as your **Login Type** and one of your agents in the **Agent to log in as** field.
11. On the **Permissions** tab, tick `all` and hit the **Save** button.
12. On n8n's HaloPSA credentials screen, fill in the values obtained in the previous steps. The **Tenant** field will be accessible only when the **Hosting Type** is set to `Hosted Solution of Halo`.
![A workflow with the HaloPSA node](/_images/integrations/builtin/credentials/halopsa/halopsa-n8n-credentials.jpg)
!['Resource Server', 'Authorisation Server', 'and Tenant'](/_images/integrations/builtin/credentials/halopsa/halopsa-credentials-1.jpg)
!['Cliend ID' and 'Client Secret'](/_images/integrations/builtin/credentials/halopsa/halopsa-credentials-2.jpg)

32
docs/integrations/builtin/credentials/harvest.md
View File

@ -1,32 +0,0 @@
# Harvest
You can use these credentials to authenticate the following nodes with Harvest.
- [Harvest](/integrations/builtin/app-nodes/n8n-nodes-base.harvest/)
## Prerequisites
Create a [Harvest](https://www.getharvest.com/) account.
## Using OAuth
1. Access the [Harvest Developer](https://id.getharvest.com/developers) portal.
2. Click on the ***Create New OAuth2 Application*** button.
3. Enter an application name in the ***Name*** field.
4. Copy the 'OAuth Callback URL' provided in the Harvest OAuth2 API credentials in n8n and paste it in the ***Redirect URL*** field.
5. Click on the ***Create Application*** button.
6. Copy the ***Client ID*** and ***Client Secret*** provided by the new Harvest app that you created and paste it in the Harvest OAuth2 API credentials in n8n.
7. Click on the circle button in the OAuth section to connect your Harvest account to n8n.
8. Click on the ***Save*** button to save your credentials.
![Getting Harvest OAuth2 credentials](/_images/integrations/builtin/credentials/harvest/using-oauth.gif)
## Using Access Token
1. Access the [Harvest Developer](https://id.getharvest.com/developers) portal.
2. Click on the ***Create New Personal Access Token*** button.
3. Enter a token name in the ***Name*** field.
4. Click on the ***Create Personal Access Token*** button.
5. Use the token with Harvest node credentials in n8n.
![Getting Harvest Access Token credentials](/_images/integrations/builtin/credentials/harvest/using-access-token.gif)

29
docs/integrations/builtin/credentials/helpScout.md
View File

@ -1,29 +0,0 @@
# Help Scout
You can use these credentials to authenticate the following nodes with Help Scout.
- [Help Scout](/integrations/builtin/app-nodes/n8n-nodes-base.helpScout/)
- [Help Scout Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.helpScoutTrigger/)
## Prerequisites
Create a [Help Scout](https://www.helpscout.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Help Scout account to n8n.
1. Log in to your Help Scout account.
2. Click on the user icon in the top right.
3. Select 'Your Profile' in the drop down menu.
4. Click on 'My Apps' in the sidebar.
5. Click on the *Create My App* button.
6. Copy the 'OAuth Callback URL' provided in the HelpScout OAuth2 API credentials in n8n and paste it in the 'Redirection URL' field in Help Scout.
7. Fill out any other information that is necessary and click 'Create'.
8. Click on the *Save* button and use the 'App ID' and the 'App Secret' with your HelpScout OAuth2 API credentials in n8n.
9. Click on the circle button in the OAuth section to connect a Help Scout account to n8n.
10. Click the *Save* button to save your credentials.
![Getting Help Scout OAuth credentials](/_images/integrations/builtin/credentials/helpscout/using-oauth.gif)

15
docs/integrations/builtin/credentials/highLevel.md
View File

@ -1,15 +0,0 @@
# HighLevel
You can use these credentials to authenticate the following nodes with HighLevel:
* [HighLevel node](/integrations/builtin/app-nodes/n8n-nodes-base.highLevel/)
## Prerequisites
Sign up for a HighLevel account.
## Using an API key
1. Follow the guidance in the [HighLevel documentation](https://help.gohighlevel.com/support/solutions/articles/48001060529-highlevel-api){:target=_blank .external-link} to get your API key.
2. Copy the key into the **API Key** field in your n8n HighLevel credentials.

18
docs/integrations/builtin/credentials/homeAssistant.md
View File

@ -1,18 +0,0 @@
# Home Assistant
You can use these credentials to authenticate the following nodes with Home Assistant.
- [Home Assistant](/integrations/builtin/app-nodes/n8n-nodes-base.homeAssistant/)
## Prerequisites
- [Install](https://www.home-assistant.io/installation/) Home Assistant
- Create a [Home Assistant](https://www.home-assistant.io/getting-started/onboarding) account.
- Review the Home Assistant [Autentication API](https://developers.home-assistant.io/docs/auth_api) documentation
## Using access token
1. Access your Home Assistant UI, for example `homeassistant.local:8123`.
2. Open your user profile page and navigate to the **Long-Lived Access Tokens** section.
3. Generate a new token and copy it.
4. Use that token with your Home Assistant node credentials in n8n.

77
docs/integrations/builtin/credentials/httpRequest.md
View File

@ -1,77 +0,0 @@
# HTTP Request
You can use these credentials to authenticate the following nodes:
- [HTTP Request](/integrations/builtin/core-nodes/n8n-nodes-base.httpRequest/)
## Prerequisites
You must use the authentication method required by the app or service you want to query.
### Existing credential types
n8n recommends using this option whenever there's a credential type available for the service you want to connect to. It offers an easier way to set up and manage credentials, compared to configuring generic credentials.
You can use [Predefined credential types](/integrations/custom-operations/#predefined-credential-types) to perform custom operations with some APIs where n8n has a node for the platform. For example, n8n has an Asana node, and supports using your Asana credentials in the HTTP Request node. Refer to [Custom operations](/integrations/custom-operations/) for more information.
### Generic authentication
The following generic authentication methods are available:
* Basic Auth
* Digest Auth
* Header Auth
* OAuth1
* OAuth2
* None
You can learn more about HTTP authentication [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#see_also){:target=_blank .external-link}.
## Using an existing credential type
--8<-- "_snippets/integrations/predefined-credential-type-how-to.md"
Refer to [Custom API operations](/integrations/custom-operations/) for more information.
## Using Basic Auth or Digest Auth
1. Update the credential name.
2. Enter the **Username** and **Password** for the app or service your HTTP Request is targeting.
3. Select **Save** to save your credentials.
## Using Header Auth
1. Update the credential name.
2. Enter the header **Name** and **Value** required for the app or service your HTTP Request is targeting. Read more about [HTTP headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers#authentication){:target=_blank .external-link}.
3. Select **Save** to save your credentials.
## Using OAuth1
1. Update the credential name.
2. Enter the following authentication details:
* **Authorization URL**
* **Access Token URL**
* **Consumer Key**
* **Consumer Secret**
* **Request Token URL**
* **Signature Method**
3. Select **Save** to save your credentials.
Read more about [OAuth1](https://oauth.net/1/){:target=_blank .external-link}.
## Using OAuth2
1. Update the credential name.
2. Enter the following authentication details:
* **Authorization URL**
* **Access Token URL**
* **Client ID**
* **Client Secret**
* **Scope**
* **Auth URI Query Parameters**
* **Authentication**
3. Select **Save** to save your credentials.
Read more about [OAuth2](https://oauth.net/2/){:target=_blank .external-link}.

83
docs/integrations/builtin/credentials/hubspot.md
View File

@ -1,83 +0,0 @@
# HubSpot
You can use these credentials to authenticate the following nodes with HubSpot.
- [HubSpot](/integrations/builtin/app-nodes/n8n-nodes-base.hubspot/)
- [HubSpot Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.hubSpotTrigger/)
## Prerequisites
Create a [HubSpot](https://www.hubspot.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your HubSpot account to n8n.
!!! warning "⚠ HubSpot old accounts"
Some HubSpot accounts don't have access to all the scopes. HubSpot is migrating accounts gradually. If you can't' find all the scopes in your current HubSpot developer account, try creating a fresh developer account.
1. Access your [HubSpot Developer Home](https://developers.hubspot.com/).
2. Click on the **Manage apps** button.
3. Click on the **Create app** button in the top right.
4. Specify an app name in the **Public app name** field.
5. Click on the 'Auth' tab.
6. Use the provided **Client ID** and the **Client secret** with your HubSpot OAuth2 API credentials in n8n.
7. If you are using the [HubSpot Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.hubSpotTrigger/) node, copy the **App ID** along with the information in the previous step.
8. Copy your OAuth Callback URL from the 'Create New Credentials' screen in n8n and paste in the **Redirect URL** section.
!!! note "Exact scope needed"
If you grant access to more or less scopes than listed below, this might cause an issue with the authentication step. Make sure to only include what is listed below.
9. In the Scopes section, select the following scopes in the **Find a scope** search box:
* Trigger node:
* oauth
* crm.objects.contacts (read),
* crm.schemas.contacts (read),
* crm.objects.companies (read),
* crm.schemas.companies (read),
* crm.objects.deals (read),
* crm.schemas.deals (read),
* Regular node:
* oauth
* crm.schemas.deals (read),
* crm.objects.owners (read),
* crm.objects.contacts (write),
* crm.objects.companies (write),
* crm.objects.companies (read),
* crm.objects.deals (read),
* crm.schemas.contacts (read),
* crm.objects.deals (write),
* crm.objects.contacts (read),
* crm.schemas.companies (read),
* forms,
* tickets,
10. Click on the **Save** button to save your settings in HubSpot.
11. Back in n8n, click on the circle button in the OAuth section to connect your HubSpot account to n8n.
12. Click the **Save** button to save your credentials.
## Using API key
1. Access your HubSpot dashboard.
2. Click on the gear icon on the top right.
3. Click on **Integrations** and then **API key**.
4. Click on the **Create key** button.
5. Use the key with HubSpot node credentials in n8n.
## Using APP Token
1. Follow the instructions in the [Private Apps Documentation](https://developers.hubspot.com/docs/api/private-apps) to get your access token.
2. Set the access token as the key in your HubSpot credentials in n8n.
## Using Developer API Key (for HubSpot Trigger node)
1. Access your [HubSpot Developer Home](https://developers.hubspot.com/).
2. Click on **Apps** in the top bar.
3. Click on the **Get HubSpot API key** button.
4. Click on the **Show key** button.
5. Use the displayed Developer API key with your HubSpot Trigger node credentials in n8n.

17
docs/integrations/builtin/credentials/humanticAi.md
View File

@ -1,17 +0,0 @@
# Humantic AI
You can use these credentials to authenticate the following nodes with Humantic AI.
- [Humantic AI](/integrations/builtin/app-nodes/n8n-nodes-base.humanticAi/)
## Using API
1. Access the [Humantic AI API](https://api.humantic.ai/) page.
2. Enter your email address in the ***Business Email*** field.
3. Click on the ***GET API KEY*** button.
4. Enter all the necessary information.
5. Click on the ***Get API Key*** button.
6. Set a password for your account and click on the ***SET PASSWORD*** button.
7. Use the provided ***api key*** with your Humantic AI API credentials in n8n.
![Getting Humantic AI credentials](/_images/integrations/builtin/credentials/humanticai/using-api-key.gif)

18
docs/integrations/builtin/credentials/hunter.md
View File

@ -1,18 +0,0 @@
# Hunter
You can use these credentials to authenticate the following nodes with Hunter.
- [Hunter](/integrations/builtin/app-nodes/n8n-nodes-base.hunter/)
## Prerequisites
Create a [Hunter](https://www.hunter.io/) account.
## Using Access Token
1. Access your Hunter dashboard.
2. Click on your profile icon on the top right.
3. Click on API.
4. Use the key with Hunter node credentials in n8n.
![Getting Hunter credentials](/_images/integrations/builtin/credentials/hunter/using-access-token.gif)

104
docs/integrations/builtin/credentials/imap.md
View File

@ -1,104 +0,0 @@
# IMAP
You can use these credentials to authenticate the following nodes with IMAP.
- [IMAP Email](/integrations/builtin/core-nodes/n8n-nodes-base.imapEmail/)
## Prerequisites
Create an email account on a service with IMAP support.
## Using IMAP
1. Retrieve your login credentials and IMAP connection parameters.
2. Use the login credentials and IMAP connection parameters with your IMAP Email node credentials in n8n.
3. Click on the ***Save*** button to save your credentials.
## Using Gmail
1. Access your [Gmail](https://mail.google.com) account.
2. Click on the gears icon on the top and click on ***See all settings***.
3. Click on the ***Forwarding and POP/IMAP*** tab.
4. Under the ***IMAP access*** section, select 'Enable IMAP'.
5. Click on the ***Save Changes*** button.
6. Go to your [Google Account](https://myaccount.google.com) page.
7. Click on ***Security*** on the left sidebar.
8. Click on ***2-Step Verification*** under the ***Signing in to Google*** section.
9. Set up your 2-Step Verification method.
10. Click on ***App passwords*** under the ***Signing in to Google*** section.
11. Select 'Mail' from the ***Select app*** dropdown list.
12. Select 'Other' from the ***Select device*** dropdown list.
13. Enter a name in the text field.
14. Click on the ***GENERATE*** button.
15. Copy the displayed password.
16. In the IMAP node credentials, enter your email address in the ***User*** field. For example, `example@gmail.com`.
17. Paste the App password you copied in **Step 15** in the ***Password*** field.
18. Enter `imap.gmail.com` in the ***Host*** field.
19. Toggle ***SSL/TLS*** to `true`.
20. Click on ***Save*** to save your credentials.
**Note:** Before executing the node, set the ***Ignore SSL Issues*** option to true as the Gmail certificate is self-signed.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/q4KUTgiglvE" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Using Yahoo Mail
1. Open your [Yahoo Mail](https://mail.yahoo.com) account.
2. Click on your avatar on the top right and select 'Account info'.
3. Click on the ***Account security*** tab in the left sidebar.
4. Scroll down to the bottom and click on ***Generate app password***.
5. Select 'Other app' from the ***Select your app*** dropdown list.
6. Enter the name of the app in the ***Enter custom name*** field.
7. Click on the ***Generate*** button.
8. Copy the displayed password.
9. Enter the name for your credentials in the ***Credentials Name*** field in the 'IMAP' credentials in n8n.
10. Enter your email address in the ***User*** field.
11. Paste the password you copied earlier in the ***Password*** field.
12. Enter `imap.mail.yahoo.com` in the ***Host*** field.
13. Toggle ***SSL/TLS*** to `true`.
14. Click on ***Save*** to save your credentials.
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/2SFGl3xBdOA" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## Using Outlook.com
1. Enter the name for your credentials in the ***Credentials Name*** field in the 'IMAP' credentials in n8n.
2. Enter your email address in the ***User*** field.
3. Enter your account password in the ***Password*** field.
4. Enter `outlook.office365.com` in the ***Host*** field.
5. Toggle ***SSL/TLS*** to `true`.
6. Click on ***Create*** to create your credentials.
**Note** If you get a connection error, please follow the steps mentioned in the [FAQs](#how-to-solve-the-connection-error-when-connecting-to-outlook-com).
The following video demonstrates the steps mentioned above.
<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/gCWiILtHnPQ" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
## FAQs
### How to solve the connection error when connecting to Outlook.com?
If you receive a connection error while configuring the credentials for your Outlook account, follow the steps mentioned below:
1. Go to [account.live.com/activity](https://account.live.com/activity).
2. Sign in using the email address and password of your account.
3. Under the ***Recent activity*** section, find the Session Type event that matches the most recent time you received the connection error and click to expand it.
4. Select ***This was me*** to let the system know you authorize the IMAP connection.
- [Set up IMAP for Gmail account](https://support.google.com/mail/answer/7126229?hl=en)
- [Sign in with App Passwords for your Gmail Account](https://support.google.com/accounts/answer/185833?hl=en)
- [Set up IMAP for Yahoo mail account](https://help.yahoo.com/kb/sln4075.html)
- [Sign in with App Passwords for your Yahoo mail Account](https://help.yahoo.com/kb/generate-manage-third-party-passwords-sln15241.html)
- [POP, IMAP, and SMTP settings for Outlook.com](https://support.microsoft.com/en-us/office/pop-imap-and-smtp-settings-for-outlook-com-d088b986-291d-42b8-9564-9c414e2aa040)

6
docs/integrations/builtin/credentials/index.md
View File

@ -1,6 +0,0 @@
# Credentials library
This section contains step-by-step information about authenticating the different nodes in n8n.
To learn more about creating, managing, and sharing credentials, refer to [Manage credentials](/credentials/).

23
docs/integrations/builtin/credentials/intercom.md
View File

@ -1,23 +0,0 @@
# Intercom
You can use these credentials to authenticate the following nodes with Intercom.
- [Intercom](/integrations/builtin/app-nodes/n8n-nodes-base.intercom/)
## Prerequisites
Create a [Intercom](https://www.intercom.com/) account.
<!-- ## Using OAuth
1. Click "Use OAuth" in Authentication page.
2. Fill out required information.
3. Use Client Secret and Client ID in your Intercom node credentials in n8n.
4. Enter n8n provided redirect URL in configuration. Redirect URL Explanation [here](/). -->
## Using Access Token
1. Create an app in your workspace.
2. Click on Configure, then Authentication within the Developer hub.
3. Use the Access Token with the Intercom node credentials in n8n.

20
docs/integrations/builtin/credentials/invoiceNinja.md
View File

@ -1,20 +0,0 @@
# Invoice Ninja
You can use these credentials to authenticate the following nodes with Invoice Ninja.
- [Invoice Ninja](/integrations/builtin/app-nodes/n8n-nodes-base.invoiceNinja/)
- [Invoice Ninja Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.invoiceNinjaTrigger/)
## Prerequisites
Create an [Invoice Ninja](https://www.invoiceninja.com/) account.
## Using Access Token
1. Access your Invoice Ninja dashboard.
2. Click on Settings in the bottom left.
3. Scroll down to API keys.
4. Add new token.
5. Use the key and your instance URL with Invoice Ninja node credentials in n8n.
![Getting Invoice Ninja credentials](/_images/integrations/builtin/credentials/invoiceninja/using-access-token.gif)

21
docs/integrations/builtin/credentials/iterable.md
View File

@ -1,21 +0,0 @@
# Iterable
You can use these credentials to authenticate the following nodes with Iterable.
- [Iterable](/integrations/builtin/app-nodes/n8n-nodes-base.iterable/)
## Prerequisites
Create an [Iterable](https://iterable.com) account.
## Using API Key
1. Access the [Iterable dashboard](https://app.iterable.com/).
2. Click on ***Integrations*** and select 'API keys'.
3. Click on the ***NEW API KEY*** button.
4. Enter a name in the ***Name*** field.
5. Click on the ***Create*** button.
6. Click on the ***Copy*** button to copy the API key.
7. Use this ***API key*** with your Iterable node credentials in n8n.
![Getting Iterable credentials](/_images/integrations/builtin/credentials/iterable/using-api-key.gif)

18
docs/integrations/builtin/credentials/jenkins.md
View File

@ -1,18 +0,0 @@
# Jenkins
You can use these credentials to authenticate the following nodes with CircleCI.
- [Jenkins](/integrations/builtin/app-nodes/n8n-nodes-base.jenkins/)
## Prerequisites
Create an account on a [Jenkins](https://www.jenkins.io/) instance.
## Using Access Token
1. Access your Jenkins User.
2. Visit the *Configure* section.
3. Click on the *Add new Token* button.
4. Type in a name for your token and click on the *Generate* button.
5. Copy the generated API Token and use it with your Jenkins API node credentials in n8n.

20
docs/integrations/builtin/credentials/jira.md
View File

@ -1,20 +0,0 @@
# Jira
You can use these credentials to authenticate the following nodes with Jira.
- [Jira](/integrations/builtin/app-nodes/n8n-nodes-base.jira/)
- [Jira Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.jiraTrigger/)
## Prerequisites
Create a [Jira](https://www.JIRA.com/) account.
## Using Access Token
1. Access your Jira dashboard.
2. Click on your user icon in the top right.
3. Click on Account Settings.
4. Click on Security tab.
5. Click on Manage API Tokens.
6. Create API token.
7. Use the API token with Jira node credentials in n8n. Your email and the domain under which the Jira account is under must also be included.

19
docs/integrations/builtin/credentials/jotForm.md
View File

@ -1,19 +0,0 @@
# JotForm
You can use these credentials to authenticate the following nodes with JotForm.
- [JotForm Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.jotFormTrigger/)
## Prerequisites
Create a [JotForm](https://www.jotform.com/) account.
## Using Access Token
1. Access your [JotForm account](https://www.jotform.com/myaccount/).
2. Click on the ***API*** tab on the left.
3. Click on the ***Create New Key*** button.
4. Change the Permissions to 'Full Access'.
5. Use the key with JotForm node credentials in n8n.
![Getting JotForm credentials](/_images/integrations/builtin/credentials/jotform/using-access-token.gif)

16
docs/integrations/builtin/credentials/kafka.md
View File

@ -1,16 +0,0 @@
# Kafka
You can use these credentials to authenticate the following nodes with Kafka.
- [Kafka](/integrations/builtin/app-nodes/n8n-nodes-base.kafka/)
- [Kafka Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.kafkaTrigger/)
## Prerequisites
Have Kafka up and running. You can refer to the official [documentation](https://kafka.apache.org/quickstart) to learn how to do that.
## Using Kafka
1. Enter a client ID in the ***Client ID*** field.
2. Retrieve the Kafka Brokers and credentials (if any).
3. Use the ***Client ID***, ***Brokers*** (comma separated), ***Username***, and ***Password*** with your Kafka node credentials in n8n.

26
docs/integrations/builtin/credentials/keap.md
View File

@ -1,26 +0,0 @@
# Keap
You can use these credentials to authenticate the following nodes with Keap.
- [Keap](/integrations/builtin/app-nodes/n8n-nodes-base.keap/)
- [Keap Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.keapTrigger/)
## Prerequisites
Create a [Keap](https://keap.com/) account.
## Using OAuth
!!! note "Note for n8n Cloud users"
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Keap account to n8n.
1. Access your [Keap Developer Console](https://keys.developer.keap.com/my-apps).
2. Click on your email address in the top right corner and select 'Apps' from the dropdown list.
3. Click on the 'New App' button.
4. Enter any necessary information, enable the 'Keap 150k' API and click on the *Create* button.
6. Use the 'Key' and the 'Secret' displayed with your Keap OAuth2 API credentials in n8n.
7. Click on the circle button in the OAuth section to connect a Keap account to n8n.
8. Click the *Save* button to save your credentials.
![Getting Keap credentials](/_images/integrations/builtin/credentials/keap/getting-oauth-credentials.gif)

Some files were not shown because too many files have changed in this diff Show More