This repository has been archived by the owner on Mar 10, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b093ae9
commit 16c5dea
Showing
125 changed files
with
9,803 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "api", | ||
"version": "0.7.4", | ||
"version": "0.7.5", | ||
"packageManager": "[email protected]", | ||
"type": "commonjs", | ||
"dependencies": { | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "mgmt-ui", | ||
"version": "0.7.4", | ||
"version": "0.7.5", | ||
"private": true, | ||
"scripts": { | ||
"dev": "next dev", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "sync-worker", | ||
"version": "0.7.4", | ||
"version": "0.7.5", | ||
"packageManager": "[email protected]", | ||
"dependencies": { | ||
"@sentry/integrations": "^7.43.0", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# API Reference | ||
|
||
Supaglue supports 2 APIs: | ||
|
||
* [Management API](api/mgmt) can be used to manage customer integrations and connections. | ||
* [CRM API](api/crm) can be used to read and write data that has been synced into Supaglue from third-party CRM providers. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
sidebar_position: 7 | ||
--- | ||
|
||
# Architecture | ||
|
||
import ThemedImage from '@theme/ThemedImage'; | ||
|
||
<ThemedImage | ||
alt="Architecture Diagram" | ||
width="75%" | ||
sources={{ | ||
light: '/img/arch.png', | ||
dark: '/img/arch.png', | ||
}} | ||
/> | ||
|
||
## Components | ||
|
||
- Sync workflows | ||
- Workflow engine (Temporal) | ||
- DB Cache (Postgres) | ||
- Backend API (Node.js Express) | ||
- Common Model | ||
|
||
## Overview | ||
|
||
Supaglue is a platform that you can self-host on your infrastructure. It consists of two services, a backend API (Node.js Express) and workflow engine (Temporal), and a database (Postgres). | ||
|
||
The backend API serves four purposes: | ||
|
||
1. As a management layer for developers to configure Integrations. | ||
2. As an authentication layer for Customers to authenticate with third-party tools to create Connections. | ||
3. As a serving layer for developers to read/write Common Model objects. | ||
4. As a worker layer for Sync workflows to read/write from third-party tools and cache in Supaglue's database. | ||
|
||
The database serves as a place to store two types of data: | ||
|
||
1. Supaglue application data (Integrations, Connections, Customers). | ||
2. Data from Customers' third-party tools (raw and Common Model formats). | ||
|
||
The workflow engine is responsible for scheduling and executing Sync workflows which move data in/out of Supaglue and third-party tools. There are two general kinds of Syncs: | ||
|
||
1. Write sync: this sync will create/update records in third-party tools and then update Supaglue's cache. | ||
2. Read sync | ||
- Object sync - this sync is responsible for reading one type of third-party object and saving it to Supaglue's database cache in a raw and Common Model format. | ||
- Association sync - this sync is run after all object syncs, scoped to a Connection, are finished running to associate related objects to one another. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Concepts | ||
|
||
Learn about major Supaglue concepts. | ||
|
||
<dl> | ||
<dt>Common Model</dt> | ||
<dd>A canonical data model that has been standardized across all CRMs.</dd> | ||
|
||
<dt>Connector</dt> | ||
<dd>A code package that is used by Supaglue to interact with a CRM's auth, APIs, and object model.</dd> | ||
|
||
<dt>Connection</dt> | ||
<dd>A link between a Customer's CRM and a Supaglue Integration.</dd> | ||
|
||
<dt>Customer</dt> | ||
<dd>An end-user of a developer's application.</dd> | ||
|
||
<dt>Embedded Link</dt> | ||
<dd>A Customer-facing HTTP link that developers embed into their applications so their customers can authenticate their CRMs to the developers' application using Supaglue.</dd> | ||
|
||
<dt>Integration</dt> | ||
<dd>An offering made available by a developer to their customers so that Customers can connect their CRMs.</dd> | ||
|
||
<dt>Provider</dt> | ||
<dd>A CRM such as Salesforce or HubSpot.</dd> | ||
|
||
<dt>Sync workflow</dt> | ||
<dd>A process that Supaglue will run to move data from a third-party tool to/from Supaglue.</dd> | ||
|
||
<dt>Sync Info</dt> | ||
<dd>Metadata (start time, end time, status, model name) related to a Sync workflow.</dd> | ||
|
||
<dt>Unified API</dt> | ||
<dd>A HTTP API that gives developers a single interface to read and write common data models from multiple CRM providers.</dd> | ||
</dl> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "Connectors", | ||
"position": 5, | ||
"link": { | ||
"type": "doc", | ||
"id": "connectors", | ||
} | ||
} |
23 changes: 23 additions & 0 deletions
23
docs/versioned_docs/version-0.7.5/connectors/activecampaign.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
sidebar_custom_props: | ||
icon: /img/connector_icons/activecampaign.png | ||
description: '' | ||
--- | ||
|
||
# Active Campaign | ||
|
||
## Overview | ||
|
||
Supaglue interfaces with the ActiveCampaign V3 API. | ||
|
||
|
||
| Feature | Available | | ||
| -------------------------- | --------- | | ||
| Auth | No | | ||
| Reads: Full refresh | No | | ||
| Reads: Incremental refresh | No | | ||
| Creates | No | | ||
| Updates | No | | ||
| Handles rate limits | No | | ||
|
||
Supported object types: - |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Connectors | ||
|
||
import DocCardList from '@theme/DocCardList'; | ||
|
||
Here are the CRM connectors built and active maintained by Supaglue Labs. Email us ([email protected]) to request a connector. | ||
|
||
<DocCardList /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
sidebar_custom_props: | ||
icon: /img/connector_icons/copper.png | ||
description: '' | ||
--- | ||
|
||
# Copper | ||
|
||
## Overview | ||
|
||
Supaglue interfaces with the Copper V1 API. | ||
|
||
| Feature | Available | | ||
| -------------------------- | --------- | | ||
| Auth | No | | ||
| Reads: Full refresh | No | | ||
| Reads: Incremental refresh | No | | ||
| Creates | No | | ||
| Updates | No | | ||
| Handles rate limits | No | | ||
|
||
Supported object types: - |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
sidebar_custom_props: | ||
icon: /img/connector_icons/ms_dynamics_365_sales.png | ||
description: '' | ||
--- | ||
|
||
# HubSpot | ||
|
||
## Overview | ||
|
||
Supaglue interfaces with the HubSpot V3 API. | ||
|
||
| Feature | Available | | ||
| -------------------------- | --------- | | ||
| Auth | Yes | | ||
| Reads: Full refresh | Yes | | ||
| Reads: Incremental refresh | Yes | | ||
| Creates | Yes | | ||
| Updates | Yes | | ||
| Handles rate limits | Yes | | ||
|
||
Supported object types: | ||
|
||
- Company | ||
- Contact | ||
- Deal | ||
- User |
23 changes: 23 additions & 0 deletions
23
docs/versioned_docs/version-0.7.5/connectors/ms_dynamics_365_sales.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
sidebar_custom_props: | ||
icon: /img/connector_icons/ms_dynamics_365_sales.png | ||
description: '' | ||
--- | ||
|
||
# Microsoft Dynamics 365 Sales | ||
|
||
## Overview | ||
|
||
Supaglue interfaces with the Microsoft Dynamics 365 V9 API. | ||
|
||
| Feature | Available | | ||
| -------------------------- | --------- | | ||
| Auth | Yes | | ||
| Reads: Full refresh | No | | ||
| Reads: Incremental refresh | No | | ||
| Creates | No | | ||
| Updates | No | | ||
| Handles rate limits | No | | ||
|
||
Supported object types: - | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
sidebar_custom_props: | ||
icon: /img/connector_icons/pipedrive.png | ||
description: '' | ||
--- | ||
|
||
# Pipedrive | ||
|
||
## Overview | ||
|
||
Supaglue interfaces with the Pipedrive V1 API. | ||
|
||
Status: Alpha | ||
|
||
| Feature | Available | | ||
| -------------------------- | --------- | | ||
| Auth | Yes | | ||
| Reads: Full refresh | No | | ||
| Reads: Incremental refresh | No | | ||
| Creates | No | | ||
| Updates | No | | ||
| Handles rate limits | No | | ||
|
||
Supported object types: - |
28 changes: 28 additions & 0 deletions
28
docs/versioned_docs/version-0.7.5/connectors/salesforce.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
sidebar_custom_props: | ||
icon: /img/connector_icons/salesforce.png | ||
description: '' | ||
--- | ||
|
||
# Salesforce | ||
|
||
## Overview | ||
|
||
Supaglue uses the Salesforce Bulk 2.0 API and the REST API. | ||
|
||
| Feature | Available | | ||
| -------------------------- | --------- | | ||
| Auth | Yes | | ||
| Reads: Full refresh | Yes | | ||
| Reads: Incremental refresh | Yes | | ||
| Creates | Yes | | ||
| Updates | Yes | | ||
| Handles rate limits | Yes | | ||
|
||
Supported object types: | ||
|
||
- Account | ||
- Contact | ||
- Lead | ||
- Opportunity | ||
- User |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
sidebar_custom_props: | ||
icon: /img/connector_icons/zoho_crm.png | ||
description: '' | ||
--- | ||
|
||
# Zoho CRM | ||
|
||
## Overview | ||
|
||
Supaglue interfaces with the Zoho REST V3 API. | ||
|
||
| Feature | Available | | ||
| -------------------------- | --------- | | ||
| Auth | Yes | | ||
| Reads: Full refresh | No | | ||
| Reads: Incremental refresh | No | | ||
| Creates | No | | ||
| Updates | No | | ||
| Handles rate limits | No | | ||
|
||
Supported object types: - |
Oops, something went wrong.
16c5dea
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
supaglue-docs – ./docs
supaglue-docs-1exg.vercel.app
docs.supaglue.com
supaglue-docs-supaglue.vercel.app
supaglue-docs-git-main-supaglue.vercel.app