diff --git a/docs/_images/integrations/builtin/credentials/onesimpleapi/one_simple_api_n8n_credentials.png b/docs/_images/integrations/builtin/credentials/onesimpleapi/one_simple_api_n8n_credentials.png deleted file mode 100644 index d57dc848407..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/onesimpleapi/one_simple_api_n8n_credentials.png and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/onesimpleapi/one_simple_api_website.png b/docs/_images/integrations/builtin/credentials/onesimpleapi/one_simple_api_website.png deleted file mode 100644 index 1d0f44925fc..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/onesimpleapi/one_simple_api_website.png and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/openweathermap/using-access-token.gif b/docs/_images/integrations/builtin/credentials/openweathermap/using-access-token.gif deleted file mode 100644 index 32c46411568..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/openweathermap/using-access-token.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/orbit/using-api.gif b/docs/_images/integrations/builtin/credentials/orbit/using-api.gif deleted file mode 100644 index 35b959fbd33..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/orbit/using-api.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/paddle/using-access-token.gif b/docs/_images/integrations/builtin/credentials/paddle/using-access-token.gif deleted file mode 100644 index b1e8c012408..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/paddle/using-access-token.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/pagerduty/using-access-token.gif b/docs/_images/integrations/builtin/credentials/pagerduty/using-access-token.gif deleted file mode 100644 index 20ba44f29ce..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/pagerduty/using-access-token.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/pagerduty/using-oauth.gif b/docs/_images/integrations/builtin/credentials/pagerduty/using-oauth.gif deleted file mode 100644 index 26fdcfa4239..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/pagerduty/using-oauth.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/paypal/using-oauth.gif b/docs/_images/integrations/builtin/credentials/paypal/using-oauth.gif deleted file mode 100644 index 25ae2e79c00..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/paypal/using-oauth.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/phantombuster/using-api.gif b/docs/_images/integrations/builtin/credentials/phantombuster/using-api.gif deleted file mode 100644 index e0fd64fdb8f..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/phantombuster/using-api.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/plivo/using-access-token.png b/docs/_images/integrations/builtin/credentials/plivo/using-access-token.png deleted file mode 100644 index 9c432e07561..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/plivo/using-access-token.png and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/postgres/using-database-connection.gif b/docs/_images/integrations/builtin/credentials/postgres/using-database-connection.gif deleted file mode 100644 index 3705ac94d6e..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/postgres/using-database-connection.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/postmark/using-access-token.gif b/docs/_images/integrations/builtin/credentials/postmark/using-access-token.gif deleted file mode 100644 index 636d94a4483..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/postmark/using-access-token.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/profitwell/using-api.gif b/docs/_images/integrations/builtin/credentials/profitwell/using-api.gif deleted file mode 100644 index c7d3d8a431c..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/profitwell/using-api.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/pushbullet/using-oauth.gif b/docs/_images/integrations/builtin/credentials/pushbullet/using-oauth.gif deleted file mode 100644 index 91f4535d81f..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/pushbullet/using-oauth.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/pushcut/using-api-key.gif b/docs/_images/integrations/builtin/credentials/pushcut/using-api-key.gif deleted file mode 100644 index 0d353750d70..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/pushcut/using-api-key.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/pushover/using-api-key.gif b/docs/_images/integrations/builtin/credentials/pushover/using-api-key.gif deleted file mode 100644 index f64f9e012c8..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/pushover/using-api-key.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/quickbase/using-api.gif b/docs/_images/integrations/builtin/credentials/quickbase/using-api.gif deleted file mode 100644 index dee2dd86160..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/quickbase/using-api.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/redis/using-database-connection.gif b/docs/_images/integrations/builtin/credentials/redis/using-database-connection.gif deleted file mode 100644 index 04af0decd89..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/redis/using-database-connection.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/rocketchat/using-access-token.gif b/docs/_images/integrations/builtin/credentials/rocketchat/using-access-token.gif deleted file mode 100644 index 2c03c465690..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/rocketchat/using-access-token.gif and /dev/null differ diff --git a/docs/_images/integrations/builtin/credentials/rundeck/using-access-token.gif b/docs/_images/integrations/builtin/credentials/rundeck/using-access-token.gif deleted file mode 100644 index 91a27185757..00000000000 Binary files a/docs/_images/integrations/builtin/credentials/rundeck/using-access-token.gif and /dev/null differ diff --git a/docs/integrations/builtin/credentials/odoo.md b/docs/integrations/builtin/credentials/odoo.md index d72c263f2b1..3e215b07497 100644 --- a/docs/integrations/builtin/credentials/odoo.md +++ b/docs/integrations/builtin/credentials/odoo.md @@ -6,18 +6,36 @@ contentType: integration # Odoo credentials -You can use these credentials to authenticate the following nodes with Odoo: +You can use these credentials to authenticate the following nodes: - [Odoo](/integrations/builtin/app-nodes/n8n-nodes-base.odoo/) -1. Sign up for Odoo and create an API key or password. Refer to Odoo's documentation for more information: [External API](https://www.odoo.com/documentation/15.0/developer/misc/api/odoo.html). Note that some Odoo modules and settings require API keys, not passwords. -2. In n8n, create a new credential. You can either: - * Click **Credentials** > **New**, then search for **Odoo API**. After selecting **Odoo API**, click **Continue**. - * In an Odoo node, click the **Credential for Odoo API** dropdown, then click **Create new**. -3. Enter your Odoo information: - * **Site URL**: the domain of your Odoo instance. - * **Username**: username as displayed on the user's **Change password** screen in Odoo. - * **Database name**: the name of the Odoo instance. - * **Password or API key**: the credential you created in step one. -4. Click **Save**. n8n tests the key to check it can connect to Odoo. +## Prerequisites + +Create an [Odoo](https://www.odoo.com/){:target=_blank .external-link} account, instance, and database. + +Refer to the Odoo [Getting Started tutorial](https://www.odoo.com/slides/getting-started-15){:target=_blank .external-link} if you're new to Odoo. + +/// note | Required plan type +Access to Odoo's external API is only available on **Custom** Odoo pricing plans. Refer to [Odoo Pricing Plans](https://www.odoo.com/pricing-plan){:target=_blank .external-link} for more information. +/// + +## Supported authentication methods + +- API key or password + +Odoo supports both formats, but some Odoo modules require an API key. + +## Related resources + +Refer to [Odoo's External API documentation](https://www.odoo.com/documentation/17.0/developer/reference/external_api.html){:target=_blank .external-link} for more information about the service. + +## Using API key or password + +To configure this credential, you'll need: + +- Your **Site URL**: The domain of your Odoo instance. +- A **Username**: Your username as displayed on the user's **Change password** screen in Odoo. +- A **Password or API key**: You can use your user password or an API key. Odoo supports both formats, but some Odoo modules require an API key. To generate an API key, go to **Your Profile > Preferences > Account Security > Developer API Keys**. Refer to [Odoo API Keys](https://www.odoo.com/documentation/15.0/developer/reference/external_api.html?#api-keys){:target=_blank .external-link} for more information. +- A **Database name**: The name of the Odoo instance. diff --git a/docs/integrations/builtin/credentials/okta.md b/docs/integrations/builtin/credentials/okta.md index c3a32505843..19f0bed2630 100644 --- a/docs/integrations/builtin/credentials/okta.md +++ b/docs/integrations/builtin/credentials/okta.md @@ -5,14 +5,27 @@ description: Documentation for the Okta credentials. Use these credentials to au # Okta credentials -You can use these credentials to authenticate when using the HTTP Request node to make a [Custom API call](/integrations/custom-operations/). +You can use these credentials to authenticate when using the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) to make a [Custom API call](/integrations/custom-operations/). -## Authentication methods +## Prerequisites -n8n supports Okta authentication with an access token. +Create an [Okta free trial](https://www.okta.com/free-trial/){:target=_blank .external-link} or create an admin account on an existing Okta org. + +## Supported authentication methods + +- SSWS API Access token ## Related resources Refer to [Okta's documentation](https://developer.okta.com/docs/reference/){:target=_blank .external-link} for more information about the service. This is a credential-only node. Refer to [Custom API operations](/integrations/custom-operations/) to learn more. View [example workflows and related content](https://n8n.io/integrations/okta/){:target=_blank .external-link} on n8n's website. + +## Using SSWS API access token + +To configure this credential, you'll need: + +- The **URL**: The base URL of your Okta org, also referred to as your unique subdomain. There are two quick ways to access it: + 1. In the Admin Console, select your **Profile**, hover over the domain listed below your username, and select the **Copy** icon. Paste this into n8n, but be sure to add `https://` before it. + 2. Copy the base URL of your Admin Console URL, for example `https://dev-123456-admin.okta.com`. Paste it into n8n and remove `-admin`, for example: `https://dev-123456.okta.com`. +- An **SSWS Access Token**: Create a token by going to **Security > API > Tokens > Create token**. Refer to [Create Okta API tokens](https://help.okta.com/en-us/content/topics/security/api.htm?cshid=ext-create-api-token#create-okta-api-token){:target=_blank .external-link} for more information. \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/onesimpleapi.md b/docs/integrations/builtin/credentials/onesimpleapi.md index cbf99751a1f..534f8355d3b 100644 --- a/docs/integrations/builtin/credentials/onesimpleapi.md +++ b/docs/integrations/builtin/credentials/onesimpleapi.md @@ -7,24 +7,28 @@ contentType: integration # One Simple API credentials -You can use these credentials to authenticate the following nodes with Nextcloud. +You can use these credentials to authenticate the following nodes: - [One Simple API](/integrations/builtin/app-nodes/n8n-nodes-base.onesimpleapi/) ## Prerequisites -Create a [One Simple API](https://onesimpleapi.com/register) account. +Create a [One Simple API](https://onesimpleapi.com/register){:target=_blank .external-link} account. -## Using an API Token +## Supported authentication methods -1. [Log in](https://onesimpleapi.com/login) to your One Simple API account. -2. Create a new API token on the [API Tokens](https://onesimpleapi.com/user/api-tokens) page. -3. Check the required permissions for your new API token. -4. Click the **Create** button. -5. Copy the API token provided by One Simple API. -![The API token shown on the One Simple API website](/_images/integrations/builtin/credentials/onesimpleapi/one_simple_api_website.png) -6. Paste the API token into the API Token field of n8n. -![The API token field in n8n](/_images/integrations/builtin/credentials/onesimpleapi/one_simple_api_n8n_credentials.png) -7. Click the **Save** button. +- API token + +## Related resources + +Refer to [One Simple API's documentation](https://onesimpleapi.com/docs){:target=_blank .external-link} for more information about the service. + +## Using API token + +To configure this credential, you'll need: + +- An **API token**: Create a new API token on the [API Tokens](https://onesimpleapi.com/user/api-tokens) page. Be sure you select appropriate permissions for the token. + +You can also access the API Tokens page by selecting your **Profile > API Tokens**. \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/onfleet.md b/docs/integrations/builtin/credentials/onfleet.md index 5b48bd01e9c..6ab95ffcd3d 100644 --- a/docs/integrations/builtin/credentials/onfleet.md +++ b/docs/integrations/builtin/credentials/onfleet.md @@ -6,18 +6,27 @@ contentType: integration # Onfleet credentials -You can use these credentials to authenticate the following nodes with Onfleet: +You can use these credentials to authenticate the following nodes: - [Onfleet](/integrations/builtin/app-nodes/n8n-nodes-base.onfleet/) - [Onfleet Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.onfleettrigger/) -1. Sign up for Onfleet and create an API key. Refer to Onfleet's documentation for more information: - * [Creating an API key](https://support.onfleet.com/hc/en-us/articles/360045763292-API) - * [Getting started with the Onfleet API](https://docs.onfleet.com/reference#setup-tutorial) -2. In n8n, create a new credential. You can either: - * Click **Credentials** > **New**, then search for **Onfleet API**. After selecting **Onfleet API**, click **Continue**. - * In an Onfleet node, click the **Credential for Onfleet API** dropdown, then click **Create new**. -3. In the **Onfleet account** modal, paste your Onfleet API key into **API key**. -4. By default, this credential is available to both the Onfleet and Onfleet Trigger nodes. You can change this using the settings on the **Details** tab. -5. After entering the key and editing the credential details, click **Save**. n8n tests the key to check it can connect to Onfleet. +## Prerequisites + +Create an [Onfleet](https://onfleet.com/){:target=_blank .external-link} administrator account. + +# Supported authentication methods + +- API key + +## Related resources + +Refer to [Onfleet's API documentation](https://docs.onfleet.com/reference/introduction){:target=_blank .external-link} for more information about the service. + +## Using API key + +To configure this credential, you'll need: + +- An **API key**: To create an API key, log into your organization's administrator account. Select **Settings > API & Webhooks**, then select **+** to create a new key. Refer to Onfleet's [Creating an API key documentation](https://support.onfleet.com/hc/en-us/articles/360045763292-API) for more information. + diff --git a/docs/integrations/builtin/credentials/opencti.md b/docs/integrations/builtin/credentials/opencti.md index 40161f1148d..557406bfc02 100644 --- a/docs/integrations/builtin/credentials/opencti.md +++ b/docs/integrations/builtin/credentials/opencti.md @@ -5,14 +5,24 @@ description: Documentation for the OpenCTI credentials. Use these credentials to # OpenCTI credentials -You can use these credentials to authenticate when using the HTTP node to make a [Custom API call](/integrations/custom-operations/). +You can use these credentials to authenticate when using the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) to make a [Custom API call](/integrations/custom-operations/). + +## Prerequisites + +Create an [OpenCTI](https://filigran.io/solutions/open-cti/){:target=_blank .external-link} developer account. ## Authentication methods -n8n supports OpenCTI authentication with an API key. +- API key ## Related resources -Refer to [OpenCTI's documentation](https://docs.opencti.io/5.7.X/deployment/integrations/){:target=_blank .external-link} for more information about the service. +Refer to [OpenCTI's documentation](https://docs.opencti.io/latest/){:target=_blank .external-link} for more information about the service. This is a credential-only node. Refer to [Custom API operations](/integrations/custom-operations/) to learn more. View [example workflows and related content](https://n8n.io/integrations/opencti/){:target=_blank .external-link} on n8n's website. + +## Using API key + +To configure this credential, you'll need: + +- An **API Key**: To get your API key, go to your **Profile > API access**. Refer to the OpenCTI [Integrations Authentication documentation](https://docs.opencti.io/latest/deployment/integrations/#authentication){:target=_blank .external-link} for more information. \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/openweathermap.md b/docs/integrations/builtin/credentials/openweathermap.md index 8a4f2b39dad..76239927930 100644 --- a/docs/integrations/builtin/credentials/openweathermap.md +++ b/docs/integrations/builtin/credentials/openweathermap.md @@ -6,20 +6,27 @@ contentType: integration # OpenWeatherMap credentials -You can use these credentials to authenticate the following nodes with OpenWeatherMap. +You can use these credentials to authenticate the following nodes: - [OpenWeatherMap](/integrations/builtin/app-nodes/n8n-nodes-base.openweathermap/) ## Prerequisites -Create a [OpenWeatherMap](https://openweathermap.org/) account. +Create an [OpenWeatherMap](https://openweathermap.org/){:target=_blank .external-link} account. -## Using Access Token +## Supported authentication methods -1. Access your OpenWeatherMap [account page](https://home.openweathermap.org/api_keys). -2. In the 'Create key' section, type a name and click on the *Generate* button. -3. Copy the API Key that you just generated. -4. Use this API key with your OpenWeatherMap API node credentials in n8n. +- API access token -![Getting OpenWeatherMap API credentials](/_images/integrations/builtin/credentials/openweathermap/using-access-token.gif) +## Related resources + +Refer to [OpenWeatherMap's API documentation](https://openweathermap.org/api){:target=_blank .external-link} for more information about the service. + +## Using API access token + +To configure this credential, you'll need: + +- An **Access Token**: When you first sign up for your account, OpenWeatherMap includes an **API Key** (APP Key) in your confirmation email. + +To create and view API keys, go to **Account >** [**API Keys**](https://home.openweathermap.org/api_keys){:target=_blank .external-link}. diff --git a/docs/integrations/builtin/credentials/orbit.md b/docs/integrations/builtin/credentials/orbit.md index 2e1850e542f..6510e88f7c4 100644 --- a/docs/integrations/builtin/credentials/orbit.md +++ b/docs/integrations/builtin/credentials/orbit.md @@ -6,24 +6,28 @@ contentType: integration # Orbit credentials -You can use these credentials to authenticate the following nodes with Orbit. +You can use these credentials to authenticate the following nodes: - [Orbit](/integrations/builtin/app-nodes/n8n-nodes-base.orbit/) ## Prerequisites -Create an [Orbit](https://app.orbit.love/) account. +Create an [Orbit](https://orbit.love/){:target=_blank .external-link} account. -## Using API Token +## Supported authentication methods -1. Access the [Account Settings page](https://app.orbit.love/user/edit). -2. Scroll down to the ***API Token*** section. -3. Click on the ***Copy*** button to copy the API Token. -4. Use this ***API Token*** in with your Orbit node credentials in n8n. +- API token -![Getting Orbit credentials](/_images/integrations/builtin/credentials/orbit/using-api.gif) +## Related resources -## Further Reference +Refer to [Orbit's API documentation](https://orbit.love/docs/developers){:target=_blank .external-link} for more information about the service. -- [Orbit API Documentation](https://www.notion.so/Orbit-API-Documentation-41ed7911e070400b99cfebb296813670#cb4111e0436e420c8c05af078496ff30) +## Using API token +To configure this credential, you'll need: + +- An **API Token**: Use either a user API token or a workspace API token. + - Get your user token in **Account Settings > API Token**. Refer to [User API tokens](https://orbit.love/docs/all/api-tokens#623e061e89cd4037bef69fe3a6af0ee5){:target=_blank .external-link} for more information. + - Get a workspace token from your **Workspace Settings > Workspace API Tokens**. Only workspace owners can create workspace tokens. Refer to [Workspace API tokens](https://orbit.love/docs/all/api-tokens#51526766b5394f7e83c0a1fc01543330){:target=_blank .external-link} for more information. + +Refer to [Which token type to use](https://orbit.love/docs/all/api-tokens#837393b02e6842a6b31865abde47511a){:target=_blank .external-link} for more information on the two token types. diff --git a/docs/integrations/builtin/credentials/oura.md b/docs/integrations/builtin/credentials/oura.md index 24405214943..4ba7da4ad3f 100644 --- a/docs/integrations/builtin/credentials/oura.md +++ b/docs/integrations/builtin/credentials/oura.md @@ -6,26 +6,26 @@ contentType: integration # Oura credentials -You can use these credentials to authenticate the following nodes with Oura. +You can use these credentials to authenticate the following nodes: - [Oura](/integrations/builtin/app-nodes/n8n-nodes-base.oura/) ## Prerequisites -Create a [Oura](https://www.ouraring.com/) account. +Create an [Oura](https://ouraring.com/developer){:target=_blank .external-link} account. -## Using Access Token +## Supported authentication methods -1. Open the [Personal Access Tokens](https://cloud.ouraring.com/personal-access-tokens) page. -2. On the top-right corner of the page, click on the ***Create A New Personal Access Token*** button. -3. Enter a note for the new Personal Access Token you are about to generate. -4. Click on the ***Create Personal Access Token*** to create the Personal Access Token. -5. Copy the displayed Personal Access Token. -6. Enter a name for your credentials in the ***Credentials Name*** field in the 'Oura API' credentials in n8n. -7. Paste the Personal Access Token in the ***Personal Access Token*** field in the 'Oura API' credentials in n8n. -8. Click on the ***Create*** button to create your credentials. +- API access token +## Related resources +Refer to [Oura's API documentation](https://cloud.ouraring.com/v2/docs){:target=_blank .external-link} for more information about the service. -- [Oura API Documentation](https://cloud.ouraring.com/docs/authentication) +## Using API access token +To configure this credential, you'll need: + +- A **Personal Access Token**: To generate a personal access token, go to the [Personal Access Tokens](https://cloud.ouraring.com/personal-access-tokens){:target=_blank .external-link} page and select **Create A New Personal Access Token**. + +Refer to [How to Generate Personal Access Tokens](https://support.ouraring.com/hc/en-us/articles/4415266939155-The-Oura-API#h_01H5B94SP4P9YHG9ZKN1H69E7Z){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/paddle.md b/docs/integrations/builtin/credentials/paddle.md index d58b5064ff2..125aff5c3e1 100644 --- a/docs/integrations/builtin/credentials/paddle.md +++ b/docs/integrations/builtin/credentials/paddle.md @@ -6,22 +6,32 @@ contentType: integration # Paddle credentials -You can use these credentials to authenticate the following nodes with Paddle. +You can use these credentials to authenticate the following nodes: - [Paddle](/integrations/builtin/app-nodes/n8n-nodes-base.paddle/) ## Prerequisites -Create a [Paddle](https://paddle.com/) account. +Create a [Paddle](https://paddle.com/){:target=_blank .external-link} account. -## Using Access Token +## Supported authentication methods -1. Open your Paddle dashboard. -2. Open the ***Developer Tools*** dropdown list in the sidebar and select ***Authentication***. -3. Enter a name and description in the ***Generate Auth Code*** section and click on ***Generate Key***. -4. Click on the ***Reveal Auth Code*** button to reveal the access token. -5. Use the displayed ***vendor_id*** and ***Auth Code*** with your Paddle API credentials in n8n. -6. Click on the ***Save*** button to save your credentials. +- API access token (Classic) -![Getting Paddle credentials](/_images/integrations/builtin/credentials/paddle/using-access-token.gif) +/// warning | Paddle Classic API +This credential works with Paddle Classic's API. If you joined Paddle after August 2023, you're using the [Paddle Billing API](https://developer.paddle.com/api-reference/overview){:target=_blank .external-link} and this credential may not work for you. +/// +## Related resources + +Refer to [Paddle Classic's API documentation](https://developer.paddle.com/classic/api-reference/1384a288aca7a-api-reference){:target=_blank .external-link} for more information about the service. + +## Using API access token (Classic) + +To configure this credential, you'll need: + +- A **Vendor Auth Code**: Created when you generate an API key. +- A **Vendor ID**: Displayed when you generate an API key. +- **Use Sandbox Environment API**: When turned on, nodes using this credential will hit the Sandbox API endpoint instead of the live API endpoint. + +To generate an auth code and view your Vendor ID, go to **Paddle > Developer Tools > Authentication > Generate Auth Code**. Select **Reveal Auth Code** to display the Auth Code. Refer to [API Authentication](https://developer.paddle.com/classic/api-reference/zg9joji1mzuzotg5-api-authentication){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/pagerduty.md b/docs/integrations/builtin/credentials/pagerduty.md index c56cfbb52fb..3b0a1940ff3 100644 --- a/docs/integrations/builtin/credentials/pagerduty.md +++ b/docs/integrations/builtin/credentials/pagerduty.md @@ -6,42 +6,47 @@ contentType: integration # PagerDuty credentials -You can use these credentials to authenticate the following nodes with PagerDuty. +You can use these credentials to authenticate the following nodes: - [PagerDuty](/integrations/builtin/app-nodes/n8n-nodes-base.pagerduty/) ## Prerequisites -Create a [PagerDuty](https://pagerduty.com/) account. +Create a [PagerDuty](https://pagerduty.com/){:target=_blank .external-link} account. -## Using OAuth +## Supported authentication methods -/// 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 PagerDuty account to n8n. -/// +- API token +- OAuth2 -1. Access your PagerDuty dashboard. -2. Select 'Developer Mode' from the number pad icon in the top right. -3. Click on the ***Create New App*** button. -4. Enter a name in the ***App Name*** field, and a description in the ***Brief Description*** field. -5. Select 'Infrastructure Automation' from the ***Category*** dropdown list. -6. Choose the appropriate option for the publication of your app and click on the ***Save*** button. -7. Click on the ***Add*** button in the 'OAuth 2.0' section. -8. Copy the 'OAuth Callback URL' provided in the 'PagerDuty OAuth2 API' credentials in n8n and paste it in the ***Redirect URL*** field in the PagerDuty app creation page. -9. Use the provided ***Client ID*** and ***Client Secret*** with your PagerDuty OAuth2 API credentials in n8n. -10. Select 'Read/Write' from the ***Set Permission Scopes*** dropdown list and then click on ***Save***. -11. Click on the circle button in the OAuth section of n8n to connect a PagerDuty account to n8n. -12. Click on the ***Save*** button to save your credentials. +## Related resources -![Getting PagerDuty OAuth credentials](/_images/integrations/builtin/credentials/pagerduty/using-oauth.gif) +Refer to [PagerDuty's API documentation](https://developer.pagerduty.com/docs/531092d4c6658-rest-api-v2-overview){:target=_blank .external-link} for more information about the service. -## Using Access Token +## Using API token -1. Access your PagerDuty dashboard. -2. Click on configuration. -3. Click on API access. -4. Create a new API key. -5. Use this API key with your PagerDuty node credentials in n8n. +To configure this credential, you'll need: + +- A general access **API Token**: To generate an API token, go to **Integrations > Developer Tools > API Access Keys > Create New API Key**. Refer to [Generate a General Access REST API key](https://support.pagerduty.com/docs/api-access-keys#generate-a-general-access-rest-api-key){:target=_blank .external-link} for more information. + +## Using OAuth2 + +--8<-- "_snippets/integrations/builtin/credentials/cloud-oauth-button.md" + +If you need to configure OAuth2 from scratch, [register a new Pagerduty app](https://developer.pagerduty.com/docs/dd91fbd09a1a1-register-an-app){:target=_blank .external-link}. + +Use these settings for registering your app: + +- In the **Category** dropdown list, select **Infrastructure Automation**. +- In the **Functionality** section, select **OAuth 2.0**. + +Once you **Save** your app, open the app details and [edit your app configuration](https://developer.pagerduty.com/docs/dd91fbd09a1a1-register-an-app#editing-your-app-configuration){:target=_blank .external-link} to use these settings: + +- Within the **OAuth 2.0** section, select **Add**. +- Copy the **OAuth Callback URL** from n8n and paste it into the **Redirect URL** field. +- Copy the **Client ID** and **Client Secret** from PagerDuty and add these to your n8n credentials. +- Select **Read/Write** from the **Set Permission Scopes** dropdown list. + +Refer to the instructions in [App functionality](https://developer.pagerduty.com/docs/b25fd1b8acb1b-app-functionality){:target=_blank .external-link} for more information on available functionality. Refer to the PagerDuty [OAuth Functionality documentation](https://developer.pagerduty.com/docs/f59fdbd94ceab-o-auth-functionality){:target=_blank .external-link} for more information on the OAuth flow. -![Getting PagerDuty credentials](/_images/integrations/builtin/credentials/pagerduty/using-access-token.gif) diff --git a/docs/integrations/builtin/credentials/paypal.md b/docs/integrations/builtin/credentials/paypal.md index d381c2e680c..5987a882557 100644 --- a/docs/integrations/builtin/credentials/paypal.md +++ b/docs/integrations/builtin/credentials/paypal.md @@ -6,25 +6,31 @@ contentType: integration # PayPal credentials -You can use these credentials to authenticate the following nodes with PayPal. +You can use these credentials to authenticate the following nodes: - [PayPal](/integrations/builtin/app-nodes/n8n-nodes-base.paypal/) - [PayPal Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.paypaltrigger/) ## Prerequisites -Create a [PayPal](https://paypal.com/) account. +Create a [PayPal developer](https://developer.paypal.com/home){:target=_blank .external-link} account. -## Using OAuth +## Supported authentication methods -1. Access your [PayPal dashboard](https://developer.paypal.com/developer/applications/). -2. Click on *Log in to Dashboard*. -3. Enter your PayPal account credentials. -4. In the section 'REST API apps', click on *Create app*. -5. Enter a name for your app in *App Name* and click on *Create App*. -6. Return to n8n and enter the Client ID and Client Secret in your PayPal API credentials. -7. Choose the environment: sandbox or live. +- API client and secret -![Getting PayPal credentials](/_images/integrations/builtin/credentials/paypal/using-oauth.gif) +## Related resources + +Refer to [Paypal's API documentation](https://developer.paypal.com/api/rest/){:target=_blank .external-link} for more information about the service. + +## Using API client and secret + +To configure this credential, you'll need: + +- A **Client ID**: Generated when you create an app. +- A **Secret**: Generated when you create an app. +- An **Environment**: Select **Live** or **Sandbox**. + +To generate the **Client ID** and **Secret**, log in to your Paypal [developer dashboard](https://developer.paypal.com/dashboard/). Select **Apps & Credentials > Rest API apps > Create app**. Refer to [Get client ID and client secret](https://developer.paypal.com/api/rest/#link-getclientidandclientsecret){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/peekalink.md b/docs/integrations/builtin/credentials/peekalink.md index 73afac53041..3b40c003544 100644 --- a/docs/integrations/builtin/credentials/peekalink.md +++ b/docs/integrations/builtin/credentials/peekalink.md @@ -6,25 +6,24 @@ contentType: integration # Peekalink credentials -You can use these credentials to authenticate the following nodes with Peekalink. +You can use these credentials to authenticate the following nodes: - [Peekalink](/integrations/builtin/app-nodes/n8n-nodes-base.peekalink/) ## Prerequisites -Create a [Peekalink](https://www.peekalink.io/) account. +Create a [Peekalink](https://www.peekalink.io/){:target=_blank .external-link} account. -## Using API Key +## Supported authentication methods -1. Open your [Peekalink](https://www.peekalink.io/app/overview) dashboard. -2. Copy the API key displayed under the ***Your API Key*** section. -3. Enter a name for your credentials in the ***Credentials Name*** field in the 'Peekalink API' credentials in n8n. -4. Paste the API key in the ***API Key*** field in the 'Peekalink API' credentials in n8n. -5. Click on the ***Create*** button to create your credentials. +- API key -The following video demonstrates the steps mentioned above. +## Related resources -
- -
+Refer to [Peekalink's API documentation](https://docs.peekalink.io/){:target=_blank .external-link} for more information about the service. +## Using API key + +To configure this credential, you'll need: + +- An **API Key**: To get your API key, access your Peekalink [dashboard](https://www.peekalink.io/app/overview){:target=_blank .external-link} and copy the key in the **Your API Key** section. Refer to [Get your API key](https://docs.peekalink.io/setup#get-your-api-key){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/phantombuster.md b/docs/integrations/builtin/credentials/phantombuster.md index 4e8bfa480ca..e0a42307473 100644 --- a/docs/integrations/builtin/credentials/phantombuster.md +++ b/docs/integrations/builtin/credentials/phantombuster.md @@ -6,21 +6,24 @@ contentType: integration # PhantomBuster credentials -You can use these credentials to authenticate the following nodes with PhantomBuster. +You can use these credentials to authenticate the following nodes: - [PhantomBuster](/integrations/builtin/app-nodes/n8n-nodes-base.phantombuster/) ## Prerequisites -Create a [PhantomBuster](https://www.phantombuster.com/) account. +Create a [PhantomBuster](https://www.phantombuster.com/){:target=_blank .external-link} account. -## Using API +## Supported authentication methods -1. Access your [PhantomBuster](https://phantombuster.com/) dashboard. -2. Click on your name on the top right and select 'Org settings'. -3. Scroll down to the ***Third party API keys*** section. -4. Click on the ***+ Add third party API key*** button. -5. Use this ***API Key*** with your PhantomBuster node credentials in n8n. +- API key -![Getting PhantomBuster credentials](/_images/integrations/builtin/credentials/phantombuster/using-api.gif) +## Related resources +Refer to [PhantomBuster's API documentation](https://hub.phantombuster.com/reference){:target=_blank .external-link} for more information about the service. + +## Using API key + +To configure this credential, you'll need: + +- An **API Key**: To get an API key, go to [**Workspace settings**](https://phantombuster.com/workspace-settings){:target=_blank .external-link} **> Third party API keys** and select **+ Add API Key**. Refer to [How to find my API key](https://hub.phantombuster.com/docs/api#how-to-find-my-api-key){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/pinecone.md b/docs/integrations/builtin/credentials/pinecone.md index 0054a102d6b..4e3585e7d58 100644 --- a/docs/integrations/builtin/credentials/pinecone.md +++ b/docs/integrations/builtin/credentials/pinecone.md @@ -9,13 +9,23 @@ You can use these credentials to authenticate the following nodes: * [Pinecone Vector Store](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstorepinecone/) - ## Prerequisites -You need an API key, and the environment for your project. +- Create a [Pinecone](https://www.pinecone.io/){:target=_blank .external-link} account. +- If you don't have an existing Pinecone project, create one. Refer to Pinecone's [Quickstart](https://docs.pinecone.io/guides/get-started/quickstart){:target=_blank .external-link} for more information. + +## Supported authentication methods + +- API key ## Related resources -Refer to [Pinecone's documentation](https://docs.pinecone.io/docs/authentication){:target=_blank .external-link} for more information about the service. +Refer to [Pinecone's documentation](https://docs.pinecone.io/reference/api/introduction){:target=_blank .external-link} for more information about the service. --8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Using API key + +To configure this credential, you'll need: + +- An **API Key**: To get an API key, open your project from your Pinecone console and go to **API Keys**. Refer to Pinecone's API [Authentication documentation](https://docs.pinecone.io/guides/get-started/authentication){:target=_blank .external-link} for more information. \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/pipedrive.md b/docs/integrations/builtin/credentials/pipedrive.md index f9e73e5130a..a8aee4db639 100644 --- a/docs/integrations/builtin/credentials/pipedrive.md +++ b/docs/integrations/builtin/credentials/pipedrive.md @@ -6,18 +6,40 @@ contentType: integration # Pipedrive credentials -You can use these credentials to authenticate the following nodes with Pipedrive. +You can use these credentials to authenticate the following nodes: - [Pipedrive](/integrations/builtin/app-nodes/n8n-nodes-base.pipedrive/) - [Pipedrive Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.pipedrivetrigger/) ## Prerequisites -Create a [Pipedrive](https://pipedrive.com/){:target=_blank .external-link} account. +- Create a [Pipedrive](https://pipedrive.com/){:target=_blank .external-link} account. +- For OAuth2 authentication, create a [Pipedrive developer sandbox](https://developers.pipedrive.com/){:target=_blank .external-link} account. -n8n supports authentication using OAuth or API token. For OAuth, follow the steps in Pipedrive's [OAuth 2.0 overview](https://pipedrive.readme.io/docs/marketplace-oauth-api){:target=_blank .external-link}. For API token, refer to [How to find the API token](https://pipedrive.readme.io/docs/how-to-find-the-api-token){:target=_blank .external-link}. +## Supported authentication methods + +- API token +- OAuth2 ## Related resources -Refer to [Pipedrive's API authentication documentation](https://pipedrive.readme.io/docs/core-api-concepts-authentication){:target=_blank .external-link} for more information about the service. +Refer to [Pipedrive's developer documentation](https://pipedrive.readme.io/docs/getting-started){:target=_blank .external-link} for more information about the service. + +## Using API token + +To configure this credential, you'll need: + +- An **API Token**: To get your API token, select your account name in the upper right > **Company Settings > Personal Preferences > API**. Refer to [How to find the API token](https://pipedrive.readme.io/docs/how-to-find-the-api-token){:target=_blank .external-link} for more information. + +## Using OAuth2 + +To configure this credential, you'll need: + +- A **Client ID**: Created when you register a new app. +- A **Client Secret**: Created when you register a new app. + +To get both, open the **Developer Hub** in your account and [register a new public app](https://pipedrive.readme.io/docs/marketplace-registering-the-app#register-a-new-public-app){:target=_blank .external-link}. Copy the **OAuth Redirect URL** from n8n and add it as the app's **Callback URL**. Copy the **Client ID** and **Client Secret** from the app's **OAuth & access scopes** tab and add them to your n8n credential. + +Be sure to add appropriate [scopes](https://pipedrive.readme.io/docs/marketplace-registering-the-app#oauth--access-scopes){:target=_blank .external-link} to your app. +Refer to [App registration form](https://pipedrive.readme.io/docs/marketplace-registering-the-app#app-registration-form){:target=_blank .external-link} for more information on registering your app. Refer to [Scopes and permissions explanations](https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations){:target=_blank .external-link} for more information on app scopes. \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/plivo.md b/docs/integrations/builtin/credentials/plivo.md index 6a17ad0b607..425d83084b3 100644 --- a/docs/integrations/builtin/credentials/plivo.md +++ b/docs/integrations/builtin/credentials/plivo.md @@ -6,27 +6,28 @@ contentType: integration # Plivo credentials -You can use these credentials to authenticate the following nodes with Plivo. +You can use these credentials to authenticate the following nodes: - [Plivo](/integrations/builtin/app-nodes/n8n-nodes-base.plivo/) ## Prerequisites -Create a [Plivo](https://console.plivo.com/accounts/register/) account. +Create a [Plivo](https://www.plivo.com/){:target=_blank .external-link} account. -## Using Access Token +## Supported authentication methods -1. Open your Plivo [console](https://console.plivo.com/dashboard/). -2. Copy the displayed Auth ID under the ***Account and Payments*** section. -3. Enter a name for your credentials in the ***Credentials Name*** field in the 'Plivo API' credentials in n8n. -4. Paste the Auth ID in the ***Auth ID*** field in the 'Plivo API' credentials in n8n. -5. Copy the Auth Token displayed on your Plivo console. -6. Paste the Auth Token in the ***Auth Token*** field in the 'Plivo API' credentials in n8n. -7. Click on the ***Create*** button to create your credentials. +- Basic auth -The following video demonstrates the steps mentioned above. +## Related resources -
- -
+Refer to [Plivo's API documentation](https://www.plivo.com/docs/voice/api/overview/){:target=_blank .external-link} for more information about the service. + +## Using basic auth + +To configure this credential, you'll need: + +- An **Auth ID**: Acts like your username. Copy yours from the **Overview** page of the Plivo [console](https://console.plivo.com/dashboard/){:target=_blank .external-link}. +- An **Auth Token**: Acts like a password. Copy yours from the **Overview** page of the Plivo [console](https://console.plivo.com/dashboard/){:target=_blank .external-link}. + +Refer to [How can I change my Auth ID or Auth Token?](https://support.plivo.com/hc/en-us/articles/360041731231-How-can-I-change-my-Auth-ID-or-Auth-Token){:target=_blank .external-link} for more detailed instructions. diff --git a/docs/integrations/builtin/credentials/postgres.md b/docs/integrations/builtin/credentials/postgres.md index 70a554255fd..023ccd9b803 100644 --- a/docs/integrations/builtin/credentials/postgres.md +++ b/docs/integrations/builtin/credentials/postgres.md @@ -6,22 +6,64 @@ contentType: integration # Postgres credentials -You can use these credentials to authenticate the following nodes with Postgres. +You can use these credentials to authenticate the following nodes: - [Postgres](/integrations/builtin/app-nodes/n8n-nodes-base.postgres/) - [Agent](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.agent) /// note | Agent node users -The Agent node doesn't support tunnels +The Agent node doesn't support SSH tunnels. /// + ## Prerequisites -Create an user account on a Postgres server. +[Create a user account](https://www.postgresql.org/docs/current/sql-createuser.html) on a Postgres server. + +## Supported authentication methods + +- Database connection + +## Related resources + +Refer to [Postgres's documentation](https://www.postgresql.org/docs/16/index.html){:target=_blank .external-link} for more information about the service. + +## Using database connection + +To configure this credential, you'll need: + +- The **Host**: Enter the host or domain name for the server. +- The **Database**: Enter the database name. +- A **User** name: Enter the username for the user account. +- A user **Password**: Enter the password for the user account. +- **Ignore SSL Issues**: When turned on, the credential will connect even if SSL validation fails. +- **SSL**: Choose whether to use SSL in your connection. Refer to Postgres [SSL Support](https://www.postgresql.org/docs/16/libpq-ssl.html){:target=_blank .external-link} for more information. Options include: + - **Allow**: Sets the `ssl-mode` parameter to `allow`. First try a non-SSL connection; if that fails, try an SSL connection. + - **Disable**: Sets the `ssl-mode` parameter to `disable`. Only try a non-SSL connection. + - **Require**: Sets the `ssl-mode` parameter to `require`. Only try an SSL connection. If a root CA file is present, verify that a trusted certificate authority (CA) issued the server certificate. + - **Verify**: Sets the `ssl-mode` parameter to `verify-ca`. Only try an SSL connection and verify that a trusted certificate authority (CA) issued the server certificate. + - **Verify-Full**: Sets the `ssl-mode` parameter to `verify-full`. Only try an SSL connection, verify that a trusted certificate authority (CA) issued the server certificate and that the requested server host name matches that in the certificate. +- The **Port**: Enter the port number to use for the connection. +- **SSH Tunnel**: If turned on, the credential uses SSH to encrypt the network connection with the Postgres server. Refer to [Using SSH tunnel](#using-ssh-tunnel) for more information. + +Refer to [Connection Strings](https://www.postgresql.org/docs/16/libpq-connect.html#LIBPQ-CONNSTRING){:target=_blank .external-link} for more information on finding and formatting these fields. + +### SSH tunnel + +Only turn on the **SSH Tunnel** if: -## Using Database Connection +- You're using the credential with the [Postgres](/integrations/builtin/app-nodes/n8n-nodes-base.postgres/) node (Agent node doesn't support SSH tunnels). +- You have an SSH server running on the same machine as the Postgres server. +- You have a user account that can log in using `ssh`. -1. Retrieve your Postgres credentials and connection parameters. -2. Use the credentials and connection parameters with your Postgres node credentials in n8n. +Once turned on, you'll need: -![Getting Postgres credentials](/_images/integrations/builtin/credentials/postgres/using-database-connection.gif) +- **SSH Authenticate with**: Select whether to authenticate SSH with a **Password** or **Private Key**. +- **SSH Host**: Enter the remote bind address you're connecting to. +- **SSH Port**: Enter the local port number for the SSH tunnel. +- **SSH Postgres Port**: Enter the remote end of the tunnel, the port number the database server is using. +- **SSH User**: Enter the username to log in as. +- **SSH Password**: Only required if you selected **Password** as the **SSH Authenticate with** type. Enter the user's SSH password. +- **Private Key**: Only required if you selected **Private Key** as the **SSH Authenticate with** type. +- **Passphrase**: Only required if you selected **Private Key** as the **SSH Authenticate with** type. +Refer to [Secure TCP/IP Connections with SSH Tunnels](https://www.postgresql.org/docs/16/ssh-tunnels.html){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/posthog.md b/docs/integrations/builtin/credentials/posthog.md index 2539bb6e2fe..39826055e24 100644 --- a/docs/integrations/builtin/credentials/posthog.md +++ b/docs/integrations/builtin/credentials/posthog.md @@ -6,29 +6,32 @@ contentType: integration # PostHog credentials -You can use these credentials to authenticate the following nodes with PostHog. +You can use these credentials to authenticate the following nodes: - [PostHog](/integrations/builtin/app-nodes/n8n-nodes-base.posthog/) - ## Prerequisites -Create a [PostHog](https://posthog.com/) account or host PostHog on your server. +Create a [PostHog](https://posthog.com/){:target=_blank .external-link} account or host PostHog on your server. + +## Supported authentication methods + +- API key + +## Related resources -## Using API Key +Refer to [PostHog's API documentation](https://posthog.com/docs/api){:target=_blank .external-link} for more information about the service. -1. Open your PostHog dashboard. -2. Click on ***Project*** on the left sidebar. -3. Click on the ***Safety & Privacy*** tab. -4. Scroll down to the ***Project API Key*** section and copy the displayed API key. -5. Enter a name for your credentials in the ***Credentials Name*** field in the 'PostHog API' credentials in n8n. -6. If you're hosting PostHog on your own server, update the URL of your PostHog instance in the ***URL*** field. -7. Paste the API key in the ***API Key*** field in the 'PostHog API' credentials in n8n. -8. Click on the ***Create*** button to create your credentials. -The following video demonstrates the steps mentioned above. +## Using API key -
- -
+To configure this credential, you'll need: +- The API **URL**: Enter the correct domain for your API requests: + - On US Cloud, use `https://us.i.posthog.com` for public POST-only endpoints or `https://us.posthog.com` for private endpoints. + - On EU Cloud, use `https://eu.i.posthog.com` for public POST-only endpoints or `https://eu.posthog.com` for private endpoints. + - For self-hosted instances, use your self-hosted domain. + - Confirm yours by checking your PostHog instance URL. +- An **API Key**: The API key you use depends on whether you're accessing public or private endpoints: + - For public POST-only endpoints, use a [Project API key](https://app.posthog.com/project/settings) from your project's **General** Settings. + - For private endpoints, use a [Personal API key](https://app.posthog.com/settings/user-api-keys) from your User account's **Personal API Keys** Settings. Refer to [How to obtain a personal API key](https://posthog.com/docs/api#private-endpoint-authentication){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/postmark.md b/docs/integrations/builtin/credentials/postmark.md index 421b243c005..e3143f7abe0 100644 --- a/docs/integrations/builtin/credentials/postmark.md +++ b/docs/integrations/builtin/credentials/postmark.md @@ -6,21 +6,24 @@ contentType: integration # Postmark credentials -You can use these credentials to authenticate the following nodes with Postmark. +You can use these credentials to authenticate the following nodes: - [Postmark Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.postmarktrigger/) ## Prerequisites -Create a [Postmark](https://postmarkapp.com/) account. +Create a [Postmark](https://postmarkapp.com/){:target=_blank .external-link} account on a Postmark server. -## Using Access Token +## Supported authentication methods -1. Access the [Postmark API Tokens page](https://account.postmarkapp.com/api_tokens). -2. Enter your postmark server name in the ***Search for a server*** field. -3. From the displayed dropdown list, select your server and click on the ***Get a server API token*** button. -4. Use the displayed ***Server API token*** with your Postmark API credentials in n8n. -5. Click the ***Save*** button to save your credentials in n8n. +- API token -![Getting Postmark credentials](/_images/integrations/builtin/credentials/postmark/using-access-token.gif) +## Related resources +Refer to [Postmark's API documentation](https://postmarkapp.com/developer/api/overview){:target=_blank .external-link} for more information about the service. + +## Using API token + +To configure this credential, you'll need: + +- A **Server API Token**: The Server API token is accessible by Account Owners, Account Admins, and users who have Server Admin privileges on a server. Get yours from the [**API Tokens**](https://account.postmarkapp.com/api_tokens){:target=_blank .external-link} tab under your Postmark server. Refer to [API Authentication](https://postmarkapp.com/developer/api/overview#authentication){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/profitwell.md b/docs/integrations/builtin/credentials/profitwell.md index ac4a984583a..ef51a175f11 100644 --- a/docs/integrations/builtin/credentials/profitwell.md +++ b/docs/integrations/builtin/credentials/profitwell.md @@ -6,21 +6,25 @@ contentType: integration # ProfitWell credentials -You can use these credentials to authenticate the following nodes with ProfitWell. +You can use these credentials to authenticate the following nodes: - [ProfitWell](/integrations/builtin/app-nodes/n8n-nodes-base.profitwell/) ## Prerequisites -Create a [ProfitWell](https://www.profitwell.com/) account. +Create a [ProfitWell](https://www2.profitwell.com/signup/start){:target=_blank .external-link} account. -## Using API +## Supported authentication methods -1. Access the [ProfitWell dashboard](https://www2.profitwell.com/app/dashboard) page. -2. Click on the gears icon on the left panel and select 'Integrations'. -3. Click on the ***API KEYS/DEV KIT*** tab. -4. Copy the ***YOUR PRIVATE KEY*** displayed. -5. Use this ***Private Key*** with your ProfitWell node credentials in n8n. +- API token -![Getting ProfitWell credentials](/_images/integrations/builtin/credentials/profitwell/using-api.gif) +## Related resources + +Refer to [Profitwell's API documentation](https://profitwellapiv2.docs.apiary.io/){:target=_blank .external-link} for more information about the service. + +## Using API token + +To configure this credential, you'll need: + +- An **API Token**: To get an API key or token, go to **Account Settings > Integrations** and select **ProfitWell API**. diff --git a/docs/integrations/builtin/credentials/pushbullet.md b/docs/integrations/builtin/credentials/pushbullet.md index 95f4fcca4e6..47ca8627ffb 100644 --- a/docs/integrations/builtin/credentials/pushbullet.md +++ b/docs/integrations/builtin/credentials/pushbullet.md @@ -6,26 +6,34 @@ contentType: integration # Pushbullet credentials -You can use these credentials to authenticate the following nodes with Pushbullet. +You can use these credentials to authenticate the following nodes: - [Pushbullet](/integrations/builtin/app-nodes/n8n-nodes-base.pushbullet/) ## Prerequisites -Create a [Pushbullet](https://www.pushbullet.com/) account. +Create a [Pushbullet](https://www.pushbullet.com/){:target=_blank .external-link} account. -## Using OAuth +## Supported authentication methods -1. Access the [create client](https://www.pushbullet.com/create-client) page. -2. Enter an app name in the ***name*** field. -3. Copy your OAuth Callback URL from the 'Create New Credentials' screen in n8n and paste it in the ***redirect_uri*** field. -4. Click on the ***Add A New OAuth Client*** button. -5. Use the provided ***client_id*** and ***client_secret*** with your Pushbullet OAuth2 API credentials in n8n. -6. Click the ***Connect my account*** button to connect to Pushbullet and save your credentials in n8n. +- OAuth2 -/// note | Pushbullet OAuth Test Link -Pushbullet does offer a test link during the client creation process described above. This link isn't compatible with n8n. To verify the authentication works, use the ***Connect my account*** button in n8n. -/// +## Related resources + +Refer to [Pushbullet's API documentation](https://docs.pushbullet.com/){:target=_blank .external-link} for more information about the service. + +## Using OAuth2 + +To configure this credential, you'll need: -![Getting Pushbullet credentials](/_images/integrations/builtin/credentials/pushbullet/using-oauth.gif) +- A **Client ID**: Generated when you create a Pushbullet app, also known as an OAuth client. +- A **Client Secret**: Generated when you create a Pushbullet app, also known as an OAuth client. + +To generate the **Client ID** and **Client Secret**, go to the [create client](https://www.pushbullet.com/create-client) page. Copy the **OAuth Redirect URL** from n8n and add this as your **redirect_uri** for the app/client. Use the **client_id** and **client_secret** from the OAuth Client in your n8n credential. + +Refer to Pushbullet's [OAuth2 Guide](https://docs.pushbullet.com/#oauth2) for more information. + +/// note | Pushbullet OAuth test link +Pushbullet offers a test link during the client creation process described above. This link isn't compatible with n8n. To verify the authentication works, use the **Connect my account** button in n8n. +/// diff --git a/docs/integrations/builtin/credentials/pushcut.md b/docs/integrations/builtin/credentials/pushcut.md index 7b87ce2c56e..c88b55befa2 100644 --- a/docs/integrations/builtin/credentials/pushcut.md +++ b/docs/integrations/builtin/credentials/pushcut.md @@ -6,22 +6,26 @@ contentType: integration # Pushcut credentials -You can use these credentials to authenticate the following nodes with Pushcut. +You can use these credentials to authenticate the following nodes: - [Pushcut](/integrations/builtin/app-nodes/n8n-nodes-base.pushcut/) - [Pushcut Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.pushcuttrigger/) ## Prerequisites -Download the [Pushcut](https://www.pushcut.io) app. +Download the [Pushcut](https://www.pushcut.io){:target=_blank .external-link} app. -## Using API Key +## Supported authentication methods -1. Access the Pushcut application on your device. -2. Click on the ***Account*** button. -3. Click on the ***Add API Key*** under the ***INTEGRATIONS*** section. -4. Click on the ***Generate*** button. -5. Use the ***API Key*** with your Pushcut node credentials in n8n. +- API key -![Getting Pushcut credentials](/_images/integrations/builtin/credentials/pushcut/using-api-key.gif) +## Related resources + +Refer to [Pushcut's Guides documentation](https://www.pushcut.io/guides){:target=_blank .external-link} for more information about the service. + +## Using API key + +To configure this credential, you'll need: + +- An **API Key**: To generate an API key, go to **Account > Integrations > Add API Key**. Refer to [Create an API key](https://www.pushcut.io/guides/homekit-api-schedule-cancel#step_2){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/pushover.md b/docs/integrations/builtin/credentials/pushover.md index 4cb4dd143ef..6a6af7e965f 100644 --- a/docs/integrations/builtin/credentials/pushover.md +++ b/docs/integrations/builtin/credentials/pushover.md @@ -6,22 +6,25 @@ contentType: integration # Pushover credentials -You can use these credentials to authenticate the following nodes with Pushover. +You can use these credentials to authenticate the following nodes: - [Pushover](/integrations/builtin/app-nodes/n8n-nodes-base.pushover/) ## Prerequisites -Create a [Pushover](https://pushover.net) account. +Create a [Pushover](https://pushover.net){:target=_blank .external-link} account. + +## Supported authentication methods + +- API key + +## Related resources + +Refer to [Pushover's API documentation](https://pushover.net/api){:target=_blank .external-link} for more information about authenticating with the service. ## Using API Key -1. Access the [Pushover dashboard](https://pushover.net/). -2. Scroll down to the bottom and click on ***Create an Application/API Token***. -3. Enter the name of your application in the ***Name*** field. -4. Read the 'Terms of Services' and the 'Guide to Being Friendly to our API' and, if you agree to them, check the checkbox. -5. Click on the ***Create Application*** button. -6. Use this ***API Key*** with your Pushover node credentials in n8n. +To configure this credential, you'll need: -![Getting Pushover credentials](/_images/integrations/builtin/credentials/pushover/using-api-key.gif) +- An **API Key**: Generated when you [register an application](https://pushover.net/apps/build){:target=_blank .external-link}. Refer to [Application Registration](https://pushover.net/api#registration){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/qdrant.md b/docs/integrations/builtin/credentials/qdrant.md index 556ab4606c9..c5de97fdf7a 100644 --- a/docs/integrations/builtin/credentials/qdrant.md +++ b/docs/integrations/builtin/credentials/qdrant.md @@ -12,12 +12,21 @@ You can use these credentials to authenticate the following nodes: ## Prerequisites -You need an API key and Qdrant cluster URL to establish a connection. +Create a [Qdrant cluster](https://qdrant.tech/documentation/cloud/create-cluster/){:target=_blank .external-link}. -Refer to [Qdrant's authentication docs](https://qdrant.tech/documentation/cloud/authentication/#authentication){:target=_blank .external-link} for guidance on getting your key and URL. +## Supported authentication methods + +- API key ## Related resources -Refer to [Qdrant's documentation](https://qdrant.tech/documentation/){:target=_blank .external-link} +Refer to [Qdrant's documentation](https://qdrant.tech/documentation/){:target=_blank .external-link} for more information. --8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Using API key + +To configure this credential, you'll need: + +- An **API Key**: Create an API key from your **Cloud Dashboard > Access Management**. Refer to [Qdrant's authentication documentation](https://qdrant.tech/documentation/cloud/authentication/){:target=_blank .external-link} for more information. +- A **Qdrant URL**: The URL for your Qdrant cluster. Refer to [Qdrant Web UI](https://qdrant.tech/documentation/interfaces/web-ui/){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/qradar.md b/docs/integrations/builtin/credentials/qradar.md index c601575360a..a52981f5cfa 100644 --- a/docs/integrations/builtin/credentials/qradar.md +++ b/docs/integrations/builtin/credentials/qradar.md @@ -5,14 +5,24 @@ description: Documentation for the QRadar credentials. Use these credentials to # QRadar credentials -You can use these credentials to authenticate when using the HTTP Request node to make a [Custom API call](/integrations/custom-operations/). +You can use these credentials to authenticate when using the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) to make a [Custom API call](/integrations/custom-operations/). -## Authentication methods +## Prerequisites -n8n supports QRadar authentication with an API key. +Create a [Qradar](https://www.ibm.com/qradar){:target=_blank .external-link} account. + +## Supported authentication methods + +- API key ## Related resources Refer to [QRadar's documentation](https://ibmsecuritydocs.github.io/qradar_api_overview/){:target=_blank .external-link} for more information about the service. This is a credential-only node. Refer to [Custom API operations](/integrations/custom-operations/) to learn more. View [example workflows and related content](https://n8n.io/integrations/qradar/){:target=_blank .external-link} on n8n's website. + +## Using API key + +To configure this credential, you'll need: + +- An **API Key**: Also known as an authorized service token. Use the **Manage Authorized Services** window on the **Admin** tab to create an authentication token. Refer to [Creating an authentication token](https://www.ibm.com/docs/en/qradar-common?topic=forwarding-creating-authentication-token){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/qualys.md b/docs/integrations/builtin/credentials/qualys.md index 98ca223e48c..bd4055bf611 100644 --- a/docs/integrations/builtin/credentials/qualys.md +++ b/docs/integrations/builtin/credentials/qualys.md @@ -5,14 +5,26 @@ description: Documentation for the Qualys credentials. Use these credentials to # Qualys credentials -You can use these credentials to authenticate when using the HTTP Request node to make a [Custom API call](/integrations/custom-operations/). +You can use these credentials to authenticate when using the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) to make a [Custom API call](/integrations/custom-operations/). -## Authentication methods +## Prerequisites -n8n supports Qualys authentication with username and password. +Create a [Qualys](https://www.qualys.com/){:target=_blank .external-link} user account with any user role except Contact. + +## Supported authentication methods + +- Basic auth ## Related resources Refer to [Qualys's documentation](https://qualysguard.qg2.apps.qualys.com/qwebhelp/fo_portal/api_doc/index.htm){:target=_blank .external-link} for more information about the service. This is a credential-only node. Refer to [Custom API operations](/integrations/custom-operations/) to learn more. View [example workflows and related content](https://n8n.io/integrations/qualys/){:target=_blank .external-link} on n8n's website. + +## Using basic auth + +To configure this credential, you'll need: + +- A **Username** +- A **Password** +- A **Requested With** string: Enter a user description, like a user agent, or keep the default `n8n application`. This sets the required `X-Requested-With` header. \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/questdb.md b/docs/integrations/builtin/credentials/questdb.md index fb7687f473f..3293bc71552 100644 --- a/docs/integrations/builtin/credentials/questdb.md +++ b/docs/integrations/builtin/credentials/questdb.md @@ -6,16 +6,36 @@ contentType: integration # QuestDB credentials -You can use these credentials to authenticate the following nodes with QuestDB. +You can use these credentials to authenticate the following nodes: - [QuestDB](/integrations/builtin/app-nodes/n8n-nodes-base.questdb/) ## Prerequisites -An available instance of QuestDB. +Create a user account on an instance of [QuestDB](https://questdb.io/){:target=_blank .external-link}. -## Using Database Connection +## Supported authentication methods -1. Retrieve your QuestDB credentials and connection parameters. -2. Use the credentials and connection parameters with your QuestDB node credentials in n8n. +- Database connection +## Related resources + +Refer to [QuestDB's documentation](https://questdb.io/docs){:target=_blank .external-link} for more information about the service. + +## Using database connection + +To configure this credential, you'll need: + +- The **Host**: Enter the host name or IP address for the server. +- The **Database**: Enter the database name, for example `qdb`. +- A **User**: Enter the username for the user account as configured in `pg.user` or `pg.readonly.user` property in `server.conf`. Default value is `admin`. +- A **Password**: Enter the password for the user account as configured in `pg.password` or `pg.readonly.password` property in `server.conf`. Default value is `quest`. +- **SSL**: Select whether the connection should use SSL, which sets the `sslmode` parameter. Options include: + - **Allow** + - **Disable** + - **Require** + - **Verify** + - **Verify-Full** +- The **Port**: Enter the port number to use for the connection. Default is `8812`. + +Refer to [List of supported connection properties](https://questdb.io/docs/reference/api/postgres/#list-of-supported-connection-properties){:target=_blank .external-link} for more information. \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/quickbase.md b/docs/integrations/builtin/credentials/quickbase.md index 1458de58264..9ffcdbe6542 100644 --- a/docs/integrations/builtin/credentials/quickbase.md +++ b/docs/integrations/builtin/credentials/quickbase.md @@ -6,29 +6,26 @@ contentType: integration # Quick Base credentials -You can use these credentials to authenticate the following nodes with Quick Base. +You can use these credentials to authenticate the following nodes: - [Quick Base](/integrations/builtin/app-nodes/n8n-nodes-base.quickbase/) ## Prerequisites -Create a [Quick Base](https://www.quickbase.com/) account. +Create a [Quick Base](https://www.quickbase.com/){:target=_blank .external-link} account. -## Using API +## Supported authentication methods -1. Access your Quick Base dashboard. -2. Click on your name on the top right and select 'My preferences' from the dropdown list. -3. Click on ***Manage my user tokens*** under the ***My User Information*** section. -4. Click on the ***+ New user token*** button. -5. Enter a name in the ***Name*** field. -6. Select an app from the ***Assign token to apps*** dropdown list. -7. Click on the ***Save*** button. -8. Copy the string of characters located between `https://` and `/db` in your Quick Base URL. This string is the hostname. -9. Use this ***Hostname*** and ***User Token*** with your Quick Base node credentials in n8n. +- API key -![Getting Quick Base credentials](/_images/integrations/builtin/credentials/quickbase/using-api.gif) +## Related resources -## Further Reference +Refer to [Quick Base's API documentation](https://developer.quickbase.com/auth/){:target=_blank .external-link} for more information about the service. -- [Quick Base API Portal](https://developer.quickbase.com/auth) +## Using API key + +To configure this credential, you'll need: + +- A **Hostname**: The string of characters located between `https://` and `/db` in your Quick Base URL. +- A **User Token**: To generate a token, select your **Profile > My preferences > My User Information > Manage my user tokens**. Refer to [Creating and using user tokens](https://helpv2.quickbase.com/hc/en-us/articles/4570374095124-Creating-and-using-user-tokens){:target=_blank .external-link} for detailed instructions. diff --git a/docs/integrations/builtin/credentials/quickbooks.md b/docs/integrations/builtin/credentials/quickbooks.md index c794d7a7741..ac08638d366 100644 --- a/docs/integrations/builtin/credentials/quickbooks.md +++ b/docs/integrations/builtin/credentials/quickbooks.md @@ -6,45 +6,40 @@ contentType: integration # QuickBooks credentials -You can use these credentials to authenticate the following nodes with QuickBooks. +You can use these credentials to authenticate the following nodes: - [QuickBooks](/integrations/builtin/app-nodes/n8n-nodes-base.quickbooks/) ## Prerequisites -Create a [Intuit developer](https://developer.intuit.com/) account. - -## Using OAuth - - - -1. Open the Intuit Developer [dashboard](https://developer.intuit.com/app/developer/dashboard) page. -2. Click on the ***+ Create an app*** button. -3. Select the ***QuickBooks Online and Payments*** platform. -4. Enter the name of the app in the ***What's your app name?*** field. -5. Select the required scopes under the ***Select Scope*** section. -6. Click on the ***Create app*** button. -7. Click on ***Keys & OAuth*** under the ***Development*** section. -8. Scroll down to the ***Redirect URIs*** section and click on the ***Add URI*** button. -9. Copy the 'OAuth Callback URL' provided in the 'QuickBooks OAuth2 API' credentials in n8n. -10. Paste the URL in the ***Link*** field. -11. Click on the ***Save*** button. -12. Copy the displayed ***Client ID***. -13. Enter a name for your credentials in the ***Credentials Name*** field in the 'QuickBooks OAuth2 API' credentials in n8n. -14. Paste the client ID in the ***Client ID*** field in the 'QuickBooks OAuth2 API' credentials in n8n. -15. Copy the displayed ***Client Secret*** from the Keys page. -16. Paste the client secret in the ***Client Secret*** field in the 'QuickBooks OAuth2 API' credentials in n8n. -17. Select 'Sandbox' from the ***Environment*** dropdown list in the 'QuickBooks OAuth2 API' credentials in n8n. -18. Click on the circle button in the OAuth section to connect a QuickBooks account to n8n. -19. Click the ***Save*** button to save your credentials in n8n. - -**Note:** To build the application in production, you will have to fulfill all the requirements mentioned by Intuit. You can learn more on Intuit's [documentation](https://developer.intuit.com/app/developer/qbo/docs/go-live). - -The following video demonstrates the steps mentioned above. - -
- -
+Create an [Intuit developer](https://developer.intuit.com/){:target=_blank .external-link} account. +## Supported authentication methods + +- OAuth2 + +## Related resources + +Refer to [Intuit's API documentation](https://developer.intuit.com/app/developer/qbo/docs/develop){:target=_blank .external-link} for more information about the service. + +## Using OAuth2 + +To configure this credential, you'll need: + +- A **Client ID**: Generated when you create an app. +- A **Client Secret**: Generated when you create an app. +- An **Environment**: Select whether this credential should access your **Production** or **Sandbox** environment. + +To generate your **Client ID** and **Client Secret**, [create an app](https://developer.intuit.com/app/developer/qbo/docs/get-started/start-developing-your-app#create-an-app){:target=_blank .external-link}. + +Use these settings when creating your app: + +- Select appropriate scopes for your app. Refer to [Learn about scopes](https://developer.intuit.com/app/developer/qbo/docs/learn/scopes){:target=_blank .external-link} for more information. +- Enter the **OAuth Redirect URL** from n8n as a **Redirect URI** in the app's **Development > Keys & OAuth** section. +- Copy the **Client ID** and **Client Secret** from the app's **Development > Keys & OAuth** section to enter in n8n. Refer to [Get the Client ID and Client Secret for your app](https://developer.intuit.com/app/developer/qbo/docs/get-started/get-client-id-and-client-secret){:target=_blank .external-link} for more information. + +Refer to Intuit's [Set up OAuth 2.0 documentation](https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0){:target=_blank .external-link} for more information on the entire process. + +/// note | Environment selection +If you're creating a new app from scratch, start with the **Sandbox** environment. Production apps need to fulfill all Intuit's requirements. Refer to Intuit's [Publish your app documentation](https://developer.intuit.com/app/developer/qbo/docs/go-live/publish-app){:target=_blank .external-link} for more information. +/// \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/rabbitmq.md b/docs/integrations/builtin/credentials/rabbitmq.md index a6a86cfafce..a21097342c8 100644 --- a/docs/integrations/builtin/credentials/rabbitmq.md +++ b/docs/integrations/builtin/credentials/rabbitmq.md @@ -6,16 +6,53 @@ contentType: integration # RabbitMQ credentials -You can use these credentials to authenticate the following nodes with RabbitMQ. +You can use these credentials to authenticate the following nodes: - [RabbitMQ](/integrations/builtin/app-nodes/n8n-nodes-base.rabbitmq/) - [RabbitMQ Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.rabbitmqtrigger/) ## Prerequisites -You need to have a RabbitMQ broker installed. +Install a [RabbitMQ broker](https://www.rabbitmq.com/). -## Using RabbitMQ +## Supported authentication methods -Use your Hostname, Port, Username, Password, and Vhost as the RabbitMQ credential data in n8n. +- User connection + +## Related resources + +Refer to [RabbitMQ's Connections documentation](https://www.rabbitmq.com/docs/connections){:target=_blank .external-link} for more information about the service. + +## Using user connection + + +To configure this credential, you'll need: + +- A **Hostname**: The hostname for the RabbitMQ broker. +- A **Port**: The port the connection should use. +- A **User**: The user to log in as for the connection. The default is `guest`. RabbitMQ recommends using a different user in production environments. Refer to [Access Control | The Basics](https://www.rabbitmq.com/docs/access-control#basics) for more information. If you're using the `guest` account with a non-localhost connection, refer to [`guest` user issues](#guest-user-issues) below for troubleshooting tips. +- A **Password**: The password for the user. The default password for the `guest` user is `guest`. +- A **Vhost**: Enter the [virtual host](https://www.rabbitmq.com/docs/vhosts){:target=_blank .external-link} the connection should use. The default virtual host is `/`. +- **SSL**: Select whether the connection should use SSL. If turned on, also set: + - **Passwordless**: Select whether the SSL certificate connection is passwordless or uses SASL mechanism EXTERNAL. If turned on, you'll also need to enter: + - The **Client Certificate**: Paste the text of the SSL client certificate to use. + - The **Client Key**: Paste the SSL client key to use. + - The **Passphrase**: Paste the SSL passphrase to use. + - **CA Certificates**: Paste the text of the SSL CA certificates to use. + + +## guest user issues + +If you use the `guest` user for the credential and you try to access a remote host, you may see a connection error. The RabbitMQ logs show an error like this: + + [error] <0.918.0> PLAIN login refused: user 'guest' can only connect via localhost + +This happens because RabbitMQ prohibits the default `guest` user from connecting from remote hosts. It can only connect over the `localhost`. + +To resolve this error, you can: + +- Update the `guest` user to allow it remote host access. +- Create or use a different user to connect to the remote host. The `guest` user is the only user limited by default. + +Refer to ["guest" user can only connect from localhost](https://www.rabbitmq.com/docs/access-control#loopback-users){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/raindrop.md b/docs/integrations/builtin/credentials/raindrop.md index 88b3e3e509d..a33bdb24072 100644 --- a/docs/integrations/builtin/credentials/raindrop.md +++ b/docs/integrations/builtin/credentials/raindrop.md @@ -6,43 +6,35 @@ contentType: integration # Raindrop credentials -You can use these credentials to authenticate the following nodes with Raindrop. +You can use these credentials to authenticate the following nodes: - [Raindrop](/integrations/builtin/app-nodes/n8n-nodes-base.raindrop/) ## Prerequisites -Create a [Raindrop](https://raindrop.io/) account. +Create a [Raindrop](https://raindrop.io/){:target=_blank .external-link} account. + +## Supported authentication methods + +- OAuth2 + +## Related resources + +Refer to [Raindrop's API documentation](https://developer.raindrop.io/){:target=_blank .external-link} for more information about the service. ## Using OAuth - - -1. Open the [Raindrop dashboard](https://app.raindrop.io/my/0) page. -2. Click on your username on the top left and select 'Settings' from the dropdown list. -3. Click on the ***Integrations*** tab. -4. Click on ***+ Create new app*** under the ***For Developers*** section. -5. Enter the name of the app in the ***Name*** field. -6. Accept the ***Raindrop.io API Terms and Guidelines***. -7. Click on the ***Create*** button. -8. Under the ***For Developers*** section, select the app that you created. -9. Enter a description in the ***Description*** field. -10. Enter a URL in the ***Site*** field. -11. Copy the 'OAuth Callback URL' provided in the 'Raindrop OAuth2 API' credentials in n8n. -12. Paste the URL in the ***Redirect URI*** field and click on the ***Save*** button. -13. Copy the displayed ***Client ID***. -14. Enter a name for your credentials in the ***Credentials Name*** field in the 'Raindrop OAuth2 API' credentials in n8n. -15. Paste the client ID in the ***Client ID*** field in the 'Raindrop OAuth2 API' credentials in n8n. -16. Copy the displayed ***Client secret*** from the Raindrop. -17. Paste the client secret in the ***Client Secret*** field in the 'Raindrop OAuth2 API' credentials in n8n. -18. Click on the circle button in the OAuth section to connect a Raindrop account to n8n. -19. Click the ***Save*** button to save your credentials in n8n. - -The following video demonstrates the steps mentioned above. - -
- -
+To configure this credential, you'll need: + +- A **Client ID** +- A **Client Secret** + +Generate both by creating a Raindrop app. + +To create an app, go to **Settings >** [**Integrations**](https://app.raindrop.io/settings/integrations){:target=_blank .external-link} and select **+ Create new app** in the **For Developers** section. + +Use these settings for your app: + +- Copy the **OAuth Redirect URL** from n8n and add it as a **Redirect URI** in your app. +- Copy the **Client ID** and **Client Secret** from the Raindrop app and enter them in your n8n credential. diff --git a/docs/integrations/builtin/credentials/recordedfuture.md b/docs/integrations/builtin/credentials/recordedfuture.md index 7e7ffb59881..c24e7defa08 100644 --- a/docs/integrations/builtin/credentials/recordedfuture.md +++ b/docs/integrations/builtin/credentials/recordedfuture.md @@ -5,14 +5,26 @@ description: Documentation for the Recorded Future credentials. Use these creden # Recorded Future credentials -You can use these credentials to authenticate when using the HTTP Request node to make a [Custom API call](/integrations/custom-operations/). +You can use these credentials to authenticate when using the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) to make a [Custom API call](/integrations/custom-operations/). -## Authentication methods +## Prerequisites -n8n supports Recorded Future authentication with an access token. +Create a [Recorded Future](https://www.recordedfuture.com){:target=_blank .external-link} account. + +## Supported authentication methods + +- API access token ## Related resources -Refer to [Recorded Future's documentation](https://api.recordedfuture.com/index.html){:target=_blank .external-link} for more information about the service. +Refer to [Recorded Future's documentation](https://api.recordedfuture.com/index.html){:target=_blank .external-link} for more information about the service. The rest of Recorded Future's help center requires a paid account. This is a credential-only node. Refer to [Custom API operations](/integrations/custom-operations/) to learn more. View [example workflows and related content](https://n8n.io/integrations/recorded-future/){:target=_blank .external-link} on n8n's website. + +## Using API access token + +To configure this credential, you'll need: + +- An API **Access Token** + +Refer to the [Recorded Future APIs documentation](https://support.recordedfuture.com/hc/en-us/categories/16372120363539-Recorded-Future-APIs){:target=_blank .external-link} for more information on getting your API access token. diff --git a/docs/integrations/builtin/credentials/reddit.md b/docs/integrations/builtin/credentials/reddit.md index 1c149e42fe9..524ec058867 100644 --- a/docs/integrations/builtin/credentials/reddit.md +++ b/docs/integrations/builtin/credentials/reddit.md @@ -6,36 +6,38 @@ contentType: integration # Reddit credentials -You can use these credentials to authenticate the following nodes with Reddit. +You can use these credentials to authenticate the following nodes: - [Reddit](/integrations/builtin/app-nodes/n8n-nodes-base.reddit/) - ## Prerequisites -Create a [Reddit](https://reddit.com/) account. - -## Using OAuth - -1. Open [Reddit](https://reddit.com). -2. Click on your avatar on the top right and select 'User Settings'. -3. Click on the ***Safety & Privacy*** tab. -4. Scroll to the bottom and click on ***Manage third-party app authorization***. -5. Click on the ***are you a developer? create an app...*** button. -6. Enter the name of your application in the ***name*** field. -7. Copy the 'OAuth Callback URL' provided in the 'Reddit OAuth2 API' credentials in n8n. -8. Paste the URL in the ***redirect uri*** field. -9. Click on the ***create app*** button. -10. Copy the client ID displayed next to the app's icon. -11. Enter a name for your credentials in the ***Credentials Name*** field in the 'Reddit OAuth2 API' credentials in n8n. -12. Paste the client ID in the ***Client ID*** field in the 'Reddit OAuth2 API' credentials in n8n. -13. Copy the client secret from Reddit and paste it in the ***Client Secret*** field in the 'Reddit OAuth2 API' credentials in n8n. -14. Click on the circle button in the OAuth section to connect a Reddit account to n8n. -15. Click on the ***Save*** button to save your credentials. - -The following video demonstrates the steps mentioned above. - -
- -
+Create a [Reddit](https://reddit.com/){:target=_blank .external-link} account. + +## Supported authentication methods + +- OAuth2 + +## Related resources + +Refer to [Reddit's developer documentation](https://support.reddithelp.com/hc/en-us/articles/14945211791892-Developer-Platform-Accessing-Reddit-Data){:target=_blank .external-link} for more information about the service. + +## Using OAuth2 + +To configure this credential, you'll need: + +- A **Client ID** +- A **Client Secret** + +/// note | Developer program +Reddit's developer program is in a closed beta. The instructions below are for regular Reddit users, not members of the developer platform. +/// + +Generate both by creating a [third-party app](https://www.reddit.com/prefs/apps){:target=_blank .external-link}. Visit the previous link or go to your **profile > Settings > Safety & Privacy > Manage third-party app authorization > are you a developer? create an app**. + +Use these settings for your app: + +- Copy the **OAuth Callback URL** from n8n and use it as your app's **redirect uri**. +- The app's client ID displays underneath your app name. Copy that and add it as your n8n **Client ID**. +- Copy the app's **secret** and add it as your n8n **Client Secret**. diff --git a/docs/integrations/builtin/credentials/redis.md b/docs/integrations/builtin/credentials/redis.md index 954e0a9362f..20ff1ea88b5 100644 --- a/docs/integrations/builtin/credentials/redis.md +++ b/docs/integrations/builtin/credentials/redis.md @@ -6,19 +6,33 @@ contentType: integration # Redis credentials -You can use these credentials to authenticate the following nodes with Redis. +You can use these credentials to authenticate the following nodes: - [Redis](/integrations/builtin/app-nodes/n8n-nodes-base.redis/) - [Redis Chat Memory](/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.memoryredischat/) ## Prerequisites -Create an user account on a Redis server. +Create a user account on a [Redis](https://redis.io/){:target=_blank .external-link} server. -## Using Database Connection +## Supported authentication methods -1. Retrieve your Redis credentials and connection parameters. -2. Use the credentials and connection parameters with your Redis node credentials in n8n. +- Database connection + +## Related resources + +Refer to [Redis's developer documentation](https://redis.readthedocs.io/en/stable/index.html){:target=_blank .external-link} for more information about the service. + +## Using database connection + +To configure this credential, you'll need: + +- A **Password**: Enter a password for the account. +- The **Host**: Enter the host name of the Redis server. Default is `localhost`. +- The **Port**: Enter the port number the connection should use to connect. Default is `6379`. +- A **Database Number**: Enter the database number. Default is `0`. +- **SSL**: When turned on, the credential connects over SSL. + +Refer to [Connecting to Redis | Generic client](https://redis.readthedocs.io/en/stable/connections.html){:target=_blank .external-link} for more information. -![Getting Redis credentials](/_images/integrations/builtin/credentials/redis/using-database-connection.gif) diff --git a/docs/integrations/builtin/credentials/rocketchat.md b/docs/integrations/builtin/credentials/rocketchat.md index 7bcd98e0274..23aa174fcbb 100644 --- a/docs/integrations/builtin/credentials/rocketchat.md +++ b/docs/integrations/builtin/credentials/rocketchat.md @@ -6,24 +6,32 @@ contentType: integration # Rocket.Chat credentials -You can use these credentials to authenticate the following nodes with Rocket.Chat. +You can use these credentials to authenticate the following nodes: - [Rocket.Chat](/integrations/builtin/app-nodes/n8n-nodes-base.rocketchat/) ## Prerequisites -- Create a [Rocket.Chat](https://rocket.chat/) account. -- Have the necessary permission `create-personal-access-tokens` (from administrator) to be able to generate personal access tokens. - -## Using Access Token - -1. Access your Rocket.Chat instance. -2. Click on the profile icon in the top left. -3. Click on My Account. -4. Click on Personal Access Tokens from the panel on the left. -5. Enter a name for your Personal access token and click on the *Add* button. -6. Copy the *Token* and enter that in the *Auth Key* field in n8n. -7. Copy the *User Id* and enter that in the *User Id* field in n8n. - -![Getting Rocket.Chat credentials](/_images/integrations/builtin/credentials/rocketchat/using-access-token.gif) - +- Create a [Rocket.Chat](https://rocket.chat/){:target=_blank .external-link} account. +- Your account must have the `create-personal-access-tokens` permission to generate personal access tokens. + +## Supported authentication methods + +- API access token + +## Related resources + + +Refer to [Rocket.Chat's API documentation](https://developer.rocket.chat/reference/api/rest-api){:target=_blank .external-link} for more information about the service. + + +## Using API access token + +To configure this credential, you'll need: + +- Your **User ID**: Displayed when you generate an access token. +- An **Auth Key**: Your personal access token. To generate an access token, go to your **avatar > Account > Personal Access Tokens**. Copy the token and add it as the n8n **Auth Key**. +- Your Rocket.Chat **Domain**: Also known as your default URL or workspace URL. + +Refer to [Personal Access Tokens](https://docs.rocket.chat/use-rocket.chat/user-guides/user-panel/account#personal-access-tokens){:target=_blank .external-link} for more information. + diff --git a/docs/integrations/builtin/credentials/rundeck.md b/docs/integrations/builtin/credentials/rundeck.md index 9cac9adf9f2..ce47ebbac34 100644 --- a/docs/integrations/builtin/credentials/rundeck.md +++ b/docs/integrations/builtin/credentials/rundeck.md @@ -6,22 +6,26 @@ contentType: integration # Rundeck credentials -You can use these credentials to authenticate the following nodes with Rundeck. +You can use these credentials to authenticate the following nodes: - [Rundeck](/integrations/builtin/app-nodes/n8n-nodes-base.rundeck/) ## Prerequisites -Create a [Rundeck](https://www.rundeck.com/) account. +Create a user account on a [Rundeck](https://www.rundeck.com/){:target=_blank .external-link} server. -## Using Access Token +## Supported authentication methods -1. Access your Rundeck dashboard. -2. Click on your user icon in the top right. -3. Click on 'Profile'. -4. Next to 'User API Tokens', click on the plus button and generate a new token. -5. Click on 'Show Token' to reveal the token you generated. -5. Use the API token with your Rundeck node credentials in n8n. +- API token -![Getting Rundeck credentials](/_images/integrations/builtin/credentials/rundeck/using-access-token.gif) +## Related resources + +Refer to [Rundeck's API documentation](https://docs.rundeck.com/docs/api/){:target=_blank .external-link} for more information about the service. + +## Using API token + +To configure this credential, you'll need: + +- Your **URL**: Enter the base URL of your Rundeck server, for example `http://myserver:4440`. Refer to [URLs](https://docs.rundeck.com/docs/api/#urls) for more information. +- A user API **Token**: To generate a user API token, go to your **Profile > User API Tokens**. Refer to [User API tokens](https://docs.rundeck.com/docs/manual/10-user.html#user-api-tokens){:target=_blank .external-link} for more information.