diff --git a/docs/_images/integrations/builtin/credentials/surveymonkey/getting-credentials.gif b/docs/_images/integrations/builtin/credentials/surveymonkey/getting-credentials.gif deleted file mode 100644 index b3fc0bd89..000000000 Binary files a/docs/_images/integrations/builtin/credentials/surveymonkey/getting-credentials.gif and /dev/null differ diff --git a/docs/integrations/builtin/credentials/supabase.md b/docs/integrations/builtin/credentials/supabase.md index 6bc9a9050..acbd192c1 100644 --- a/docs/integrations/builtin/credentials/supabase.md +++ b/docs/integrations/builtin/credentials/supabase.md @@ -6,22 +6,30 @@ contentType: integration # Supabase credentials -You can use these credentials to authenticate the following nodes with Supabase. +You can use these credentials to authenticate the following nodes: - [Supabase](/integrations/builtin/app-nodes/n8n-nodes-base.supabase/) - [Supabase Vector Store](/integrations/builtin/cluster-nodes/root-nodes/n8n-nodes-langchain.vectorstoresupabase/) - ## Prerequisites -Create a [Supabase](https://supabase.com/) account. +Create a [Supabase](https://supabase.com/){:target=_blank .external-link} account. + +## Supported authentication methods + +- API key + +## Related resources + +Refer to [Supabase's API documentation](https://supabase.com/docs/guides/api){:target=_blank .external-link} for more information about the service. ## Using Access Token -1. In the [Supabase UI](https://app.supabase.io/), navigate to the project you would like to connect to. -2. Navigate to Settings page (through the gears button in the left sidebar). -3. Under *Project settings*, click on **API**. -4. Copy the value from the Supabase `URL` field into the `Host` field of your Supabase credentials in n8n. -5. Copy the value from the Supabase `service_role secret` field into the `Service Role Secret` field of your Supabase credentials in n8n. -6. Click `Save` on the n8n credentials screen. +To configure this credential, you'll need: +- A **Host**: Go to [**Project Settings > API**](https://supabase.com/dashboard/project/_/settings/api){:target=_blank .external-link}. Copy the **URL** from the **Config** section and enter it as your n8n **Host**. +- A **Service Role Secret**: Go to [**Project Settings > API**](https://supabase.com/dashboard/project/_/settings/api){:target=_blank .external-link}. Reveal the secret for the `service_role` API key. Copy that **secret** and enter it as your n8n **Service Role Secret**. + +Refer to [API URL and keys](https://supabase.com/docs/guides/api#api-url-and-keys){:target=_blank .external-link} for more detailed instructions. + +Refer to [Understanding API Keys](https://supabase.com/docs/guides/api/api-keys){:target=_blank .external-link} for more information on the `service_role` privileges. diff --git a/docs/integrations/builtin/credentials/surveymonkey.md b/docs/integrations/builtin/credentials/surveymonkey.md index 0def6d9c5..1aeb0b18a 100644 --- a/docs/integrations/builtin/credentials/surveymonkey.md +++ b/docs/integrations/builtin/credentials/surveymonkey.md @@ -6,36 +6,66 @@ contentType: integration # SurveyMonkey credentials -You can use these credentials to authenticate the following nodes with SurveyMonkey. +You can use these credentials to authenticate the following nodes: - [SurveyMonkey Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.surveymonkeytrigger/) ## Prerequisites -Create a [SurveyMonkey](https://surveymonkey.com/) account. +- Create a [SurveyMonkey](https://www.surveymonkey.com){:target=_blank .external-link} account. +- [Register an app](https://api.surveymonkey.com/v3/docs?api_key=3yr7n6m8sjwvm48x8nhxej52#registering-an-app){:target=_blank .external-link} from your [**Developer dashboard > My apps**](https://developer.surveymonkey.com/apps/){:target=_blank .external-link}. + - Refer to [Required app scopes](#required-app-scopes) for information on the scopes you must use. + +## Supported authentication methods + +- API access token +- OAuth2 + +## Related resources + +Refer to [SurveyMonkey's API documentation](https://developer.surveymonkey.com/api/v3/#SurveyMonkey-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**: Generated once you create an app. +- A **Client ID**: Generated once you create an app. +- A **Client Secret**: Generated once you create an app. + +Once you've created your app and assigned appropriate scopes, go to **Settings > Credentials**. Copy the **Access Token**, **Client ID**, and **Secret** and add them to n8n. ## Using OAuth -1. Access your SurveyMonkey dashboard. -2. Click on the context menu in the top right. -3. Click on Integrations & Plug-ins -4. Click on Develop. -5. Click on My Apps in the top panel. -6. Create a new app, fill in details. -7. Once created, go to settings. -8. Use the client ID and client secret with your SurveyMonkey OAuth API credentials in n8n. +To configure this credential, you'll need: -## Using Access Token +- A **Client ID**: Generated once you create an app. +- A **Client Secret**: Generated once you create an app. -1. Access your SurveyMonkey dashboard. -2. Click on the context menu in the top right. -3. Click on Integrations & Plug-ins -4. Click on Develop. -5. Click on My Apps in the top panel. -6. Create a new app, fill in details. -7. Once created, go to settings. -8. Use the access token, client ID and client secret with your SurveyMonkey node credentials in n8n. +Once you've created your app and assigned appropriate scopes: -![Getting SurveyMonkey credentials](/_images/integrations/builtin/credentials/surveymonkey/getting-credentials.gif) +1. Go to the app's **Settings > Settings**. +2. From n8n, copy the **OAuth Redirect URL**. +3. Overwrite the app's existing **OAuth Redirect URL** with that URL. +4. Select **Submit Changes**. +5. Be sure the **Scopes** section contains the [Required app scopes](#required-app-scopes). +From the app's **Settings > Credentials**, copy the **Client ID** and **Client Secret** and add them to your n8n credential. You can now select **Connect my account** from n8n. + +/// note | SurveyMonkey Test OAuth Flow +This option only works if you keep the default SurveyMonkey **OAuth Redirect URL** and add the n8n OAuth Redirect URL as an **Additional Redirect URL**. +/// + +## Required app scopes + +Once you create your app, go to **Settings > Scopes**. Select these scopes for your n8n credential to work: + +- **View Surveys** +- **View Collectors** +- **View Responses** +- **View Response Details** +- **Create/Modify Webhooks** +- **View Webhooks** + +Select **Update Scopes** to save them. diff --git a/docs/integrations/builtin/credentials/syncromsp.md b/docs/integrations/builtin/credentials/syncromsp.md index 28e768c3f..5052d248b 100644 --- a/docs/integrations/builtin/credentials/syncromsp.md +++ b/docs/integrations/builtin/credentials/syncromsp.md @@ -6,21 +6,25 @@ contentType: integration # SyncroMSP credentials -You can use these credentials to authenticate the following nodes with SyncroMSP. +You can use these credentials to authenticate the following nodes: - [SyncroMSP](/integrations/builtin/app-nodes/n8n-nodes-base.syncromsp/) ## Prerequisites -Create a [SyncroMSP](https://syncromsp.com/) account. +Create a [SyncroMSP](https://syncromsp.com/){:target=_blank .external-link} account. -## Using Access Token +## Supported authentication methods -1. With administrator privileges, navigate to the [API Tokens page in SyncroMSP](https://n8nchangelog.syncromsp.com/api_tokens). -2. Click on the `+ New Token` button. -3. On the `Custom Permissions` tab, enter a name for your new token and adjust the permissions to match your requirements. -4. Click `Create API Token` once done. -5. Copy the key shown by SyncroMSP into the `API Key` field of your SyncroMSP credentials in n8n. -6. Enter your SyncroMSP subdomain (the part between `https://` and `.syncromsp.com`) in the `Subdomain` field of your SyncroMSP credentials in n8n. -7. Click `Save` on the n8n credentials screen. +- API key +## Related resources + +Refer to [SyncroMSP's API documentation](https://api-docs.syncromsp.com/){:target=_blank .external-link} for more information about the service. + +## Using API key + +To configure this credential, you'll need: + +- An **API Key**: Called an **API token** in SyncroMSP. To create an API token, go to your **user menu > Profile/Password > API Tokens** and select the option to **Create New Token**. Select **Custom Permissions** to enter a name for your token and adjust the permissions to match your requirements. +- Your **Subdomain**: Enter your SyncroMSP subdomain. This is visible in the URL of your SyncroMSP, located between `https://` and `.syncromsp.com`. If your full URL is `https://n8n-instance.syncromsp.com`, you'd enter `n8n-instance` as the subdomain.