mirror of
https://github.com/n8n-io/n8n-docs.git
synced 2025-11-20 17:48:34 +00:00
merge main
This commit is contained in:
commit
b48ffe5f43
@ -0,0 +1,8 @@
|
||||
To use a predefined credential type:
|
||||
|
||||
1. Open your HTTP Request node, or add a new one to your workflow.
|
||||
2. In **Authentication**, select **Existing Credential Type**.
|
||||
3. In **Credential Type**, select the API you want to use.
|
||||
4. In **Credential for `<API name>`**, you can:
|
||||
1. Select an existing credential for that platform, if available.
|
||||
2. Select **Create New** to create a new credential.
|
||||
BIN
docs/_images/integrations/custom-operations/scopes.png
Normal file
BIN
docs/_images/integrations/custom-operations/scopes.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
@ -8,13 +8,19 @@ The HTTP Request node is one of the most versatile nodes in n8n. It allows you t
|
||||
|
||||
## Node Reference
|
||||
|
||||
- **Authentication:** Select the authentication method to use for the request from the following:
|
||||
- Basic Auth
|
||||
- Digest Auth
|
||||
- Header Auth
|
||||
- OAuth1
|
||||
- OAuth2
|
||||
- None
|
||||
- **Authentication:** there are two options for authentication:
|
||||
- Select **Existing Credential Type** to use predefined credential types. This allows you to perform custom operations with some APIs where n8n has a node for the platform. For example, n8n has an Asana node, and supports using your Asana credentials in the HTTP Request node. Refer to [Custom API operations](/integrations/custom-operations/) for more information.
|
||||
- Select **Generic Credential Type** to set up authentication using one of the following methods.
|
||||
- Basic Auth
|
||||
- Digest Auth
|
||||
- Header Auth
|
||||
- OAuth1
|
||||
- OAuth2
|
||||
- None
|
||||
|
||||
!!! note "Use existing credential type when possible"
|
||||
n8n recommends using the **Existing credential type** option when it's available. It offers an easier way to set up and manage credentials, compared to configuring generic credentials.
|
||||
|
||||
- **Request Method:** Select the method to be used for the request:
|
||||
- DELETE
|
||||
- GET
|
||||
|
||||
@ -6,7 +6,17 @@ You can use these credentials to authenticate the following nodes:
|
||||
|
||||
## Prerequisites
|
||||
|
||||
You must use the authentication method required by the app or service you want to query. The following authentication methods are available:
|
||||
You must use the authentication method required by the app or service you want to query.
|
||||
|
||||
### Existing credential types
|
||||
|
||||
n8n recommends using this option whenever there's a credential type available for the service you want to connect to. It offers an easier way to set up and manage credentials, compared to configuring generic credentials.
|
||||
|
||||
You can use [Predefined credential types](/integrations/custom-operations/#predefined-credential-types) to perform custom operations with some APIs where n8n has a node for the platform. For example, n8n has an Asana node, and supports using your Asana credentials in the HTTP Request node. Refer to [Custom operations](/integrations/custom-operations/) for more information.
|
||||
|
||||
### Generic authentication
|
||||
|
||||
The following generic authentication methods are available:
|
||||
|
||||
* Basic Auth
|
||||
* Digest Auth
|
||||
@ -17,6 +27,13 @@ You must use the authentication method required by the app or service you want t
|
||||
|
||||
You can learn more about HTTP authentication [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#see_also).
|
||||
|
||||
|
||||
## Using an existing credential type
|
||||
|
||||
--8<-- "_snippets/integrations/predefined-credential-type-how-to.md"
|
||||
|
||||
Refer to [Custom API operations](/integrations/custom-operations/) for more information.
|
||||
|
||||
## Using Basic Auth / Digest Auth
|
||||
|
||||
1. Enter a descriptive *Credentials Name*.
|
||||
@ -57,3 +74,4 @@ Read more about [OAuth1](https://oauth.net/1/).
|
||||
3. Click **Create** to save your credentials.
|
||||
|
||||
Read more about [OAuth2](https://oauth.net/2/).
|
||||
|
||||
|
||||
25
docs/integrations/custom-operations.md
Normal file
25
docs/integrations/custom-operations.md
Normal file
@ -0,0 +1,25 @@
|
||||
# Custom API operations
|
||||
|
||||
n8n supplies hundreds of nodes, allowing you to create workflows that link multiple products. However, some nodes don't include all the possible operations supported by a product's API. You can work around this by making a custom API call using the [HTTP Request](/integrations/core-nodes/n8n-nodes-base.httpRequest/) node.
|
||||
|
||||
One of the most complex parts of setting up API calls is managing authentication. To simplify this, n8n provides a way to use existential credential types (credentials associated with n8n nodes).
|
||||
|
||||
## Predefined credential types
|
||||
|
||||
A predefined credential type is a credential associated with a particular platform. You can use predefined credential types instead of generic credentials in the HTTP Request node.
|
||||
|
||||
For example: you create an Asana credential, for use with the Asana node. Later, you want to perfom an operation that isn't supported by the Asana node, using Asana's API. You can use your existing Asana credential in the HTTP Request node to perform the operation.
|
||||
|
||||
### Using predefined credential types
|
||||
|
||||
--8<-- "_snippets/integrations/predefined-credential-type-how-to.md"
|
||||
|
||||
|
||||
### Credential scopes
|
||||
|
||||
Some existing credential types have specfic scopes: endpoints that they work with. n8n warns you about this when you select the credential type.
|
||||
|
||||
For example, follow the steps in [Using predefined credential types](#using-predefined-credential-types), and select **Google Calendar OAuth2 API** as your **Credential Type**. n8n displays a box listing the two endpoints you can use this credential type with:
|
||||
|
||||

|
||||
|
||||
@ -1,16 +1,16 @@
|
||||
# Data collection
|
||||
|
||||
n8n collects selected usage and performance data to help us diagnose problems and improve the platform. We take care to keep this data anonymous and to avoid collecting sensitive data. Read about how this information is stored and processed in our [privacy policy](https://n8n.io/legal/privacy).
|
||||
n8n collects selected usage and performance data to help diagnose problems and improve the platform. n8n takes care to keep this data anonymous and to avoid collecting sensitive data. Read about how n8n stores and processes this information in the [privacy policy](https://n8n.io/legal/privacy).
|
||||
|
||||
## What we collect
|
||||
## What n8n collects
|
||||
|
||||
- Error codes and messages of failed executions (excluding any payload data, and not for custom nodes)
|
||||
- The graph of a workflow (types of nodes used and how they are connected)
|
||||
- From node parameters, only:
|
||||
- The graph of a workflow (types of nodes used and how they're connected)
|
||||
- From node parameters:
|
||||
- The 'resource' and 'operation' that a node is set to (if applicable)
|
||||
- The domain for HTTP nodes (but no path, query parameters or other information)
|
||||
- For HTTP request nodes, the domain, path, and method (with personal data anonymized)
|
||||
- The number of workflow executions and their status
|
||||
- Details on how the UI is used (e.g. navigation, nodes panel searches)
|
||||
- Details on how the UI is used (for example, navigation, nodes panel searches)
|
||||
- Diagnostic information
|
||||
- n8n version
|
||||
- Selected settings:
|
||||
@ -22,20 +22,20 @@ n8n collects selected usage and performance data to help us diagnose problems an
|
||||
- OS, RAM, and CPUs
|
||||
- Anonymous instance ID
|
||||
|
||||
## What we don't collect
|
||||
## What n8n doesn't collect
|
||||
|
||||
We do not collect private or sensitive information, such as:
|
||||
n8n doesn't collect private or sensitive information, such as:
|
||||
|
||||
- Personally identifiable information
|
||||
- Credential information
|
||||
- Node parameters (except 'resource' and 'operation')
|
||||
- Execution data
|
||||
- Sensitive settings (e.g. endpoints, ports, DB connections, username/password)
|
||||
- Sensitive settings (for example, endpoints, ports, DB connections, username/password)
|
||||
- Error payloads
|
||||
|
||||
## How collection works
|
||||
|
||||
Telemetry is collected anonymously, with most data sent to n8n as events that generate it occur. Workflow execution counts and an instance pulse are sent periodically (every 6 hours).
|
||||
n8n collects telemetry anonymously, with most data sent to n8n as events that generate it occur. Workflow execution counts and an instance pulse are sent periodically (every 6 hours).
|
||||
|
||||
## Opting out of telemetry
|
||||
|
||||
|
||||
@ -1,8 +1,44 @@
|
||||
# Release notes
|
||||
|
||||
## n8n@0.177.0
|
||||
## n8n@0.178.0
|
||||
|
||||
|
||||
View the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.177.0...n8n@0.178.0){:target=_blank .external-link} for this version.<br />
|
||||
**Release date:** 2022-05-24
|
||||
|
||||
This release adds support for reusing existing credentials in the HTTP Request node, making it easier to do custom operation with APIs where n8n already has an integration.
|
||||
|
||||
The release also includes improvements to the nodes view, giving better detail about incoming data, as well as some bug fixes.
|
||||
|
||||
### New features
|
||||
|
||||
<div class="n8n-new-features" markdown>
|
||||
|
||||
#### Credential reuse for custom API operations
|
||||
|
||||
n8n supplies hundreds of nodes, allowing you to create workflows that link multiple products. However, some nodes don't include all the possible operations supported by a product's API. You can work around this by making a custom API call using the HTTP Request node.
|
||||
|
||||
One of the most complex parts of setting up API calls is managing authentication. To simplify this, n8n now provides a way to use existential credential types (credentials associated with n8n nodes) in the HTTP Request node.
|
||||
|
||||
For more information, refer to [Custom API operations](/integrations/custom-operations/){:target=_blank}.
|
||||
|
||||
#### Node details view
|
||||
|
||||
An improved node view, showing more detail about node inputs.
|
||||
|
||||
</div>
|
||||
|
||||
### Node enhancements
|
||||
|
||||
[Salesforce Node](/integrations/nodes/n8n-nodes-base.salesforce){:target=_blank}: Add the **Country** field.
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* **Editor UI**: don't display the dividing line unless necessary.
|
||||
* **Editor UI**: don't display the 'Welcome' sticky in template workflows.
|
||||
* [Slack Node](/integrations/nodes/n8n-nodes-base.slack){:target=_blank}: Fix the kick operation for the channel resource.
|
||||
|
||||
|
||||
## n8n@0.177.0
|
||||
|
||||
View the [commits](https://github.com/n8n-io/n8n/compare/n8n@0.176.0...n8n@0.177.0){:target="_blank" .external-link} for this version.<br />
|
||||
**Release date:** 2022-05-17
|
||||
|
||||
@ -1,7 +1,5 @@
|
||||
## n8n@<version-number>
|
||||
|
||||
|
||||
|
||||
View the [commits](<url for GitHub's 'Comparing changes' view, comparing this release to the previous one>) for this version.<br />
|
||||
**Release date:** _yyyy-MM-dd_
|
||||
|
||||
@ -39,4 +37,4 @@ _Description of new feature. Link to new node doc._
|
||||
|
||||
### Contributors
|
||||
|
||||
_List contributors. Do not use a bulleted list here._
|
||||
_List external contributors. Do not use a bulleted list here._
|
||||
@ -118,6 +118,7 @@ nav:
|
||||
- Nodes: integrations/nodes/
|
||||
- Trigger nodes: integrations/trigger-nodes/
|
||||
- Credentials: integrations/credentials/
|
||||
- Custom API actions for existing nodes: integrations/custom-operations.md
|
||||
- Community nodes:
|
||||
- Overview: integrations/community-nodes/index.md
|
||||
- Installation and management: integrations/community-nodes/installation.md
|
||||
|
||||
Loading…
Reference in New Issue
Block a user