A universal guide outlining the common steps involved in setting up any OAuth2 application, including registering your application, obtaining client credentials, and defining redirect URIs.

• Sign-in to to your ActiveCampaign account. Once you are logged in, locate the "Settings" option. This can be found in the bottom left corner of the homepage.

• Within the settings page, you will see a section labeled 'Developer'. Click on this section to navigate to the Developer page. On the 'Developer' page, you will see your API URL and your API key.

• use the API Key to authenticate ActiveCampaign components in the Appmixer Designer.

Setup the App and Administrator account

Sign up with Airtable: https://airtable.com/signup

Specify Base name

Specify Table name

Specify Table details (fields)

Now the Airtable workspace/base is prepared. Let's configure the OAuth app.

2. Register OAuth app

Specify name

Specify name and callback url

Generate client secret

Specify scopes

Set clientId and clientSecret into Appmixer Backoffice.

The last step is to configure clientId and clientSecret in the Appmixer Backoffice for appmixer:airtable

Authentication

Lambda, S3 and SNS

To authenticate with AWS services Lambda, S3, and SNS, you need to provide Access Key Id and Secret Access Key. You can create a new user in the AWS IAM console (https://console.aws.amazon.com/iam/home) and assign the necessary permissions to that user.

The neccessary permissions depend on the services and components you want to use. For example, if you want to use the New S3 Object component, you need to assign the AmazonS3ReadOnlyAccess policy to your user. If you want to use the Send SNS Message component, you need to assign the AmazonSNSFullAccess policy.

Controls

HTTP CONNECTOR

HTML to JSON Converter

Description Convert an HTML table file into a JSON file.

Input Parameters

• fileId (string) - The ID of the file to be converted.

Output Parameters

• fileId (string) - The ID of the newly created JSON file.

• fileName (string) - The name of the converted JSON file.

Unfortunately, since August 20, 2018 Highrise no longer accepts signups.

We keep the module in Appmixer for the older customers who have their Oauth2 application. If you are a new Appmixer customer, you won't be able to create the OAuth2 application and therefore use the Highrise module. In that case, you should remove it from the platform.

User-Agent

Requests to the Highrise API contain headers with User-Agent property. This is set by default to Appmixer, but it can be overwritten using Backoffice:

You will need to create a new Redmine installation. Go to https://www.redmine.org/projects/redmine/wiki/RedmineInstall and follow the instructions. Alternatively, you can use a Docker image: https://hub.docker.com/_/redmine or a hosted solution.

Once you have your Redmine application make sure you have the REST API enabled. Go to Administration -> Settings -> API and check the "Enable REST web service" option.

After that, you will need to create a new API key. Go to Administration -> Users -> Edit user and create a new API key.

You will enter this API key and also the URL of your Redmine installation in when connecting each Redmine component.

1. Create Asana account

Sign up with Asana:

2. Register OAuth app

To create an OAuth app with Asana, follow the oficial documentation: .

Take note of the application's client ID and the client secret (which should be protected as a password)

You will need to specify the App name and Redirect URL in this step.

• The App name can be anything you want.

• The Redirect URL should be the URL where Asana will redirect the user after they authorize your app. This depends on your environment, usually in the following format: https://api.qa.appmixer.com/auth/asana/callback

Set clientId and clientSecret into Appmixer Backoffice.

The last step is to configure clientId and clientSecret in the Appmixer Backoffice for appmixer:asana

Cloudflare WAF integrations allows you to actively block attacker IP by using Cloudflare WAF infrastructure.

Authentication

Cloudflare WAF connector support authentication via Account API Token or User API Token

Account API Token

To create the Account API Token, go to the Manage Accounts > Account API Tokens, click on "Create Token". On the next screen, select the "Create Custom Token" option.

Name the token and select the permission:

• Account | Rule Rulesets | Edit

User API Token

To create the User API Token, go to the Profile > API Tokens, click on "Create Token". On the next screen, select the "Create Custom Token" option.

Name the token and select the permission:

• Account | Rule Rulesets | Edit

In the Cloudflare connector authentication window, use your API Token to log in.

Access the Dropbox App Console

• Open the .

• Log in with your Dropbox account credentials.

Create OAuth app

Settings page

• Set the Redirect URI to https://[YOUR_API_BASE]/auth/dropbox/callback, for example https://api.appmixer.com/auth/dropbox/callback

• To allow additional users, click on "Enable Additional Users.

• Configure the App Key as clientId and the App Secret as clientSecret in the service settings within the Backoffice, under the configuration ID appmixer:dropbox.

• To learn more about configuring connectors, please visit the section.

Permissions page

Ensure that the following permissions are selected:

• account_info.read

• files.content.read

• files.content.write

• files.metadata.read

1. Create Freshdesk account

Sign up with Freshdesk:

2. Obtain API key

Navigate to Profile Settings -> API. Copy the API token on the right side. If you don't see the API key, please refer to the for more information.

Use the copied token as API key along with Domain when connecting Freshdesk components in Appmixer. In this example the domain is acme-help and the API key is the copied token.

1. Create Pipedrive account

Sign up with Pipedrive:

2. Obtain API key

Navigate to My Account -> Personal Preferences -> API. Copy the API token.

Use the copied token as apiKey when connecting Pipedrive components in Appmixer.

• OpenAI Account: The first thing you need to do is have an OpenAI account. You can sign up for free.

• After signing up, go to https://platform.openai.com/api-keys.

• Create a New API Key: You would find a button or link labeled "Create a new key" or "Generate API keys". Click on it.

• Keep this key safe and secure. It should not be shared with anyone or exposed in client-side code, as it could be used to misuse your OpenAI services.

• use the API Key to authenticate OpenAI components in the Appmixer Designer.

Appmixer offers a built-in component for taking Screenshots.

It uses API. If you want to have this module on the platform you have to create your own Screenshot account and set the API token in the Backoffice.

Sign-up at DeepAI

Visit https://deepai.org and sign-up:

Copy api-key from your profile dashboard:

Set the API key via the the Backoffice Connector Configuration page:

And then add you own apiKey value:

Log In to JotForm

• Go to the .

• Log in with your JotForm account credentials.

Generate a New API Key

• Navigate to Account Settings: Click on your avatar/initials in the top right corner of the page. Choose "Settings" from the dropdown menu. Or go directly to the

• Here, you might see a list of existing API keys if you've created any before. To generate a new one, click the “Create New Key” button

Use the API key in the Appmixer

• In the authentication pop-up enter your API key.

Appmixer AI utilities allows you to introduce AI functionality in your integrations, automations or simply extend your product with AI capabilities via Appmixer's No-Code Studio.

After installing the appmixer.utils.ai module, go to the Backoffice to configure the OpenAI apiKey for the module:

Additionally, you can also override the default OpenAI models for the SendPrompt (default is "gpt-4o") and GenerateImage (default is "dall-e-3") components:\

Appmixer offers a built-in component for sending emails from the platform.

The SendEmail component uses our Mandrill API KEY by default. It is recommended to change that to your own Mandrill API KEY if you want to keep using Mandrill as the email service provider. You can do that from the Backoffice. The service ID is appmixer:utils:email in this case. You can also change the default from email address which is set to [email protected].

The SendEmail component is an example, how sending emails from Appmixer can be done. You can have your own mailing system which you would like to use or you would like to use a different third-party application. In such a case, you should remove the SendEmail component from the system and offer your users your own implementation.

Overview

The CSV2HTML component converts a CSV file into an HTML table. This allows for easier visualization and sharing of structured data.

Input Parameters

Output Parameters

Instructions

1. Select the CSV File:

   • Provide the fileId of the CSV file to be converted.

2. Processing:

   • The component will transform the CSV file into an HTML table.

3. Retrieve Output:

   • The converted HTML file’s fileId and fileName will be returned.

Description

Convert a CSV file to XLSX (Excel 2007+ XML Format).

Input Parameters

Output Parameters

Instructions

1. Provide File ID:

   • Select the CSV file to be converted using its fileId.

2. Processing:

   • The component processes the file and converts it into an XLSX format.

3. Retrieve Output:

   • The converted file is returned with a fileId and fileName for further use.

XLSX2JSON Component

Description: Convert an XLSX (Excel 2007+ XML format) file to JSON.

Input Parameters:

• fileId (string, required): The ID of the file to be converted.

Output Parameters:

• fileId (string): The unique ID of the converted JSON file.

• fileName (string): The name of the generated JSON file.

Description

Create a new CSV file with an initial text content.

Input Parameters

Output Parameters

Instructions

1. Provide File Name: Enter the desired CSV file name.

2. Set Delimiter: Define a delimiter (default: ,).

3. Enter Initial Content: Add pre-formatted CSV content.

4. Process CSV Creation: The component generates a CSV file.

Overview

The JSON2HTML component converts a JSON file into an HTML table.

Input Parameters

Output Parameters

Instructions

1. Provide the JSON File:

   • Select or upload a JSON file using its fileId.

2. Processing:

   • The component reads the JSON file and converts it into an HTML table.

3. Retrieve the Output:

   • The output file is provided as an HTML file with a fileId and fileName.

Overview

The AddRow component allows adding a single row to a dataset.

Input Parameters

Output Parameters

Instructions

1. Provide the Dataset:

   • Ensure the dataset is passed in the correct array format.

2. Add Row Data:

   • Provide the new row as an object where keys match column names.

3. Process & Output:

   • The component adds the row and outputs the updated dataset.

JSON2XLSX Component

Overview

The JSON2XLSX component converts a JSON file into an XLSX (Excel 2007+ XML Format) file.

Input Parameters

Output Parameters

Instructions

1. Select the Input JSON File:

   • Upload or provide the fileId of the JSON file to be converted.

2. Processing:

   • The component converts the JSON file into an XLSX format.

3. Retrieve the XLSX File:

   • The output provides the new file's fileId and fileName.

JSON2CSV Component

Overview

The JSON2CSV component converts a JSON file into a CSV format. This enables easier data handling for spreadsheet applications and data processing tools that require CSV input.

Input Parameters

• fileId (string, required): The ID of the JSON file to be converted.

Output Parameters

• fileId (string): The ID of the newly generated CSV file.

• fileName (string): The name of the generated CSV file.

Instructions

1. Upload JSON File: Provide the fileId of the JSON file you wish to convert.

2. Processing: The component processes the input JSON and converts it into a structured CSV format.

3. Retrieve Output: The resulting CSV file's fileId and fileName are returned as output.

XLSX2HTML Component

Overview

The XLSX2HTML component converts an XLSX (Excel 2007+ XML) file into an HTML table format.

Input Parameters

Output Parameters

Instructions

1. Select the XLSX File

   • Choose an existing XLSX file by providing its fileId.

2. Processing

   • The component will convert the XLSX file into an HTML table.

3. Output

   • The resulting file ID and name will be returned for further use.

Overview

The AddRows component allows adding multiple rows to an existing dataset.

Input Parameters

Output Parameters

Instructions

1. Provide the Dataset:

   • Ensure the dataset is passed in the correct array format.

2. Add Rows Data:

   • Provide multiple rows in an array where each object represents a row.

3. Process & Output:

   • The component adds the rows and outputs the updated dataset.

The Apigee connector allows you block requests from specific IP addresses. To make the integration work, you need to

1. register Google OAuth2 application

2. perform setup in Apigee instance

Google OAuth2 application registration

Application verification

In 2020 Google introduced Application verification If an app uses Google APIs to access Google users’ data. This makes it impossible to use the Appmixer Google modules in production without the verification process. Such a verification process has to be done by you.

Most of the Google modules need what Google marks as Sensitive or Restricted Scope in order to work. For example, the Gmail module needs https://www.googleapis.com/auth/gmail.compose scope to create a new email and https://www.googleapis.com/auth/gmail.readonly to get new emails.

Required scopes

• www.googleapis.com/auth/cloud-platform (sensitive scope)

Required user roles

The connector requires the following IAM permission. This is the end-user permission needed to use the connector:

• apigee.keyvaluemapentries.get

• apigee.keyvaluemapentries.create

• apigee.keyvaluemapentries.update

• apigee.environments.list (Optional. Used to display a list of Apigee environments, allowing the user to easily select the desired environment in the Designer.)

• apigee.keyvaluemaps.create (Optional. If this permission is not granted, you will need to manually create a Key Value Map (KVM) in Apigee; see the KVM storage section for instructions. If the permission is granted, the connector will automatically create the KVM.)

Register Oauth2 app

Go to the Google developer console at https://console.developers.google.com/ and create a new project.

Next, enable the required APIs for your project. Go to you project APIs & Services > Enable APIs & service and click on the Enable APIs and Services button. Enable the following APIs:

• Apigee API: apigee.googleapis.com

• Api HUB API: apihub.googleapis.com

• Service Networking: servicenetworking.googleapis.com

• Compute Engine: compute.googleapis.com

• Cloud Key Management Service (KMS): cloudkms.googleapis.com

source: Step 1: Enable required APIs

OAuth consent screen

The next step is the OAuth consent screen.

User Type - Internal vs External. The Internal user type allows you to use the Google modules without the app verification process mentioned at the beginning of this page. However, the modules will work only for accounts within your organization.

We are going to choose External for the purpose of this tutorial.

On the next page, leave the scopes empty.

You can add test users, but you can do this later. Only users added as test users will be able to authenticate!

Here is the Oauth consent screen configured. The app is in the testing mode, it is external (for users outside your organization). No more than 100 accounts (user cap) can be used with this application.

Client ID and Client Secret

We need a client ID and a client secret.

Choose the Web application type and give it a name and authorize redirect URI.

For the purpose of this tutorial, we are going to use localhost:2200 which is the default port for the Appmixer API when running on localhost. If you are creating an Oauth application for your production/QA, the URI of your server will be here. The suffix /auth/google/callback will remain there.

You will get your Client ID and Client Secret.

They have to be inserted into the Appmixer. You can use the Backoffice to do that.

Custom callback URL

By default the callback URL passed to Google is in the form of <your-api-url>/auth/apigee/callback. However in some cases, you could need to pass a different callback URL. You can do this by inserting a callbackUrl value in the service configuration:

Domain verification

In order to use Google API Webhooks, you have to verify your domain ownership. More about domain verification can be found here. If you use the Appmixer Self-Managed package and you run Appmixer on your own servers using your custom domain, you can use CNAME records to verify your domain ownership. Otherwise, if you are an Appmixer Hosted customer, you can use the HTML file method to verify your Appmixer tenant domain (api.YOUR_TENANT.appmixer.cloud) at Google.

First, open the Google developers console and your Appmixer project and follow the instructions in the next picture.

Add your Appmixer tenant API URL (api.YOUR_TENANT.appmixer.cloud) and continue to verify the domain ownership. Click 'Take me there' and then 'Add a property'.

Again, use api.YOUR_TENANT.appmixer.cloud. Then download the HTML verification file.

After you download your HTML verification file, upload it via the Appmixer Backoffice interface to the Public Files section on the left. When you are done you should see your file listed:

Click the 'Verify' button to finish the verification process.

Now, you can go back to the developer console and add the api.YOUR_TENANT.appmixer.cloud domain once more. But this time, because it's already verified, it will appear in the list of your domains.

The new domain has to be added to the OAuth consent screen as well.

Apigee setup

Blocking IP Shared Flow Installation Guide

Shared flows in Apigee allow you to create reusable policies that can be applied across multiple API proxies. Blocking IP Shared Flow is a shared flow that blocks requests from specific IP addresses.

To install the Blocking IP Shared Flow and apply the Shared flow in any Proxy API, follow these steps:

Get the bundle:

Upload bundle Go to Apigee and navigate to the Shared Flows section, then click on the Upload Bundle icon to upload a new shared flow bundle.

Deploy the shared flow

Once deployed, go to you API proxy and add the shared flow to the preflow of the proxy endpoint.

• API Proxy > Open your proxy > DEVELOP

• Navigate to Policies and click on the plus icon to add a policy.

• Select the Flow Callout

• Enter any name and display name, for example FC-blocking-ip-shared-flow

• Select the shared flow deplyed in the previous step: blocking-ip-shared-flow

• hit Create

To apply the policy, go to Proxy Endpoints and select the PreFlow tab.

Click on the plus icon to add the policy step.

Select the policy you just created: FC-blocking-ip-shared-flow

• Save the changes, deploy the API proxy and you are done.

Configure KVM storage

The Blocking IP Shared Flow uses the Apigee Key Value Map (KVM) to store the blocked IP addresses.

to create a KVM, follow these steps:

• Go to Management > Environments > {env} > Key Value Maps

• click on the Create Key Value Map button

• name the KVM as apigee-blocked-ips

Cloudflare List Integrations allow you to manage IP lists efficiently. You can add or remove IPs from Cloudflare IP Lists and specify the TTL (Time To Live), which automatically removes the IP after a set time period.

Custom IPs list

You can access custom lists in your Cloudflare account by navigating to Manage Account > Configurations > Lists. Cloudflare Lists connector only supports IP lists.

Authentication

Cloudflare Lists connector support authentication via Account API Token, User API Token, or Global API Key (deprecated).

Account API Token

To create the Account API Token, go to the Manage Accounts > Account API Tokens, click on "Create Token". On the next screen, select the "Create Custom Token" option.

Name the token and select the permission:

• Account | Account Filter Lists | Edit

User API Token

To create the User API Token, go to the Profile > API Tokens, click on "Create Token". On the next screen, select the "Create Custom Token" option.

Name the token and select the permission:

• Account | Account Filter Lists | Edit

Global API Key (deprecated)

My Profile > API Tokens. Click on "View" to get the token:

In the Cloudflare connector authentication window, use your Cloudflare account email and the Global API Key or your API Token to log in. Please note that when you use the API Token (User or Account), don't enter the email, just leave the email input empty.

Setup Mailchimp account

Sign up with Mailchimp: https://mailchimp.com/

2. Register OAuth app

Now you need to add an OAuth application. Navigate to: Profile > Extras > Registered apps.

Click on the "Register an app" button.

Specify client details

Generate client secret

Now save the OAuth client and copy the client ID and secret. You will need them later.

Set clientId, clientSecret and subdomain into Appmixer Backoffice.

The last step is to configure clientId and clientSecret in the Appmixer Backoffice for appmixer:mailchimp connector.

Register an OAuth2 application in a similar way as usual Microsoft Azure App with few changes:

• you don't need to configure OneDrive file picker

• configure API permissions for Dynamics 365, see below

Go to the API permissions section:

Choose Dynamics CRM:

Delegated permissions:

The final set of permissions:

Creating CRM Dataverse environment

In order to use the Microsoft Dynamics 365 CRM connector, you'll need a Dataverse environment alongside your Microsoft account. You can review your environments in PowerPlatform administration. If you don't have any environment there, you can start with a trial. From the list of available apps, select Dynamics 365 Sales. Once you complete the sign-up process, the CRM environment will be created.

Once created you can view details of the environment and see Environment URL address which you will need when connecting a Microsoft Dynamics 365 CRM component to your account.

Note that in order to interact with Lead entities, you'll need to install Sales module into your Dataverse environment. Some entities like Contact or Account come with a Dataverse environment by default, but it is not the case for Lead entity.

Addition configuration

Microsoft Dynamics 365 CRM connector has additional settings when it comes to caching Dataverse environment schema and data. These settings can be configured in the Backoffice the same way as clientId or clientSecret:

• listLookupOptionsCacheTTL - Cache TTL for inspector variables in milliseconds. Default value 1 minute. Determines how long the values of various Lookup fields are stored in Appmixer cache. This affects values fetched into select boxes in the inspector for fields like Currency, Contact, etc.

• listOutportCacheTTL - Cache TTL for outports in milliseconds. Default 1 hour. Determines how long Appmixer caches the structure of the Dataverse instance (environment) for output ports. In case you add a new table or change an existing table (eg. by changing column type), this is the time you need to wait before the changes are propagated into components outPort schema.

• listInspectorCacheTTL - Cache TTL for inspector in milliseconds. Default 1 hour. Similar to listOutportCacheTTL. Determines how long Appmixer caches the structure of the Dataverse instance (environment) for the inspector. In case you add a new table or change an existing table (eg. by changing column type), this is the time you need to wait before the changes are propagated into the component's inspector.

First, you need to set an Quickbooks key and endpoint through the Backoffice in order to provide the Quickbooks components to your customers.

Go to the https://developer.intuit.com/app/developer/dashboard to create a new app.

Select the name and scope:

Then you receive your clientID and clientSecret.

Also add the redirect URL. Example: https://api.YOUR_SUBDOMAIN.appmixer.cloud/auth/quickbooks/callback.

Go the Appmixer BackOffice -> Configuration. Add new configuration: appmixer:quickbooks Add your clientId and clientSecret keys.

Webhooks

All trigger components (for example NewInvoice) use QuickBooks webhooks. In order to use this component(s) in Appmixer, you have to register Appmixer's QuickBooks URI in QuickBooks first and set the webhook key in the Appmixer BackOffice.

Go to https://developer.intuit.com/app/developer/dashboard then choose your Appmixer app. Navigate to the "Webhooks" section either for the sandbox or production environment and add a new webhook.

Fill the field Endpoint URL with https://api.acme.appmixer.cloud/plugins/appmixer/quickbooks/webhooks (replace acme with your subdomain) and select the events you want to listen to. Configure the event triggers you want to listen to.

For detailed steps, see QuickBooks documentation.

Make sure to copy the Verifier Token and paste it to the Appmixer BackOffice -> Configuration -> appmixer:quickbooks -> webhookVerifierToken field.

Register OAuth app

• You need to start by creating a new app on the LinkedIn Developer platform. Visit https://developer.linkedin.com/ and log into your account. Once logged in, navigate to "MyApps", then click on "Create App". Fill in all necessary information like app name, app logo, app description, app privacy policy URL etc. You also need to fill the "Associated LinkedIn page". This is the LinkedIn page that will be associated with the app. If you don't have a LinkedIn page, you can create one by clicking on the "Create a LinkedIn Page" link.

• Navigate to the "Auth" section where you will find OAuth 2.0 settings. Here, you can set the "Authorized Redirect URLs". Take note of the application's client ID and the client secret (which should be protected as a password)

  You will need to specify the Redirect URL in this step.

  The Redirect URL should be the URL where LinkedIn will redirect the user after they authorize your app. This depends on your environment, usually in the following format: https://api.ACME.com/auth/asana/callback

• Configure scopes: Navigate to the "Products" section, request access to "Share on LinkedIn" and "Sign In with LinkedIn using OpenID Connect", once approved (it's instant approval), you will be able to see them on the top of the screen:

Appmixer Backoffice.

Set clientId and clientSecret into Appmixer Backoffice for appmixer:linkedin

Verification

Verification will enable scopes to be used in the LinkedIn Appmixer connector: "Advertising API", "Lead Sync API", "Conversions API" and "LinkedIn Ad Library". These scopes are not used in the current version of the LinkedIn connector, therefore it's not required. You can still perform the verification by sending the verification link generated in the "Settings" tab to the Super Admin of the page associated with the App.

Process estimated time: instant approval.

When creating Typeform Oauth2 application (https://admin.typeform.com/account#/section/apps), you can choose between access tokens that do expire in a week and access tokens that do not expire.

The token expiration is new in Typeform. Appmixer components before version 4.2 cannot handle it.

If you're registering the Oauth application for version 4.2 or newer, you can decide if you want to use tokens that do expire or not. If you decide to go with Unlimited then you don't have to set anything in the Backoffice, it is the default behavior. On the other hand, if you want to use tokens that expire, you have to go to the Backoffice and set the useRefreshToken to true for the appmixer:typeform service.

Then you can use the One Week configuration.

Go to the Apps and Keys page (you can also get there from the Docs)

Add a new app:

Get the ClientId, ClientSecret and set the redirect URI:

clientId: Integration Key

clientSecret: Secret Keys

set the Redirect URI to https://[YOUR_API_BASE]/auth/docusign/callback, for example https://api.appmixer.com/auth/docusign/callback

And set the clientId, clientSecret to the service configuration in the Backoffice.

Access the Twitter App Console

• Navigate to the Twitter Developer Platform and sign up if you haven't already.

• You might be required to apply for a developer account where you'll need to provide some information about your intended use of Twitter’s API.

Create OAuth app

• After logging in to your Twitter Developer account, navigate to the Developer Dashboard.

• Twitter should automatically create a default project and application for you. If it doesn't, click "Create Project" and follow the prompts to set up a new one. After creating the project, you'll be able to create an application. Navigate to your project and select "Add App."

• Update application details, such as the name, description, and icon, by clicking the "Edit" button. Next, configure the authentication settings.

User Authentication Settings

• Set the "App permissions" to "Read and write" and "Type of App" to "Web App"

• Set the Redirect URI to https://[YOUR_API_BASE]/auth/twitter/callback, for example https://api.appmixer.com/auth/titter/callback

Keys and Tokens

• Get the Client Id and Client Secret from the Keys and Tokens page

• Configure the App Key as clientId and the App Secret as clientSecret in the service settings within the Backoffice, under the configuration ID appmixer:twitter.

• To learn more about configuring connectors, please visit the Connector Configuration section.

• First, you'll need to create an account on the Twilio website.

• After signing up, go to https://console.twilio.com/

• Copy the Account SID and Auth Token from the "Account Info". Alternatively you can navigate to the "API Keys & Tokens" section, SID and Auth Token are available there.

• use the Auth Token and Account Token to authenticate the Twilio components in the Appmixer Designer.

1. Create Monday account

Sign up with Monday: https://auth.monday.com/users/sign_up_new

2. Obtain API key

Navigate to your Monday Developer Center -> My access tokens. Create a new token and copy it.

Use the copied token as apiKey when connecting Monday components in Appmixer.

Get your consumer key and secret

Log in to your Schoology server. Look at the top navigation bar and go to Tools > School Management.

In the new screen, click on Integrations in the left menu. Now click on the API tab. You should see your consumer key and secret. The secret is hidden, so you have to use the Reveal Existing Secret option.

Configure the authentication values in Appmixer

Log into the Backoffice and go to the Services section. Add a new service configuration named appmixer:schoology. After it is created, add the following configuration values:

Here is the explanation for each value:

• baseUrl: The API base URL. Usually is https://api.schoology.com/v1, but there are some cases where it could be different.

• consumerKey and consumerSecret: The consumer key and secret we got from the Schoology server.

• domain: The subdomain part from your server. For example, if your server URL is https://example.schoology.com, then the domain value is just an example.

Create Facebook OAuth Application

1. Visit https://developers.facebook.com/ and create a new OAuth application (or use your existing one).

2. Add Facebook Login for Business and Marketing API products.\
3. Copy the App ID and App Secret a and paste it to your Appmixer Backoffice -> Connector Configuration page under the appmixer:facebookbusiness configuration ID as clientId and clientSecret, respectively:\
4. Add your Appmixer tenant domains as your App domains:\

   Note: replace YOUR_TENANT with the name of your hosted tenant. If you're a customer on an Appmixer Self-Managed plan, you can have a completely custom domains that Appmixer runs on. Use your own domains instead.

5. Set the OAuth redirect URI under Facebook Login for Business / Settings to https://api.YOUR_TENANT.appmixer.cloud/auth/facebookbusiness/callback:\

Since version 4.2.1 you can configure the string that appears on the Trallo Oauth page.

If you don't do this, the Oauth page will show Appmixer by default.

Create Blackboard App in the Developer portal

The first thing you need is an app created in the developer portal. Navigate to and signup for an account. When you are logged in, you can see a dashboard with a list of your applications and a button to create a new one:

Note that listed applications have an Application ID. We will need it when we register our application in the blackboard instance. Click on the + button to create a new application. A simple form appears with your Application name and description inputs, and a domains input, for your domains. After you fill in the fields, create the new application.

Register your application on Blackboard

Self-managed instances

Log in with admin privileges, and go to the System Admin tab in the top menu. After that, look under Integrations for REST API Integrations:

Next, you will see a list with all your API Integrations. Click on Create Integration to add a new one:

After that, you will show a small form. One of the inputs is the Application ID which as we showed in the first step, is available in the applications list at the developer portal. Next, browse and select a user. We recommend using the same user you are logged in with. On the End User Access and Authorized To Act As User, select Yes in both options. After that click on Submit to finish the registration.

Configure the Backoffice

Finally, we need to set the OAuth clientId and clientSecret in the to finish the integration. To obtain these values, go to the applications list in the developer portal. Find your application and click on the 3 dots at the end of the row. Then click on the Manage Keys option:

After you will see a list of your application keys. Click on the + sign to create a new key. Your key will be created and its information will be shown to you:

Be sure to store this information somewhere safe, as you won't be able to get it again.

Next, log into the Backoffice and go to Services. Next create a configuration for appmixer:blackboard. Finally, add your Application ID as clientId and Secret as clientSecret. Also set serverUrl to your instance URL:

And you are done! You are ready to use the Blackboard module.

Calendly – Connector Configuration

Step 1: Create a Developer Account & First Application

• Create a Calendly Developer account:

• Go to and sign up.

⚠️ Note: This is not your Calendly user account. It’s a separate developer account.

Step 2: Register Your OAuth Application

1. Create a new OAuth application:

   • Provide a name for your application.

   • Select the kind of application:

     • Web

   • Select your environment:

     • Sandbox (recommended for development)

     • Production (use when going live with customer data)

Step 3: Set Redirect URI

• Sandbox: HTTP with localhost domain allowed Example:

• Production: Must use HTTPS.

👉 You can add multiple redirect URIs, separated by commas. 👉 For Appmixer, set the redirect URI to:

Example:

Step 4: Copy Your Credentials

Once the app is created, you’ll see:

• Client ID

• Client Secret

⚠️ Important: These values will only be shown once. Copy them immediately!

Step 5: Connector Configuration

1. Go to the Appmixer BackOffice -> Configuration.

2. Add new configuration: acme:calendly .

3. Add your clientId and clientSecret keys with values.

Step 6: Edit Your Application

• To edit an existing OAuth app in Calendly:

  • Click the menu icon → Edit.

• Editable attributes:

  • Application Name

  • Kind of App

  • Environment Type

  • Redirect URI

⚠️ Note: Client Secret and Webhook Signing Key cannot be retrieved again after creation.

Authentication

To authenticate Imperva connector, an API Key is required. To obtain this key, log in to your Imperva account and navigate to Account > My Profile > API Keys. Click on "Add API Key" to generate a new key. Enter a name (and optionally otherparameters) for the API Key and click on "Create".

Take note of the API ID and API Key. You will need these to authenticate the connector.

You can also view the API Key details in the API Keys section.

In the Imperva connector authentication window, use your Imperva API ID and API Key to log in.

Configuration

There are three optional configuration parameters for the SetBlockIPRule action of the Imperva connector. See the table below for more information.

Register OAuth app

You can find all the necessary information on how to register an OAuth app in Jira in their .

Access and create a new app. Click Create and select OAuth 2.0 integration.

Click on the "Register an app" button.

Set up distribution

When you create an OAuth 2.0 (3LO) app, it's private by default. This means that only you can install and use it. If you want to distribute your app to other users, you must enable sharing.

Please follow the instructions in the to set up distribution.

Specify scopes

You need to specify the scopes that your app will use. For Jira, you will need to select the following scopes:

• read:me

• read:jira-work

• write:jira-work

• manage:jira-project

• manage:jira-configuration

• read:jira-user

• report:personal-data

This is how the permissions should look like:

Specify Callback URL

Overview

After you have created the app, you will see the overview of the app. Here you can find the client ID and client secret.

Set clientId, clientSecret into Appmixer Backoffice.

The last step is to configure clientId and clientSecret in the Appmixer Backoffice for appmixer:jira connector.

Register OAuth2 app

You need to create a developer account first (more about different Hubspot accounts can be found here)

Create a new application.

In order to get rid of a warning that your users will see before installing Hubspot module, you have to verify your identity as an app provider.

You can manage the Contact & Support settings.

Or skip for now.

Set the application name, logo, and description.

Go to the Auth tab and copy&paste these values into the .

Create Hubspot configuration in the .

Go back to Hubspot and set the redirect URL, replace acme.com with your domain and keep the suffix /auth/hubspot/callback

Adding scopes.

Hit Save.

One more thing that you will need is the Hubspot, go back to the Apps page and hit the Get HubSpot API key button.

Then copy&paste the generated key and put it into the .

Hubspot App verification

Your domain is unverified Until your domain is set and verified, users will see a warning when installing your app.

Users will encounter this warning during the installation or management of the app. To eliminate this warning, the verification process must be completed. HubSpot mandates the configuration of a DNS TXT record as the sole method for verification.

To configure and verify a custom HubSpot app for a hosted instance of Appmixer, such as ACME.appmixer.cloud, you will need to establish a custom domain for the Appmixer instance (for example, ACME.com). Without this custom domain, domain verification will not be possible.

Setting Up a Shopify Partner Account

Sign Up or Log In: If you haven’t already, go to the and sign up for an account. If you have an account, just log in.

Create a New App

Create a New App: Once logged in, navigate to the "Apps" section using the dashboard menu. Click on "Create app" to get started, select the "Create app manually"

Note the clientId and clientSecret. Next, click on the "Choose distribution"

Select the "Public distribution" option

Go to the "Configuration" section from the main menu

• set the Redirect URI to https://[YOUR_API_BASE]/auth/twitter/callback, for example https://api.appmixer.com/auth/titter/callback

• event version to the latest (2024-01)

• Embed app in Shopify admin: false

• set the compliance webhooks (it's required for the submission)

  • Customer data request endpoint: https://[YOUR_API_BASE]/plugins/appmixer/shopify/customers/data_request

  • Customer data erasure endpoint: https://[YOUR_API_BASE]/plugins/appmixer/shopify/customers/redact

  • Shop data erasure endpoint: https://[YOUR_API_BASE]/plugins/appmixer/shopify/shop/redact

Go to the "API Access" section from the main menu. In the "Access requests" request access for the "Protected customer data access" Fill details in the "Select your data use and reasons" section:

Fill the form in the "Provide your data protection details" section:

Configuration in the Backoffice

• Configure the App Key as clientId and the App Secret as clientSecret in the service settings within the Backoffice, under the configuration ID appmixer:shopify. Also, add the appStoreInstallRedirectUri pointing to your instance, for example https://my.master-hamster-87765.appmixer.cloud/

• To learn more about configuring connectors, please visit the section.

Please note that only a 'developer' shop instance can be authenticated with your OAuth application unless your app is verified. 'Production' shop instances cannot authenticate with an unverified app. This guide does not cover all the requirements for the app verification process.

Account

You'll need a Snowflake account. If you don't have one, you can sign up for a free trial on the .

Obtain Credentials and Configuration

You will need the following details to connect to your Snowflake database:

• Account Name: This is often part of your Snowflake URL. You can find it in the Snowflake web interface after logging into your account.

• Username: The username of the Snowflake user account you wish to use.

• Password: The password for that Snowflake user.

• Database Name: The name of the database you want to connect to.

• Warehouse: The name of the virtual warehouse to use for running queries.

How to Find This Information:

• Account:

  • Your account identifier is usually part of your Snowflake URL.

  • When you log into Snowflake, the URL looks like https: //abc12345.us-east-1.snowflakecomputing.com.

  • Here, abc12345.us-east-1 is your account identifier.

• Username and Password:

  • The credentials you use to log into the Snowflake web interface.

• Database and Warehouse:

  • After logging into Snowflake, navigate to the Databases and Warehouses tabs to see available options.

  • Choose the appropriate database and warehouse for your needs.

Register OAuth2 app

Go to the Discord Developer Portal: https://discord.com/developers/applications and create a new Application.

1. Click “New Application”

2. Give it a name, accept their Terms of Service and click “Create”

3. Open your new application

Basic Information

To obtain your OAuth credentials, go to OAuth2 tab:

• Client ID: shown on the “Client information” card as “Client ID”

• Client Secret: click “Reset Secret” to generate a secret and copy it

You’ll paste these into the Appmixer Backoffice later.

OAuth2 & Redirect URL

You must add the redirect/callback URL so Discord can return users to Appmixer after authorization.

• Go to OAuth2 tab

• In “Redirects”, add your Appmixer URL. Example:

  https://api.YOUR_SUBDOMAIN.appmixer.cloud/auth/discord/callback

Note: Replace YOUR_SUBDOMAIN with your actual Appmixer subdomain. The path “/auth/discord/callback” follows the same pattern as other Appmixer connectors.

Add a Bot and get the Bot Token

To make the events (sending messages, reacting to events) be from a bot, add one:

• Click “Reset Token” to reveal the Bot Token and copy it

Keep the token secure. You’ll paste it in the Backoffice as well.

Check the settings below in Authorization Flow, recommended set up is:

• Public Bot: ON

• Requires OAuth2 Code Grant: ON

• Server Members Intent: ON

Rest can be turned off.

Scopes and Permissions

How you configure scopes:

• Installation → Default Install Settings:

  • User Install: applications.commands

  • Guild Install: applications.commands, bot

Backoffice (Appmixer admin)

Copy and paste the values into the Backoffice under the Discord connector configuration (appmixer:discord):

• clientId → "Client ID" from Discord

• clientSecret → “Client Secret” from Discord

• botToken → “Bot Token”

After saving, return to your flow in Appmixer. Click “Connect account” for the Discord connector, complete the authorization, and you’re ready to use Discord components in your flows.

Overview

The Join Component is used to merge multiple input connections. It forwards every received message to the output port without modification.

Usage

Input Ports

Output Ports

Instructions

1. Connect Multiple Inputs

   • Attach multiple input sources to the in port.

2. Forward Messages

   • Every received message is immediately sent to the out port.

Notes

• Does Not Modify Messages: Messages are forwarded exactly as received.

• Useful for Routing: Can be used to merge multiple data streams into one processing path.

Overview

The DataUri2File component converts a Data URI into a file. It extracts the file content and metadata from the Data URI and generates a downloadable file.

Input Parameters

Output Parameters

Instructions

1. Provide a Data URI

   • Input a valid Data URI string that represents a file.

2. Specify a File Name (Optional)

   • Enter a desired file name with or without an extension.

   • If omitted, the extension is inferred from the file type.

3. Processing

   • The component extracts the file content from the Data URI and saves it as a downloadable file.

   • Returns the fileId and fileName of the newly created file.

Overview

The Counter Component maintains an internal counter that increments with each received message. It can also be reset to a specified value.

Usage

Input Parameters

Input Ports

Output Ports

Instructions

1. Set Initial Value and Increment

   • Configure the count parameter for the starting value.

   • Set increment to define how much the counter increases or decreases.

2. Increment Behavior

   • Each time a message arrives at the item port, the counter increases by the increment value.

3. Reset Counter

   • Sending a message to the reset port resets the counter to the specified value or its initial value if no value is provided.

Notes

• Supports both increment and decrement operations.

• State is maintained: The counter retains its value across executions until reset.

• Useful for tracking counts in loops, event occurrences, or rate-limiting scenarios.

Overview

The HTML to CSV Converter component allows you to transform an HTML table file into a CSV format. This is useful for extracting structured data from HTML documents into a tabular format.

Input Parameters

Output Parameters

Instructions

1. Select the HTML File:

   • Provide the fileId of the HTML document that contains a table.

2. Processing:

   • The component extracts the table data from the HTML file and converts it into a structured CSV format.

3. Retrieve Output:

   • The component returns a new file with fileId and fileName in CSV format.

XLSX2CSV Component

Overview

The XLSX2CSV component converts an XLSX Excel 2007+ XML format file into a CSV file.

Input Parameters

Output Parameters

Instructions

1. Provide File ID:

   • Select an XLSX file using its fileId.

2. Conversion Process:

   • The component processes the XLSX file and converts it into CSV format.

3. Retrieve Output:

   • The converted file is returned with its fileId and fileName.

This component is useful for extracting tabular data from Excel files into a widely used CSV format for further processing.

Overview

The CSV2JSON component converts a CSV file into a JSON file.

Input Parameters

Output Parameters

Instructions

1. Provide File ID:

   • Select or upload the CSV file to be converted.

2. Processing:

   • The component processes the CSV file and converts it into JSON format.

3. Output:

   • The converted JSON file is available with its unique fileId and fileName.

Overview

The SetVariable Component assigns variables dynamically based on input type and value. It allows storing values in various formats such as text, numbers, dates, booleans, and files.

Usage

Input Ports

Output Ports

Supported Variable Types

• Text (text) – Stores a string value.

• Textarea (textarea) – Stores a longer text value.

• Number (number) – Stores a numeric value.

• Date-Time (date-time) – Stores a date and time.

• Boolean (toggle) – Stores a true/false value.

• File (filepicker) – Stores a selected file reference.

Instructions

1. Provide Variables

   • Send an object containing variable names, types, and values to the in port.

2. Processing Variables

   • The component assigns the variables dynamically based on their types.

3. Retrieve Output

   • The processed variables are sent as an object through the out port.

Notes

• Flexible Variable Storage: Supports multiple data types for dynamic variable assignments.

• Useful for Workflow Automation: Allows temporary storage of values for later processing.

• Outputs in Key-Value Format: The output is structured as an object containing assigned values.

Overview

The DeleteColumns component removes specific columns from a CSV file. It allows users to define which columns to delete, using either column names (if headers exist) or column indices.

Usage

Input Parameters

Output Parameters

Instructions

1. Determine Column Identification Method

   • If the first row contains column names, set withHeaders to true. This ensures the correct columns are deleted based on their names.

   • If column names are not available, columns are identified by index.

2. Select Columns to Remove

   • Specify the columns you want to delete.

   • Ensure the correct format is used for column identification.

3. Processing

   • The component removes the selected columns and generates a new CSV file.

   • The modified file is returned with a new fileId.

4. Output

   • The processed file can be downloaded or used as input for further data processing.

Overview

The OnStart Component is a trigger that fires once when the flow starts. It emits a timestamp indicating when the flow was initiated.

Usage

Output Ports

Output Data for out Port

Instructions

1. Automatic Trigger

   • The component automatically fires when the flow begins execution.

2. Start Time Emission

   • Outputs a started timestamp that can be used for logging, tracking, or scheduling purposes.

Notes

• One-Time Execution: Triggers only once per flow execution.

• Useful for Logging: Can be used to capture flow start times for analytics or debugging purposes.

Overview

The HTML2XLSX component converts an HTML table file into an XLSX (Excel 2007+ XML Format) file.

Input Parameters

Output Parameters

Instructions

1. Provide the File ID:

   • Select or upload an HTML file containing a table.

2. Conversion Process:

   • The component extracts tabular data from the HTML file and converts it into an Excel spreadsheet.

3. Retrieve the Output:

   • The resulting XLSX file is provided as output with a unique fileId and fileName.

Overview

The GetRows component retrieves rows from a CSV file. It allows filtering of rows based on conditions and supports column headers for structured data extraction.

Input Parameters

Output Parameters

Instructions

1. Use Column Headers (Optional)

   • If the first row of the CSV file contains column names, enable the Use Column Names toggle.

   • Otherwise, columns will be identified by their index.

2. Apply Row Filters (Optional)

   • Enable Filter Rows if you want to return only the rows matching specific criteria.

   • Filters can be defined based on column values.

3. Processing

   • The component extracts rows based on the provided criteria.

   • The processed data is returned as an array of rows.

4. Output

   • The retrieved rows can be used for further processing or stored for reference.

Description: The ExportCSV component exports structured data into a CSV file.

Input Parameters

Output Parameters

Instructions

1. Define Data Source:

   • Provide structured data in an array format, ensuring proper key-value mapping.

2. Set Output File Name:

   • Choose a name for the CSV file, including the .csv extension.

3. Include Headers (Optional):

   • Enable Use Headers if the first row should contain column headers.

4. Processing:

   • The component processes the structured data and creates a CSV file.

   • The newly generated file is output with its fileId and fileName.

Description: The GetCell component finds the first row that matches the provided filter and returns the row value under the specified column.

Input Parameters

Output Parameters

Instructions

1. Use Column Names (Optional):

   • If the first row of the CSV file contains column names, enable the Use Column Names toggle.

   • Otherwise, columns will be identified by their index.

2. Processing:

   • The component scans the CSV file for a row that matches the given filter.

   • Once found, it returns the value of the specified column in that row.

Overview

The UpdateRows component updates all rows in a CSV file that match a provided filter. It allows users to modify values while maintaining the integrity of the dataset.

Input Parameters

Output Parameters

Instructions

1. Enable Column Header Usage (Optional)

   • If your CSV file contains column headers in the first row, enable withHeaders to update rows based on column names.

   • Otherwise, updates will be performed based on column indices.

2. Specify Filters and Updates

   • Define conditions that identify which rows should be updated.

   • Provide new values for selected columns.

3. Processing

   • The component updates all matching rows in the CSV file.

   • The modified file is outputted with a new fileId.

Description: The GetRow component finds the first row that matches the provided filter and returns the entire row.

Input Parameters

Output Parameters

Instructions

1. Use Column Names (Optional):

   • If the first row of the CSV file contains column names, enable the Use Column Names toggle.

   • Otherwise, columns will be identified by their index.

2. Processing:

   • The component scans the CSV file for a row that matches the given filter.

   • Once found, it returns the entire row as an object.

Overview

The AddColumn component allows adding a new column to an existing dataset.

Input Parameters

Output Parameters

Instructions

1. Provide the Dataset:

   • Ensure the dataset is passed in the correct array format.

2. Specify Column Details:

   • Enter the column name.

   • Optionally, provide a default value for all rows.

3. Process & Output:

   • The component adds the column and outputs the updated dataset.

Description: The DeleteRows component removes specific rows from a CSV file based on a defined filter.

Input Parameters

Output Parameters

Instructions

1. Use Column Names (Optional):

   • If the first row of the CSV file contains column names, enable the Use Column Names toggle.

   • Otherwise, columns will be identified by their index.

2. Processing:

   • The component scans the CSV file for rows that match the given filter.

   • Any matching rows are removed, and a new CSV file is generated.

Overview

The ImportCSV component allows users to import a CSV file into a workflow. It supports specifying a delimiter and can process files from user input.

Input Parameters

Output Parameters

Instructions

1. Select a CSV File

   • Use the file picker to choose a CSV file for import.

   • Alternatively, specify the file ID if it's already stored.

2. Define the Delimiter (Optional)

   • If the CSV file uses a delimiter other than a comma (,), specify it in the Delimiter field.

3. Processing

   • The component will parse the CSV file and make it available for further processing.

Overview

The RenameColumn component renames a column in a CSV file. This is useful for standardizing column names before processing or integrating CSV data with other systems.

Input Parameters

Output Parameters

Instructions

1. Specify CSV File and Delimiter

   • Provide the fileId of the CSV file containing the column to be renamed.

   • Set the correct delimiter (e.g., ,, ;, \t).

2. Rename the Column

   • Enter the current column name in columnName.

   • Specify the new column name in newColumnName.

3. Processing

   • The component will rename the specified column in the CSV file.

   • The modified file will be outputted with a new fileId.

Overview

The HTTP GET component allows sending HTTP GET requests to external services. It is useful for retrieving data from APIs and other web resources. The connector processes the request and returns the response details, including body, headers, and status code.

Usage

Input Parameters

Output Parameters

Instructions

1. Ensure API Endpoint Supports GET Requests

   • The url must be a valid API endpoint accepting GET requests.

2. Set Necessary Headers

   • If authentication is required, pass headers (e.g., Authorization token).

3. Provide Query Parameters

   • Use the body parameter to define query parameters as a JSON object.

4. Configure Response Encoding

   • Use utf8 (default) or other supported encodings.

5. Review API Response

   • Check statusCode and body for success or failure messages.

Overview

The HTTP PUT Component sends HTTP PUT requests to external services. It is commonly used for updating or replacing resources via API calls.

Usage

Input Parameters

Output Parameters

Instructions

1. Ensure API Endpoint Supports PUT Requests

   • The url must be a valid API endpoint accepting PUT requests.

2. Set Necessary Headers

   • If authentication is required, pass headers (e.g., Authorization token).

3. Provide Request Body

   • Use the body parameter to define the data being sent.

4. Configure Response Encoding

   • Use utf8 (default) or other supported encodings.

5. Review API Response

   • Check statusCode and body for success or failure messages.

Notes

• PUT requests typically replace entire resources: Ensure that the provided data includes all necessary fields.

• Proper headers must be set: Use Content-Type: application/json for JSON payloads.

Overview

The HTTP DELETE component allows sending HTTP DELETE requests to external services, enabling users to remove resources via API calls. It provides response details, including body, headers, and status code.

Usage

Input Parameters

Output Parameters

Instructions

1. Ensure API Endpoint Supports DELETE Requests

   • The url must be a valid API endpoint accepting DELETE requests.

2. Set Necessary Headers

   • If authentication is required, pass headers (e.g., Authorization token).

3. Provide Optional Request Body

   • Some APIs accept a request body in DELETE requests.

4. Configure Response Encoding

   • Use utf8 (default) or other supported encodings.

5. Review API Response

   • Check statusCode and body for success or failure messages.

Overview

The HTTP POST Component sends HTTP POST requests to external services. It supports both raw body and form-data submissions, making it suitable for various API interactions.

Usage

Input Parameters