## Compliance Certifications
At Alloy Automation, we take security very seriously. In fact, we take a number of steps to mitigate any security risk. Alloy Automation is [SOC 2 Type I and II Compliant](https://us.aicpa.org/interestareas/frc/assuranceadvisoryservices/aicpasoc2report), SOC3, HIPAA, GDPR, and CCPA compliant. We undergo a regular SOC2 audit yearly. We work with a 3rd Party monitoring system to ensure continuous compliance. Potential customers can reach out to us to request a copy of our SOC 2 Report.
SOC 2 is a report based on the Auditing Standards Board of the American Institute of Certified Public Accountants' (AICPA) existing Trust Services Criteria (TSC). The purpose of this report is to evaluate an organization’s information systems relevant to security, availability, processing integrity, confidentiality, and privacy.
In addition to SOC 2, we are HIPAA, CCPA and GDPR Compliant and offers endpoints to allow customers to easily request data deletion in compliance with GDPR standards.
# GDPR Policies
Source: https://docs.runalloy.com/embedded/certifications/gdpr
To comply with GDPR, we allow you to remove any customer data for any given user. By using Alloy Embedded, it is your responsibility to remove any and all user data upon a user's request in accordance with European Union law.
To remove user data, you can invoke our [DELETE users/logs](/reference/embedded/delete-logs-for-a-user) endpoint.
# HIPAA Policies
Source: https://docs.runalloy.com/embedded/certifications/hipaa
Alloy Automation is compliant with the Health Insurance Portability and Accountability Act (HIPAA).
To ensure compliance, Alloy Automation has partnered with [Secureframe](https://secureframe.com/frameworks/hipaa). If you have any questions about our HIPAA compliance, please contact your account rep.
# SOC 2
Source: https://docs.runalloy.com/embedded/certifications/soc-2
Alloy Automation maintains compliance with the Service Organization Control Type 2 standards. Alloy Automation is both SOC2 Type I and SOC2 Type II compliant. Further, Alloy Automation maintains SOC3 compliance as well.
We undergo an annual audit of all systems to ensure strict adherence to SOC requirements. If you are a prospective customer looking to obtain a copy of our SOC2 report or if you have any questions on our controls, please contact your account rep.
# Concurrency
Source: https://docs.runalloy.com/embedded/concurrency
## Overview
In this guide, we'll take a look at how Alloy handles concurrency when running workflow executions. Understanding concurrency is important to having a solid grasp of our infrastructure.
## How it Works
To understand how concurrency works at Alloy, let's take two scenarios:
* Scenario 1: You have a single workflow that listens for new records created in BigCommerce and proxies those events over to your API. Let's assume this workflow receives 5,000 events in the first hour.
* Scenario 2: You've set up two workflows, one that receives customer sign-up events and adds them to a list in klaviyo, and a second workflow that receives Clicked Email events from Klaviyo and proxies those events to your API.
Alloy handles concurrency by spreading out workflow executions at the Workflow level. In other words, a workflow execution, or execution for short, represents any given job associated with a workflow. In Scenario 1, the rate at which Alloy can process the event and send it to your API is largely dictated by the rate-limiting of your API. If BigCommerce sends the first 1,000 events to Alloy over the course of a minute, we wouldn't want to immediately send those 1,000 events to your API if it has a 60 request-per-minute limit. Alloy instead adds those requests to a queue spread out over time to avoid having to handle rate-limit errors with retries. When the remaining 4,000 events are received over the course of an hour, they will be queued up to run after the last batch of events if there are still any outstanding.
In Scenario 2, if Alloy receives a customer signup event and clicked email event simultaneously, both workflows will execute simultaneously. These two workflows function independent of one another, and events received by one will not impact the event scheduling of the other.
## Wrapping Up
In this tutorial, we took at look at how Alloy handles concurrency across workflow executions.
# Custom Action
Source: https://docs.runalloy.com/embedded/custom-action
The Custom Action connector allows developers to define and execute arbitrary API requests using an existing application's authenticated credentials.
### Base API URL
When making requests against our APIs, it's important to select the EU data center if you intend to have all data pass through the European Union. Note that any users, credentials, etc created in the EU data center will not be accessible in the US data center and vice versa.
### Base API URL
When making requests against our APIs, it's important to select the US data center if you intend to have all data pass through the United States. Note that any users, credentials, etc created in the US data center will not be accessible in the EU data center and vice versa.
With Custom OAuth, you can supply your own **Client Id** and **Client Secret**and Alloy Embedded will use those credentials to make the appropriate requests on your behalf. The result of this is that when an end user authenticates, they see "Your \[App Name] is requesting access...".
The below video shows how an Embedded integration will look when Custom OAuth is enabled.
## Getting Started with Custom OAuth
On every OAuth block you'll see a configuration in the integration Settings as seen below in the Salesforce CRM example.
To configure Custom OAuth, you'll need to provide Alloy Embedded with the necessary information – each app may vary slightly but generally most apps follow the [OAuth standard](https://oauth.net/2/) .
Custom OAuth will prompt you to enter the required fields. In the case of Salesforce CRM those are as follows:
* **Client Id**: The client Id of your Salesforce CRM app
* **Client Secret**: The client secret for your Salesforce CRM app
* **Scope**: The scopes (provided by Alloy) Alloy Embedded needs to collect. You may need to request these scopes in your Salesforce CRM OAuth app configuration.
* **Redirect URL**: The URL (provided by Alloy) where the OAuth app should redirect to. You may need to specify this in your Salesforce CRM OAuth app configuration. This tells Salesforce how to properly handle the redirection request after the OAuth handshake is completed and customers will be routed back to your site upon redirection.
Failure to provide the right scopes may result in errors during workflow executions.
By default, we request all the scopes we need to support *every API endpoint* supported by Alloy Embedded. If you want to limit that or only need access to a select few, you can configure that via the scope checkboxes as seen below. Note that failure to supply the right scopes may result in workflows erroring. Generally, we recommend ensuring your app has full access to all required scopes.
## Wrapping Up
In this tutorial, we looked at how to set up our own client Id and client secret to whitelabel the end user's OAuth experience. With Custom OAuth, users will see your company's branding on OAuth-enabled apps.
# Handling Output Data
Source: https://docs.runalloy.com/embedded/handling-output-data
## Overview
In the Embedded workflow builder, each block has output data that enables variables to be mapped from one block another. Output data is sourced one of three ways:
1. By making a call to the API you're interacting with an pulling live data from your account.
2. Using a payload obtained from the third-party's documentation site when the required resource is inaccessible (ex. the data doesn't exist in your account or the API doesn't make the data available via API).
3. Using a custom payload defined by you
Below, we'll walk through an example of each and show you what you can do with your output data.
## Understanding output data sources
Most of the time, you'll be interacting with sample data that's sourced from the credentials that you've added to Embedded. When that's not possible, Embedded uses a payload that's defined by the third-party app's documentation.
Even then, data from your account may not always be available. For example, you may not have access to an account with valid credentials, the specified resource may not yet exist in the credential, or the API may not provide access to the get the data structure of the resource programmatically.
However, even with options to select data sourced from your account or the app documentation, there may still be instances in which they do not accurately represent data that you may encounter in production executions. If this is the case, you can edit the output data exactly to your requirements.
## How to use output data in subsequent blocks
Output data from one block defines the variable selector of subsequent blocks. You are able to select variables at any level of the JSON or the output over in it's entirety.
# Headless Mode
Source: https://docs.runalloy.com/embedded/headless-mode
## Overview
Headless Mode allows you to build a fully custom interface without displaying any Alloy-branded components. This gives you complete control over the end-to-end user experience while leveraging our integration infrastructure behind the scenes.
## Getting Started
A typical Headless Mode user flow looks like this:
Let's explore each step in detail.
### Create a User
First, create a user by calling the `/users` endpoint:
```bash cURL theme={null}
curl --request POST \
--url https://embedded.runalloy.com/users \
--header 'Authorization: YOUR_BEARER_KEY' \
--header 'accept: application/json'
```
**Sample Response**
```json JSON theme={null}
{
"userId": "6634f9aa6adb117b4c47d8ab"
}
```
This returns a `userId` for the newly created user.
### List Integrations
To [list your available integrations](/reference/embedded/list-integrations), use any `userId` or `username` you've previously created:
```bash cURL theme={null}
curl --request GET \
--url https://embedded.runalloy.com/integrations?userId=ANY_USER_ID \
--header 'Authorization: YOUR_BEARER_KEY' \
--header 'accept: application/json'
```
### Display and Collect Auth Fields
Once your user selects an integration to connect, you'll need to display the authentication fields required by that third-party app. To determine which fields to show, make a request to the `metadata/credentials` endpoint. Replace `APP_NAME` with the name of the selected integration (e.g., Shopify):
```bash cURL" theme={null}
curl --request GET \
--url https://embedded.runalloy.com/metadata/credentials/APP_NAME \
--header 'Authorization: YOUR_BEARER_KEY' \
--header 'accept: application/json'
```
The `APP_NAME` can be found in the response from the [List integrations](/embedded/headless-mode#list-integrations) endpoint.
**Sample Response**
Here's a sample response for Shopify:
```json JSON" theme={null}
{
"data": {
"name": "shopify",
"icon": "https://cdn.runalloy.com/icons/shopify.png",
"isOauth": true,
"properties": [
{
"name": "shopSubdomain",
"displayName": "Shop Subdomain",
"description": "Enter your store subdomain. If your store domain is example.myshopify.com, the subdomain would be example."
}
]
}
}
```
From this response, you can see that Shopify uses OAuth authentication (`isOauth: true`) and requires one auth field: **Shop subdomain**. Display this field in your interface:
Once the user enters the required auth field(s), proceed to obtain a `credentialId`.
## Getting a CredentialId
A `credentialId` allows your app to perform actions like reading and writing data on behalf of the end-user once authenticated.
Typically, authentication is handled via the [Alloy Modal](/embedded/modal/modal-sdk). But to leverage a truly headless experience, you can ditch the modal completely. This is where our programmatic credential endpoints come in.
First, you'll need to determine if the third-party app uses OAuth or non-OAuth for authentication. See the [Display and Collect Auth fields](/embedded/headless-mode#display-and-collect-auth-fields) section for more.
### Custom OAuth (Optional)
When using Headless Mode, users will see the **Alloy Automation is requesting access to...** screen on the third-party app. To display your branding instead, you'll need approval from the third-party app. Read [this tutorial](/embedded/handling-custom-oauth) to learn more about using Custom OAuth with Headless Mode.
### Getting a CredentialId for OAuth Apps
If the third-party app uses OAuth, follow these steps:
## What is an Integration?
An integration is a combination of workflows centered around a Third Party App. For example, you could build a Shopify integration that has two workflows:
* Workflow #1 is triggered whenever an end user places an order in your platform and then creates an order record in Shopify.
* Workflow #2 listens for new order creations in Shopify and streams them to your data warehouse
## Breaking it Down
The below illustration details the flow of data within these two workflows.
This integration sends data to your server and also receives data from your application:
* In Workflow #1, your application is the *Event* and Shopify is the *Destination*.
* In Workflow #2, Shopify is the *Event* and your application is the *Destination*.
We assume you're [streaming data](/connectors/utility/data-streaming) to your application via the Data Stream block.
This flow works in many scenarios but you might not always want to ingest data in your server. In many instances, it makes more sense to send incoming data directly to a data warehouse (such as Snowflake, BigQuery, etc). The below illustration shows how you could configure such a flow.
Being able to send outgoing data to a Third Party App and also receive events from the same app is known as a **bi-directional data sync**.
For more information about how to stream data to a destination, [see this article](/connectors/utility/data-streaming#streaming-data-to-a-warehouse).
## Wrapping Up
In this tutorial, we learned how to build an integration. Integrations are a collection of workflows that send outgoing data to a Third Party App and can also listen in for incoming data.
We call this two way flow a bi-direction data sync. With Alloy Embedded, you can build powerful integrations in minutes.
# Building Integrations With Custom Event and Custom Action
Source: https://docs.runalloy.com/embedded/knowledge-articles/building-integrations-with-custom-event-and-custom-action
## Overview
Custom action allows ISVs to support endpoints that Alloy may not support out of the box. Learn more about
## Setting up your First Custom Event
## Creating Users
Each user on your platform that uses Embedded should be tied to a corresponding user in Embedded. Let's take an example. Assume your company, ACME Co, has purchased Embedded and is building a Slack integration. A new user called "Joe Smoe [joe@example.com](mailto:joe@example.com)" signs up for your platform. In order to enable Embedded for Joe, you'll need to create a user via the Embedded API. The Create User endpoint takes an email address as input to easily identify the user in question. For any historical users you have on your platform prior to ACME Co using Embedded, you'll want to create the relevant Embedded users too.
Creating a new user in Embedded returns a unique username. We recommend storing this username somewhere in your database; you can however reference it anytime you like by using our Get User or List Users endpoints. As mentioned above, a best practice when using Embedded would be to create users for all old and new merchants. While accounts can be created on-demand, proactive creation allows you to catch email conflicts and speed up the merchant flow upon the first integration installation.
## Managing User Tokens
Once the user is created, in order to render the Embedded modal, you'll want to [generate a User Token](https://alloyautomation.readme.io/reference/get-user-token). The User Token is a JSON Web Token (JWT) that is required to securely render the Embedded Modal in your application and must be regenerated every time you want to show the modal.
### When to use
Use the Modal SDK if you present the Embedded iPaaS modal inside your product. It is not required for Headless or Alloy Link flows.
**What it provides**
* Render the Embedded iPaaS modal for integrations and workflows
* Authenticate the end user with `Alloy.setToken(...)`
* Install, edit, and update workflows: `Alloy.install`, `Alloy.edit`, `Alloy.update`
* Query installed integrations and workflows: `Alloy.getIntegrations`, `Alloy.getWorkflows`
* Activate or deactivate workflows: `Alloy.reactivate`, `Alloy.deactivate`
### Installing the Modal SDK
Install via npm or yarn:
```sh theme={null}
npm install alloy-frontend
# or
yarn add alloy-frontend
```
Or include via script tag:
```html theme={null}
```
Set your user token before calling SDK methods:
```js theme={null}
Alloy.setToken("
## Creating users
Create a user in Embedded iPaaS for each account in your app that needs integrations. For example, when a new user signs up in your product, call the **Create User** endpoint with their email. Store the returned `username` in your database. You can retrieve users later via **Get User** or **List Users**.
Proactive creation for existing accounts is recommended to surface any email conflicts early and to speed up the first-time integration flow.
* API reference: [Create a User](https://alloyautomation.readme.io/reference/create-a-user)
## Managing user tokens
To render the Embedded iPaaS modal, generate a **User Token** (JWT) for the target user each time you show the modal. Tokens expire after a maximum of 30 minutes.
* API reference: [Get User Token](https://alloyautomation.readme.io/reference/get-user-token)
## Overview
In this guide, we'll walk through how to get started building integrations with Alloy Embedded. Alloy Embedded is the easiest and fastest way to go live with not just one but hundreds of pre-built, maintained, and powerful integrations.
Offering your users integrations with Third Party Apps (3PA) has increasingly become an essential part of any successful SaaS product. But building and maintaining dozens of robust integrations require a sizable time and financial commitment that ultimately takes time away from your product roadmap.
Enter Alloy Embedded.
Alloy Embedded is an Embedded iPaaS product designed to streamline building native integration experiences. Let us handle the complexity of managing integrations – just implement our SDK once and build integrations with ease.
In this Quick Start guide, you'll learn how to create comprehensive integrations with the Alloy Embedded platform. We’ll cover the following topics:
* Key concepts
* How to build an integration
* How to add Alloy Embedded to your application
* Going live
Prior to reading this guide, we strongly recommend reviewing our [Terminology](/embedded/terminology) page as we'll be mentioning these terms throughout this guide.
Grab a cup of coffee and let’s dive in!
## Key Concepts
Before we begin, let's align on a handful of key terms:
| Term | Definition |
| :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ISV | We refer to you as the Independent Software Vendor (ISV). The ISV determines what integrations to build and show in their application |
| End User | We refer to the users/clients of your application as users or end users. Users authenticate their credentials and choose which integrations to install. Users interact with your platform and connect their integrations using the Alloy Embedded modal behind the scenes. |
| Integrations | An integration is a combination of workflows centered around a Third Party Application. For example, you could build a Shopify integration with three workflows: (a) workflow #1 sends *order* data to your data warehouse every time a Shopify order is placed, (b) workflow #2 syncs *customer* data to your data warehouse, and (c) workflow #3 tags a customer in Shopify when a user clicks a button on your site. |
| Workflows | Workflows define exactly what should happen when any given event occurs. A workflow consists of an event (also known as a "trigger") and a destination (also known as an "action block"). An event initiates the workflow. A destination defines where the data from the event should be routed to (e.g. assume you built a workflow that creates a new contact in NetSuite every time a customer signs up in your app. In this scenario, the event is triggered whenever a customer signs up in your application and the destination is NetSuite). |
| Installation | You build workflows and integrations using our visual interface, known as the Alloy Workflow Builder. Every time an end user installs a workflow, they create a copy of the template you've built. Each user-specific copy of the template is called an installation. You can think of a workflow like a class in programming. The template you build in the Alloy Workflow Builder defines the general structure of your flow. When your end user installs that workflow, they create an instance (i.e. an installation) of that workflow specific to them. |
| Alloy Modal | Often referred to as just the “modal”, the Alloy Modal is part of our [Frontend JavaScript SDK](/embedded/frontend-javascript-sdk) and is used to collect the details from users needed to setup and configure an integration (example below). |
## Integration Structure
Before we build our first integration, let's take a moment to plan it. Assume you're a software engineer at AcmeCo were given the following product requirements:
We'll need to build two workflows to support this use case:
* **Workflow #1**: When a new order is created in BigCommerce, create a new record in AcmeCo
* **Workflow #2**: When a fulfillment status is updated in AcmeCo, update the order status in BigCommerce
## Use Case Overview
When developing features for small businesses, it's crucial to quickly assess their financial position. Implementing workflows to retrieve a merchant's accounts payable data can help you automate services such as cash advances and business loans.
### Define the Payload
To get started, create a workflow with a Custom Event and select the Accounting System of your choosing. You will need to define the schema you'll be sending over to Alloy in your Custom Event payload.
Next, select the Accounting System of choice. For our demo, we'll use Quickbooks.
### Lookup a Vendor by Email
Next, we'll check if the Vendor exists in the Accounting System. To do so, we can look them up by email. If the Vendor exists, we'll use the Vendor Id when we create a Bill.
### Add a conditional
Next, we'll introduce a conditional that checks if the Vendor exists. If the Vendor exists, we'll create a Bil. Ilf the Vendor does not exist, we'll first create a Vendor record and then Create the Bill after the Vendor record has been saved. We need to associate Vendors with Bills.
### Create a Customer
If the Customer does not already exist within the Accounting System, we'll need to first create a Customer record. Creating a customer is necessary in order to properly associate a Customer to an Invoice record. Select the **Create Customer** action and map the relevant fields accordingly.
### Create Bill
Now that we've created a Vendor, we can associate the Vendor with a Bill and create the Bill accordingly.
## Wrapping Up
By now, your workflow should look like the below. To recap, let's walk through how this flow functions:
## Use Case Overview
When developing features for small businesses, it's crucial to quickly assess their financial position. Implementing workflows to retrieve a merchant's accounts receivable data can help you automate services such as cash advances and business loans.
### Define the Payload
To get started, create a workflow with a Custom Event and select the Accounting System of your choosing. You will need to define the schema you'll be sending over to Alloy in your Custom Event payload.
Next, select the Accounting System of choice. For our demo, we'll use Quickbooks.
### Lookup a Customer by Email
Next, we'll check if the Customer exists in the Accounting System. To do so, we can look them up by email. If the customer exists, we'll use the Customer Id when we create the Invoice.
### Add a conditional
Next, we'll introduce a conditional that checks if the Customer exists. If the Customer exists, we'll create an Invoice. If the Customer does not exist, we'll first create a Customer record and then Create the Invoice after the Customer record has been saved.
### Create a Customer
If the Customer does not already exist within the Accounting System, we'll need to first create a Customer record. Creating a customer is necessary in order to properly associate a Customer to an Invoice record. Select the **Create Customer** action and map the relevant fields accordingly.
### Create Invoice
Now that we've created a Customer, we can associate the Customer with an Invoice and create the Invoice accordingly. You'll be prompted to map various data fields like Country, Customer Reference, and Line Items. You can find a more complete example in the Workflow Builder.
## Wrapping Up
By now, your workflow should look like the below. To recap, let's walk through how this flow functions:
## Use Case Overview
Let's assume you are building a tool that gives businesses visibility into their financial health using data from their balance sheet. To successfully build and launch this tool, you'll need a way for these businesses to quickly and securely grant you access to their accounting data. This is where Alloy comes in! With Alloy, A business can safely and securely grant access to their financial information to software vendors like you.
In this guide, we'll cover how to retrieve the data needed to help a Business understand their balance sheet better.
### Balance Sheet Data
Learn more about building a [balance sheet](/embedded/use-cases/accounting-and-erps/underwriting#balance-sheet-data) workflow with Alloy.
## Wrapping up
Alloy provides the tools to help you build powerful accounting workflows, helping your end users gain better visibility into their financial data.
# Cash Flow Analysis
Source: https://docs.runalloy.com/embedded/use-cases/accounting-and-erps/cash-flow-analysis
In this guide, we'll look at how to get all of the necessary data you need to perform a Cash flow analysis on a business.
## Use Case Overview
A cash flow analysis is essential when analyzing a business's liquidity position, forecasting a business' future cash flow, or helping a company make better operational decisions.
With Alloy, you can quickly access the real-time financial data you need to make data-driven decisions for a business. To conduct a thorough cash flow analysis, you'll need to gather data such as bank transactions, accounts receivable (invoices), accounts payable (bills), and payments, among other financial details. In this guide, we'll look at how to retrieve this essential data when analyzing a business.
### Bank Transactions
To start, create a workflow using the **On Installation Trigger**.
## Use Case Overview
When preparing a compliance report, you need several pieces of accounting data to ensure that all financial activities are reported accurately.
Assume you are building compliance software for businesses. Compliance reporting requires accounting data such as Profit and Loss statements, Balance sheets, Cash flow statements, Accounts payable, Accounts receivable, payroll data, tax data, and more.
In this guide, we'll cover how to retrieve the data needed to help prepare a compliance report for a business with Alloy.
### General Ledger Report
To start, create a workflow using the **On Installation Trigger**.
## Use Case Overview
As a Fintech, Neobank, or expense card provider, when building an expense management app or feature, you need access to a company's recorded expenses. With Alloy, you can build integrations with any accounting software businesses use today, providing a consolidated view of a business' expenses.
Using Alloy's accounting integrations you can categorize expenses and perform in-depth analysis, enabling businesses to gain actionable insights into their spend. To achieve this, you'll need access to data like accounts payable (bills) and payments.
### Accounts Payable (Bills)
Learn more about building an [Accounts payable](/embedded/use-cases/accounting-and-erps/accounts-payable) workflow.
### Payments
Learn more about building a [payments](/embedded/use-cases/accounting-and-erps/underwriting#payments) workflow.
## Wrapping up
When building an expense management feature, you can save time by using Alloy to quickly integrate with the accounting software your end users use. With these integrations, you can pull the necessary information to help businesses manage their expenses effectively.
# Tax Reporting
Source: https://docs.runalloy.com/embedded/use-cases/accounting-and-erps/tax-reporting
In this guide, we'll look at how to get the necessary data you need to prepare a comprehensive tax report.
## Use Case Overview
When preparing a tax report, you need to gather several accounting data to make sure that all taxable income, deductible expenses, and any other relevant financial activities are reported accurately.
Let's assume you are building tax reporting software for businesses. You'll need access to a business' books to accurately help them calculate, prepare, and report their taxes. Tax reporting requires accounting data such as Profit and Loss, expenses, assets, and more.
In this guide, we'll cover how to retrieve the data needed for a business to accurately report their taxes using Alloy.
### Profit and Loss
To get a business' income data, you'll need access to its profit and loss statement.
To start, create a workflow using the **On Installation Trigger**.
## Use Case Overview
Picture this: you're a lending business and want to underwrite a \$50,000 loan for a merchant. How do you validate the merchant should be eligible for this loan? Traditionally, you *could* look at bank statements manually but clearly this isn't ideal.
Using Alloy, you can easily grab realtime financial data to get the most accurate financial picture when underwriting.
### Balance Sheet Data
To get started, create a workflow with the On Installation Trigger and select the Accounting System of your choosing. The On Installation Trigger tells Alloy to only run this workflow the initial time an end user connects. If you need to run the workflow multiple times, you can use a Custom Event or a Scheduled Trigger to run at specific intervals.
Next, select the Accounting System of choice. For our demo, we'll use Xero. You can see a snippet of the financial data available below:
### Obtaining Balance Sheet
To obtain Balance Sheet data, select the Retrieve Balance Sheet action. We can then stream the Balance Sheet data back to your application with the Data Stream connector.
Your workflow should look like the below.
### Trial Balance
You can use Alloy to retrieve a user's Trial Balance. Select the Trial Balance action within Alloy to retrieve and then stream this data back to your application.
### Payments
Use Alloy to retrieve all payments in your Accounting System/ERP. The workflow below makes it easy to configure this use case.
### Profit & Loss
You can also retrieve Profit and Loss data via Alloy's accounting integrations as seen below.
## Wrapping Up
You can use Alloy to build powerful workflows that retrieve financial data including P\&L, Balance Sheet, Trial Balance, Payments, etc. You also also subscribe to realtime events to get notified each time a record is updated or created in a 3rd party app (i.e. every time a new Sales Order is created, notify me).
# Catalog Sync
Source: https://docs.runalloy.com/embedded/use-cases/ecommerce/catalog-sync
In this guide, we'll take a look at how to use Alloy to configure Catalog Sync workflows with popular e-commerce applications
## Use Case Overview
Let's assume you're building an app that needs to sync catalog data from an e-commerce system such as Shopify into your platform. You need to first obtain a historical listing of all the relevant products and then subscribe to realtime events each and every time an product is created or updated.
To do this, we'll build a few workflows. Our first workflow will grab the historical list of all available products. Our second workflow will set up realtime event forwarding for events you will send to Alloy and pass them along to your commerce system. Lastly, our third and final workflow will subscribe to all catalog updates so you can be alerted each and every time an update occurs on a product.
Time to dive in!
### Syncing Historical Catalog
Create a new workflow. For the trigger, we'll select "On Installation" as our trigger. This trigger tells Alloy to only run this workflow once, upon the user's initial install.
Next, add a e-commerce connector. For our demo, we'll use Shopify but you can easily use others like BigCommerce, Adobe Magento, WooCommerce, etc. Select the list all products action.
Lastly, add a Stream Data connector. This connector will tell Alloy where to send all the catalog records to. Specify a destination URL of your choosing. You can see an example of this workflow below.
### Realtime Catalog Alerts
Next, let's build another workflow that allows us to create a product in our e-commerce system. For this workflow, we'll choose a [Custom Event](/embedded/custom-events) Trigger as our starting point. This will allow Alloy to map the data and take action in our commerce system.
Next, add a e-commerce connector. Select the create a product action. This is where we will map our dynamic values from the event we will send to Alloy into the Shopify inputs.
### Realtime Catalog Updates
Lastly, let's create a workflow that alerts us each time a product is updated in our e=commerce system. For this workflow, we'll choose the Shopify Trigger as our starting point and subscribe to the Product Updated event.
Add a Stream Data connector to send over the product payload in real time to your application. You can see an example of this workflow below.
## Wrapping Up
As you can see, it's easy to create workflows that subscribe to both historical and realtime catalog data in e-commerce systems. Let's take a look at what we covered in this tutorial:
In this guide, we'll take a look at how to use Alloy to configure Order Sync workflows with popular e-commerce applications
## Use Case Overview
Let's assume you're building an app that needs to sync order data from an e-commerce system such as Shopify into your platform. You need to first obtain a historical listing of all the relevant orders and then subscribe to realtime events each and every time an order is placed.
To do this, we'll build a few workflows. Our first workflow will grab the historical list of all available orders. Our second workflow will set up realtime event forwarding to subscribe us to incoming orders placed and pass them along to your application. Lastly, our third and final workflow will subscribe to all order updates so you can be alerted each and every time an update (e.g. a status change) occurs on an order.
Let's dive in!
### Syncing Historical Orders
Create a new workflow. For the trigger, we'll select "On Installation" as our trigger. This trigger tells Alloy to only run this workflow once, upon the user's initial install.
Next, add an e-commerce connector. For our demo, we'll use Shopify but you can easily use others like BigCommerce, Adobe Magento, WooCommerce, etc. Select the list all orders action.
Lastly, add a [Stream Data](/connectors/utility/data-streaming) connector. This connector will tell Alloy where to send all the order records to. Specify a destination URL of your choosing. You can see an example of this workflow below.
### Realtime Order Alerts
Next, let's build another workflow that allows us to create an order in our e-commerce system. For this workflow, we'll choose a [Custom Event](/embedded/custom-events) Trigger as our starting point. This will allow Alloy to map the data and take action in our commerce system.
Next, add a e-commerce connector. Select the create an order action. This is where we will map our dynamic values from the event we will send to Alloy into the Shopify inputs.
### Realtime Order Updates
Lastly, let's create a workflow that alerts us each time an order is updated in our e-commerce system. This is helpful to understand changes in the order state (i.e. if the status changed). For this workflow, we'll choose the Shopify Trigger as our starting point and subscribe to the Order Updated event.
Add a Stream Data connector to send over the order payload in real time to your application. You can see an example of this workflow below.
## Wrapping Up
As you can see, it's easy to create workflows that subscribe to both historical and realtime order data in e-commerce systems. Let's take a look at what we covered in this tutorial:
## Use Case Overview
As a Fintech or Neobank business, you recognize that deciding who to advance credit is never an easy decision. Having access to real-time data can help take the hassle out of the process. Leveraging integrations by Alloy can provide you with a competitive edge by significantly reducing the turnaround time for extending same-day credit to a business.
### Accessing Real-time Balance
You can access a Business' real-time balance in Stripe using Alloy's Stripe connector.
To start, create a workflow using the **On Installation Trigger**.
## Use Case Overview
For businesses handling tens of thousands of transactions daily, managing customer disputes can be a pain. Alloy helps software vendors solve this problem for their merchants by providing integrations with payment providers like Square, Stripe, and Recharge, enabling efficient dispute management.
### Sending alerts when a Dispute is raised
Let's create a workflow to notify our app whenever a dispute is raised in a merchant's account on our platform.
Navigate to the Alloy workflow builder. Click New Integration and search for Stripe.
On the Workflows screen, click New Workflow.
Next, select a trigger for the workflow. Search for Stripe Trigger in the list of connectors. Drag the Stripe Trigger into the Workflow UI and search for *Trigger workflow when issuing dispute created*. Add this action to the workflow builder.
Next, use the Stream Data connector to stream the result from the Stripe trigger connector to your servers.
Once you receive this notification within your app, you can choose how to notify the affected merchant; via an in-app notification, E-mail, or SMS.
Your completed workflow should look like below:
## Wrapping Up
Alloy's payments connector allows you to build dispute management features into your app using a simple workflow editor.
# Payouts
Source: https://docs.runalloy.com/embedded/use-cases/payments/payouts
In this guide, you'll learn how to get real-time notifications when a payout is made within a user's account.
## Use Case Overview
If you're building features for reconciliation, cash flow management, or financial reporting in your app, knowing when a payout is initiated in your merchant's account is essential for maintaining accurate financial data.
With Alloy, you can receive real-time alerts allowing your app to react to changes in your merchant's accounts.
### Getting a Payout Alert
Let's build a simple workflow that sends a notification to your server when a payout is initiated in your merchant's account.
Navigate to the Alloy workflow builder. Click New Integration and search for Stripe.
On the Workflows screen, click New Workflow.
Next, select a trigger for the workflow. Search for Stripe Trigger in the list of connectors. Drag the Stripe Trigger into the Workflow UI and select the *Trigger workflow when payout created* action. Add this action to your workflow.
Next, use the Stream Data connector to stream the result from the Stripe trigger connector to your servers.
Your completed workflow should look like this:
You can use this information to update a user's financial records with you and also to alert them.
## Wrapping Up
Alloy provides integrations with payment systems like Stripe, Square, and Recharge, enabling you to gain real-time access to transaction data when a critical event like Payout creation occurs.
# Refunds
Source: https://docs.runalloy.com/embedded/use-cases/payments/refund
In this guide, you'll learn how to get real-time notifications when a refund is initiated in a merchant's account.
## Use Case Overview
If you're building features for reconciliation, cash flow management, or financial reporting in your app, knowing when a refund is initiated in your merchant's account is essential for maintaining accurate financial data.
With Alloy, you can quickly integrate with a merchant's payment platforms to receive real-time alerts when events like refund initiations occur.
### Getting a Refund Alert
Let's build a simple workflow that sends a notification to your server when a refund has been initiated in your merchant's account by a customer.
Navigate to the Alloy workflow builder. Click New Integration and search for Stripe.
On the Workflows screen, click New Workflow.
Next, select a trigger for the workflow. Search for Stripe Trigger in the list of connectors. Drag the Stripe Trigger into the Workflow UI and select the *Trigger workflow when new refund* action. Add this action to your workflow.
Next, use the Stream Data connector to stream the result from the Stripe trigger connector to your servers.
Your completed workflow should look like this:
## Wrapping Up
Alloy provides integrations with payment systems like Stripe, Square, and Recharge, enabling you to gain real-time access to transaction data when a critical event like refund initiation occurs.
# Subscriptions
Source: https://docs.runalloy.com/embedded/use-cases/payments/subscriptions
In this guide, you'll learn how to get real-time alerts when a subscription is created or updated within your merchant's accounts.
## Use Case Overview
If you're building a CRM or billing and invoicing software for merchants, you need to know when a new subscription has been created or updated in the third-party software the merchant uses.
With Alloy, you can receive real-time alerts allowing your app to react to changes in subscription data within a merchant's account.
### Receiving Subscription Alerts
Let's build a simple workflow that notifies your server when a subscription is created or updated within a merchant's account.
Navigate to the Alloy workflow builder. Click New Integration and search for Stripe.
On the Workflows screen, click New Workflow.
Next, select a trigger for the workflow. Search for Stripe Trigger in the list of connectors. Drag the Stripe Trigger into the Workflow UI and select the *Trigger workflow when new subscription* action. Add this action to your workflow.
Next, use the Stream Data connector to stream the result from the Stripe trigger connector to your Webhook server.
Your completed workflow should look like this:
## Wrapping Up
Alloy provides integrations with payment systems like Stripe, Square, and Recharge, allowing you to gain real-time access to events like Subscriptions created or updated.
# Automated Lead Routing
Source: https://docs.runalloy.com/embedded/use-cases/sales-and-crm/automated-lead-routing
Alloy simplifies the process of setting up lead routing from any third-party system directly into your app.
You can do so in three steps:
{docs.map(doc =>
)}
-
{doc.links.map(link =>
- {link.text} )}
Browse by topic
{topics.map(topic =>
)}
-
{topic.links.map(link =>
- {link.text} )}
Alloy Automation Documentation
Let's get started!
What is Alloy Automation?
Alloy Automation is the all-in-one integration platform designed for SaaS and AI.
We offer three ways to build enterprise-grade workflows and connectivity.
The Connectivity API embeds native integrations via a single endpoint. Embedded turns integration requests into marketplace offerings, enabling fast builds with minimal engineering. MCP provides AI agents secure, remote-hosted access to 1000+ tools with built-in context, permissioning, and authentication.
Browse by Product
Drag-and-drop orchestration tool for creating integrations and mapping data without engineering lift. It's ideal for teams shipping embedded iPaaS experiences quickly.
Real-time, native integration UIs with a single API, including hosted config and auth flows. It's ideal for teams embedding integrations directly into their product with minimal setup.
{messages.map(m => (
{m.role}:
{m.content}
))}
(tools/call) activate M M->>M: Validate Auth M->>M: Check Rate Limits M->>M: Apply Restrictions M->>A: API Request activate A A->>A: Decrypt Credentials A->>P: Platform API Call activate P P-->>A: Platform Response deactivate P A-->>M: Formatted Response deactivate A M-->>C: MCP Response deactivate M ``` This diagram shows the complete authentication and request flow: 1. **Authentication**: The MCP Server validates the request authentication 2. **Rate Limiting**: Checks against rate limits (100 req/min default) 3. **Restrictions**: Applies any configured access restrictions 4. **API Request**: Makes authenticated request to Alloy API 5. **Credential Decryption**: Alloy decrypts stored platform credentials 6. **Platform Call**: Executes the action on the external platform 7. **Response**: Returns formatted response to MCP client ## Best Practices * **Least privilege**: Restrict access to only the connectors and actions the server needs. * **Rotate secrets**: Periodically regenerate API keys and server tokens. * **Isolate users**: Use JWTs (`x-alloy-user-token`) to segregate end-user actions on shared servers. * **Store secrets securely**: Use environment variables or secret managers. Never hardcode credentials in code or HTML. # Connectivity API Source: https://docs.runalloy.com/reference/connectivity-api/connectivity-api The Alloy Connectivity API enables you to create and manage MCP (Model Context Protocol) servers that provide secure, controlled access to platform integrations for AI assistants. ## Authentication `HTTP: Bearer Auth` | Security Scheme Type: | http | | :------------------------- | :----- | | HTTP Authorization Scheme: | bearer | | Bearer format: | Bearer | ### Contact
In order to upgrade a workflow via this endpoint, the new workflow must have the same configurable fields as the original. If any new configurable fields were added, you will not be able to upgrade the workflow programmatically and instead would need to reinstall the workflow for the end user. # Acuity Scheduling Source: https://docs.runalloy.com/connectors/AcuityScheduling Integration details and setup guide for the Acuity Scheduling connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------- | | **Authentication** | HTTP Basic Authentication (User ID/API Key) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes (API-based) | | **Supports Rate Limiting** | Yes (10 requests per second) | | **Authentication Scopes Supported** | N/A (credentials are User ID and API Key) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Acuity Scheduling**: * **Appointments** * **Clients** * **Calendars** * **Appointment Types** * **Availability** * **Blocks** (Blocked Time) * **Forms** * **Coupons** * **Products** * **Certificates** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Acuity Scheduling offers a free 7-day trial. Sign up at [https://acuityscheduling.com](https://acuityscheduling.com). | | **Requires requires paid sandbox** | No paid sandbox required. You can test with your trial account. | | **Requires partnership to obtain authentication?** | No. You can obtain API credentials directly from your Acuity Scheduling account settings. | *** ### Authentication (HTTP Basic Authentication) Acuity Scheduling uses HTTP Basic Authentication with your User ID and API Key. #### Create your Acuity Scheduling account 1. Sign up for a free trial at **Acuity Scheduling** ([https://acuityscheduling.com](https://acuityscheduling.com)). 2. Once logged in, navigate to **Business Settings** → **Integrations** → **API**. 3. Your **User ID** is displayed at the top of the API page (a numeric value). 4. Click **Show API Key** to reveal your API Key, or generate a new one if needed. 5. Copy your **User ID** and **API Key**. 6. Enter your **User ID** as the username and **API Key** as the password into Alloy Automation. #### API Documentation For detailed API documentation, visit: [https://developers.acuityscheduling.com/reference/quick-start](https://developers.acuityscheduling.com/reference/quick-start) *** ## Use Cases ### 1) Automated appointment confirmations Sync appointment data from Acuity Scheduling to your CRM or communication platform to send automated confirmations, reminders, and follow-up messages, reducing no-shows and improving customer engagement. ### 2) Client data synchronization Keep client information synchronized between Acuity Scheduling and your CRM or customer database, ensuring your team has access to up-to-date contact information and appointment history across all systems. ### 3) Calendar availability management Automatically update availability across multiple scheduling platforms by syncing calendar blocks and availability changes from Acuity Scheduling, preventing double-bookings and maintaining consistent scheduling options. ### 4) Revenue and analytics tracking Pull appointment, product, and coupon data from Acuity Scheduling into your business intelligence or accounting systems for comprehensive revenue tracking, appointment analytics, and financial reporting. ### 5) Custom workflow automation Trigger custom workflows when appointments are booked, rescheduled, or canceled—such as sending intake forms, preparing meeting materials, or notifying team members—streamlining your operational processes. *** ## API Gotchas * ⚠️ **Rate limiting:** Acuity Scheduling enforces a rate limit of 10 requests per second. Implement throttling in your integration to avoid 429 responses. * ⚠️ **Webhook verification:** Acuity Scheduling webhooks include a signature in the request headers. Verify this signature to ensure webhook authenticity and security. * ⚠️ **Time zones:** All appointment times are returned in the time zone configured in your Acuity Scheduling account. Be mindful of time zone conversions when integrating with other systems. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Aircall Source: https://docs.runalloy.com/connectors/Aircall Integration details and setup guide for the Aircall connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) or Bearer Token (API Key) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes (100 requests per minute per account) | | **Authentication Scopes Supported** | `public_api` (access to public API) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Aircall**: * **Calls** (Call records and details) * **Users** (Team members) * **Numbers** (Phone numbers) * **Contacts** * **Tags** * **Teams** * **Voicemails** * **Comments** (Call comments) * **Webhooks** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | -------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Aircall offers a 7-day free trial. Sign up at [https://aircall.io](https://aircall.io). | | **Requires requires paid sandbox** | No paid sandbox required. You can test with your trial account. | | **Requires partnership to obtain authentication?** | No. You can obtain API credentials directly from your Aircall dashboard. | *** ### Authentication (OAuth 2.0 or Bearer Token) #### Option 1: OAuth 2.0 (Recommended for user-facing integrations) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. 1. Log in to your **Aircall dashboard** and navigate to **Integrations** → **API Keys**. 2. Click **Create a new OAuth app**. 3. Configure your OAuth application: * Add the redirect URI: [https://api.runalloy.com/api/strategy/connector/aircall/callback](https://api.runalloy.com/api/strategy/connector/aircall/callback) * The `public_api` scope is automatically granted and provides access to all API resources 4. Copy your **Client ID** and **Client Secret**. 5. Enter your **Client ID** and **Client Secret** into Alloy Automation. #### Option 2: Bearer Token (API Key) 1. Log in to your **Aircall dashboard** and go to **Integrations** → **API Keys**. 2. Click **Create a new API Key**. 3. Copy the generated API key. 4. Enter the API key into Alloy Automation as a Bearer token. #### OAuth Authorization URL The authorization URL for Aircall is: [https://dashboard-v2.aircall.io/oauth/authorize](https://dashboard-v2.aircall.io/oauth/authorize) #### Scopes Aircall uses a simplified scope model where the `public_api` scope provides access to all API resources. Access is automatically limited by the user's permissions within the Aircall account. #### API Documentation For detailed API documentation, visit: [https://developer.aircall.io/api-references](https://developer.aircall.io/api-references) *** ## Use Cases ### 1) Call logging and CRM synchronization Automatically sync call records, recordings, and metadata from Aircall into your CRM, ensuring sales and support teams have complete visibility into customer conversations without manual logging. ### 2) Contact enrichment and management Synchronize contacts between Aircall and your customer database, automatically updating contact information, tags, and call history across platforms to maintain data consistency. ### 3) Real-time call notifications Use Aircall webhooks to trigger real-time notifications or workflows when calls are answered, missed, or completed—such as creating support tickets, sending follow-up emails, or logging activities in project management tools. ### 4) Performance analytics and reporting Pull call data, user metrics, and team statistics from Aircall into your business intelligence platform to analyze call volume, response times, team performance, and customer engagement patterns. ### 5) Automated voicemail transcription workflows Monitor new voicemails via webhooks and trigger custom workflows like transcription services, sentiment analysis, or automatic ticket creation based on voicemail content and urgency. *** ## API Gotchas * ⚠️ **Rate limiting:** Aircall enforces a rate limit of 100 requests per minute per account. Exceeding this limit will result in 429 responses. Implement request throttling and exponential backoff. * ⚠️ **Webhook payload size:** Aircall webhooks include minimal data in the payload. You'll typically need to make follow-up API calls to fetch complete call or contact details after receiving a webhook event. * ⚠️ **Call recording URLs:** Call recording URLs are temporary and expire after a certain period. Download and store recordings in your own system if long-term access is required. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Airtable Source: https://docs.runalloy.com/connectors/Airtable Integration details and setup guide for the Airtable connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with PKCE and refresh tokens) or Personal Access Token (Bearer) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes (5 requests per second per base) | | **Authentication Scopes Supported** | `data.records:read` (read records), `data.records:write` (write and delete records), `data.recordComments:read` (see comments), `data.recordComments:write` (create, edit, and delete comments), `schema.bases:read` (read schema), `schema.bases:write` (edit base structure), `webhook:manage` (manage webhooks), `user.email:read` (read user email) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Airtable**: * **Bases** * **Tables** * **Records** * **Fields** * **Views** * **Users** * **Webhooks** * **Attachments** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Airtable offers a free tier with limited records and features. Sign up at [https://airtable.com](https://airtable.com) to test the integration. | | **Requires requires paid sandbox** | No paid sandbox required. | | **Requires partnership to obtain authentication?** | No. OAuth 2.0 credentials and Personal Access Tokens can be obtained directly through your Airtable account settings. | *** ### Authentication (OAuth 2.0 or Personal Access Token) #### Option 1: OAuth 2.0 (Recommended for user-facing integrations) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. 1. Go to **Airtable Developer Hub** ([https://airtable.com/create/oauth](https://airtable.com/create/oauth)) and create a new OAuth integration. 2. Configure your OAuth application: * Add the redirect URI: [https://api.runalloy.com/api/strategy/connector/airtable/callback](https://api.runalloy.com/api/strategy/connector/airtable/callback) * Select the scopes your integration requires (e.g., `data.records:read`, `data.records:write`, `schema.bases:read`, etc.) 3. Copy your **Client ID** and **Client Secret**. 4. Enter your **Client ID** and **Client Secret** into Alloy Automation. #### Option 2: Personal Access Token (PAT) 1. Log in to your **Airtable account** and go to **Account Settings**. 2. Navigate to the **Developer** section and click **Generate token**. 3. Select the scopes and bases your token should have access to. 4. Copy the generated Personal Access Token. 5. Enter the token into Alloy Automation as a Bearer token. #### PKCE Support Airtable's OAuth 2.0 implementation uses PKCE (Proof Key for Code Exchange) for enhanced security. Alloy Automation handles this automatically during the OAuth flow. #### Scopes Airtable uses granular scopes for different operations: * `data.records:read` and `data.records:write` for record operations * `schema.bases:read` and `schema.bases:write` for schema operations * `webhook:manage` for webhook operations * Additional scopes for comments and user information *** ## Use Cases ### 1) Project management sync Sync project data, tasks, and status updates between Airtable and other project management tools, keeping teams aligned across multiple platforms without manual data entry. ### 2) Customer data aggregation Collect customer information from various sources and consolidate it into Airtable bases, creating a centralized customer database that's accessible to your entire team. ### 3) Webhook-driven automation Set up real-time triggers that respond to changes in Airtable records—such as new leads, status updates, or form submissions—and automatically initiate workflows in other systems. ### 4) Dynamic schema management Programmatically create and modify Airtable base structures based on changing business needs, enabling flexible data models that adapt to your workflows. ### 5) Content and asset management Use Airtable as a content repository with attachment support, syncing files and metadata across your content creation and publishing pipeline. *** ## API Gotchas * ⚠️ **Rate limiting:** Airtable enforces a rate limit of 5 requests per second per base. Implement request queuing and backoff strategies to avoid hitting limits. * ⚠️ **Webhook expiration:** Airtable webhooks expire after 7 days of inactivity, Alloy Automation handles this logic behind the scenes. * ⚠️ **Field ID vs. Field Name:** When working with records, you can reference fields by name or ID. Field IDs are more stable as names can change. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Amazon Seller Central Source: https://docs.runalloy.com/connectors/AmazonSellerCentral Integration details and setup guide for the Amazon Seller Central connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) or LWA Access Token (Bearer) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes (varies by endpoint and selling partner type) | | **Authentication Scopes Supported** | Scopes are configured per application in Seller Central Developer Console | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Amazon Seller Central**: * **Catalog Items** * **Orders** * **Listings** * **Fulfillment by Amazon (FBA) Inventory** * **Fulfillment Inbound Shipments** * **Fulfillment Outbound Orders** * **Product Pricing** * **Product Fees** * **Reports** * **Feeds** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Amazon provides a free sandbox environment (both static and dynamic) for SP-API testing without affecting production data or triggering real-world events. Sign up for a seller account at [https://sellercentral.amazon.com](https://sellercentral.amazon.com). Developer sandbox documentation available [here](https://developer-docs.amazon.com/sp-api/docs/sp-api-sandbox#sp-api-static-sandbox). | | **Requires requires paid sandbox** | No paid sandbox required. The sandbox environment is free to use. | | **Requires partnership to obtain authentication?** | No, but you must register as a developer in Seller Central and create an SP-API application. Production access requires approval from Amazon. | *** ### Authentication (OAuth 2.0) #### Prerequisites Before starting, ensure you have: * An active **Amazon Seller Central account** (Professional or Individual plan) * Access to **Seller Central Developer Console** #### Create your SP-API application 1. Log in to **Seller Central** and navigate to **Apps & Services** → **Develop Apps**. 2. Click **Add new app client** and provide: * **App Name**: A descriptive name for your integration * **OAuth Redirect URI**: [https://api.runalloy.com/api/strategy/connector/amazonSellerCentral/callback](https://api.runalloy.com/api/strategy/connector/amazonSellerCentral/callback) 3. Under **API Access**, select the SP-API roles your application needs: * **Orders**: View and manage orders * **Catalog**: Search and retrieve product information * **Listings**: Create and manage product listings * **FBA**: Manage FBA inventory and shipments * **Pricing**: Retrieve pricing and competitive offer data * **Reports**: Generate and download business reports * **Feeds**: Submit bulk data updates 4. Save your application and copy the following credentials: * **LWA Client Identifier** (Client ID) * **LWA Client Secret** (Client Secret) * **Application ID** (required for OAuth authorization) 5. Enter these credentials into Alloy Automation. #### Regional endpoints Amazon SP-API operates across three regional endpoints: * **North America (NA)**: sellingpartnerapi-na.amazon.com (US, Canada, Mexico, Brazil) * **Europe (EU)**: sellingpartnerapi-eu.amazon.com (European marketplaces) * **Far East (FE)**: sellingpartnerapi-fe.amazon.com (Singapore, Australia, Japan, India) Configure the appropriate region in Alloy Automation based on your marketplace. #### Sandbox testing Amazon provides a sandbox environment for testing SP-API calls without affecting production data or triggering real-world events. The sandbox includes both static and dynamic modes for comprehensive testing. Learn more about the [SP-API Sandbox](https://developer-docs.amazon.com/sp-api/docs/sp-api-sandbox#sp-api-static-sandbox). *** ## Use Cases ### 1) Order fulfillment automation Automatically retrieve new orders from Amazon Seller Central and sync them to your warehouse management system, order management platform, or ERP—enabling faster order processing and reducing manual data entry. ### 2) Inventory synchronization Keep Amazon FBA inventory levels synchronized with your inventory management system in near real-time, preventing overselling and ensuring accurate stock availability across all sales channels. ### 3) Pricing optimization Pull competitive pricing data and product fees from Amazon, then dynamically adjust your pricing strategy based on market conditions, competitor prices, and profitability targets. ### 4) Bulk listing management Use the Feeds API to create, update, or delete product listings in bulk, making it easy to manage large catalogs or synchronize product data from your PIM or e-commerce platform to Amazon. ### 5) Business intelligence and reporting Extract sales reports, inventory reports, and financial data from Amazon Seller Central to build custom dashboards and analytics tools that provide unified visibility into your Amazon business performance. *** ## API Gotchas * ⚠️ **Rate limiting:** Amazon SP-API enforces dynamic rate limits that vary by endpoint and selling partner type. Professional sellers typically have higher limits than Individual sellers. * ⚠️ **Regional restrictions:** Each seller account is associated with specific marketplaces. You must use the correct regional endpoint (NA, EU, or FE) for the marketplaces you're selling in. * ⚠️ **Application approval required:** While you can create a draft application immediately, accessing production data requires Amazon's approval, which can take several days. Plan accordingly. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Asana Source: https://docs.runalloy.com/connectors/Asana Integration details and setup guide for the Asana connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------------------------------------ | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) or Personal Access Token (Bearer) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes (150 requests per minute) | | **Authentication Scopes Supported** | `default` (provides access to all resources) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Asana**: * **Access Requests** * **Allocations** * **Attachments** * **Audit Log API** * **Batch API** * **Custom Field Settings** * **Custom Fields** * **Custom Types** * **Events** * **Exports** * **Goal Relationships** * **Goals** * **Jobs** * **Memberships** * **Messages** * **Organization Exports** * **Portfolios** * **Portfolio Memberships** * **Project Briefs** * **Project Memberships** * **Project Statuses** * **Project Templates** * **Projects** * **Rules** * **Sections** * **SSPM** * **Status Updates** * **Stories** * **Tags** * **Task Templates** * **Tasks** * **Team Memberships** * **Teams** * **Time Periods** * **Time Tracking Entries** * **Typeahead** * **User Task Lists** * **Users** * **Webhooks** * **Workspace Memberships** * **Workspaces** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Asana offers a free Basic plan with limited features. Sign up at [https://asana.com](https://asana.com) to test the integration. | | **Requires requires paid sandbox** | No paid sandbox required. | | **Requires partnership to obtain authentication?** | No. OAuth 2.0 credentials and Personal Access Tokens can be obtained directly through your Asana account settings. | *** ### Authentication (OAuth 2.0 or Personal Access Token) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Option 1: OAuth 2.0 (Recommended for user-facing integrations) 1. Go to **Asana Developer Console** ([https://app.asana.com/0/my-apps](https://app.asana.com/0/my-apps)) and click **Create new app**. 2. Fill in your app details: * **App Name**: A descriptive name for your integration * **App URL**: Your application's website * **Redirect URL**: [https://api.runalloy.com/api/strategy/connector/asana/callback](https://api.runalloy.com/api/strategy/connector/asana/callback) 3. Once created, navigate to the **OAuth** section of your app. 4. Copy your **Client ID** and **Client Secret**. 5. Enter your **Client ID** and **Client Secret** into Alloy Automation. #### Option 2: Personal Access Token (PAT) 1. Log in to your **Asana account** and go to **My Settings**. 2. Navigate to the **Apps** tab and scroll to **Personal Access Tokens**. 3. Click **Create new token**, provide a description, and click **Create token**. 4. Copy the generated Personal Access Token (you won't be able to see it again). 5. Enter the token into Alloy Automation as a Bearer token. #### Scopes Asana uses a simplified scope model where the `default` scope provides access to all resources the authenticating user can access. Access is automatically limited by the user's permissions within Asana workspaces and projects. *** ## Use Cases ### 1) Project and task synchronization Sync projects, tasks, and subtasks between Asana and other project management tools or issue trackers, ensuring teams stay aligned across multiple platforms without manual updates. ### 2) Automated task creation from external events Automatically create Asana tasks when specific events occur in other systems—such as customer support tickets, form submissions, or pipeline stage changes—streamlining workflow automation. ### 3) Time tracking and resource management Integrate Asana's time tracking entries with timesheets, billing systems, or resource planning tools to provide comprehensive visibility into team capacity and project budgets. ### 4) Custom field data enrichment Sync custom field data between Asana and other business systems, enabling consistent data models across platforms and advanced reporting based on custom attributes. ### 5) Portfolio and goal tracking Pull portfolio and goal data from Asana into business intelligence tools or executive dashboards, providing leadership with real-time visibility into strategic initiatives and OKR progress. *** ## API Gotchas * ⚠️ **Rate limiting:** Asana enforces a rate limit of 150 requests per minute per access token. The API uses a cost-based system where different endpoints have different costs. * ⚠️ **Pagination:** Asana uses cursor-based pagination. Always use the `offset` token from the response to fetch the next page rather than implementing page number-based pagination. * ⚠️ **Webhook handshake:** When creating webhooks, Asana sends a handshake request that must be responded to with a 200 status and the `X-Hook-Secret` header value within 10 seconds. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Avalara Source: https://docs.runalloy.com/connectors/Avalara Integration details and setup guide for the Avalara connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | --------------------------------------------- | | **Authentication** | HTTP Basic Authentication (Username/Password) | | **Two-Way Sync** | Yes | | **Events Supported** | No | | **Realtime** | Yes (API-based) | | **Supports Rate Limiting** | Yes (429 status code handling) | | **Authentication Scopes Supported** | N/A (credentials are username and password) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Avalara**: * **Transactions** (Create, Commit, Void, List) * **Companies** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Avalara offers a free sandbox account for development and testing. Sign up at [https://developer.avalara.com/get-started](https://developer.avalara.com/get-started). | | **Requires requires paid sandbox** | No paid sandbox required. The free sandbox is fully functional for testing tax calculations. | | **Requires partnership to obtain authentication?** | No. You can create a free developer account directly on the Avalara developer portal. | *** ### Authentication (HTTP Basic Authentication) Avalara uses HTTP Basic Authentication with username and password credentials. #### Create your Avalara account 1. Sign up for a free sandbox account at **Avalara Developer Portal** ([https://developer.avalara.com/get-started](https://developer.avalara.com/get-started)). 2. Once registered, navigate to **Settings** → **License and API Keys** in your Avalara account. 3. Click **Generate License Key** to create API credentials. 4. Copy your **Account Number** (username) and **License Key** (password). 5. Enter your **Account Number** and **License Key** into Alloy Automation. #### Sandbox vs. Production * **Sandbox**: Use the sandbox environment ([https://rest.avatax.com](https://rest.avatax.com)) for development and testing. Sandbox accounts are free and fully functional. * **Production**: Once ready, you can upgrade to a production account and update your API credentials to use the production environment. #### API Documentation For detailed API documentation, visit: [https://developer.avalara.com/api-reference/avatax/rest/v2/](https://developer.avalara.com/api-reference/avatax/rest/v2/) *** ## Use Cases ### 1) Real-time sales tax calculation Calculate sales tax in real-time during checkout by sending transaction details to Avalara, ensuring accurate tax rates for every order based on product type, customer location, and applicable exemptions. ### 2) Automated tax transaction management Automatically create, commit, and void tax transactions in Avalara as orders are placed, fulfilled, or canceled in your eCommerce or ERP system, maintaining accurate tax records without manual intervention. ### 3) Multi-jurisdiction tax compliance Handle complex multi-state or international tax calculations effortlessly by leveraging Avalara's tax engine, which supports thousands of jurisdictions and keeps up-to-date with changing tax rates and rules. ### 4) Tax exemption management Apply customer tax exemptions automatically by passing exemption certificates and entity use codes to Avalara during transaction creation, ensuring compliant handling of tax-exempt sales. ### 5) Tax reporting and reconciliation Sync completed transactions from Avalara into your accounting system or data warehouse for comprehensive tax reporting, audit trails, and reconciliation with actual sales data. *** ## API Gotchas * ⚠️ **Transaction commits are permanent:** Once a transaction is committed, it cannot be modified. You can only void committed transactions. Always test transactions in "uncommitted" mode before committing. * ⚠️ **Rate limiting:** Avalara enforces rate limits and returns 429 status codes when exceeded. Implement exponential backoff and retry logic in your integration. * ⚠️ **Address validation is critical:** Accurate tax calculation depends on precise address information. Use proper address formatting and consider using Avalara's address validation API before calculating taxes. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Awtomic Source: https://docs.runalloy.com/connectors/Awtomic Integration details and setup guide for the Awtomic connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------------------- | | **Authentication** | API Key (Header: x-api-key) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes (API-based) | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (API key provides full access) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Awtomic**: * **Subscriptions** * **Customers** * **Orders** * **Products** * **Subscription Plans** * **Billing Cycles** * **Payment Methods** * **Subscription Actions** (pause, resume, skip) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Offers free trial?** | Awtomic pricing is based on the Shopify store plan. Install from the Shopify App Store at [https://apps.shopify.com/awtomic-subscriptions](https://apps.shopify.com/awtomic-subscriptions) or contact Awtomic for trial information. | | **Requires requires paid sandbox** | No separate sandbox required. You can test with development stores on Shopify. | | **Requires partnership to obtain authentication?** | No. Awtomic is a Shopify app, and API credentials are available directly from the app settings. | *** ### Authentication (API Key) Awtomic uses API Key authentication via the `x-api-key` header. #### Obtain your Awtomic API Key 1. Install the **Awtomic Subscriptions** app from the Shopify App Store on your Shopify store. 2. Once installed, open the Awtomic app from your Shopify admin panel. 3. Navigate to **Settings** within the Awtomic app. 4. Find the **API Key** section and copy your API key. 5. Enter your API key into Alloy Automation. #### API Documentation For detailed API documentation, visit: [https://api.awtomic.com](https://api.awtomic.com) (or contact Awtomic support for API documentation access) *** ## Use Cases ### 1) Subscription order fulfillment Automatically sync subscription orders from Awtomic to your fulfillment or logistics system, ensuring recurring orders are processed on schedule without manual intervention. ### 2) Customer subscription management Synchronize subscription data between Awtomic and your CRM, providing customer service teams with complete visibility into subscription status, billing cycles, and payment history. ### 3) Subscription analytics and reporting Pull subscription metrics, customer lifetime value, and churn data from Awtomic into your business intelligence platform for comprehensive subscription analytics and forecasting. ### 4) Automated subscription workflows Trigger custom workflows when subscriptions are created, paused, resumed, or canceled—such as sending personalized emails, updating inventory forecasts, or creating support tickets for at-risk customers. ### 5) Payment failure recovery Monitor failed payments and automatically trigger dunning workflows, alternative payment reminders, or customer outreach to reduce involuntary churn and recover revenue. *** ## API Gotchas * ⚠️ **Shopify dependency:** Awtomic is built on top of Shopify, so changes to Shopify products or customer data can affect Awtomic subscriptions. Maintain synchronization between both systems. * ⚠️ **Subscription state management:** Be careful when programmatically modifying subscription states (pause, resume, cancel) as these actions can trigger billing and customer notification workflows. * ⚠️ **API key security:** The API key provides full access to your Awtomic data. Store it securely and rotate it periodically. Never commit API keys to version control. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Calendly Source: https://docs.runalloy.com/connectors/Calendly Integration details and setup guide for the Calendly connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------------------------------------------ | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) or Bearer Token (Personal Access Token) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes (1000 requests per hour) | | **Authentication Scopes Supported** | Single scope with full API access | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Calendly**: * **Event Types** (Meeting types and configurations) * **Scheduled Events** (Booked meetings) * **Invitees** (Event attendees) * **Users** * **Organizations** * **Webhooks** * **Routing Forms** * **Data Compliance** (GDPR deletion requests) * **Activity Log** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Calendly offers a free Basic plan with limited features. Sign up at [https://calendly.com](https://calendly.com). | | **Requires requires paid sandbox** | No paid sandbox required. You can test with your free or trial account. | | **Requires partnership to obtain authentication?** | No. OAuth credentials and personal access tokens can be obtained directly from your Calendly account settings. | *** ### Authentication (OAuth 2.0 or Bearer Token) #### Option 1: OAuth 2.0 (Recommended for user-facing integrations) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. 1. Log in to your **Calendly account** and navigate to **Integrations** → **API & Webhooks**. 2. Click **Register New App** to create an OAuth application. 3. Configure your OAuth application: * Add the redirect URI: [https://api.runalloy.com/api/strategy/connector/calendly/callback](https://api.runalloy.com/api/strategy/connector/calendly/callback) * Calendly uses a simplified scope model with full API access 4. Copy your **Client ID** and **Client Secret**. 5. Enter your **Client ID** and **Client Secret** into Alloy Automation. #### Option 2: Bearer Token (Personal Access Token) 1. Log in to your **Calendly account** and go to **Integrations** → **API & Webhooks**. 2. Navigate to the **Personal Access Tokens** section and click **Generate New Token**. 3. Give your token a descriptive name and copy the generated token. 4. Enter the token into Alloy Automation as a Bearer token. #### OAuth Authorization URL The authorization URL for Calendly is: [https://auth.calendly.com/oauth/authorize](https://auth.calendly.com/oauth/authorize) #### API Documentation For detailed API documentation, visit: [https://developer.calendly.com/api-docs](https://developer.calendly.com/api-docs) *** ## Use Cases ### 1) Automated event synchronization Sync scheduled Calendly events to your CRM, calendar system, or project management tool, ensuring your team has visibility into all booked meetings without manual entry. ### 2) Invitee data enrichment Automatically pull invitee information from Calendly into your marketing automation or customer database, enriching contact records with meeting attendance and scheduling behavior. ### 3) Real-time booking notifications Use Calendly webhooks to trigger instant notifications, reminder workflows, or preparation tasks when new meetings are booked, canceled, or rescheduled. ### 4) Event type management Programmatically create, update, or manage Calendly event types based on team availability, campaign requirements, or seasonal scheduling needs, maintaining consistent booking options across your organization. ### 5) Analytics and reporting Pull scheduling data, no-show rates, and booking patterns from Calendly into your business intelligence platform for comprehensive analysis of meeting efficiency and customer engagement. *** ## API Gotchas * ⚠️ **Rate limiting:** Calendly enforces a rate limit of 1000 requests per hour per organization. Monitor usage and implement request throttling to avoid hitting limits. * ⚠️ **Organization scope:** Most API requests require an organization URI. Ensure you obtain and use the correct organization identifier for your API calls. * ⚠️ **Webhook event payloads:** Calendly webhooks contain minimal data in the payload. You'll typically need to make follow-up API calls to retrieve complete event or invitee details. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Copper Source: https://docs.runalloy.com/connectors/Copper Integration details and setup guide for the Copper connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------- | | **Authentication** | API Key (Header: X-PW-AccessToken) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes (180 requests per minute per user) | | **Authentication Scopes Supported** | N/A (API key provides access based on user permissions) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Copper**: * **Leads** * **People** (Contacts) * **Companies** * **Opportunities** * **Tasks** * **Activities** * **Projects** * **Pipelines** and **Pipeline Stages** * **Custom Fields** * **Tags** * **Webhooks** * **Related Items** (Entity relationships) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Copper offers a 14-day free trial. Sign up at [https://www.copper.com](https://www.copper.com). | | **Requires requires paid sandbox** | No paid sandbox required. You can test with your trial account. | | **Requires partnership to obtain authentication?** | No. API keys are available directly from your Copper account settings. | *** ### Authentication (API Key) Copper uses API Key authentication via the `X-PW-AccessToken` header, along with a user email header. #### Generate your Copper API Key 1. Log in to your **Copper account**. 2. Click on **Settings** (gear icon) in the top-right corner. 3. Navigate to **Integrations** → **API Keys**. 4. Click **Generate** to create a new API key. 5. Copy the generated API key. 6. Enter your **API Key** and **User Email** into Alloy Automation. #### Required Headers * `X-PW-AccessToken`: Your API key * `X-PW-UserEmail`: The email address of the API key owner * `X-PW-Application`: Always set to `developer_api` #### API Documentation For detailed API documentation, visit: [https://developer.copper.com](https://developer.copper.com) *** ## Use Cases ### 1) CRM data synchronization Sync leads, contacts, companies, and opportunities between Copper and other business systems, ensuring consistent customer data across your entire tech stack without manual data entry. ### 2) Lead routing and assignment Automatically create or update leads in Copper based on form submissions, marketing campaigns, or sales activities, and route them to the appropriate sales representatives using custom assignment logic. ### 3) Opportunity pipeline tracking Pull opportunity data, pipeline stages, and deal values from Copper into your business intelligence tools for comprehensive sales forecasting, pipeline analysis, and revenue tracking. ### 4) Task and activity management Synchronize tasks and activities between Copper and your project management or productivity tools, ensuring sales teams stay organized and follow-up activities are tracked across systems. ### 5) Relationship mapping Leverage Copper's related items functionality to maintain and sync complex entity relationships (people to companies, opportunities to contacts) across your integrated systems for complete relationship visibility. *** ## API Gotchas * ⚠️ **Rate limiting:** Copper enforces a rate limit of 180 requests per minute per user. Requests exceeding this limit will return a 429 status code. Implement exponential backoff and request throttling. * ⚠️ **Custom fields:** Custom field IDs and structures vary between Copper accounts. Use the field layouts endpoint to discover available custom fields before attempting to read or write custom field data. * ⚠️ **Lead conversion:** When converting a lead to a person, the lead record is archived and cannot be modified afterward. Ensure all necessary lead data is captured before conversion. * ⚠️ **Webhook limit:** Copper allows a maximum of 100 active webhook subscriptions per account. Plan your webhook strategy accordingly to stay within this limit. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Customer IO Source: https://docs.runalloy.com/connectors/CustomerIO Integration details and setup guide for the Customer IO connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ----------------------------------------------- | | **Authentication** | HTTP Basic Authentication (Site ID and API Key) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (API Key based authentication) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Customer IO**: * **Customers** * **Events** * **Campaigns** * **Segments** * **Messages** * **Broadcasts** * **Newsletters** * **Transactional Messages** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | **Offers free trial?** | Yes. Customer.io offers a free tier for up to 12,000 profiles. Sign up at [https://customer.io](https://customer.io) to get started. | | **Requires requires paid sandbox** | No paid sandbox required. You can use the free tier for testing. | | **Requires partnership to obtain authentication?** | No. API credentials can be obtained directly from your Customer.io workspace settings. | *** ### Authentication (HTTP Basic Authentication) Customer.io uses HTTP Basic Authentication with your Site ID and API Key. 1. Log in to your **Customer.io account** at [https://fly.customer.io](https://fly.customer.io). 2. Navigate to **Settings** → **API Credentials** in your workspace. 3. Copy your **Site ID** and **API Key** (or create a new API key if needed). 4. Enter your **Site ID** as the username and **API Key** as the password in Alloy Automation. #### API Documentation For detailed API documentation, visit: [https://customer.io/docs/api/](https://customer.io/docs/api/) #### Important Notes * Customer.io provides separate API keys for tracking and app API access * Tracking API is used for sending customer data and events * App API is used for managing campaigns, segments, and exports * Make sure to use the correct API key based on your integration needs *** ## Use Cases ### 1) Customer lifecycle automation Sync customer data from your application into Customer.io to trigger automated email campaigns, push notifications, and SMS messages based on user behavior and lifecycle stages. ### 2) Event-driven messaging Send real-time events from your platform to Customer.io to trigger transactional emails, in-app messages, and multi-channel campaigns based on specific user actions. ### 3) Segment synchronization Keep customer segments in sync between Customer.io and your CRM or data warehouse, ensuring consistent targeting across all marketing channels. ### 4) Campaign performance tracking Pull campaign metrics and message delivery data from Customer.io into your analytics platform for comprehensive marketing performance reporting. ### 5) Profile enrichment Enrich customer profiles in Customer.io with data from other systems like CRMs, support tools, and product analytics platforms to enable more personalized messaging. *** ## API Gotchas * **Rate limiting:** Customer.io enforces rate limits on API requests. The tracking API has different limits than the app API. Monitor response headers and implement appropriate backoff strategies. * **Site ID vs API key:** Customer.io uses a Site ID (username) and API Key (password) for basic authentication. Don't confuse the Site ID with the API key. * **Different APIs for different purposes:** Customer.io has separate APIs for tracking (sending data) and app operations (managing campaigns). Ensure you're using the correct endpoint. * **Batch operations:** For sending large volumes of customer data or events, use the batch API endpoints to improve performance and reduce rate limiting issues. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Delighted Source: https://docs.runalloy.com/connectors/Delighted Integration details and setup guide for the Delighted connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ----------------------------------- | | **Authentication** | HTTP Basic Authentication (API Key) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes (100 requests per 10 seconds) | | **Authentication Scopes Supported** | N/A (API Key based authentication) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Delighted**: * **People** * **Survey Responses** * **Survey Types** (NPS, CSAT, CES, 5-Star, Thumbs Up/Down, Smileys) * **Metrics** * **Unsubscribes** * **Bounces** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Offers free trial?** | Yes. Delighted offers a free trial with up to 50 survey responses per month. Sign up at [https://delighted.com](https://delighted.com) to get started. | | **Requires requires paid sandbox** | No paid sandbox required. You can use the free trial for testing. | | **Requires partnership to obtain authentication?** | No. API credentials can be obtained directly from your Delighted account settings. | *** ### Authentication (HTTP Basic Authentication) Delighted uses HTTP Basic Authentication with your API Key. 1. Log in to your **Delighted account** at [https://delighted.com](https://delighted.com). 2. Navigate to **Settings** → **API** in the left sidebar. 3. Copy your **API Key** from the API settings page. 4. Enter **"api"** as the username and your **API Key** as the password in Alloy Automation (or just use the API key if your system supports API key authentication). #### API Documentation For detailed API documentation, visit: [https://delighted.com/docs/api](https://delighted.com/docs/api) #### Important Notes * Delighted's API uses basic authentication with the username "api" and your API key as the password * Each Delighted account has a unique API key that provides access to all survey data * API keys should be kept secure and regenerated if compromised *** ## Use Cases ### 1) Customer feedback automation Automatically trigger Delighted surveys after key customer interactions such as purchases, support tickets, or feature usage to capture real-time satisfaction data. ### 2) Response aggregation and analysis Pull survey responses from Delighted into your data warehouse or analytics platform to combine feedback data with product usage, customer demographics, and business metrics. ### 3) NPS score tracking Sync NPS scores and promoter/detractor classifications to your CRM to enable sales and support teams to take action based on customer sentiment. ### 4) Automated follow-up workflows Trigger automated workflows in other systems based on survey responses—such as routing detractors to customer success teams or sending thank-you messages to promoters. ### 5) Multi-channel feedback collection Integrate Delighted with your communication platforms to send surveys via email, SMS, in-app, or link, and centralize all feedback data for unified reporting. *** ## API Gotchas * **Rate limiting:** Delighted enforces a rate limit of 100 requests per 10-second window. Implement exponential backoff when you receive 429 rate limit errors. * **API key security:** The API key provides full access to your Delighted account. Store it securely and never expose it in client-side code. * **Pagination:** When fetching large numbers of survey responses or people, use pagination parameters (`per_page` and `page`) to avoid timeouts and ensure complete data retrieval. * **Survey types:** Delighted supports multiple survey types (NPS, CSAT, CES, etc.). Make sure to filter or handle responses appropriately based on the survey type you're working with. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Dropbox Source: https://docs.runalloy.com/connectors/Dropbox Integration details and setup guide for the Dropbox connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | Bearer Token (OAuth 2.0) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | `account_info.read`, `files.metadata.write`, `files.metadata.read`, `files.content.write`, `files.content.read`, `sharing.write`, `sharing.read`, `file_requests.read`, `file_requests.write` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Dropbox**: * **Files** * **Folders** * **Shared Links** * **Shared Folders** * **File Requests** * **Paper Documents** * **Team Members** (Dropbox Business) * **Team Folders** (Dropbox Business) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Dropbox offers a free Basic plan with 2GB of storage. Sign up at [https://www.dropbox.com](https://www.dropbox.com) to get started. Dropbox Business offers a 30-day free trial. | | **Requires requires paid sandbox** | No paid sandbox required. You can use the free Basic plan for testing. | | **Requires partnership to obtain authentication?** | No. OAuth credentials can be obtained directly from the Dropbox App Console. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. 1. Go to the **Dropbox App Console** at [https://www.dropbox.com/developers/apps](https://www.dropbox.com/developers/apps). 2. Click **Create app** and configure your application: * Choose the API you want to use (Dropbox API or Dropbox Business API) * Choose the type of access (Full Dropbox or App folder) * Give your app a name 3. In the app settings, add the redirect URI: [https://api.runalloy.com/api/strategy/connector/dropbox/callback](https://api.runalloy.com/api/strategy/connector/dropbox/callback) 4. Configure the **Permissions** tab to select the scopes your integration requires (e.g., `files.metadata.read`, `files.content.write`, etc.) 5. Copy your **App key** (Client ID) and **App secret** (Client Secret) from the Settings tab. 6. Enter your **App key** and **App secret** into Alloy Automation. #### OAuth Scopes Dropbox uses granular permission scopes: * **Account info:** `account_info.read` (view basic account information) * **Files metadata:** `files.metadata.read`, `files.metadata.write` (view and edit file metadata) * **Files content:** `files.content.read`, `files.content.write` (download and upload files) * **Sharing:** `sharing.read`, `sharing.write` (manage shared links and folders) * **File requests:** `file_requests.read`, `file_requests.write` (manage file requests) #### API Documentation For detailed API documentation, visit: [https://www.dropbox.com/developers/documentation/http/documentation](https://www.dropbox.com/developers/documentation/http/documentation) *** ## Use Cases ### 1) Document storage and retrieval Automatically upload files generated by your application to Dropbox folders and retrieve documents for processing, enabling centralized file management across systems. ### 2) Backup automation Sync critical files from your application or database to Dropbox for automatic backup and disaster recovery purposes. ### 3) Collaborative workflows Enable file sharing and collaboration by automatically creating shared links or shared folders in Dropbox when users collaborate on projects in your platform. ### 4) File request automation Create Dropbox file requests programmatically to collect documents from customers, partners, or team members directly into organized folders. ### 5) Content distribution Distribute large files, media assets, or documentation to users by generating time-limited shared links that can be embedded in emails or applications. *** ## API Gotchas * **Rate limiting:** Dropbox enforces rate limits based on your app's usage patterns. Monitor for 429 status codes and implement exponential backoff with jitter. * **File path case sensitivity:** Dropbox file paths are case-insensitive but case-preserving. Be careful when referencing files to avoid unexpected behavior. * **Cursor-based pagination:** Dropbox uses cursor-based pagination for listing files. Always use the cursor from the previous response to get the next page of results. * **Upload session for large files:** Files larger than 150MB should be uploaded using the upload session API endpoints rather than a single upload call. * **Webhook verification:** Dropbox webhooks require verification. When you register a webhook, Dropbox will send a challenge parameter that must be echoed back. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # EasyShip Source: https://docs.runalloy.com/connectors/EasyShip Integration details and setup guide for the EasyShip connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | -------------------------------- | | **Authentication** | Bearer Token (API Key) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (Token-based authentication) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **EasyShip**: * **Account** * **Addresses** * **Analytics** * **Auto Recharge** * **Batches** * **Boxes** * **Categories** * **Companies** * **Courier Accounts** * **Rates** * **Shipments** * **Tracking** * **Warehouses** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Easyship offers a free account with pay-as-you-go pricing. Sign up at [https://www.easyship.com](https://www.easyship.com) to get started. | | **Requires requires paid sandbox** | No paid sandbox required. You can use the free account with test mode for development. | | **Requires partnership to obtain authentication?** | No. API credentials can be obtained directly from your Easyship account settings. | *** ### Authentication (Bearer Token) Easyship uses Bearer token authentication with an API key. 1. Log in to your **Easyship account** at [https://www.easyship.com](https://www.easyship.com). 2. Navigate to **Connect** → **API Access** in the left sidebar. 3. Click **Generate API Key** or copy your existing API key. 4. Enter your **API Key** as a Bearer token in Alloy Automation. #### API Documentation For detailed API documentation, visit: [https://developers.easyship.com/](https://developers.easyship.com/) #### Important Notes * Easyship provides both production and sandbox API keys for testing * The API key provides full access to your account, so keep it secure * Easyship uses version-specific API endpoints (e.g., v2024-09) *** ## Use Cases ### 1) Multi-carrier shipping rates Fetch real-time shipping rates from multiple carriers through a single API integration, enabling customers to compare options and select their preferred shipping method at checkout. ### 2) Label generation and fulfillment Automatically create shipments and generate shipping labels when orders are placed in your ecommerce platform, streamlining the order fulfillment process. ### 3) International shipping automation Calculate duties, taxes, and landed costs for international shipments, and generate compliant customs documentation automatically for cross-border orders. ### 4) Tracking and notifications Sync tracking numbers and shipment status updates from Easyship to your order management system, enabling automated customer notifications and support inquiries. ### 5) Warehouse and inventory management Manage multiple warehouses, allocate inventory across locations, and optimize shipping costs by automatically selecting the nearest fulfillment center for each order. *** ## API Gotchas * **API versioning:** Easyship uses date-based API versions (e.g., v2024-09). Make sure to use the correct version in your API requests and stay updated on version deprecations. * **Rate limiting:** Easyship enforces rate limits on API requests. Monitor response headers for rate limit information and implement appropriate retry logic. * **Currency and units:** Be consistent with currency codes (ISO 4217) and measurement units (metric vs imperial) across your integration to avoid errors in rate calculations. * **Address validation:** Easyship performs address validation during shipment creation. Invalid addresses will result in errors, so validate addresses before submitting shipment requests. * **Courier account setup:** Some shipping options require you to connect your own courier accounts in Easyship. Make sure the necessary courier accounts are set up before attempting to create shipments. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Easypost Source: https://docs.runalloy.com/connectors/Easypost Integration details and setup guide for the Easypost connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ----------------------------------- | | **Authentication** | HTTP Basic Authentication (API Key) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (API Key based authentication) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Easypost**: * **Addresses** * **Parcels** * **Shipments** * **Rates** * **Tracking** * **Batches** * **Insurance** * **Customs Info** * **Carriers** * **Webhooks** * **Events** * **Pickups** * **Refunds** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. EasyPost offers a free test mode with no credit card required. Sign up at [https://www.easypost.com](https://www.easypost.com) to get started. Production usage is pay-as-you-go. | | **Requires requires paid sandbox** | No paid sandbox required. Test mode is completely free for development and testing. | | **Requires partnership to obtain authentication?** | No. API credentials can be obtained directly from your EasyPost account dashboard. | *** ### Authentication (HTTP Basic Authentication) EasyPost uses HTTP Basic Authentication with your API Key. 1. Log in to your **EasyPost account** at [https://www.easypost.com](https://www.easypost.com). 2. Navigate to **API Keys** in your account dashboard. 3. You'll see both **Test** and **Production** API keys. Copy the appropriate key for your environment. 4. Enter **your API key** as the username in Alloy Automation (password field can be left empty or use the API key again). #### API Documentation For detailed API documentation, visit: [https://www.easypost.com/docs/api](https://www.easypost.com/docs/api) #### Important Notes * EasyPost provides separate API keys for test and production environments * Test mode uses test carrier credentials and won't create real shipments * Production API keys require account verification and funding * API keys authenticate using HTTP Basic Auth with the key as the username and blank password *** ## Use Cases ### 1) Multi-carrier rate shopping Compare shipping rates across 100+ carriers in real-time to offer customers the best price and delivery options at checkout without managing individual carrier integrations. ### 2) Label printing automation Automatically purchase shipping labels when orders are placed, eliminating manual label creation and streamlining your fulfillment workflow. ### 3) Package tracking Retrieve real-time tracking information from multiple carriers through a unified API, enabling automated customer notifications and support ticket updates. ### 4) Address verification Validate and standardize shipping addresses before creating shipments to reduce delivery failures and return-to-sender issues. ### 5) International shipping compliance Automatically generate customs forms and calculate duties and taxes for international shipments, ensuring compliance with cross-border shipping regulations. *** ## API Gotchas * **API key security:** EasyPost API keys provide full account access. Never expose them in client-side code or public repositories. Use separate test and production keys. * **Test vs production mode:** Test API keys use test carrier accounts that don't create real shipments. Make sure to switch to production keys when going live. * **Address verification timing:** Address verification is a separate API call that should be done before creating shipments. Unverified addresses may result in delivery failures. * **Rate caching:** Shipping rates can change frequently. Don't cache rates for extended periods—fetch fresh rates at checkout to ensure accurate pricing. * **Webhook signatures:** EasyPost webhooks include signatures for security. Always verify webhook signatures to ensure requests are coming from EasyPost. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Eventbrite Source: https://docs.runalloy.com/connectors/Eventbrite Integration details and setup guide for the Eventbrite connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------------- | | **Authentication** | Bearer Token (OAuth 2.0) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes (1000 requests per hour per user, 50 requests per second) | | **Authentication Scopes Supported** | N/A (OAuth token provides access based on user permissions) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Eventbrite**: * **Events** * **Orders** * **Attendees** * **Tickets** * **Venues** * **Organizations** * **Categories** * **Formats** * **Discounts** * **Webhooks** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Eventbrite offers a free plan for free events. You can create paid events with a per-ticket fee. Sign up at [https://www.eventbrite.com](https://www.eventbrite.com) to get started. | | **Requires requires paid sandbox** | No paid sandbox required. You can create free test events for development. | | **Requires partnership to obtain authentication?** | No. OAuth credentials can be obtained directly from the Eventbrite App Management page. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. 1. Go to **Eventbrite Account Settings** at [https://www.eventbrite.com/account-settings/apps](https://www.eventbrite.com/account-settings/apps). 2. Click **Create New App** and fill in the required information: * Application name * Application description * Application URL 3. Add the redirect URI: [https://api.runalloy.com/api/strategy/connector/eventbrite/callback](https://api.runalloy.com/api/strategy/connector/eventbrite/callback) 4. Once your app is created, copy your **OAuth Token** (or **Client Secret** if using full OAuth flow). 5. Enter your credentials into Alloy Automation. #### API Documentation For detailed API documentation, visit: [https://www.eventbrite.com/platform/api](https://www.eventbrite.com/platform/api) #### Important Notes * Eventbrite supports both private tokens (for personal integrations) and OAuth 2.0 (for public apps) * Private tokens are simpler to set up but only work for your own events * OAuth 2.0 is required if you're building an app for other Eventbrite users * Tokens have access to all resources the authenticated user has permission to view *** ## Use Cases ### 1) Event data synchronization Sync event details, schedules, and venue information from Eventbrite to your website or app, ensuring consistent information across all platforms. ### 2) Attendee management Pull attendee lists and registration data from Eventbrite into your CRM or marketing automation platform for follow-up campaigns and relationship management. ### 3) Order processing and analytics Retrieve order data and ticket sales information to generate custom reports, track revenue, and analyze event performance across your business intelligence tools. ### 4) Automated check-in systems Build custom check-in applications that sync with Eventbrite attendee data in real-time, enabling smooth event entry and attendance tracking. ### 5) Multi-event management Aggregate data across multiple events and organizations to provide unified reporting, cross-event analytics, and centralized event management dashboards. *** ## API Gotchas * **Rate limiting:** Eventbrite enforces strict rate limits of 1000 requests per hour per user and 50 requests per second. Monitor the `X-RateLimit-*` headers and implement exponential backoff. * **Pagination:** Large datasets require pagination using the `continuation` token. Don't assume all results fit in a single response—always check for and handle pagination. * **Webhook retries:** Eventbrite will retry failed webhook deliveries up to 10 times with exponential backoff. Ensure your webhook endpoint returns 2xx status codes promptly. * **Event status transitions:** Events can be in various states (draft, live, started, ended, completed). Not all API operations are available in all states, so check event status before performing actions. * **Timezone handling:** Eventbrite stores event times in the event's local timezone. Always handle timezone conversions carefully when syncing to other systems. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Faire Source: https://docs.runalloy.com/connectors/Faire Integration details and setup guide for the Faire connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------- | | **Authentication** | API Key (X-FAIRE-ACCESS-TOKEN header) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (API Key based authentication) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Faire**: * **Products** * **Orders** * **Brands** * **Inventory** * **Shipments** * **Returns** * **Invoices** * **Retailers** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Faire is free to join for both brands and retailers. Brands can create an account at [https://www.faire.com/brand](https://www.faire.com/brand) and retailers at [https://www.faire.com/retailer](https://www.faire.com/retailer). | | **Requires requires paid sandbox** | No paid sandbox required. You can use your Faire account for testing. | | **Requires partnership to obtain authentication?** | No. API credentials can be obtained directly from your Faire account settings once approved for API access. | *** ### Authentication (API Key) Faire uses API Key authentication via the X-FAIRE-ACCESS-TOKEN header. 1. Log in to your **Faire account** at [https://www.faire.com](https://www.faire.com). 2. Navigate to **Settings** → **Integrations** → **API Access**. 3. Request API access if you haven't already (approval may be required). 4. Once approved, generate your **API Access Token** from the API settings page. 5. Enter your **API Access Token** into Alloy Automation. #### API Documentation For detailed API documentation, visit: [https://www.faire.com/external-api-docs](https://www.faire.com/external-api-docs) #### Important Notes * Faire API access requires approval from Faire's team * API keys are available for brands selling on Faire * The API provides access to order management, inventory updates, and product catalog * Keep your API token secure as it provides full access to your Faire account *** ## Use Cases ### 1) Order synchronization Automatically sync new orders from Faire retailers into your order management system or ERP, ensuring timely fulfillment and inventory updates. ### 2) Inventory management Push real-time inventory levels from your warehouse management system to Faire, preventing overselling and keeping your product availability accurate for retailers. ### 3) Product catalog updates Automatically update product information, pricing, and images on Faire when changes are made in your product information management (PIM) system. ### 4) Shipping and tracking Sync shipment information and tracking numbers from your fulfillment system to Faire, keeping retailers informed about their order status. ### 5) Returns processing Automatically process return requests and update inventory levels when retailers initiate returns through the Faire platform. *** ## API Gotchas * **API access approval:** Faire requires approval for API access. Apply for API access through your account settings and wait for approval before integrating. * **Rate limiting:** Faire enforces rate limits on API requests. Monitor response headers and implement retry logic with exponential backoff when you receive rate limit errors. * **Webhook reliability:** Ensure your webhook endpoints are highly available and respond quickly with 2xx status codes. Failed webhooks may result in missed order notifications. * **Inventory accuracy:** Faire expects accurate inventory levels. Overselling can result in penalties, so ensure your inventory sync is reliable and real-time. * **Product requirements:** Products on Faire must meet specific quality and content standards. Ensure product data is complete and compliant before publishing. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Fairing Source: https://docs.runalloy.com/connectors/Fairing Integration details and setup guide for the Fairing connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------------------- | | **Authentication** | API Key (Authorization header) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (API Key based authentication) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Fairing**: * **Survey Responses** * **Questions** * **Surveys** * **Attribution Data** * **Customer Insights** * **Post-Purchase Survey Results** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Fairing offers a free trial for new customers. Sign up at [https://www.fairing.co](https://www.fairing.co) to get started. | | **Requires requires paid sandbox** | No paid sandbox required. You can use your trial account for testing. | | **Requires partnership to obtain authentication?** | No. API credentials can be obtained directly from your Fairing account settings. | *** ### Authentication (API Key) Fairing uses API Key authentication via the Authorization header. 1. Log in to your **Fairing account** at [https://app.fairing.co](https://app.fairing.co). 2. Navigate to **Settings** → **Integrations** or **API Settings**. 3. Generate or copy your **API Key**. 4. Enter your **API Key** into Alloy Automation (typically used in the Authorization header). #### API Documentation For detailed API documentation and support, contact Fairing support or visit: [https://www.fairing.co](https://www.fairing.co) #### Important Notes * Fairing specializes in post-purchase surveys and customer attribution * API access allows you to retrieve survey responses and customer insights * The API key provides access to all survey data in your account * Keep your API key secure and rotate it periodically for security *** ## Use Cases ### 1) Attribution data collection Pull post-purchase survey responses from Fairing to understand how customers discovered your brand, enabling better marketing attribution and channel optimization. ### 2) Customer insights aggregation Sync survey responses and customer feedback into your data warehouse or analytics platform for comprehensive customer behavior analysis. ### 3) Marketing optimization Use attribution data from Fairing surveys to optimize ad spend across channels by identifying which marketing sources drive the most valuable customers. ### 4) CRM enrichment Enrich customer profiles in your CRM with survey responses about preferences, interests, and purchase motivations collected through Fairing's post-purchase surveys. ### 5) Product feedback analysis Collect and analyze product feedback from post-purchase surveys to inform product development, merchandising decisions, and customer experience improvements. *** ## API Gotchas * **Survey timing:** Fairing surveys are triggered post-purchase. Ensure your integration accounts for the timing delay between order placement and survey completion. * **Response rates:** Not all customers complete surveys. Your integration should handle cases where survey data is unavailable for certain orders. * **Data freshness:** Survey responses may not be available immediately after purchase. Implement appropriate polling intervals or use webhooks for real-time updates. * **Question configuration:** Survey questions can be customized in Fairing. Ensure your integration can handle dynamic question types and response formats. * **Rate limiting:** Implement rate limiting and exponential backoff to avoid overwhelming the API when syncing large volumes of survey data. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # FedEx Source: https://docs.runalloy.com/connectors/FedEx Integration details and setup guide for the FedEx connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------------------------------- | | **Authentication** | OAuth 2.0 (Client Credentials) or Bearer Token | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks/Tracking) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (Client Credentials flow) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **FedEx**: * **Shipments** * **Tracking** * **Rates** * **Address Validation** * **Pickup** * **Service Availability** * **Documents** (Labels, Commercial Invoices) * **Location Services** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. FedEx provides a test environment for developers. Sign up for a FedEx Developer account at [https://developer.fedex.com](https://developer.fedex.com) to get started. | | **Requires requires paid sandbox** | No paid sandbox required. FedEx provides a free test environment with test credentials. | | **Requires partnership to obtain authentication?** | Yes. You need a FedEx account number to access production APIs. Register at [https://developer.fedex.com](https://developer.fedex.com). | *** ### Authentication (OAuth 2.0 Client Credentials) FedEx uses OAuth 2.0 Client Credentials flow for API authentication. 1. Go to **FedEx Developer Portal** at [https://developer.fedex.com](https://developer.fedex.com). 2. Sign in or create a new developer account. 3. Navigate to **My Projects** and create a new project. 4. Select the APIs you need (e.g., Ship, Track, Rate) and note the API key and secret key provided. 5. Your application will use these credentials to obtain access tokens via the OAuth 2.0 Client Credentials flow: * Token URL: [https://apis.fedex.com/oauth/token](https://apis.fedex.com/oauth/token) * Grant Type: client\_credentials 6. Enter your **API Key** (Client ID) and **Secret Key** (Client Secret) into Alloy Automation. #### API Documentation For detailed API documentation, visit: [https://developer.fedex.com/api/en-us/home.html](https://developer.fedex.com/api/en-us/home.html) #### Important Notes * FedEx APIs require a valid FedEx account number for production use * Test environment credentials are separate from production credentials * Access tokens expire after a certain period and must be refreshed * Different APIs may require different API products to be enabled in your project *** ## Use Cases ### 1) Shipping rate calculation Fetch real-time shipping rates from FedEx at checkout, allowing customers to compare service levels and costs before completing their purchase. ### 2) Label generation and fulfillment Automatically create FedEx shipping labels when orders are placed, including domestic and international shipments with customs documentation. ### 3) Package tracking Retrieve real-time tracking updates for FedEx shipments and push notifications to customers about their delivery status. ### 4) Address verification Validate shipping addresses before creating shipments to reduce delivery failures and ensure accurate address information. ### 5) Pickup scheduling Automatically schedule FedEx pickups when shipments are ready, streamlining the fulfillment process and eliminating manual pickup requests. *** ## API Gotchas * **OAuth token expiration:** Access tokens expire after a set period (typically 1 hour). Implement token refresh logic to avoid authentication failures during long-running operations. * **Account number required:** Most FedEx API operations require a valid FedEx account number. Ensure your account is properly configured before attempting to create shipments. * **Test vs production:** Test environment data doesn't create real shipments or charges. Always test thoroughly before switching to production credentials. * **Service availability:** Not all FedEx services are available in all regions. Check service availability before attempting to create shipments to specific destinations. * **Address validation:** FedEx performs strict address validation. Invalid or incomplete addresses will result in errors during shipment creation. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Flock Source: https://docs.runalloy.com/connectors/Flock Integration details and setup guide for the Flock connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------------------- | | **Authentication** | API Key (Authorization header) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (API Key based authentication) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Flock**: * **Messages** * **Channels** * **Users** * **Groups** * **Conversations** * **Files** * **Events** * **Notifications** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | **Offers free trial?** | Yes. Flock offers a free plan for small teams. Sign up at [https://www.flock.com](https://www.flock.com) to get started. | | **Requires requires paid sandbox** | No paid sandbox required. You can use the free plan for testing. | | **Requires partnership to obtain authentication?** | No. API credentials can be obtained directly from the Flock Admin Panel. | *** ### Authentication (API Key) Flock uses API Key authentication via the Authorization header. 1. Log in to your **Flock account** at [https://www.flock.com](https://www.flock.com). 2. Navigate to the **Flock Admin Panel** at [https://admin.flock.com](https://admin.flock.com). 3. Go to **App Store** → **Build Your Own** → **Create a new app**. 4. Configure your app settings and generate your **API Token**. 5. Enter your **API Token** into Alloy Automation (used in the Authorization header). #### API Documentation For detailed API documentation, visit: [https://docs.flock.com/display/flockos/Flock+API](https://docs.flock.com/display/flockos/Flock+API) #### Important Notes * Flock API tokens are specific to the app you create * Tokens provide access to channels, messages, and users based on app permissions * Different scopes can be configured when creating your Flock app * Keep your API token secure as it provides access to team communications *** ## Use Cases ### 1) Team notification automation Send automated notifications to Flock channels when important events occur in other systems, such as new customer signups, support tickets, or sales updates. ### 2) Message synchronization Sync messages between Flock and other communication platforms or archive Flock conversations to external storage for compliance and record-keeping. ### 3) Bot integration Build custom Flock bots that respond to commands, automate workflows, and provide information to team members directly within Flock channels. ### 4) User management Automatically provision Flock users when employees are added to your HRIS system and manage user permissions across your organization. ### 5) File sharing automation Automatically share files from external systems (like Google Drive or Dropbox) to relevant Flock channels, keeping teams informed of new resources. *** ## API Gotchas * **Token permissions:** Flock API tokens have specific permissions based on how the app is configured. Ensure your app has the necessary scopes for the operations you need. * **Rate limiting:** Flock enforces rate limits on API requests. Implement retry logic with exponential backoff when you receive rate limit errors. * **Channel access:** Bots and integrations can only access channels they've been invited to. Ensure your bot is added to the appropriate channels before attempting to send messages. * **Message formatting:** Flock supports rich text formatting with special syntax. Ensure messages are properly formatted to display correctly in the Flock UI. * **Webhook verification:** When setting up webhooks, Flock may require verification. Implement proper webhook signature validation for security. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Freshdesk Source: https://docs.runalloy.com/connectors/Freshdesk Integration details and setup guide for the Freshdesk connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ----------------------------------- | | **Authentication** | HTTP Basic Authentication (API Key) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes (varies by plan) | | **Authentication Scopes Supported** | N/A (API Key based authentication) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Freshdesk**: * **Tickets** * **Contacts** * **Companies** * **Agents** * **Groups** * **Conversations** * **Time Entries** * **Products** * **Satisfaction Ratings** * **Forums** * **Solutions (Knowledge Base Articles)** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Freshdesk offers a 21-day free trial with full access to features. Sign up at [https://freshdesk.com](https://freshdesk.com) to get started. There's also a free plan for up to 10 agents. | | **Requires requires paid sandbox** | No paid sandbox required. You can use the free trial or free plan for testing. | | **Requires partnership to obtain authentication?** | No. API credentials can be obtained directly from your Freshdesk account settings. | *** ### Authentication (HTTP Basic Authentication) Freshdesk uses HTTP Basic Authentication with your API Key. 1. Log in to your **Freshdesk account** at https\://{yourdomain}.freshdesk.com. 2. Click on your **profile picture** in the top-right corner and select **Profile Settings**. 3. On the right side, you'll see your **API Key**. Copy it or click to view/regenerate if needed. 4. Enter your **API Key** as the username and **X** as the password in Alloy Automation (Freshdesk requires any character as password). 5. Also configure your **Freshdesk domain** (e.g., yourcompany.freshdesk.com) in the connection settings. #### API Documentation For detailed API documentation, visit: [https://developers.freshdesk.com/api/](https://developers.freshdesk.com/api/) #### Important Notes * Freshdesk API keys are tied to individual agent accounts * The API key provides the same permissions as the agent it belongs to * Freshdesk requires your subdomain (e.g., yourcompany.freshdesk.com) in API requests * Rate limits vary based on your Freshdesk plan *** ## Use Cases ### 1) Ticket synchronization Sync support tickets between Freshdesk and your CRM or project management system, ensuring customer issues are tracked across all platforms. ### 2) Customer profile enrichment Automatically update Freshdesk contact records with customer data from your ecommerce platform, CRM, or data warehouse for better support context. ### 3) Automated ticket creation Create Freshdesk tickets automatically when specific events occur, such as failed payments, product issues, or customer feedback submissions. ### 4) Knowledge base integration Sync Freshdesk solution articles with your website or app to provide consistent support documentation across all customer touchpoints. ### 5) SLA and performance reporting Pull ticket data, response times, and satisfaction ratings from Freshdesk into your analytics platform for comprehensive support performance reporting. *** ## API Gotchas * **Domain requirement:** Freshdesk API requests require your specific subdomain (e.g., yourcompany.freshdesk.com). Ensure this is correctly configured in your integration. * **Rate limiting:** Rate limits vary by plan (typically 50-100 requests per minute). Monitor the `X-RateLimit-*` response headers and implement appropriate throttling. * **Pagination:** Large result sets require pagination. Use the `page` parameter and respect the maximum of 100 records per page. * **Password field:** When using basic auth with API keys, Freshdesk requires any non-empty string as the password. Typically "X" is used. * **Webhook validation:** Freshdesk webhooks include authentication. Verify the source of webhook requests to ensure they're coming from Freshdesk. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Gladly Source: https://docs.runalloy.com/connectors/Gladly Integration details and setup guide for the Gladly connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ----------------------------------------------------- | | **Authentication** | HTTP Basic Authentication (Agent Email and API Token) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (API Token based authentication) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Gladly**: * **Customers** * **Conversations** * **Messages** * **Agents** * **Topics** * **Contact Channels** (Email, Phone, Chat, SMS) * **Custom Attributes** * **Tasks** * **Notes** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Gladly typically requires a demo and custom pricing. Request a demo and trial access at [https://www.gladly.com/request-demo](https://www.gladly.com/request-demo). | | **Requires requires paid sandbox** | Contact Gladly for sandbox or trial environment access. | | **Requires partnership to obtain authentication?** | No. Once you have a Gladly account, API credentials can be obtained from your account settings. | *** ### Authentication (HTTP Basic Authentication) Gladly uses HTTP Basic Authentication with your Agent Email and API Token. 1. Log in to your **Gladly account** at https\://{subdomain}.gladly.com. 2. Navigate to **Settings** → **Developers** or **API Settings** (admin access required). 3. Generate or copy your **API Token**. 4. Enter your **Agent Email** as the username and **API Token** as the password in Alloy Automation. 5. Also configure your **Gladly subdomain** in the connection settings. #### API Documentation For detailed API documentation, visit: [https://developer.gladly.com/](https://developer.gladly.com/) #### Important Notes * Gladly requires your subdomain (e.g., yourcompany.gladly.com) in API requests * API tokens are tied to specific agent accounts * The API provides access to customer profiles, conversations, and communication channels * Gladly focuses on radically personal customer service with people-centric design *** ## Use Cases ### 1) Customer profile enrichment Automatically sync customer data from your CRM, ecommerce platform, or data warehouse into Gladly to provide agents with complete customer context during conversations. ### 2) Omnichannel conversation routing Route conversations from multiple channels (email, chat, SMS, phone) through Gladly and sync conversation data to ticketing or analytics systems. ### 3) Order and subscription integration Pull order details, subscription status, and purchase history from ecommerce platforms into Gladly customer profiles for seamless support experiences. ### 4) Agent performance tracking Export conversation metrics, response times, and customer satisfaction data from Gladly to business intelligence platforms for comprehensive support analytics. ### 5) Automated workflows Trigger automated workflows in other systems based on Gladly conversation events, such as escalating high-priority issues or notifying account managers of VIP customer interactions. *** ## API Gotchas * **Subdomain requirement:** Gladly API requests require your specific subdomain (e.g., yourcompany.gladly.com). Ensure this is correctly configured in your integration. * **People-centric model:** Gladly uses a people-centric approach rather than ticket-centric. Conversations are tied to customers, not individual tickets, which may require different integration logic. * **Rate limiting:** Gladly enforces rate limits on API requests. Implement retry logic with exponential backoff when rate limits are exceeded. * **Webhook reliability:** Ensure your webhook endpoints respond quickly with 2xx status codes. Slow or failing endpoints may result in webhook delivery issues. * **Custom attributes:** Gladly supports custom attributes for customers. Ensure your integration handles dynamic custom fields appropriately. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Gmail Source: https://docs.runalloy.com/connectors/Gmail Integration details and setup guide for the Gmail connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes (Google API quotas & 429 handling) | | **Authentication Scopes Supported** | `https://mail.google.com/` (full access), `https://www.googleapis.com/auth/gmail.readonly`, `https://www.googleapis.com/auth/gmail.send`, `https://www.googleapis.com/auth/gmail.compose`, `https://www.googleapis.com/auth/gmail.modify`, `https://www.googleapis.com/auth/gmail.labels`, `https://www.googleapis.com/auth/userinfo.email`, `https://www.googleapis.com/auth/userinfo.profile` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Gmail**: * **Drafts** * **Labels** * **Messages** * **Threads** * **Profile** * **Attachments** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Offers free trial?** | Yes. Create a free Google account at [https://accounts.google.com/signup](https://accounts.google.com/signup) and set up a Google Cloud project at [https://console.cloud.google.com](https://console.cloud.google.com). | | **Requires paid sandbox** | No paid sandbox required. | | **Requires partnership to obtain authentication?** | No. However, Google App Verification may be required in production for sensitive scopes, which can add review time. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Create your OAuth app (Google Cloud Console) 1. Go to **Google Cloud Console** ([https://console.cloud.google.com](https://console.cloud.google.com)) → **APIs & Services** → **Credentials**. 2. Create an **OAuth client ID** (application type: *Web application*). 3. Add the redirect URI: [https://api.runalloy.com/api/strategy/connector/gmail/callback](https://api.runalloy.com/api/strategy/connector/gmail/callback) 4. Enable the **Gmail API** for your project (APIs & Services → Library). 5. Configure the scopes you intend to request: * `https://mail.google.com/` (full access) * `https://www.googleapis.com/auth/gmail.readonly` (read-only access) * `https://www.googleapis.com/auth/gmail.send` (send emails) * `https://www.googleapis.com/auth/gmail.compose` (compose and send) * `https://www.googleapis.com/auth/gmail.modify` (read, compose, send) * `https://www.googleapis.com/auth/gmail.labels` (manage labels) * `https://www.googleapis.com/auth/userinfo.email` * `https://www.googleapis.com/auth/userinfo.profile` 6. Copy your **Client ID** and **Client Secret** into Alloy Automation. #### Consent screen & verification * Set up the **OAuth consent screen** with your app details and domain. * For production use or external users, complete **Google app verification** (may require demo video, privacy policy, and domain ownership). * If using the full `https://mail.google.com/` scope, expect stricter review requirements. *** ## Use Cases ### 1) Automated email management and routing Monitor incoming emails matching specific criteria (labels, senders, keywords) and automatically route them to appropriate systems, create tasks, or trigger workflows based on email content. ### 2) Email-to-ticket automation Automatically parse incoming Gmail messages and create support tickets, CRM leads, or project tasks in your application, including attachment handling and thread tracking. ### 3) Scheduled email campaigns and drip sequences Build automated email sequences that send personalized messages based on user actions, signup dates, or custom triggers while maintaining thread continuity and tracking responses. ### 4) Gmail inbox integration for SaaS apps Embed Gmail functionality directly into your application, allowing users to send, receive, and manage emails without leaving your platform, with full label and search capabilities. ### 5) Email data extraction and analysis Extract email content, metadata, and attachment data for analytics, compliance archiving, or machine learning pipelines, with support for filtering by date ranges, labels, and search queries. *** ## API Gotchas * ⚠️ **Partial responses & fields selection:** Gmail's API often benefits from specifying the `format` parameter and `metadataHeaders` to limit payload size. Fetching full message bodies repeatedly can hit quota limits quickly. Use `format=metadata` or `format=minimal` when you don't need full content. * ⚠️ **Base64URL encoding for message bodies:** When sending or creating messages with the `raw` field, Gmail expects the entire MIME message to be base64url encoded (not standard base64). Missing this encoding causes 400 errors. * ⚠️ **Label IDs vs Label names:** Gmail uses label IDs (e.g., `Label_123`) internally, but also has system labels with special IDs like `INBOX`, `SENT`, `DRAFT`, `SPAM`, and `TRASH`. Always use the `listLabels` endpoint to map user-facing names to IDs. * ⚠️ **Query syntax differences:** Gmail search queries (the `q` parameter) use Gmail's search operators (like `from:`, `to:`, `subject:`, `is:unread`, `has:attachment`), not standard SQL or REST filtering. Test queries in the Gmail web interface first. * ⚠️ **History API limitations:** Gmail's history API requires storing the `historyId` from previous requests to detect changes. If you lose this ID or it expires, you must perform a full sync again. * ⚠️ **App verification (production):** Using broad scopes like `https://mail.google.com/` triggers a stricter Google review process that can take weeks. If you only need limited access, prefer narrower scopes (e.g., `gmail.send` or `gmail.readonly`) to ease verification. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Google Ads Source: https://docs.runalloy.com/connectors/GoogleAds Integration details and setup guide for the Google Ads connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) + Developer Token | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes (Google Ads API quotas & 429 handling) | | **Authentication Scopes Supported** | `https://www.googleapis.com/auth/adwords`, `https://www.googleapis.com/auth/cloud-platform`, `https://www.googleapis.com/auth/cloud-platform.read-only`, `https://www.googleapis.com/auth/userinfo.email`, `https://www.googleapis.com/auth/userinfo.profile` | *** ## Objects Supported Alloy Automation supports the following via **Google Ads API v16**: * **Campaigns** * **Ad Groups** * **Ads** * **Keywords** * **Audiences** * **Conversions** * **Reports** (via Google Ads Query Language) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Create a Google Ads account at [https://ads.google.com/start](https://ads.google.com/start) and set up a test account (MCC test account) for development. | | **Requires paid sandbox** | No. Google provides test accounts for development purposes. | | **Requires partnership to obtain authentication?** | No. However, you must apply for a Developer Token from Google Ads, which can take several business days for approval. | *** ### Authentication (OAuth 2.0 + Developer Token) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Prerequisites 1. **Developer Token:** Before using the Google Ads API, you must apply for and receive a Developer Token: * Go to **Google Ads** ([https://ads.google.com](https://ads.google.com)) → **Tools & Settings** → **API Center** * Apply for a Developer Token (approval typically takes 24-48 hours) * For production use, your token must be approved by Google (requires demonstrating compliance with Google Ads API Terms) #### Create your OAuth app (Google Cloud Console) 1. Go to **Google Cloud Console** ([https://console.cloud.google.com](https://console.cloud.google.com)) → **APIs & Services** → **Credentials**. 2. Create an **OAuth client ID** (application type: *Web application*). 3. Add the redirect URI: [https://api.runalloy.com/api/strategy/connector/googleAds/callback](https://api.runalloy.com/api/strategy/connector/googleAds/callback) 4. Enable the **Google Ads API** for your project (APIs & Services → Library). 5. Configure the scopes you intend to request: * `https://www.googleapis.com/auth/adwords` (full access to Google Ads) * `https://www.googleapis.com/auth/userinfo.email` * `https://www.googleapis.com/auth/userinfo.profile` 6. Copy your **Client ID** and **Client Secret** into Alloy Automation. 7. Additionally, provide your **Developer Token** in Alloy Automation's configuration. #### Consent screen & verification * Set up the **OAuth consent screen** with your app details and domain. * For production use, complete **Google app verification** if using external users. * Your Developer Token must be approved for production access (test tokens have limited functionality). *** ## Use Cases ### 1) Campaign performance monitoring and alerting Automatically fetch campaign, ad group, and keyword performance metrics to monitor spend, conversions, and ROI. Trigger alerts or workflows when campaigns exceed budget thresholds or underperform. ### 2) Automated bid management Build custom bid adjustment workflows that respond to performance data, competitor activity, or inventory levels by programmatically updating bids for keywords, ad groups, or campaigns. ### 3) Cross-platform advertising analytics Consolidate Google Ads performance data with other advertising platforms (Facebook Ads, LinkedIn Ads) into unified dashboards or data warehouses for comprehensive marketing attribution analysis. ### 4) Dynamic ad copy and creative updates Automatically generate and update ad copy, headlines, and descriptions based on inventory changes, seasonal promotions, or A/B test results, keeping campaigns fresh and relevant. ### 5) Lead and conversion synchronization Sync Google Ads conversion data with your CRM or analytics platform to close the loop on attribution, enabling better optimization decisions based on downstream customer value. *** ## API Gotchas * ⚠️ **Developer Token required:** Unlike most Google APIs, Google Ads requires a separate Developer Token in addition to OAuth credentials. This token must be included in the `developer-token` header for every request. Test tokens have limited daily quotas and can only access test accounts. * ⚠️ **Google Ads Query Language (GAQL):** The Google Ads API uses GAQL for fetching data, which is similar to SQL but has its own syntax and limitations. You must specify exactly which fields you want to retrieve, and not all field combinations are allowed together. * ⚠️ **Customer ID format:** Customer IDs in Google Ads must be formatted without hyphens (e.g., `1234567890` not `123-456-7890`). Many API endpoints require the customer ID in the path, so ensure proper formatting. * ⚠️ **Manager (MCC) account access:** If using a Manager account, you must specify the customer ID of the sub-account you want to access. Queries don't automatically aggregate across all sub-accounts unless you explicitly request manager-level reporting. * ⚠️ **Rate limiting per customer:** Google Ads enforces rate limits per customer account, not per developer. High-volume operations across multiple customer accounts require careful quota management and exponential backoff strategies. * ⚠️ **API version lifecycle:** Google Ads API versions are supported for one year after release. Plan for regular migrations as older versions are deprecated. The API is currently on v16 as of late 2024. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Google Calendar Source: https://docs.runalloy.com/connectors/GoogleCalendar Integration details and setup guide for the Google Calendar connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) | | **Two-Way Sync** | Yes | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes (Google API quotas & 429 handling) | | **Authentication Scopes Supported** | `https://www.googleapis.com/auth/calendar` (read-write access), `https://www.googleapis.com/auth/calendar.readonly`, `https://www.googleapis.com/auth/userinfo.email`, `https://www.googleapis.com/auth/userinfo.profile` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Google Calendar**: * **Calendar List** (user's calendars) * **Calendars** (metadata) * **Events** * **Attendees** * **Reminders** * **Conference Data** (Meet, Zoom, etc.) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Offers free trial?** | Yes. Create a free Google account at [https://accounts.google.com/signup](https://accounts.google.com/signup) and set up a Google Cloud project at [https://console.cloud.google.com](https://console.cloud.google.com). | | **Requires paid sandbox** | No paid sandbox required. | | **Requires partnership to obtain authentication?** | No. However, Google App Verification may be required in production for sensitive scopes, which can add review time. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Create your OAuth app (Google Cloud Console) 1. Go to **Google Cloud Console** ([https://console.cloud.google.com](https://console.cloud.google.com)) → **APIs & Services** → **Credentials**. 2. Create an **OAuth client ID** (application type: *Web application*). 3. Add the redirect URI: [https://api.runalloy.com/api/strategy/connector/googleCalendar/callback](https://api.runalloy.com/api/strategy/connector/googleCalendar/callback) 4. Enable the **Google Calendar API** for your project (APIs & Services → Library). 5. Configure the scopes you intend to request: * `https://www.googleapis.com/auth/calendar` (full read-write access) * `https://www.googleapis.com/auth/calendar.readonly` (read-only access) * `https://www.googleapis.com/auth/userinfo.email` * `https://www.googleapis.com/auth/userinfo.profile` 6. Copy your **Client ID** and **Client Secret** into Alloy Automation. #### Consent screen & verification * Set up the **OAuth consent screen** with your app details and domain. * For production use or external users, complete **Google app verification** (may require demo video, privacy policy, and domain ownership). *** ## Use Cases ### 1) Automated meeting scheduling and calendar sync Synchronize calendar availability across multiple platforms, automatically create meetings based on booking forms or CRM activities, and ensure conflicts are prevented across integrated systems. ### 2) Event-driven workflow automation Trigger workflows when calendar events are created, updated, or deleted—such as sending reminders, preparing meeting materials, updating project management tools, or notifying team members. ### 3) Resource and conference room booking Manage shared resources like conference rooms, equipment, or vehicles by syncing availability with Google Calendar, automatically blocking time slots and handling booking conflicts. ### 4) Customer appointment management Build appointment booking systems that sync with Google Calendar, send automated confirmations and reminders, handle rescheduling, and manage multi-timezone scheduling for global customers. ### 5) Time tracking and productivity analytics Extract calendar event data for time tracking, productivity analysis, and utilization reporting by analyzing meeting patterns, focus time, and cross-functional collaboration metrics. *** ## API Gotchas * ⚠️ **Calendar ID format:** The primary calendar uses the special ID `primary`, but secondary calendars use email-like IDs (e.g., `calendar-id@group.calendar.google.com`). Always use the `calendarList` endpoint to discover available calendars and their IDs. * ⚠️ **Timezone handling:** Events can have different timezones for start and end times. Always specify the `timeZone` field when creating events, and be careful when converting to/from UTC. All-day events use the `date` field instead of `dateTime`. * ⚠️ **Recurring events complexity:** Recurring events have a parent event (with `recurrence` rules in RRULE format) and individual instances. Modifying a single occurrence creates an exception. Use the `recurringEventId` field to identify instances. * ⚠️ **Attendee response status:** When creating events with attendees, the creator is automatically added as an organizer. Attendee response statuses (`needsAction`, `accepted`, `declined`, `tentative`) are managed by Google and may not update immediately. * ⚠️ **Conference data creation:** To add Google Meet or other conference solutions, you must send a `conferenceDataVersion` parameter and specify the `conferenceSolution` type. Not all calendar types support conference data. * ⚠️ **Incremental sync with syncToken:** For efficient syncing, use the sync token pattern: after the first full sync, store the `syncToken` and use it in subsequent requests to only fetch changes. Tokens expire after a period of time. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Google Docs Source: https://docs.runalloy.com/connectors/GoogleDocs Integration details and setup guide for the Google Docs connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) | | **Two-Way Sync** | Yes | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes (Google API quotas & 429 handling) | | **Authentication Scopes Supported** | `https://www.googleapis.com/auth/documents` (read-write access), `https://www.googleapis.com/auth/documents.readonly`, `https://www.googleapis.com/auth/drive`, `https://www.googleapis.com/auth/drive.readonly`, `https://www.googleapis.com/auth/drive.file`, `https://www.googleapis.com/auth/userinfo.email`, `https://www.googleapis.com/auth/userinfo.profile` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Google Docs**: * **Documents** * **Text Content** * **Text Styles** (formatting) * **Paragraphs** * **Tables** * **Images** * **Lists** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Offers free trial?** | Yes. Create a free Google account at [https://accounts.google.com/signup](https://accounts.google.com/signup) and set up a Google Cloud project at [https://console.cloud.google.com](https://console.cloud.google.com). | | **Requires paid sandbox** | No paid sandbox required. | | **Requires partnership to obtain authentication?** | No. However, Google App Verification may be required in production for sensitive scopes, which can add review time. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Create your OAuth app (Google Cloud Console) 1. Go to **Google Cloud Console** ([https://console.cloud.google.com](https://console.cloud.google.com)) → **APIs & Services** → **Credentials**. 2. Create an **OAuth client ID** (application type: *Web application*). 3. Add the redirect URI: [https://api.runalloy.com/api/strategy/connector/googleDocs/callback](https://api.runalloy.com/api/strategy/connector/googleDocs/callback) 4. Enable the **Google Docs API** for your project (APIs & Services → Library). 5. Configure the scopes you intend to request: * `https://www.googleapis.com/auth/documents` (full read-write access) * `https://www.googleapis.com/auth/documents.readonly` (read-only access) * `https://www.googleapis.com/auth/drive` or `https://www.googleapis.com/auth/drive.file` (required for listing documents) * `https://www.googleapis.com/auth/userinfo.email` * `https://www.googleapis.com/auth/userinfo.profile` 6. Copy your **Client ID** and **Client Secret** into Alloy Automation. #### Consent screen & verification * Set up the **OAuth consent screen** with your app details and domain. * For production use or external users, complete **Google app verification** (may require demo video, privacy policy, and domain ownership). *** ## Use Cases ### 1) Automated document generation from templates Generate personalized documents (contracts, reports, proposals) by duplicating templates and programmatically inserting dynamic content like customer names, dates, and transaction details. ### 2) Document content extraction and indexing Extract text content from Google Docs for search indexing, compliance archiving, content migration, or feeding into analytics and machine learning pipelines. ### 3) Collaborative document workflows Build approval workflows where documents are created, reviewed, and updated programmatically based on business logic, with automatic text insertions for comments, updates, or status changes. ### 4) Document formatting automation Apply consistent formatting, styles, and branding to documents at scale by programmatically updating text styles, paragraph formatting, and document structure across multiple documents. ### 5) Cross-platform document synchronization Sync document content between Google Docs and other systems (CMS, databases, project management tools) to maintain a single source of truth for documentation. *** ## API Gotchas * ⚠️ **Index-based operations:** Google Docs API uses character-based indexes (UTF-16 code units) for all text operations. Inserting or deleting text shifts all subsequent indexes, so plan your batch operations carefully. Process operations from end-to-beginning to avoid index shifts. * ⚠️ **Batch update request order:** When using `batchUpdate`, requests are processed sequentially in the order they appear in the array. Each request affects the document state for subsequent requests, so order matters significantly. * ⚠️ **Read before write pattern:** Always read the document's current revision ID before making updates. Include the revision ID in your update request to detect conflicts if the document was modified by another client. * ⚠️ **Listing documents requires Drive API:** The Docs API doesn't have a "list documents" endpoint. You must use the Google Drive API with the MIME type `application/vnd.google-apps.document` to discover documents. * ⚠️ **Complex formatting limitations:** While you can apply basic text formatting (bold, italic, fonts, colors), more complex formatting like comments, suggestions, and track changes have limited API support. Some visual elements must be managed through the UI. * ⚠️ **Segment IDs for headers/footers:** Documents are divided into segments (body, headers, footers). When inserting content into headers or footers, you must specify the correct `segmentId`. An empty or missing segment ID defaults to the document body. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Google Drive Source: https://docs.runalloy.com/connectors/GoogleDrive Integration details and setup guide for the Google Drive connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes (Google API quotas & 429 handling) | | **Authentication Scopes Supported** | `https://www.googleapis.com/auth/drive` (read-write), `https://www.googleapis.com/auth/userinfo.email`, `https://www.googleapis.com/auth/userinfo.profile` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Google Drive**: * **File** * **Folder** * **Drive** * **Drive List** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Offers free trial?** | Yes. Create a free Google account at [https://accounts.google.com/signup](https://accounts.google.com/signup) and set up a Google Cloud project at [https://console.cloud.google.com](https://console.cloud.google.com). | | **Requires requires paid sandbox** | No paid sandbox required. | | **Requires partnership to obtain authentication?** | No. However, Google App Verification may be required in production for sensitive scopes, which can add review time. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Create your OAuth app (Google Cloud Console) 1. Go to **Google Cloud Console** ([https://console.cloud.google.com](https://console.cloud.google.com)) → **APIs & Services** → **Credentials**. 2. Create an **OAuth client ID** (application type: *Web application*). 3. Add the redirect URI: [https://api.runalloy.com/api/strategy/connector/googleDrive/callback](https://api.runalloy.com/api/strategy/connector/googleDrive/callback) 4. Enable the **Google Drive API** for your project (APIs & Services → Library). 5. Configure the scopes you intend to request: * `https://www.googleapis.com/auth/drive` * `https://www.googleapis.com/auth/userinfo.email` * `https://www.googleapis.com/auth/userinfo.profile` 6. Copy your **Client ID** and **Client Secret** into Alloy Automation. #### Consent screen & verification * Set up the **OAuth consent screen** with your app details and domain. * For production use or external users, complete **Google app verification** (may require demo video, privacy policy, and domain ownership). *** ## Use Cases ### 1) Embedded file picker & uploader Allow your users to browse their Google Drive, select files/folders, and upload new versions—directly inside your app's UI—while Alloy Automation handles OAuth, permissions, and token refresh. ### 2) Automated document ingestion Ingest new files from specific folders or shared drives on a schedule or via webhook notifications, normalize metadata, and route content into your product (e.g., knowledge bases, underwriting pipelines). ### 3) Cross-tenant provisioning for shared drives Programmatically create and manage Shared Drives per customer account, apply folder structures, and set initial permissions as part of onboarding flows. ### 4) Compliance & lifecycle workflows Detect updated or deleted files and trigger downstream policies—e.g., archive, quarantine, classify by MIME type, or sync file metadata to your system of record. *** ## API Gotchas * ⚠️ **Partial responses & fields selection:** Google Drive’s API often benefits from specifying `fields` to limit payload size. If you fetch large lists without `fields`, responses can be slower and quota-heavier. * ⚠️ **App verification (production):** Using broad scopes like `drive` may trigger a stricter Google review. If you only need limited access, prefer narrower scopes (e.g., `drive.file`) to ease verification. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Google Sheets Source: https://docs.runalloy.com/connectors/GoogleSheets Integration details and setup guide for the Google Sheets connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) | | **Two-Way Sync** | Yes | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes (Google API quotas & 429 handling) | | **Authentication Scopes Supported** | `https://www.googleapis.com/auth/spreadsheets` (read-write), `https://www.googleapis.com/auth/spreadsheets.readonly`, `https://www.googleapis.com/auth/drive`, `https://www.googleapis.com/auth/drive.readonly`, `https://www.googleapis.com/auth/drive.file`, `https://www.googleapis.com/auth/userinfo.email`, `https://www.googleapis.com/auth/userinfo.profile` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Google Sheets**: * **Spreadsheets** * **Sheets** (individual tabs) * **Cell Values** * **Ranges** * **Developer Metadata** * **Named Ranges** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Offers free trial?** | Yes. Create a free Google account at [https://accounts.google.com/signup](https://accounts.google.com/signup) and set up a Google Cloud project at [https://console.cloud.google.com](https://console.cloud.google.com). | | **Requires paid sandbox** | No paid sandbox required. | | **Requires partnership to obtain authentication?** | No. However, Google App Verification may be required in production for sensitive scopes, which can add review time. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Create your OAuth app (Google Cloud Console) 1. Go to **Google Cloud Console** ([https://console.cloud.google.com](https://console.cloud.google.com)) → **APIs & Services** → **Credentials**. 2. Create an **OAuth client ID** (application type: *Web application*). 3. Add the redirect URI: [https://api.runalloy.com/api/strategy/connector/googleSheets/callback](https://api.runalloy.com/api/strategy/connector/googleSheets/callback) 4. Enable the **Google Sheets API** for your project (APIs & Services → Library). 5. Configure the scopes you intend to request: * `https://www.googleapis.com/auth/spreadsheets` (full read-write access) * `https://www.googleapis.com/auth/spreadsheets.readonly` (read-only access) * `https://www.googleapis.com/auth/drive` or `https://www.googleapis.com/auth/drive.file` (required for listing spreadsheets) * `https://www.googleapis.com/auth/userinfo.email` * `https://www.googleapis.com/auth/userinfo.profile` 6. Copy your **Client ID** and **Client Secret** into Alloy Automation. #### Consent screen & verification * Set up the **OAuth consent screen** with your app details and domain. * For production use or external users, complete **Google app verification** (may require demo video, privacy policy, and domain ownership). *** ## Use Cases ### 1) Database-like operations for lightweight data storage Use Google Sheets as a lightweight database for configuration data, feature flags, simple CRM data, or user-generated content that non-technical users can edit directly. ### 2) Automated reporting and data aggregation Pull data from multiple systems, aggregate it, and write results to Google Sheets for business intelligence dashboards, weekly reports, or sharing with stakeholders who prefer spreadsheets. ### 3) Data import/export workflows Build ETL pipelines that extract data from Google Sheets for processing, or export processed data back to Sheets for user review, approval workflows, or further manual analysis. ### 4) Form responses and survey data processing Automatically process form responses collected in Google Sheets, validate data, trigger notifications, update other systems, or perform calculations and data enrichment. ### 5) Inventory and pricing synchronization Sync product catalogs, inventory levels, and pricing data between e-commerce platforms and Google Sheets, enabling business teams to manage data in familiar spreadsheet interfaces. *** ## API Gotchas * ⚠️ **A1 notation is required:** All range operations use A1 notation (e.g., `Sheet1!A1:B10`). The sheet name is required if you have multiple sheets. Special characters in sheet names must be wrapped in single quotes (e.g., `'My Sheet'!A1:B10`). * ⚠️ **valueInputOption matters:** When writing data, you must specify `valueInputOption`. Use `USER_ENTERED` if you want Google Sheets to parse the data (recognize numbers, dates, formulas), or `RAW` to store everything as plain strings. This is a common source of bugs. * ⚠️ **Append vs Update behavior:** The `append` endpoint finds the first empty row after your specified range and inserts data there. The `update` endpoint overwrites existing data at the exact range specified. Choose the right endpoint for your use case. * ⚠️ **Listing spreadsheets requires Drive API:** The Sheets API doesn't have a "list spreadsheets" endpoint. You must use the Google Drive API with the MIME type `application/vnd.google-apps.spreadsheet` to discover spreadsheets. * ⚠️ **Sheet IDs vs Sheet names:** The Sheets API uses numeric `sheetId` values internally for many operations, but A1 notation uses sheet names. Always use the correct identifier for each endpoint. The `sheets` array in responses contains both. * ⚠️ **Batch operations have size limits:** `batchUpdate` requests can include multiple operations, but there's a limit on payload size (\~10MB) and complexity. Large operations may need to be split into multiple requests. * ⚠️ **Values array structure:** When reading/writing values, the response is a 2D array where outer arrays represent rows and inner arrays represent cells. Empty cells may be omitted entirely from the response, so always check array bounds. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Google Workspace Admin Source: https://docs.runalloy.com/connectors/GoogleWorkspaceAdmin Integration details and setup guide for the Google Workspace Admin connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | No (Polling) | | **Supports Rate Limiting** | Yes (Google API quotas & 429 handling) | | **Authentication Scopes Supported** | `https://www.googleapis.com/auth/admin.directory.user`, `https://apps-apis.google.com/a/feeds/policies/`, `https://www.googleapis.com/auth/admin.directory.orgunit`, `https://www.googleapis.com/auth/admin.directory.orgunit.readonly`, `https://www.googleapis.com/auth/admin.directory.user.readonly`, `https://www.googleapis.com/auth/admin.directory.user.security` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Google Workspace Admin**: * **Organizational Units** * **Users** * **User Tokens** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Sign up for Google Workspace at [https://workspace.google.com/](https://workspace.google.com/) or use a standard Google Workspace account with admin privileges. | | **Requires paid sandbox?** | No paid sandbox required. | | **Requires partnership to obtain authentication?** | No. However, Google App Verification may be required in production for certain admin scopes, which can add review time. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Create your OAuth app (Google Cloud Console) 1. Go to **Google Cloud Console** ([https://console.cloud.google.com](https://console.cloud.google.com)) → **APIs & Services** → **Credentials**. 2. Create an **OAuth client ID** (application type: *Web application*). 3. Add the redirect URI: `https://api.runalloy.com/api/strategy/connector/googleWorkspaceAdmin/callback` 4. Enable the **Admin SDK API** for your project (APIs & Services → Library → Search for "Admin SDK API"). 5. Configure the scopes you intend to request: * `https://www.googleapis.com/auth/admin.directory.user` (Manage users) * `https://www.googleapis.com/auth/admin.directory.orgunit` (Manage organizational units) * `https://www.googleapis.com/auth/admin.directory.user.readonly` (View users) * `https://www.googleapis.com/auth/admin.directory.orgunit.readonly` (View organizational units) * `https://www.googleapis.com/auth/admin.directory.user.security` (Manage user security settings) 6. Copy your **Client ID** and **Client Secret** into Alloy Automation. #### Consent screen & verification * Set up the **OAuth consent screen** with your app details and domain. * For production use with admin scopes or external users, complete **Google app verification** (may require demo video, privacy policy, and domain ownership). * Admin scopes require that the authorizing user has Google Workspace admin privileges. #### Getting Started * **Sign up for Google Workspace**: [https://workspace.google.com/](https://workspace.google.com/) * **Google Cloud Console**: [https://console.cloud.google.com](https://console.cloud.google.com) * **Admin SDK API Documentation**: [https://developers.google.com/admin-sdk](https://developers.google.com/admin-sdk) * **OAuth 2.0 Setup Guide**: [https://developers.google.com/identity/protocols/oauth2](https://developers.google.com/identity/protocols/oauth2) *** ## Use Cases ### 1) Automated user provisioning and deprovisioning Automatically create, update, or suspend Google Workspace users based on employee onboarding/offboarding events from your HR system, ensuring consistent access control and license management. ### 2) Organizational unit synchronization Sync organizational structure from your internal systems to Google Workspace, automatically placing users in the correct OUs based on department, location, or team assignments. ### 3) Security token auditing Retrieve and monitor third-party application tokens granted by users in your domain to identify security risks, detect unauthorized app access, and enforce compliance policies. ### 4) User directory reporting Generate comprehensive reports on user accounts, including last login times, 2FA enrollment status, admin privileges, and suspended accounts for compliance and security audits. ### 5) Cross-platform identity management Synchronize user profiles and organizational hierarchy between Google Workspace and other enterprise systems (CRM, ERP, HRIS) to maintain a single source of truth for identity data. *** ## API Gotchas * The **customerId** parameter can use the alias `my_customer` to represent your own account, which simplifies API calls when you don't know your exact customer ID. * **Admin privileges required**: OAuth tokens must be granted by a user with super admin or delegated admin privileges. Regular users cannot authorize apps that request admin scopes. * **Pagination tokens**: When listing large numbers of users or organizational units, use the `pageToken` parameter to retrieve subsequent pages. Don't assume all results fit in a single response. * **Rate limiting and quotas**: Google Admin SDK has per-project quotas (typically 1,500-2,400 requests per minute). Monitor your quota usage in the Google Cloud Console and implement exponential backoff for 429 responses. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Grin Source: https://docs.runalloy.com/connectors/Grin Integration details and setup guide for the Grin connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------- | | **Authentication** | Bearer Token (API Key) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | No (Polling) | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (API key-based authentication provides full access) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Grin**: Grin's OpenAPI specification defines various endpoints for managing influencer relationships, campaigns, and performance metrics. Objects typically include: * **Influencers** * **Campaigns** * **Products** * **Orders** * **Content** * **Analytics** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Contact Grin for a demo at [https://grin.co/request-demo/](https://grin.co/request-demo/). Free trial availability varies based on business requirements. | | **Requires paid sandbox?** | No dedicated sandbox environment. Testing is typically done in your production account with test data. | | **Requires partnership to obtain authentication?** | No. API access is available to Grin customers. | *** ### Authentication (API Key) Grin uses API key authentication with Bearer token format. #### Obtain your API key 1. Log in to your Grin account at [https://app.grin.co](https://app.grin.co) 2. Navigate to **Settings** → **Integrations** or **API Settings** 3. Look for the **API Access** or **API Token** section 4. Click **Generate API Key** or **Create New Token** 5. Provide a descriptive name for your API key (e.g., "Alloy Automation Integration") 6. Copy the generated **API Key** 7. **Important**: Store the API key securely—it provides full access to your Grin account 8. The API key should be used as a Bearer token in the Authorization header: `Authorization: Bearer YOUR_API_KEY` #### Additional configuration * API keys have full access to your Grin account data * You can generate multiple API keys for different integrations * Revoke any API keys that are no longer needed or have been compromised * Test your API key with a simple GET request to verify authentication #### Getting Started * **Grin Website**: [https://grin.co/](https://grin.co/) * **Request Demo**: [https://grin.co/request-demo/](https://grin.co/request-demo/) * **API Documentation**: [https://help.grin.co/docs/integrating-with-the-grin-api](https://help.grin.co/docs/integrating-with-the-grin-api) * **Help Center**: [https://help.grin.co/](https://help.grin.co/) *** ## Use Cases ### 1) Influencer relationship management Sync influencer profiles, contact information, and engagement metrics from Grin to your CRM or data warehouse, enabling comprehensive tracking of influencer relationships and performance across your marketing stack. ### 2) Campaign performance tracking Automatically pull campaign results, ROI metrics, and content performance data into your analytics platform to measure influencer marketing effectiveness alongside other marketing channels. ### 3) Product seeding automation Integrate Grin with your inventory management system to automate product shipments to influencers, track seeding campaigns, and monitor which products generate the most authentic content. ### 4) Content rights management Extract influencer-generated content metadata and usage rights from Grin to populate your digital asset management system, ensuring proper tracking of content licensing and usage permissions. ### 5) Commission and payment workflow Sync order data, commission calculations, and payment status between Grin and your financial systems to streamline influencer payment processing and maintain accurate financial records. *** ## API Gotchas * **Rate limiting**: Grin implements rate limits on API requests to ensure system stability. Monitor your request volume and implement appropriate throttling to avoid 429 responses. Contact Grin support if you need higher rate limits. * **Authentication errors**: If you receive authentication errors, verify that your API key is correctly formatted with the Bearer prefix and hasn't been revoked. API keys don't expire automatically but can be manually revoked in settings. * **Data sync delays**: When syncing large amounts of historical data, be aware that Grin's API may return paginated results. Implement proper pagination handling to ensure you retrieve all records. * **Limited documentation**: Grin's public API documentation may be less comprehensive than other platforms. For specific endpoint details or advanced use cases, contact Grin's support team or your account manager for assistance. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Heap Source: https://docs.runalloy.com/connectors/Heap Integration details and setup guide for the Heap connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------------------------------- | | **Authentication** | OAuth 2.0 (Client Credentials) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | No (Polling) | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (Client Credentials grant full API access) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Heap**: * **Events** * **Users** * **Accounts** * **Segments** * **Funnels** * **Analytics Data** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Heap offers a free tier with limited features and data retention. Sign up at [https://heap.io/](https://heap.io/). | | **Requires paid sandbox?** | No. You can use the free tier or your production account for testing. | | **Requires partnership to obtain authentication?** | No. API access is available to all Heap customers. | *** ### Authentication (OAuth 2.0 Client Credentials) Heap uses OAuth 2.0 Client Credentials flow, which is suitable for server-to-server authentication. #### Obtain your API credentials 1. Log in to your Heap account at [https://heapanalytics.com](https://heapanalytics.com) 2. Navigate to **Account Settings** → **Projects** 3. Select the project you want to integrate with 4. Go to **APIs & Integrations** or **Account** → **Manage** → **API** 5. Look for the **API Access** section 6. Generate new API credentials if needed: * Click **Generate API Key** or **Create New Token** * You'll receive a **Client ID** and **Client Secret** 7. Copy both the **Client ID** and **Client Secret** 8. **Important**: Store these credentials securely—they provide full access to your Heap analytics data #### Token Exchange Heap uses the OAuth 2.0 Client Credentials flow: * Token URL: `https://heapanalytics.com/api/public/v0/auth_token` * Content-Type: `application/json` * Authentication Method: `client_secret_basic` (credentials sent in Authorization header) * The API will return an access token that should be used for subsequent requests #### Getting Started * **Sign up for Heap**: [https://heap.io/](https://heap.io/) * **Heap Dashboard**: [https://heapanalytics.com](https://heapanalytics.com) * **API Documentation**: [https://developers.heap.io/reference](https://developers.heap.io/reference) * **Getting Started Guide**: [https://help.heap.io/](https://help.heap.io/) *** ## Use Cases ### 1) Product analytics data pipeline Export user behavior events, session data, and conversion funnels from Heap into your data warehouse for custom analysis, cross-platform reporting, and integration with other business intelligence tools. ### 2) Customer segmentation sync Pull Heap user segments and behavioral cohorts into your marketing automation platform or CRM to trigger personalized campaigns based on product usage patterns and engagement metrics. ### 3) Event tracking validation Automatically compare events tracked in Heap against your event tracking specification to identify missing events, incorrect properties, or implementation gaps across your digital properties. ### 4) User journey analysis Extract sequential event data to build comprehensive user journey maps that combine Heap's automatic event tracking with data from other customer touchpoints in your ecosystem. ### 5) A/B test results integration Sync A/B test results, statistical significance data, and winning variants from Heap to your experiment tracking system or product roadmap tools for centralized experiment management. *** ## API Gotchas * **Client Credentials flow**: Heap uses OAuth 2.0 Client Credentials instead of the more common Authorization Code flow. This means tokens are obtained server-to-server without user interaction, making it ideal for backend integrations. * **Access token expiration**: Access tokens have a limited lifetime and must be refreshed periodically. Implement automatic token refresh logic to prevent authentication failures during long-running operations. * **Rate limiting**: Heap enforces rate limits on API requests to ensure system performance. Monitor rate limit headers in responses and implement exponential backoff when you approach or hit limits. * **Data export delays**: Analytics data in Heap may have processing delays, especially for recent events. When pulling data for real-time use cases, account for potential latency between event occurrence and API availability. * **Query complexity limits**: Complex queries with multiple filters or large date ranges may timeout or return partial results. Break large data requests into smaller chunks and implement pagination for reliable data extraction. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # HubSpot Source: https://docs.runalloy.com/connectors/HubSpot Integration details and setup guide for the HubSpot connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | No (Polling) | | **Supports Rate Limiting** | Yes (HubSpot API rate limits & 429 handling) | | **Authentication Scopes Supported** | `oauth`, `crm.objects.companies.read`, `crm.objects.contacts.read`, `crm.objects.deals.read`, `crm.objects.companies.write`, `crm.objects.contacts.write`, `crm.objects.deals.write`, `crm.lists.read`, `crm.lists.write`, `crm.objects.line_items.read`, `crm.objects.line_items.write`, `crm.objects.marketing_events.read`, `crm.objects.marketing_events.write`, `crm.objects.owners.read`, `crm.objects.quotes.read`, `crm.objects.quotes.write`, `crm.schemas.companies.read`, `crm.schemas.companies.write`, `crm.schemas.contacts.read`, `crm.schemas.contacts.write`, `crm.schemas.deals.read`, `crm.schemas.deals.write`, `settings.users.write`, `settings.users.read`, `settings.users.teams.write`, `settings.users.teams.read` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **HubSpot**: * **Companies** * **Contacts** * **Deals** * **Emails** * **Tickets** * **Tasks** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. HubSpot offers a free CRM tier with core features available indefinitely. Sign up at [https://www.hubspot.com/products/get-started](https://www.hubspot.com/products/get-started). | | **Requires paid sandbox?** | No. The free tier can be used for development and testing. | | **Requires partnership to obtain authentication?** | No. OAuth apps can be created by any HubSpot user. However, public apps require app review for marketplace listing. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Create your OAuth app (HubSpot Developer Portal) 1. Go to **HubSpot Developer Portal** at [https://developers.hubspot.com/](https://developers.hubspot.com/) 2. Sign in with your HubSpot account (or create a free developer account) 3. Navigate to **Apps** from the top menu 4. Click **Create app** button 5. Fill in your app details: * App name * Description * Logo (optional) 6. Go to the **Auth** tab 7. Add the redirect URI: `https://api.runalloy.com/api/strategy/connector/hubspot/callback` 8. Select the scopes you need under **Scopes**: * Required: `oauth` (base OAuth scope) * `crm.objects.contacts.read` / `crm.objects.contacts.write` (for contacts) * `crm.objects.companies.read` / `crm.objects.companies.write` (for companies) * `crm.objects.deals.read` / `crm.objects.deals.write` (for deals) * Additional scopes as needed for your integration 9. Copy your **Client ID** and **Client Secret** from the Auth tab 10. Save your changes #### OAuth Configuration * Authorization URL: `https://app.hubspot.com/oauth/authorize` * Token URL: `https://api.hubapi.com/oauth/v1/token` * Refresh URL: `https://api.hubapi.com/oauth/v1/token` * Client Authentication Method: `client_secret_post` #### Getting Started * **Sign up for HubSpot**: [https://www.hubspot.com/products/get-started](https://www.hubspot.com/products/get-started) * **Developer Portal**: [https://developers.hubspot.com/](https://developers.hubspot.com/) * **API Documentation**: [https://developers.hubspot.com/docs/api/overview](https://developers.hubspot.com/docs/api/overview) * **OAuth Guide**: [https://developers.hubspot.com/docs/api/working-with-oauth](https://developers.hubspot.com/docs/api/working-with-oauth) * **CRM API Guide**: [https://developers.hubspot.com/docs/guides/api/crm/objects/contacts](https://developers.hubspot.com/docs/guides/api/crm/objects/contacts) *** ## Use Cases ### 1) Bidirectional CRM synchronization Keep contact, company, and deal records synchronized between HubSpot and other business systems, ensuring sales teams have up-to-date information regardless of which platform they use. ### 2) Lead enrichment and scoring Automatically enrich HubSpot contacts with data from third-party sources and sync lead scores from external scoring models back to HubSpot for better segmentation and prioritization. ### 3) Multi-channel engagement tracking Create email and task records in HubSpot from interactions that occur in other channels (support tickets, in-app messages, etc.) to maintain a complete engagement history on the timeline. ### 4) Custom workflow automation Trigger complex workflows in external systems based on HubSpot deal stage changes, contact property updates, or other CRM events that go beyond HubSpot's native workflow capabilities. ### 5) Reporting and analytics consolidation Extract HubSpot CRM data into your data warehouse or BI tool to combine sales metrics with data from other platforms for comprehensive revenue analytics and forecasting. *** ## API Gotchas * **Property pagination**: When requesting properties in GET requests, HubSpot limits which properties are returned by default. Always specify the `properties` parameter to explicitly request the fields you need rather than relying on defaults. * **Association type IDs**: When creating associations between objects (e.g., linking a contact to a company), you need to specify the correct `associationTypeId`. Common types include: contact-to-company (1), company-to-contact (2), deal-to-contact (3). Refer to HubSpot's documentation for the complete list. * **Rate limits vary by subscription**: API rate limits depend on your HubSpot subscription tier. Free and Starter plans have lower limits than Professional and Enterprise. Monitor the `X-HubSpot-RateLimit-*` headers in responses to track usage. * **Archived objects**: Deleted objects in HubSpot are archived, not permanently deleted. They can be restored within 90 days. Use the `archived=true` parameter to include or exclude archived objects in your queries. * **Custom properties**: HubSpot allows extensive property customization. When integrating, be prepared to handle custom properties dynamically rather than hardcoding expected fields, as each HubSpot portal may have different custom properties defined. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Hunter Source: https://docs.runalloy.com/connectors/Hunter Integration details and setup guide for the Hunter connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | --------------------------------------------------------- | | **Authentication** | API Key (Query Parameter) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | No (Polling) | | **Supports Rate Limiting** | Yes (Hunter enforces monthly search limits based on plan) | | **Authentication Scopes Supported** | N/A (API key provides full access based on plan tier) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Hunter**: * **Domain Search** (Find email addresses associated with a domain) * **Email Finder** (Find specific email addresses) * **Email Verifier** (Verify email address validity) * **Account Information** (API usage and limits) * **Leads** (Saved leads and lists) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Hunter offers a free plan with 25 searches and 50 verifications per month. | | **Requires paid sandbox?** | No. The free plan can be used for development and testing. | | **Requires partnership to obtain authentication?** | No. API access is available to all Hunter users, including free tier. | *** ### Authentication (API Key) Hunter uses API key authentication passed as a query parameter. #### Obtain your API key 1. Sign up for Hunter at [https://hunter.io/users/sign\_up](https://hunter.io/users/sign_up) (or log in if you have an account) 2. After logging in, navigate to your **Dashboard** 3. Click on **API** in the left sidebar, or go directly to [https://hunter.io/api\_keys](https://hunter.io/api_keys) 4. You'll see your API key displayed on this page 5. If no API key exists, click **Create New API Key** 6. Copy your **API Key** 7. **Important**: Keep your API key secure—it provides access to your Hunter account and counts against your usage limits #### API Key Usage * The API key is passed as a query parameter: `?api_key=YOUR_API_KEY` * Example: `https://api.hunter.io/v2/domain-search?domain=example.com&api_key=YOUR_API_KEY` * Each API request counts against your monthly search or verification quota * Monitor your usage in the Hunter dashboard to avoid exceeding limits #### Getting Started * **Sign up for Hunter**: [https://hunter.io/users/sign\_up](https://hunter.io/users/sign_up) * **API Dashboard**: [https://hunter.io/api\_keys](https://hunter.io/api_keys) * **API Documentation**: [https://hunter.io/api-documentation/v2](https://hunter.io/api-documentation/v2) * **Pricing and Plans**: [https://hunter.io/pricing](https://hunter.io/pricing) *** ## Use Cases ### 1) Lead generation and enrichment Automatically find and verify email addresses for prospects using domain searches, then enrich your CRM or lead database with verified contact information for sales outreach campaigns. ### 2) Email verification workflow Validate email addresses before sending campaigns or adding contacts to your mailing lists, reducing bounce rates and protecting sender reputation by filtering out invalid addresses. ### 3) Prospect research automation Integrate Hunter's domain search with your prospect research workflow to automatically discover key contacts at target companies based on job titles, departments, or seniority levels. ### 4) Data cleansing operations Periodically verify email addresses in your existing database to identify and remove invalid or outdated contacts, maintaining database hygiene and improving deliverability metrics. ### 5) Sales intelligence platform Combine Hunter's email discovery with other data sources to build a comprehensive sales intelligence platform that provides verified contact information alongside firmographic and technographic data. *** ## API Gotchas * **Query parameter authentication**: Unlike many modern APIs that use Bearer tokens in headers, Hunter requires the API key as a query parameter (`api_key=YOUR_KEY`). Ensure your API client is configured to pass credentials via query string. * **Monthly quotas**: Hunter enforces strict monthly limits on searches and verifications based on your subscription plan. Track your usage carefully and implement quota monitoring to avoid service disruptions mid-month. * **Rate limiting**: In addition to monthly quotas, Hunter may enforce rate limits on requests per second. If you're processing large batches, implement delays between requests to avoid 429 (Too Many Requests) errors. * **Email pattern confidence scores**: When Hunter returns email addresses from domain searches, they include confidence scores. Not all results are verified emails—some are patterns Hunter has inferred. Always check the confidence score and consider verifying important addresses before use. * **Free plan restrictions**: The free plan has limited searches per month and may not include access to all API endpoints or advanced features. Upgrade to a paid plan if you need higher limits or additional functionality. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # IBM Sterling OMS Source: https://docs.runalloy.com/connectors/IBMSterlingOMS Integration details and setup guide for the IBM Sterling OMS connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | -------------------------------- | | **Authentication** | Basic Auth (Username & Password) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (Basic Auth) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **IBM Sterling OMS**: * **Orders** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | No. IBM Sterling OMS is an enterprise order management system. Contact IBM at [https://www.ibm.com/products/order-management](https://www.ibm.com/products/order-management) for information. | | **Requires paid sandbox** | Yes. Access requires an enterprise license or sandbox environment from IBM. | | **Requires partnership to obtain authentication?** | Yes. You must work with IBM or an IBM partner to provision your Sterling OMS instance. | *** ### Authentication (Basic Auth) IBM Sterling OMS uses Basic HTTP Authentication with a username and password. #### How to obtain credentials 1. **Provision your IBM Sterling OMS instance** through IBM or an IBM partner. 2. **Access the Sterling Business Center** or your OMS admin console. 3. **Create a service user** with appropriate permissions for REST API access: * Navigate to Users & Permissions management * Create a new user with API access permissions * Set read/write permissions for orders, inventory, and other required resources 4. **Obtain the REST API endpoint URL** for your instance (e.g., `https://your-sterling-instance.com/smcfs/restapi`) 5. **Configure Basic Auth credentials** in Alloy Automation: * **Username**: Your Sterling OMS API username * **Password**: Your Sterling OMS API password 6. **Test the connection** by calling the `getOrderList` API to verify access. #### REST API Documentation * IBM Sterling OMS REST API Guide: [https://www.ibm.com/docs/en/order-management-sw](https://www.ibm.com/docs/en/order-management-sw) * REST API wrappers are typically used to interface with Sterling's service APIs *** ## Use Cases ### 1) Real-time order synchronization Sync orders from IBM Sterling OMS to your internal systems, data warehouse, or analytics platform in near real-time, enabling unified order visibility across your technology stack. ### 2) Order status updates and tracking Automatically pull order status changes and shipment tracking information to update your customer-facing applications, CRM, or customer service platforms with the latest fulfillment data. ### 3) Multi-channel order aggregation Aggregate orders across multiple sales channels managed by Sterling OMS into a central system for reporting, analysis, and customer service operations. ### 4) Automated order modifications Build workflows that automatically modify orders in Sterling OMS based on business rules, inventory availability, or customer requests, reducing manual intervention. ### 5) Order data enrichment Enrich order data from Sterling OMS with customer information, product details, or external data sources to create comprehensive order records for downstream systems. *** ## API Gotchas * **XML vs JSON**: Sterling OMS traditionally uses XML for API requests/responses, but REST wrappers typically support JSON. Verify your instance's API format and ensure proper content-type headers. * **Complex data structures**: Sterling OMS APIs often return deeply nested XML/JSON structures. The `OrderDetailsOutput` response includes multiple nested objects for order lines, payments, shipments, and addresses - ensure your integration handles these hierarchical structures correctly. * **OrderHeaderKey vs OrderNo**: Sterling uses both `OrderHeaderKey` (internal system key) and `OrderNo` (user-facing order number). Always store and use `OrderHeaderKey` for subsequent API calls as it's the immutable identifier. * **Status codes and descriptions**: Orders and order lines have numeric status codes (e.g., `1000`, `3700`) with corresponding `StatusDescription` fields. Map these status codes to your system's workflow states during integration. * **Date formats**: Sterling OMS uses ISO 8601 date-time format. Ensure your integration correctly parses and formats timestamps for query parameters like `FromOrderDate` and `ToOrderDate`. * **API throttling**: Enterprise instances may have API rate limits. Implement exponential backoff and respect any rate limiting headers returned by the API. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Intercom Source: https://docs.runalloy.com/connectors/Intercom Integration details and setup guide for the Intercom connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) or Bearer Token | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes (429 handling & rate limit headers) | | **Authentication Scopes Supported** | `read_contacts`, `write_contacts`, `read_conversations`, `write_conversations`, `read_articles`, `write_articles`, `read_admins` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Intercom**: * **Contacts** * **Admins** * **Articles** * **Conversations** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | **Offers free trial?** | Yes. Intercom offers a 14-day free trial. Sign up at [https://www.intercom.com/](https://www.intercom.com/). | | **Requires paid sandbox** | No. You can use the trial account for testing. | | **Requires partnership to obtain authentication?** | No. Anyone can create an Intercom app and generate API credentials. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Create your OAuth app 1. Go to **Intercom Developer Hub** ([https://app.intercom.com/a/apps/\_/developer-hub](https://app.intercom.com/a/apps/_/developer-hub)) 2. Click **New app** to create a new application 3. Fill in your app details: * **App name**: Your application name * **Description**: Brief description of your app 4. Configure OAuth settings: * Add the redirect URI: `https://api.runalloy.com/api/strategy/connector/intercom/callback` * Select required scopes based on your needs: * `read_contacts` - Read access to contacts * `write_contacts` - Write access to contacts * `read_conversations` - Read access to conversations * `write_conversations` - Write access to conversations * `read_articles` - Read access to help center articles * `write_articles` - Write access to help center articles * `read_admins` - Read access to admin information 5. Copy your **Client ID** and **Client Secret** 6. Configure these credentials in Alloy Automation #### API Documentation * Intercom API Reference: [https://developers.intercom.com/docs/references/rest-api](https://developers.intercom.com/docs/references/rest-api) * OAuth Guide: [https://developers.intercom.com/docs/build-an-integration/learn-more/authentication](https://developers.intercom.com/docs/build-an-integration/learn-more/authentication) *** ## Use Cases ### 1) Unified customer support data Sync Intercom conversations, contacts, and support tickets into your data warehouse or CRM, creating a single source of truth for customer interactions and support history. ### 2) Automated contact enrichment Automatically create and update Intercom contacts when new users sign up or customer data changes in your application, ensuring your support team always has the latest information. ### 3) Help center content synchronization Sync Intercom help center articles to external documentation systems, knowledge bases, or search platforms to make support content accessible across multiple touchpoints. ### 4) Conversation routing and analytics Pull conversation data to analyze support patterns, measure response times, and route high-priority conversations to appropriate teams based on custom business logic. ### 5) Cross-platform messaging Integrate Intercom conversations with other messaging platforms or ticketing systems, enabling support teams to manage customer communications from a unified interface. *** ## API Gotchas * **API versioning**: Intercom requires the `Intercom-Version` header (e.g., `2.14`) on all requests. Always specify the API version to ensure consistent behavior. Missing this header may result in unexpected responses or errors. * **Cursor-based pagination**: Most list endpoints use cursor-based pagination with `starting_after` parameter. You must store the `pages.next.starting_after` value from the response to fetch the next page - page numbers are not supported for these endpoints. * **Search vs List**: The `/contacts/search` endpoint offers powerful filtering capabilities but has different rate limits than `/contacts`. Use search for complex queries and list for simple pagination. * **Rate limiting**: Intercom enforces rate limits per workspace. When you receive a `429` response, check the `X-RateLimit-Reset` header to determine when you can retry. Implement exponential backoff to avoid repeatedly hitting rate limits. * **Contact roles**: When creating contacts, you must specify a `role` field (typically `user`). Missing this required field will result in a validation error. * **Date formats**: Intercom uses both ISO 8601 date-time strings (for most fields) and Unix timestamps (for certain fields like `signed_up_at`). Ensure your integration handles both formats correctly based on the field being used. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Inveterate Source: https://docs.runalloy.com/connectors/Inveterate Integration details and setup guide for the Inveterate connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------- | | **Authentication** | API Key (Header-based) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (API Key) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Inveterate**: * Custom actions and resources (refer to Inveterate API documentation for available endpoints) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Contact Inveterate for trial access information at [https://www.inveterate.com/](https://www.inveterate.com/). | | **Requires paid sandbox** | Unknown. Contact Inveterate sales for sandbox availability. | | **Requires partnership to obtain authentication?** | No, but you must be an Inveterate customer. | *** ### Authentication (API Key) Inveterate uses API Key authentication passed in the request header. #### How to obtain your API Key 1. **Log in to your Inveterate account** at [https://app.inveterate.com](https://app.inveterate.com) 2. Navigate to **Settings** or **App Settings** in your dashboard 3. Look for the **API** or **Integrations** section 4. **Generate a new API Key** or copy your existing key 5. Store this key securely - it will be used as the `X-Inveterate-Api-Key` header 6. **Configure the API Key in Alloy Automation**: * Header name: `X-Inveterate-Api-Key` * Header value: Your generated API key #### API Documentation * Inveterate API Endpoint: [https://public.inveterateapi.com](https://public.inveterateapi.com) * For detailed API documentation, contact Inveterate support or check their developer portal *** ## Use Cases ### 1) Loyalty program data synchronization Sync customer loyalty data, rewards, and engagement metrics from Inveterate to your CRM, data warehouse, or customer analytics platform for unified customer insights. ### 2) Automated reward fulfillment Trigger automated workflows when customers reach reward milestones in Inveterate, such as sending personalized emails, creating discount codes, or updating customer segments. ### 3) Cross-platform loyalty tracking Integrate Inveterate loyalty data with your e-commerce platform, point-of-sale system, or mobile app to provide customers with real-time loyalty status across all touchpoints. ### 4) Customer segmentation Pull loyalty program participation and engagement data to create sophisticated customer segments based on reward tier, points balance, or redemption behavior. ### 5) Reporting and analytics Export Inveterate loyalty program data to business intelligence tools for custom reporting on program performance, customer engagement, and reward redemption trends. *** ## API Gotchas * **Limited public documentation**: Inveterate's public API documentation may be limited. Work directly with Inveterate support to understand available endpoints, request/response formats, and rate limits for your specific use case. * **API key security**: The `X-Inveterate-Api-Key` header grants full access to your account data. Never expose this key in client-side code or public repositories. Rotate keys regularly and immediately revoke compromised keys. * **Custom action support**: Since Inveterate is marked with `x-alloy-custom-action: true`, you may need to define custom API calls for specific operations. Work with Alloy Automation support to configure these custom actions based on your Inveterate API needs. * **Base URL**: Ensure you're using the correct base URL (`https://public.inveterateapi.com`) for API requests. Some Inveterate features may use different endpoints or subdomains. * **Response formats**: Verify the expected response format (JSON, XML, etc.) for each endpoint. The OpenAPI spec doesn't define specific response schemas, so test your integration thoroughly to ensure proper data parsing. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Jira Source: https://docs.runalloy.com/connectors/Jira Integration details and setup guide for the Jira connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------- | | **Authentication** | Basic Auth (Email & API Token) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (Basic Auth with API Token) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Jira**: * **Issues** * **Labels** * **Plans** * **Projects** * **Status** * **Tasks** * **Users** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------- | | **Offers free trial?** | Yes. Jira Cloud offers a free plan for up to 10 users. | | **Requires paid sandbox** | No. The free plan can be used for development and testing. | | **Requires partnership to obtain authentication?** | No. Anyone can create a Jira Cloud account and generate API tokens. | *** ### Authentication (Basic Auth with API Token) Jira Cloud uses Basic Authentication with your email address and an API token. #### How to obtain your API Token 1. **Create a Jira Cloud account** at [https://www.atlassian.com/software/jira](https://www.atlassian.com/software/jira) 2. **Log in to your Atlassian account** ([https://id.atlassian.com](https://id.atlassian.com)) 3. Navigate to **Account Settings** > **Security** 4. Click **Create and manage API tokens** 5. Click **Create API token** * Give your token a descriptive label (e.g., "Alloy Automation Integration") * Copy the generated token immediately (you won't be able to see it again) 6. **Configure credentials in Alloy Automation**: * **Username**: Your Atlassian account email address * **Password**: The API token you just generated 7. **Identify your Jira domain**: Your Jira site URL (e.g., `yourcompany.atlassian.net`) * The domain part (e.g., `yourcompany`) will be used as the `{domain}` variable in API calls #### API Documentation * Jira Cloud REST API: [https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro) * API Token Management: [https://id.atlassian.com/manage-profile/security/api-tokens](https://id.atlassian.com/manage-profile/security/api-tokens) * Authentication Guide: [https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/) *** ## Use Cases ### 1) Automated issue creation and tracking Automatically create Jira issues from external systems like customer support tools, monitoring platforms, or incident management systems, ensuring all issues are tracked in a centralized location. ### 2) Project and sprint synchronization Sync Jira project data, sprint information, and workflow states to project management tools, reporting dashboards, or data warehouses for cross-platform visibility. ### 3) Engineering metrics and analytics Pull issue data, status transitions, and assignment information to calculate development velocity, cycle time, and other engineering metrics for performance analysis. ### 4) Cross-platform task management Integrate Jira issues with other task management tools, enabling teams to work in their preferred platforms while maintaining a single source of truth in Jira. ### 5) Automated workflow orchestration Trigger automated workflows based on Jira issue changes, such as notifying stakeholders when issues reach specific states, updating external systems, or creating follow-up tasks. *** ## API Gotchas * **Domain variable required**: Jira Cloud API URLs include your site's subdomain (e.g., `yourcompany.atlassian.net`). You must configure the `{domain}` variable correctly when setting up the integration - using an incorrect domain will result in 404 errors. * **API token vs password**: Never use your Atlassian account password for API authentication. Always generate and use API tokens. Tokens can be revoked independently without changing your password and provide better security. * **Issue key formats**: Jira issue keys follow the format `PROJECT-123` (project key + numeric ID). When creating or updating issues, ensure you use the correct format and that the project key exists in your Jira instance. * **Custom fields**: Jira projects often have custom fields with IDs like `customfield_10001`. These IDs are instance-specific and vary between Jira sites. You must query the field metadata API to discover custom field IDs for your specific instance. * **Bulk operations limits**: When performing bulk operations (create, update, delete), Jira imposes limits on the number of items per request. Typically, you can process up to 1000 issues at once, but check the specific endpoint documentation for exact limits. * **Pagination**: List endpoints use different pagination mechanisms. Most use `startAt` and `maxResults` parameters. Always check for `isLast` or `total` fields in responses to determine if more pages exist. * **Rate limiting**: Jira Cloud enforces rate limits per user and per app. When you hit rate limits, you'll receive a `429` response. Implement exponential backoff and respect the `Retry-After` header. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Junip Source: https://docs.runalloy.com/connectors/Junip Integration details and setup guide for the Junip connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------- | | **Authentication** | API Key (Header-based) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (API Key) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Junip**: * Custom actions and resources (refer to Junip API documentation for available endpoints) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------- | | **Offers free trial?** | Contact Junip for trial access information at [https://juniphq.com/](https://juniphq.com/). | | **Requires paid sandbox** | Unknown. Contact Junip sales for sandbox availability. | | **Requires partnership to obtain authentication?** | No, but you must be a Junip customer. | *** ### Authentication (API Key) Junip uses API Key authentication passed via the `Junip-Store-Key` header. #### How to obtain your API Key 1. **Log in to your Junip account** at [https://app.juniphq.com](https://app.juniphq.com) 2. Navigate to **Settings** in your Junip dashboard 3. Look for the **API** or **Integrations** section 4. **Generate a new API Key** or copy your existing store key 5. Store this key securely - it will be used as the `Junip-Store-Key` header 6. **Configure the API Key in Alloy Automation**: * Header name: `Junip-Store-Key` * Header value: Your generated store API key #### API Documentation * Junip API Base URL: [https://api.juniphq.com/](https://api.juniphq.com/) * For detailed API documentation, contact Junip support or check their developer portal *** ## Use Cases ### 1) Review data synchronization Sync customer reviews and ratings from Junip to your e-commerce platform, marketing tools, or data warehouse to leverage social proof across your entire marketing stack. ### 2) Automated review request workflows Trigger automated review request campaigns when orders are fulfilled or delivered, using data from your order management system to identify eligible customers. ### 3) Product feedback analysis Pull review data into analytics platforms to analyze product feedback, identify trends, and inform product development decisions based on customer sentiment. ### 4) UGC content distribution Distribute user-generated content (reviews, photos, ratings) from Junip to social media platforms, email campaigns, or product pages to maximize the impact of customer testimonials. ### 5) Customer sentiment tracking Integrate Junip review data with customer success platforms to track customer satisfaction trends, identify at-risk customers, and proactively address concerns. *** ## API Gotchas * **Limited public documentation**: Junip's API documentation may not be publicly available. Work directly with Junip support to understand available endpoints, request/response formats, and rate limits. * **Store key security**: The `Junip-Store-Key` header grants access to your store's review data. Never expose this key in client-side code, public repositories, or version control. Rotate keys regularly and revoke compromised keys immediately. * **Custom action configuration**: Since Junip is marked with `x-alloy-custom-action: true`, you'll need to work with Alloy Automation support to configure custom API calls for your specific Junip integration needs. * **Base URL**: Ensure you're using the correct base URL (`https://api.juniphq.com/`) for all API requests. Some features may use different endpoints or API versions. * **Response handling**: Without detailed schema information, thoroughly test your integration to ensure proper parsing of API responses. Review data structures may vary based on your Junip account configuration. * **Rate limiting**: While rate limits are supported, specific limits are not documented in the OpenAPI spec. Monitor your API usage and implement exponential backoff to handle potential rate limiting scenarios. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Klaviyo Source: https://docs.runalloy.com/connectors/Klaviyo Integration details and setup guide for the Klaviyo connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with PKCE and refresh tokens) | | **Two-Way Sync** | Yes | | **Events Supported** | Yes (Webhooks) | | **Realtime** | Yes | | **Supports Rate Limiting** | Yes (Burst: 1/s, Steady: 15/m for most endpoints) | | **Authentication Scopes Supported** | `accounts:read`, `campaigns:read`, `campaigns:write`, `catalogs:read`, `catalogs:write`, `conversations:read`, `conversations:write`, `coupons:read`, `coupons:write`, `events:read`, `events:write`, `flows:read`, `flows:write`, `forms:read`, `images:read`, `images:write`, `lists:read`, `lists:write`, `metrics:read`, `metrics:write`, `profiles:read`, `profiles:write`, `reviews:read`, `segments:read`, `segments:write`, `subscriptions:read`, `subscriptions:write`, `tags:read`, `tags:write`, `templates:read`, `templates:write`, `webhooks:read`, `webhooks:write` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Klaviyo**: * **Accounts** * **Campaigns** * **Catalogs** * **Coupons** * **Data Privacy** * **Events** * **Flows** * **Forms** * **Images** * **Lists** * **Metrics** * **Profiles** * **Reporting** * **Reviews** * **Segments** * **Tags** * **Templates** * **Tracking Settings** * **Webhooks** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Klaviyo offers a free tier with limited features. Create a free account at [https://www.klaviyo.com/sign-up](https://www.klaviyo.com/sign-up) to test the integration. | | **Requires requires paid sandbox** | No paid sandbox required. | | **Requires partnership to obtain authentication?** | No. OAuth 2.0 credentials can be obtained directly through the Klaviyo developer portal. | *** ### Authentication (OAuth 2.0) #### Create your OAuth app (Klaviyo Developer Portal) 1. Log in to your **Klaviyo account** and navigate to **Settings** → **API Keys**. 2. Click **Create Private API Key** or navigate to the OAuth section to create an OAuth application. 3. Configure your OAuth application settings: * Add the redirect URI: [https://api.alloyautomation.com/oauth/callback](https://api.alloyautomation.com/oauth/callback) * Select the scopes your integration requires (e.g., `profiles:read`, `profiles:write`, `lists:read`, `campaigns:read`, etc.) 4. Copy your **Client ID** and **Client Secret**. 5. Enter your **Client ID** and **Client Secret** into Alloy Automation. #### PKCE Support Klaviyo's OAuth 2.0 implementation uses PKCE (Proof Key for Code Exchange) for enhanced security. Alloy Automation handles this automatically during the OAuth flow. #### Scopes Klaviyo uses granular scopes for different resources. Select only the scopes your integration needs: * Read scopes (e.g., `profiles:read`, `campaigns:read`) for viewing data * Write scopes (e.g., `profiles:write`, `campaigns:write`) for creating/updating data *** ## Use Cases ### 1) Customer profile synchronization Sync customer profiles between Klaviyo and your application in real-time, ensuring email marketing lists stay up-to-date with the latest customer information from your e-commerce platform or CRM. ### 2) Event-driven campaign triggers Automatically trigger Klaviyo email campaigns and flows based on events in your application—such as abandoned carts, purchase completions, or subscription renewals—enabling personalized customer journeys. ### 3) Segment-based automation Create and manage Klaviyo segments programmatically based on customer behavior across multiple systems, enabling sophisticated cross-platform marketing automation. ### 4) Campaign performance reporting Pull campaign and flow metrics from Klaviyo into your custom dashboards or analytics tools, providing unified visibility into marketing performance alongside other business metrics. ### 5) Product catalog sync for personalization Keep Klaviyo's product catalog synchronized with your e-commerce platform, ensuring personalized email recommendations always reflect current inventory, pricing, and product information. *** ## API Gotchas * ⚠️ **Rate limiting:** Klaviyo enforces burst (1/s) and steady (15/m) rate limits on most endpoints. * ⚠️ **Profile identifiers:** Klaviyo profiles can be identified by email, phone number, or external ID. Ensure you're using consistent identifiers across your integration to avoid duplicate profiles. * ⚠️ **PKCE requirement:** OAuth flows require PKCE (Proof Key for Code Exchange). Ensure your OAuth implementation supports PKCE code challenges and verifiers. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Kustomer Source: https://docs.runalloy.com/connectors/Kustomer Integration details and setup guide for the Kustomer connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------- | | **Authentication** | Bearer Token (API Key) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (Bearer Token) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Kustomer**: * Custom actions and resources (refer to Kustomer API documentation for available endpoints) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Contact Kustomer for trial access at [https://www.kustomer.com/](https://www.kustomer.com/). Kustomer typically offers demos and proof-of-concept trials. | | **Requires paid sandbox** | Yes. Kustomer is an enterprise platform requiring a paid subscription. | | **Requires partnership to obtain authentication?** | No, but you must be a Kustomer customer. | *** ### Authentication (Bearer Token) Kustomer uses HTTP Bearer authentication with an API key. #### How to obtain your API Key 1. **Log in to your Kustomer account** at [https://app.kustomerapp.com](https://app.kustomerapp.com) 2. Navigate to **Settings** > **Security** > **API Keys** 3. Click **Create API Key** 4. Configure the API key: * Give it a descriptive name (e.g., "Alloy Automation Integration") * Set the appropriate permissions based on your integration needs * Choose between User Token (acts as a specific user) or Organization Token (acts as the organization) 5. Copy the generated API key immediately (you won't be able to see it again) 6. **Configure the Bearer token in Alloy Automation**: * Authentication type: Bearer Token * Token value: Your generated API key #### API Documentation * Kustomer API Documentation: [https://developer.kustomer.com/kustomer-api-docs/reference/introduction](https://developer.kustomer.com/kustomer-api-docs/reference/introduction) * Authentication Guide: [https://developer.kustomer.com/kustomer-api-docs/reference/authentication](https://developer.kustomer.com/kustomer-api-docs/reference/authentication) * API Keys Management: Available in Kustomer Settings > Security *** ## Use Cases ### 1) Unified customer support platform Sync customer conversations, tickets, and support history from Kustomer to your CRM, data warehouse, or analytics platform for comprehensive customer insights. ### 2) Automated customer data enrichment Automatically update Kustomer customer profiles when data changes in your product, CRM, or other systems, ensuring support agents always have the latest customer context. ### 3) Cross-platform ticket management Integrate Kustomer conversations with other ticketing systems, project management tools, or escalation platforms to enable seamless workflows across support teams. ### 4) Support analytics and reporting Pull Kustomer conversation data, resolution times, and customer satisfaction metrics into business intelligence tools for custom reporting and performance analysis. ### 5) Proactive customer support Trigger Kustomer conversations or notifications based on customer behavior, product usage, or external events to provide proactive support before customers reach out. *** ## API Gotchas * **API key types**: Kustomer offers User Tokens and Organization Tokens. User Tokens act on behalf of a specific user and inherit their permissions, while Organization Tokens have broader access. Choose the appropriate type based on your use case and required permissions. * **Base URL configuration**: Ensure you're using the correct base URL (`https://api.kustomerapp.com/v1/`). Note the `/v1/` version prefix in the URL. * **Bearer token format**: When making API requests, include your API key in the Authorization header as `Bearer YOUR_API_KEY`. Do not include additional text like "Token" or quotes around the key. * **Rate limiting**: Kustomer enforces API rate limits per organization. Monitor the rate limit headers in API responses (`X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`) and implement exponential backoff when approaching limits. * **Custom objects and fields**: Kustomer allows extensive customization of objects and fields. Your integration may need to account for custom fields specific to your Kustomer instance. Use the metadata endpoints to discover available fields. * **Webhook support**: While not detailed in the basic OpenAPI spec, Kustomer supports webhooks for real-time event notifications. Consider using webhooks in addition to polling for more responsive integrations. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Lightspeed Source: https://docs.runalloy.com/connectors/Lightspeed Integration details and setup guide for the Lightspeed connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) or Bearer Token | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | `employee:all`, `employee:register`, `employee:register_read`, `employee:inventory`, `employee:inventory_read`, `employee:reports`, `employee:admin`, `employee:admin_shops`, `employee:admin_employees`, `employee:admin_purchases`, `employee:admin_void_sale`, `employee:admin_inventory`, `employee:workbench`, `employee:customers`, `employee:customers_read`, `employee:customers_view_gift_card_numbers` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Lightspeed**: * Custom actions and resources (refer to Lightspeed API documentation for available endpoints) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Lightspeed Retail POS offers a 14-day free trial. Sign up at [https://www.lightspeedhq.com/pos/retail/](https://www.lightspeedhq.com/pos/retail/). | | **Requires paid sandbox** | No. You can use the trial account for testing and development. | | **Requires partnership to obtain authentication?** | No, but you must create a Lightspeed developer account to build OAuth apps. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Create your OAuth app 1. **Create a Lightspeed Retail account** at [https://www.lightspeedhq.com/pos/retail/](https://www.lightspeedhq.com/pos/retail/) 2. **Sign up for a Developer account** at [https://cloud.lightspeedapp.com/developers/](https://cloud.lightspeedapp.com/developers/) 3. **Create a new application**: * Navigate to the Developer Portal * Click **Create New App** * Fill in your application details (name, description, website) 4. **Configure OAuth settings**: * Add the redirect URI: `https://api.runalloy.com/api/strategy/connector/lightspeed/callback` * Select the required scopes based on your needs (see scopes list above) * Note: Scopes are combined with `+` delimiter (e.g., `employee:all+employee:register`) 5. **Copy your OAuth credentials**: * Client ID * Client Secret 6. Configure these credentials in Alloy Automation #### Obtaining an Account ID * After OAuth authorization, you'll receive an `accountID` which represents the specific Lightspeed account * This ID is required for making API calls and should be stored alongside the access token #### API Documentation * Lightspeed Retail API: [https://developers.lightspeedhq.com/retail/introduction/introduction/](https://developers.lightspeedhq.com/retail/introduction/introduction/) * OAuth Guide: [https://developers.lightspeedhq.com/retail/authentication/authentication/](https://developers.lightspeedhq.com/retail/authentication/authentication/) * API Reference: [https://developers.lightspeedhq.com/retail/endpoints/endpoints/](https://developers.lightspeedhq.com/retail/endpoints/endpoints/) *** ## Use Cases ### 1) Retail inventory synchronization Sync product inventory levels, variants, and stock information from Lightspeed POS to your e-commerce platform, warehouse management system, or ERP for unified inventory management. ### 2) Omnichannel sales reporting Aggregate sales data from Lightspeed POS locations with online sales channels to create comprehensive revenue reports and understand customer purchasing behavior across all touchpoints. ### 3) Customer data unification Sync customer information, purchase history, and loyalty data from Lightspeed to your CRM or marketing platform to create personalized campaigns and customer experiences. ### 4) Automated reorder workflows Monitor inventory levels in Lightspeed and automatically trigger purchase orders or restock notifications when products reach minimum thresholds, preventing stockouts. ### 5) Multi-location reporting Pull sales, inventory, and employee data from multiple Lightspeed POS locations into a centralized business intelligence platform for enterprise-wide analytics and decision making. *** ## API Gotchas * **Scope delimiter**: Lightspeed uses `+` as the scope delimiter instead of the more common space or comma. When requesting multiple scopes, combine them like `employee:all+employee:register+employee:inventory`. * **Account ID requirement**: Many API endpoints require an `accountID` parameter, which represents the specific Lightspeed account. This ID is returned during the OAuth flow and must be stored for subsequent API calls. * **Rate limiting**: Lightspeed enforces rate limits on API requests. The specific limits depend on your account plan. Monitor rate limit headers and implement exponential backoff to avoid throttling. * **API versioning**: The Lightspeed Retail API is at version 3 (`/API/V3`). Always use the versioned endpoint to ensure consistent behavior. Future versions may introduce breaking changes. * **Token refresh**: OAuth access tokens expire after a certain period. Implement proper token refresh logic using the refresh token to maintain uninterrupted API access. * **Read vs write scopes**: Lightspeed provides granular read/write scopes (e.g., `employee:inventory_read` vs `employee:inventory`). Request only the minimum required scopes for your use case to follow the principle of least privilege. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # LineTen Source: https://docs.runalloy.com/connectors/LineTen Integration details and setup guide for the LineTen connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ---------------------------------------------- | | **Authentication** | OAuth 2.0 (Client Credentials) or Bearer Token | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (Client Credentials flow) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **LineTen**: * Custom actions and resources (refer to LineTen API documentation for available endpoints) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | --------------------------------------------------------------------------------------------- | | **Offers free trial?** | Contact LineTen for trial access information at [https://lineten.com/](https://lineten.com/). | | **Requires paid sandbox** | Yes. LineTen typically requires a staging or sandbox environment. Contact LineTen support. | | **Requires partnership to obtain authentication?** | No, but you must be a LineTen customer or partner. | *** ### Authentication (OAuth 2.0 Client Credentials) LineTen uses OAuth 2.0 Client Credentials flow for machine-to-machine authentication. #### How to obtain credentials 1. **Contact LineTen support** at [support@lineten.com](mailto:support@lineten.com) or through your account representative 2. **Request API access** for your organization 3. LineTen will provide you with: * **Client ID**: Your application identifier * **Client Secret**: Your application secret key * **Token URL**: The endpoint to obtain access tokens (typically `https://api-l10-idp-staging-neu.azurewebsites.net/connect/token` for staging) * **API Base URL**: Your instance's API endpoint (e.g., `https://api-nxd-staging-neu.azurewebsites.net/`) 4. **Configure credentials in Alloy Automation**: * Authentication type: OAuth 2.0 Client Credentials * Client ID: Provided by LineTen * Client Secret: Provided by LineTen * Token URL: Provided by LineTen * Note: Client credentials are sent using HTTP Basic Authentication (`client_secret_basic`) #### API Documentation * Contact LineTen support for comprehensive API documentation * Base URLs may differ between staging and production environments * Ensure you're using the correct environment URLs for your integration *** ## Use Cases ### 1) Last-mile delivery optimization Integrate LineTen's delivery management data with your order fulfillment system to optimize routing, track delivery performance, and provide real-time updates to customers. ### 2) Shipping cost calculation Use LineTen's rate calculation capabilities to dynamically compute shipping costs during checkout based on delivery address, package dimensions, and service levels. ### 3) Multi-carrier shipment tracking Consolidate tracking information from multiple carriers managed by LineTen into your customer portal, providing a unified tracking experience regardless of the shipping provider. ### 4) Returns and reverse logistics Automate returns processing by integrating LineTen's reverse logistics capabilities with your order management system, triggering return shipments and tracking return deliveries. ### 5) Delivery analytics and reporting Pull LineTen shipment data into your business intelligence platform to analyze delivery performance, identify bottlenecks, and optimize your logistics operations. *** ## API Gotchas * **Client Credentials flow**: LineTen uses OAuth 2.0 Client Credentials flow instead of the typical Authorization Code flow. This is a machine-to-machine authentication pattern that doesn't involve user interaction. Your application exchanges client credentials directly for an access token. * **Environment URLs**: LineTen uses different URLs for staging and production environments. The OpenAPI spec shows staging URLs (e.g., `api-nxd-staging-neu.azurewebsites.net`). Ensure you update to production URLs when deploying to production. * **Token management**: Access tokens from Client Credentials flow typically have shorter lifespans. Implement token caching and automatic refresh logic to minimize token requests and ensure uninterrupted API access. * **Client authentication method**: LineTen uses `client_secret_basic` authentication, meaning client credentials are sent in the Authorization header (Basic Auth) when requesting tokens, not in the request body. * **Limited public documentation**: LineTen's API documentation may not be publicly available. Work closely with LineTen support to understand available endpoints, request/response formats, and any instance-specific configurations. * **Azure-hosted infrastructure**: LineTen's API is hosted on Azure (azurewebsites.net). Be aware of Azure service limits and regional considerations when planning your integration architecture. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Linear Source: https://docs.runalloy.com/connectors/Linear Integration details and setup guide for the Linear connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------------------------- | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) or Bearer Token | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | `read`, `write`, `issues:create`, `comments:create`, `timeSchedule:write` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Linear**: * **Users** * **Comments** * **Projects** * **Workflow States** * **Labels** * **Teams** *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Linear offers a free plan for individuals and small teams. Sign up at [https://linear.app/signup](https://linear.app/signup). | | **Requires paid sandbox** | No. The free plan can be used for development and testing. | | **Requires partnership to obtain authentication?** | No. Anyone can create a Linear account and OAuth application. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Create your OAuth app 1. **Create a Linear account** at [https://linear.app](https://linear.app) 2. **Navigate to Settings** > **API** > **Applications** 3. Click **Create new application** ([https://linear.app/settings/api/applications/new](https://linear.app/settings/api/applications/new)) 4. Fill in your application details: * **Name**: Your application name * **Description**: Brief description of your app * **Website URL**: Your application's website 5. **Configure OAuth settings**: * Add the redirect URI: `https://api.runalloy.com/api/strategy/connector/linear/callback` * Select required scopes: * `read` - Read access for the user's account * `write` - Write access for the user's account * `issues:create` - Create new issues and attachments * `comments:create` - Create new issue comments * `timeSchedule:write` - Create and modify time schedules * Note: Scopes are comma-separated 6. Copy your **Client ID** and **Client Secret** 7. Configure these credentials in Alloy Automation #### API Documentation * Linear API: [https://developers.linear.app/docs](https://developers.linear.app/docs) * GraphQL API Endpoint: [https://api.linear.app/graphql](https://api.linear.app/graphql) * OAuth Guide: [https://developers.linear.app/docs/oauth/authentication](https://developers.linear.app/docs/oauth/authentication) *** ## Use Cases ### 1) Automated issue creation from support tickets Automatically create Linear issues when customer support tickets are submitted, bug reports are filed, or monitoring alerts are triggered, ensuring engineering teams have visibility into all product issues. ### 2) Project management synchronization Sync Linear projects, teams, and workflow states to other project management tools, enabling cross-functional teams to work in their preferred platforms while maintaining a single source of truth. ### 3) Engineering metrics and analytics Pull Linear issue data, state transitions, and completion times into analytics platforms to calculate velocity, cycle time, lead time, and other engineering performance metrics. ### 4) Cross-platform collaboration Integrate Linear with Slack, Microsoft Teams, or other collaboration tools to post issue updates, comments, and status changes, keeping distributed teams informed in real-time. ### 5) Automated workflow orchestration Trigger automated workflows based on Linear issue state changes, such as notifying stakeholders when issues move to specific states, updating external systems, or creating follow-up tasks. *** ## API Gotchas * **GraphQL API**: Linear uses GraphQL instead of REST. All API calls are POST requests to `https://api.linear.app/graphql` with a GraphQL query in the request body. This is different from traditional REST APIs and requires understanding GraphQL query syntax. * **Cursor-based pagination**: Linear uses cursor-based pagination for list queries. Store the `endCursor` from `pageInfo` to fetch the next page. The pagination uses `first`/`after` or `last`/`before` parameters for forward and backward pagination. * **Field selection**: GraphQL requires you to explicitly specify which fields you want in the response. Missing required fields in your query will result in incomplete data. Use the `returnFields` configuration to specify all needed fields. * **Scope delimiter**: Linear uses commas (`,`) to separate OAuth scopes, not spaces. When requesting multiple scopes, format them as `read,write,issues:create`. * **Rate limiting**: Linear enforces rate limits per user and per application. Implement exponential backoff when receiving rate limit errors. The API typically returns rate limit information in error responses. * **Team and organization context**: Many Linear resources are scoped to specific teams or organizations. Ensure your queries include appropriate team or organization filters to retrieve the correct data. * **Date formats**: Linear uses ISO 8601 date-time format for all timestamp fields. Ensure your integration correctly parses these timestamps when processing issue creation dates, updates, and deadlines. > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # LinkedIn Source: https://docs.runalloy.com/connectors/LinkedIn Integration details and setup guide for the LinkedIn connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ------------------------------------------------------------------ | | **Authentication** | OAuth 2.0 (Authorization Code with refresh tokens) or Bearer Token | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | `r_emailaddress`, `r_liteprofile`, `w_member_social` | *** ## Objects Supported Alloy Automation supports syncing the following objects from **LinkedIn**: * Custom actions and resources (refer to LinkedIn API documentation for available endpoints) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Creating a LinkedIn account and developer app is free. Sign up at [https://www.linkedin.com/signup](https://www.linkedin.com/signup) and access the developer portal at [https://www.linkedin.com/developers/](https://www.linkedin.com/developers/). | | **Requires paid sandbox** | No. LinkedIn provides free API access for approved applications. | | **Requires partnership to obtain authentication?** | No, but your application must go through LinkedIn's app review process for production use. | *** ### Authentication (OAuth 2.0) For customers who want to completely whitelabel their OAuth experience, you can provide your own developer keys instead of using Alloy Automation's. #### Create your OAuth app 1. **Create a LinkedIn account** (or use an existing personal/company account) 2. **Go to LinkedIn Developers** at [https://www.linkedin.com/developers/](https://www.linkedin.com/developers/) 3. Click **Create app** to register a new application 4. Fill in required information: * **App name**: Your application name * **LinkedIn Page**: Associate with your company's LinkedIn page (required) * **App logo**: Upload your application logo * **Legal agreement**: Accept LinkedIn's API Terms of Use 5. Once created, navigate to the **Auth** tab 6. **Configure OAuth 2.0 settings**: * Add redirect URL: `https://api.runalloy.com/api/strategy/connector/linkedin/callback` * Note your **Client ID** and **Client Secret** 7. **Request API Products**: * Go to the **Products** tab * Request access to required products (e.g., "Sign In with LinkedIn", "Share on LinkedIn") * Wait for LinkedIn's approval (can take a few days) 8. **Configure OAuth scopes** (under the Auth tab): * `r_emailaddress` - Access to email address * `r_liteprofile` - Access to basic profile information * `w_member_social` - Post on behalf of the member 9. Copy your credentials and configure them in Alloy Automation #### API Documentation * LinkedIn API Documentation: [https://docs.microsoft.com/en-us/linkedin/](https://docs.microsoft.com/en-us/linkedin/) * OAuth 2.0 Guide: [https://docs.microsoft.com/en-us/linkedin/shared/authentication/authentication](https://docs.microsoft.com/en-us/linkedin/shared/authentication/authentication) * Developer Portal: [https://www.linkedin.com/developers/](https://www.linkedin.com/developers/) *** ## Use Cases ### 1) Social media content distribution Automatically post content to LinkedIn when new blog posts, articles, or announcements are published on your website or CMS, expanding your content's reach across social channels. ### 2) Lead generation and enrichment Capture LinkedIn profile information when users authenticate with LinkedIn, enriching your CRM with professional data like job titles, companies, and industries. ### 3) Professional network analytics Pull LinkedIn engagement data (likes, shares, comments) to analyze content performance and understand which messages resonate with your professional audience. ### 4) Employee advocacy programs Enable employees to easily share company content on their LinkedIn profiles, amplifying your brand's reach and establishing thought leadership. ### 5) Recruitment and talent sourcing Integrate LinkedIn profile data with your applicant tracking system to streamline candidate evaluation and track professional backgrounds during the hiring process. *** ## API Gotchas * **App review required**: LinkedIn requires app review and approval before you can request certain scopes or move to production. The review process can take several days to weeks. Plan accordingly and submit your app for review early in your development cycle. * **Scope limitations**: Not all API endpoints are available to all applications. Some features (like company page management or advertising APIs) require specific LinkedIn products to be approved for your app. Check product requirements before building features. * **Profile data restrictions**: LinkedIn has strict policies about how profile data can be used and stored. You cannot use profile data for advertising purposes or store it longer than necessary. Review LinkedIn's API Terms of Use carefully. * **Rate limiting**: LinkedIn enforces application-level and user-level rate limits. Limits vary by API endpoint and your application's approval status. Implement exponential backoff and respect rate limit headers. * **Token expiration**: LinkedIn access tokens expire after 60 days. Implement refresh token logic to maintain long-term access, or prompt users to re-authenticate when tokens expire. * **API migration**: LinkedIn APIs have undergone significant changes (v1 to v2). Ensure you're using the latest API version and endpoints. Legacy v1 endpoints are deprecated and will stop working. * **Scope delimiter**: LinkedIn uses space-separated scopes in the OAuth authorization URL. When requesting multiple scopes, separate them with spaces (e.g., `r_liteprofile r_emailaddress w_member_social`). > For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**. # Lob Source: https://docs.runalloy.com/connectors/Lob Integration details and setup guide for the Lob connector in Alloy Automation. ## Pre-Built Tooling | Category | Details | | ----------------------------------- | ----------------------------------------------------- | | **Authentication** | HTTP Basic Auth (API Key as username, blank password) | | **Two-Way Sync** | No | | **Events Supported** | No | | **Realtime** | Polling | | **Supports Rate Limiting** | Yes | | **Authentication Scopes Supported** | N/A (API Key) | *** ## Objects Supported Alloy Automation supports syncing the following objects from **Lob**: * Custom actions and resources (refer to Lob API documentation for available endpoints) *** ## Set Up Guide ### Trial Access | Question | Answer | | -------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Offers free trial?** | Yes. Lob offers test API keys for development and testing at no cost. Sign up at [https://dashboard.lob.com/register](https://dashboard.lob.com/register). | | **Requires paid sandbox** | No. Test mode is free and includes full API access with test data. | | **Requires partnership to obtain authentication?** | No. Anyone can sign up and obtain API keys. | *** ### Authentication (HTTP Basic Auth) Lob uses HTTP Basic Authentication where your API Key acts as the username and the password field is left blank. #### How to obtain your API Key 1. **Sign up for a Lob account** at [https://dashboard.lob.com/register](https://dashboard.lob.com/register) 2. **Log in to your Lob Dashboard** at [https://dashboard.lob.com](https://dashboard.lob.com) 3. Navigate to **Settings** > **API Keys** 4. You'll see two types of API keys: * **Test keys** (prefix `test_`): For development and testing, no charges apply * **Live keys** (prefix `live_`): For production use, actual charges apply 5. **Copy your API key** (start with test key for integration development) 6. **Configure in Alloy Automation**: * Authentication type: Basic Auth * **Username**: Your Lob API Key (e.g., `test_abc123...`) * **Password**: Leave blank (empty string) #### Important Notes * The API key must be base64-encoded as part of the Authorization header: `Authorization: Basic
Make sure you check off the**Configurable by user** setting which will expose this variable to your end-users when they install. You can create your own label and help text to better instruct end-users on how to utilize this field.
### 2. Choose a Workflow Trigger
Here, we'll assume that the orders are originating in your platform, as the ISV, or a platform that you manage on behalf of your customers. As order fulfillment is a fairly time-sensitive process we suggest chooseing a real-time or near-real-time method for syncing order data from your systems into your e-commerce platform of choice:
* [Custom Event](https://docs.runalloy.com/embedded/custom-events#custom-events) - Invoked in your systems and can be used to pass along order data as individual orders are created
* **Recurring Sync** - Can be used to run the order syncing workflow on a recurring basis, should also be combined with a polling endpoint from which the workflow can pull bulk orders via [Custom API Call](https://docs.runalloy.com/embedded/custom-api-calls#custom-api-calls)
### 3. Send Order Data to Alloy
If using a Custom Event to send real-time order data from your systems, you can pass the entire order payload as part of the Custom Event schema. If you'll be polling a bulk order export endpoint on your REST API instead, you can pass along an array of order payloads.
### 6. Creating Line Items
Some E-Commerce connectors in Alloy will allow you to add line items directly within the 'Create Order' connector action. Other Connectors will require you to manually create line items\_after\_ the order is created, using a separate action. In this case you'll want to do the following:
* After the 'Create Order' action, add an [Iterate](https://docs.runalloy.com/embedded/iterate#iterate) node and pass in the 'line items' list from the original order payload as the**List to loop through** .
* Within each loop iteration, add a 'Create Order Line Item' action to capture each individual line item
* Pass the returned 'Order ID' from the 'Create Order' action into the**Order ID** field in the 'Create Order Line Item' action. This is how we associate line items created in a separate step, with the parent Order object
If you're able to create line items within the same action as creating an order, you can typically use**Dynamic List Mode** which allows you to pass an list directly into the action and Alloy will automatically iterate through all records in the list
## Video Walkthrough Library
*We've created video walkthroughs for the most common and complex integration scenarios. Choose a walkthrough below to build alongside our experts. We regularly add new videos, so check back for updates!*
In Shopify's GraphQL API, however, the return itself is a separate API request. You can see an example of that request below:
```
mutation CreateReturn($input: ReturnCreateInput!) {
returnCreate(return: $input) {
return {
id
status
returnLineItems {
id
quantity
}
}
userErrors {
field
message
}
}
}
```
### 6. Communicate the Refund to the Customer (Optional)
