# ActionKit for Tool Calling
Source: https://docs.useparagon.com/actionkit/actionkit-for-tool-calling

Use ActionKit to provide your AI agent with hundreds of Integration Actions.

ActionKit is designed to give AI agents the ability to call out to integration logic as a part of a prompt or ongoing conversation with a user. The API exposes JSON Schema specs to easily provide your agent with capabilities including:

* Creating tasks in Jira based on action items an agent recognizes from a meeting transcript
* Querying real-time sales reports in Shopify when an agent is asked questions about online sales
* Creating a Google Docs draft to start a project based on a user prompt

## Implementation Examples

### Vercel AI SDK

```js Implementing ActionKit in AI SDK expandable
import { generateText, jsonSchema, tool } from "ai";
import { openai } from "@ai-sdk/openai";

const response = await fetch(
  "https://actionkit.useparagon.com/projects/<Project ID>/actions",
  {
    method: "GET",
    headers: {
      Authorization: `Bearer ${paragonUserToken}`,
    },
  }
);

const { actions, errors } = await response.json();

if (errors.length === 0) {
  await generateText({
    model: openai("gpt-4o"),
    tools: Object.fromEntries(
      actions.map((action) => [
        action.function.name,
        tool({
          description: tool.function.description,
          parameters: jsonSchema(tool.function.parameters),
          execute: async (params: any, { toolCallId }) => {
            try {
              const response = await fetch(
                `https://actionkit.useparagon.com/projects/<Project ID>/actions`,
                {
                  method: "POST",
                  body: JSON.stringify({
                    action: tool.function.name,
                    parameters: params,
                  }),
                  headers: {
                    Authorization: `Bearer ${session.paragonUserToken}`,
                    "Content-Type": "application/json",
                  },
                }
              );
              const output = await response.json();
              if (!response.ok) {
                throw new Error(JSON.stringify(output, null, 2));
              }
              return output;
            } catch (err) {
              if (err instanceof Error) {
                return { error: { message: err.message } };
              }
              return err;
            }
          },
        }),
      ])
    ),
    toolChoice: "auto",
    temperature: 0,
    system: "You are a helpful assistant. Be as concise as possible.",
    prompt: "Help me create a new task in Jira.",
  });
}
```

### LangGraph / LangChain

```py Implementing ActionKit in LangChain expandable
import json
import requests
from typing import Annotated, Any, TypedDict
from langchain.tools import BaseTool
from langchain.schema import HumanMessage
from langgraph.graph import StateGraph, START, END
from langgraph.graph.message import add_messages
from langgraph.prebuilt import ToolNode, tools_condition
from langchain_openai import ChatOpenAI

PARAGON_PROJECT_ID = ""
PARAGON_USER_TOKEN = ""
OPENAI_API_KEY = ""

class ActionKitTool(BaseTool):
    name: str
    description: str
    action_name: str
    paragon_token: str

    def _run(self, tool_input: str) -> str:
        try:
            params = json.loads(tool_input)
            response = requests.post(
                url=f"https://actionkit.useparagon.com/projects/{PARAGON_PROJECT_ID}/actions",
                headers={
                    "Authorization": f"Bearer {self.paragon_token}",
                    "Content-Type": "application/json",
                },
                json={
                    "action": self.action_name,
                    "parameters": params,
                },
                timeout=30
            )
            data = response.json()

            if not response.ok:
                raise ValueError(json.dumps(data, indent=2))

            return json.dumps(data)
        except Exception as e:
            return json.dumps({"error": {"message": str(e)}})

class State(TypedDict):
    messages: Annotated[list, add_messages]

def main():
    graph_builder = StateGraph(State)
    url = f"https://actionkit.useparagon.com/projects/{PARAGON_PROJECT_ID}/actions"
    headers = {"Authorization": f"Bearer {PARAGON_USER_TOKEN}"}
    
    resp = requests.get(url, headers=headers)
    json_resp = resp.json()
    actions = json_resp.get("actions", [])
    errors = json_resp.get("errors", [])

    if not actions:
        print("Failed to fetch Paragon actions or encountered errors:")
        print(errors)
        return

    tools = []
    for integration in actions:
        integration_actions = actions.get(integration)
        for action in integration_actions:
            func_def = action["function"]
            tool_name = func_def["name"]
            tool_description = func_def["description"]

            paragon_tool = ActionKitTool(
                name=tool_name,
                description=tool_description,
                action_name=tool_name,
                paragon_token=PARAGON_USER_TOKEN
            )
            tools.append(paragon_tool)

    llm = ChatOpenAI(
        openai_api_key=OPENAI_API_KEY,
        model_name="o1"
    )
    
    def chatbot(state: State):
        return {"messages": [llm.bind_tools(tools).invoke(state["messages"])]}
    
    graph_builder.add_node("chatbot", chatbot)
    tools_node = ToolNode(tools=tools)
    graph_builder.add_node("tools", tools_node)
    graph_builder.add_conditional_edges(
        "chatbot",
        tools_condition,
    )
    graph_builder.add_edge("tools", "chatbot")
    graph_builder.add_edge(START, "chatbot")

    graph = graph_builder.compile()

    def stream_graph_updates(user_input: str):
        for event in graph.stream({"messages": [{"role": "user", "content": user_input}]}):
            for value in event.values():
                print("Assistant:", value["messages"][-1].content)

    while True:
        try:
            user_input = input("User: ")
            if user_input.lower() in ["quit", "exit", "q"]:
                print("Goodbye!")
                break

            stream_graph_updates(user_input)
        except:
            # fallback if input() is not available
            user_input = "What do you know about LangGraph?"
            print("User: " + user_input)
            stream_graph_updates(user_input)
            break

if __name__ == "__main__":
    main()
```

### Other implementations

If you’re not using TypeScript, you can pass the JSON Schema specs from the ActionKit to the request to your LLM. Here is an example in Python with OpenAI’s library:

```py Loading ActionKit tools for OpenAI client library expandable
import requests
from openai import OpenAI
client = OpenAI()

actions_url = f"https://actionkit.useparagon.com/projects/{project_id}/actions"
actions_auth_header = {
	"Authorization": f"Bearer {user_token}"
}
get_actions_params = {
    "format": "json_schema",
    "categories": "crm,project_management"
}

response = requests.get(actions_url, params=params, headers=actions_auth_header)
paragon_tools = response.json()

messages = [{"role": "user", "content": "Help me create a Jira ticket"}]
completion = client.chat.completions.create(
  model="gpt-4o",
  messages=messages,
  tools=paragon_tools["actions"],
  tool_choice="auto"
)
```

When passing the specs directly, you will also need to respond to the agent’s request to use a tool and route it to the ActionKit:

```py Calling ActionKit tools with OpenAI client library expandable
message = completion["choices"][0]["message"]

if message.get("function_call"):
    function_name = message["function_call"]["name"]
    arguments = json.loads(message["function_call"]["arguments"])
    
    # Check if this tool uses ActionKit
    if any(tool["name"] == function_name for tool in paragon_tools["actions"]):
        run_actions_body = {
            "action": function_name,
            "parameters": arguments
        }

        # Run Action
        response = requests.post(actions_url, body=run_actions_body, headers=actions_auth_header)
        result = response.json()
        messages.append({
            "role": "function",
            "name": function_name,
            "content": json.dumps(result)
        })

        # Return to chat with tool result
        completion = client.chat.completions.create(
            model="gpt-4o",
            messages=messages,
            tools=paragon_tools,
            tool_choice="auto"
        )
```


# Logs and Errors
Source: https://docs.useparagon.com/actionkit/actionkit-logs

Search, view, and trace logs for all of your ActionKit requests.

## Overview

Quickly search, view, and trace through logs of your ActionKit calls in Task History. The Actions tab within Task History provides a timeline of all ActionKit usage, including all *List Actions* and *Run Action* requests.

With ActionKit Logs:

* Understand how your AI agent is performing ActionKit calls on behalf of your users.
* Investigate why Action calls fail for particular Connected Users.
* Discover which ActionKits requests your users are utilizing and the parameters used to make those requests.

<Info>
  ActionKit Logs are currently in beta. While in beta, Logs are subject to deletion and their contents may change.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202025-02-24%20at%2016.22.07@2x.png?maxW=3680&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=daa7d05de832bea906763fcefdd946ce" alt="" width="3680" height="2382" data-path="assets/CleanShot 2025-02-24 at 16.22.07@2x.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202025-02-24%20at%2016.22.07@2x.png?w=280&maxW=3680&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f1e6879a50755335bc9ad26f306cdfe7 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202025-02-24%20at%2016.22.07@2x.png?w=560&maxW=3680&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=db555368aba19db98fc984d32e1e921d 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202025-02-24%20at%2016.22.07@2x.png?w=840&maxW=3680&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f2d388cba9b80a1b7db104dcc941e8cf 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202025-02-24%20at%2016.22.07@2x.png?w=1100&maxW=3680&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=cb8ab95355b91f8e6794f85f3f2eef11 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202025-02-24%20at%2016.22.07@2x.png?w=1650&maxW=3680&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c7019be884984930959009959a830b5d 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202025-02-24%20at%2016.22.07@2x.png?w=2500&maxW=3680&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e99bd28335cdecb317d9c0eb282a457a 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Filtering

Filters allow you to view the history of specific requests that meet criteria, including:

* **User ID**

* **Integration name**

* **Status**
  * Success
  * Errored

* **Action name**

* **Trace ID**

  * When an ActionKit request errors, a trace or `requestId` is returned via the API response. Provide this ID to filter for the request.

  ```json
  // Sameple ActionKit error response with a requestId
  {
    "message": "{\"message\":\"Unable to update Task\",\"details\":{\"err\":\"Team not authorized\",\"ECODE\":\"OAUTH_027\"}}",
    "code": "41070",
    "status": 500,
    "meta": {
      "requestId": "4c7445d2-1972-4ed6-9e47-46053bf1d45f"
    }
  }
  ```

* **Date range**

  * Filter by the date the ActionKit request was received by Paragon.

Clicking into an Action call opens a Log Trace view, which shows the underlying logs of an ActionKit call.

## Log Trace

The Log Trace view shows logs from your ActionKit request. These logs display information about the initial HTTP request received by Paragon, events within Paragon's system, and any API requests made to the integration providers.

With Log Trace:

* Clicking into a log shows additional information such as an integration API `response` , error messages, and HTTP status codes.
* The `body` of API requests are displayed only in logs classified with an *Error* severity level. All other logs do not retain the contents of the body.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Area.gif?maxW=1180&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=01b9321919104812c8e0037a6ea5b2ce" alt="" width="1180" height="720" data-path="assets/Area.gif" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Area.gif?w=280&maxW=1180&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=6265ce3daa0fa745a4f6acd0e2c0126c 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Area.gif?w=560&maxW=1180&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f33423b5ae0ea2024cffe85800bab8e8 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Area.gif?w=840&maxW=1180&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=93560e709c10bbeb29f9b23b070bfd87 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Area.gif?w=1100&maxW=1180&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3b6ca5078afe389cf56b95559fb730ba 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Area.gif?w=1650&maxW=1180&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=76d45797b9ed0226aa964e668c6ccad1 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Area.gif?w=2500&maxW=1180&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3f317128c3c136b04be87fa4b4703986 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Log Behaviors and Limitations

* ActionKit Logs are automatically refreshed and displayed every 60 seconds.
* Each request to `POST /actions` and `GET /actions` is an ActionKit request and is assigned a unique Trace ID.
* ActionKit Logs are retained for 30 days.


# AI Agent Playground
Source: https://docs.useparagon.com/actionkit/actionkit-playground

Try ActionKit in the AI Agent Playground, a sandbox to test chatting with an agent that has access to ActionKit tools.

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/%5BActions%20Playground%5D%202025-01-09%20at%2004.33.42%20PM@2x.png?maxW=3034&auto=format&n=867oBBVpxd2C3zc4&q=85&s=e123ba2db6e07fb8af79da6eb77385eb" alt="" width="3034" height="2166" data-path="assets/[Actions Playground] 2025-01-09 at 04.33.42 PM@2x.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/%5BActions%20Playground%5D%202025-01-09%20at%2004.33.42%20PM@2x.png?w=280&maxW=3034&auto=format&n=867oBBVpxd2C3zc4&q=85&s=f80efec630ec8d21aa2a9f89b5f00f60 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/%5BActions%20Playground%5D%202025-01-09%20at%2004.33.42%20PM@2x.png?w=560&maxW=3034&auto=format&n=867oBBVpxd2C3zc4&q=85&s=04af8ec2770111a63c7128343754899b 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/%5BActions%20Playground%5D%202025-01-09%20at%2004.33.42%20PM@2x.png?w=840&maxW=3034&auto=format&n=867oBBVpxd2C3zc4&q=85&s=be097c0155b18b4a34c8d9a432d48c08 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/%5BActions%20Playground%5D%202025-01-09%20at%2004.33.42%20PM@2x.png?w=1100&maxW=3034&auto=format&n=867oBBVpxd2C3zc4&q=85&s=5e395d2285e622bc70fcc666014f9f65 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/%5BActions%20Playground%5D%202025-01-09%20at%2004.33.42%20PM@2x.png?w=1650&maxW=3034&auto=format&n=867oBBVpxd2C3zc4&q=85&s=f7a3090516b8e0236a280ba2991b7839 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/%5BActions%20Playground%5D%202025-01-09%20at%2004.33.42%20PM@2x.png?w=2500&maxW=3034&auto=format&n=867oBBVpxd2C3zc4&q=85&s=c2959f5b5e45cbe1c93cb06f1355580c 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Info>
  **Get the source on GitHub**

  Find the source code for AI Agent Playground on our [GitHub repository](https://github.com/useparagon/actionkit-playground).
</Info>

## Setup

To run the AI Agent Playground locally, you will need the following:

* [Node.js](https://nodejs.org/en) ≥ v22 and `pnpm` available in \$PATH ([Install instructions](https://pnpm.io/installation))
* OpenAI API Key
* Paragon Project ID and [Signing Key](/getting-started/installing-the-connect-sdk#setup)

<Accordion title="How do I find my Project ID?">
  You can copy your Project ID by clicking Copy Project ID under the Environment switcher:

  <Frame>
        <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=b37df23ba6e601c8050b64b4b8c9ffd2" alt="" width="800" height="411" data-path="assets/[Paragon] 2025-02-17 at 10.49.44 PM.gif" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=280&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=8c455cda8182ae718b132f91605ab66d 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=560&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d8269a3bcb11802c13916fa80ba8d60d 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=840&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=74048103991e6f31b8bae1ef2492ac17 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=1100&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d8e3b6984edff98a56d57a4b02480cce 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=1650&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=b1c073034427d24165dbbc0fdf3f0859 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=2500&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d33e7e440d11c010292b163e32f49909 2500w" data-optimize="true" data-opv="2" />
  </Frame>
</Accordion>

Start by cloning the source of Playground locally:

```bash
git clone git@github.com:useparagon/actionkit-playground.git && cd actionkit-playground
```

Install the dependencies with pnpm:

```bash
pnpm install
```

Next, create a local SQLite database by running the migration script:

```bash
pnpm migrate
```

Then, copy the `.env.example` into a `.env.local` file:

```bash
cp .env.example .env.local
```

In the `.env.local` file, provide your values for OPENAI\_API\_KEY, PARAGON\_SIGNING\_KEY, and NEXT\_PUBLIC\_PARAGON\_PROJECT\_ID.

Finally, run Playground:

```bash
pnpm dev
```

Playground will start locally on port 3000 by default.

## Using the Playground

The Playground is intended to help guide development of your own integration-enabled agents.

Try connecting integrations that will be relevant to your customers and iterating on system prompts that reflect the goals of the agents you are building.

Here's how to start using the Playground:

### 1. Connect an account in the sidebar

When you click on an integration, the [Connect Portal](/connect-portal/connect-portal-customization) will appear. In your app, you can place the Connect Portal wherever your users will find integrations.

**Note**: Only [Active integrations](/getting-started/displaying-the-connect-portal#activating-the-integration) that are supported by ActionKit will appear in the sidebar.

### 2. Add Actions to the chat

Once you have connected an integration account, you can add Actions to a chat by expanding the integration in the sidebar and clicking the checkmark next to the action name.

In your app, you can control what Actions a chat has access to with your own application logic.

### 3. Customize system instructions

Write instructions for your agent in the System Instructions input at top of the conversation.

For example: "You are a sales copilot that assists users with doing research on potential prospects and allows them to update their CRM with their findings..."

### 4. Send a chat

Try messaging your agent. When your agent uses a tool, a row will appear to show the tool-calling status, with input and output from the ActionKit API.

To start a new chat with new context, click the top-left navigation menu and select **New chat**. You can also navigate a history of previous chats in the sidebar.

## Troubleshooting

<AccordionGroup>
  <Accordion title="Error: Invalid keyData">
    This means that your Signing Key was not correctly formatted or supplied.

    Make sure that you have a `.env.local` file (copied from `.env.example`) that includes a value for `PARAGON_SIGNING_KEY`. The value should be on one line, separated with `\n`.
  </Accordion>

  <Accordion title="Integrations are not loading">
    Check your browser console (Inspect Element > Console).

    If you are seeing 401 responses from the Paragon API, double-check the values for your `NEXT_PUBLIC_PARAGON_PROJECT_ID` and `PARAGON_SIGNING_KEY`.
  </Accordion>

  <Accordion title="Integrations are not appearing">
    Verify that [ActionKit-compatible integrations](/actionkit/supported-integrations) have been added to your Paragon project and are [Active](/getting-started/displaying-the-connect-portal#activating-the-integration).
  </Accordion>

  <Accordion title="Error generating response. An unknown error occurred.">
    Check the shell/terminal window where you are running `pnpm dev` to see any possible errors.

    If you are getting rate limit errors associated with your OpenAI account, the chat may stop or fail to save once the conversation reaches a certain length, or if you select too many tools at once.

    * **Resolution:** Keep message contents smaller in size and restrict tools to only those that are necessary to a given message.
  </Accordion>
</AccordionGroup>


# API Reference
Source: https://docs.useparagon.com/actionkit/api-reference

Reference for API endpoints available in ActionKit.

## Authorization

**Base URL**

```js
https://actionkit.useparagon.com/projects/[Project ID]
```

<Accordion title="For on-premise instances">
  ```js
  https://worker-actionkit.[On-Prem Base URL]/projects/[Project ID]
  ```
</Accordion>

**Authentication**

To authenticate to ActionKit API, present a Bearer token with the Paragon User Token (a JWT):

```js
Authorization: Bearer [Paragon User Token]
```

This is the same token that you used to call `.authenticate` with the Paragon SDK. See examples in [Installing the SDK](/getting-started/installing-the-connect-sdk).

## Endpoints

### List Actions

Every Connected User will have access to different Actions, depending on what Integrations you have enabled in your project and what accounts they have connected. You can list available Actions using the `GET /actions` endpoint.

<Info>
  **The schema returned by Actions may be user-specific.** For example, if the user has custom fields defined for Salesforce Opportunities, they will appear in their version of the `SALESFORCE_CREATE_RECORD_OPPORTUNITY` Action schema.
</Info>

**URL**

```bash
GET /actions
```

**Parameters**

| Key                      | Description                                                                                                                                                                                                                                                                                                                                             | Default       |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| **format**               | The response format for available actions. <br /><br /> Defaults to `json_schema` for tool-calling agent use cases. Learn more about [available formats](/actionkit/schema-formats).                                                                                                                                                                    | `json_schema` |
| **limit\_to\_available** | If `true`, only `available_actions` will be returned. <br />Otherwise, `all_actions` will include all Actions from Integrations in your project, regardless of the accounts your user has connected.                                                                                                                                                    | `true`        |
| **reload\_fields**       | If `true`, forcibly reload any custom fields that belong to the schema for included Actions. This may result in additional latency added to your request. <br /><br />By default, Paragon will cache your user’s fields and refresh them periodically. Fields have a TTL of 8 hours, and `reload_fields` will immediately invalidate any cached fields. | `false`       |
| **integrations**         | Filter by specific integrations that the user has connected. By default, all integrations are returned. <br />Example: <br /> `salesforce,hubspot`                                                                                                                                                                                                      |               |
| **categories**           | Filter by specific integration categories, based on integrations the user has connected. By default, all integrations from all categories are returned. <br />Example: <br /> `crm,project_management`                                                                                                                                                  |               |

**Output**

| Key     | Description                                                                                      |
| ------- | ------------------------------------------------------------------------------------------------ |
| actions | A map of integrations with a list of Action definitions, in the selected format.                 |
| errors  | An array of errors, if there were any problems loading Action definitions for some integrations. |

<Accordion title="Example response">
  ```json
  {
    "actions": {
      "hubspot": [{
        "type": "function",
        "function": {
          "name": "HUBSPOT_CREATE_RECORD_CONTACTS",
          "description": "Create a contact in HubSpot CRM",
          "parameters": {
            "type": "object",
            "properties": {
              "field-email": {
                "type": "string",
                "description": "Email"
              },
              "field-firstname": {
                "type": "string",
                "description": "First Name"
              },
              "field-lastname": {
                "type": "string",
                "description": "Last Name"
              },
              "field-jobtitle": {
                "type": "string",
                "description": "Job Title"
              },
              "field-company": {
                "type": "string",
                "description": "Company Name"
              },
              "field-hubspot_owner_id": {
                "type": "string",
                "description": "Contact Owner: The HubSpot user who is assigned to this contact. Use Connect Portal Workflow Settings to allow users to select an Owner. (example value: \\"{{settings.owner}}\\")"
              },
              "field-lifecyclestage": {
                "type": "string",
                "description": "Lifecycle Stage: Defaults to the user’s first Lifecycle Stage if not provided. Use Connect Portal Workflow Settings to allow users to select a Lifecycle Stage. (example value: \\"{{settings.lifecycleStage}}\\")"
              },
              "field-hs_lead_status": {
                "type": "string",
                "description": "Lead Status: Defaults to the user’s first Lead Status if not provided. Use Connect Portal Workflow Settings to allow users to select a Lead Status. (example value: \\"{{settings.leadStatus}}\\")"
              },
              "additionalFieldsJSON": {
                "type": "string",
                "description": "Additional Fields: Specify any other fields that should be updated in JSON below. Use Connect Portal Workflow Settings to allow users to select which Contact fields to update. (example value: \\"{\\n  \\"property_number\\": \\"17\\",\\n  \\"property_dropdown\\": \\"choice_b\\",\\n  \\"property_radio\\": \\"option_1\\",\\n  \\"property_string\\": \\"value\\",\\n  \\"property_date\\": \\"1572480000000\\"\\n}\\")"
              }
            },
            "required": [
              "recordType",
              "field-email"
            ],
            "additionalProperties": false,
            "$schema": "<http://json-schema.org/draft-07/schema#>"
          }
        }
      }]
    },
    "errors": []
  }
  ```
</Accordion>

### Run Action

To run an Action, call the Run Actions endpoint with the required parameters.

**URL**

```bash
POST /actions
```

**Request body**

```json
{
    "action": "SLACK_SEND_MESSAGE",
    "parameters": {
        "channel": "#general",
        "message": "Hello world!"
    }
}
```

<Accordion title="Example response">
  Note: Responses will vary by integration provider. Paragon returns the API response of the last request that was used to run this Action.

  ```json
  {
      "ok": true,
      "channel": "CSQCUNXBP",
      "ts": "1739896301.418839",
      "message": {
          "user": "U0101SYAC07",
          "type": "message",
          "ts": "1739896301.418839",
          "bot_id": "B0101SYAB3R",
          "app_id": "A01001G1G7J",
          "text": "test",
          "team": "TM7FL705V",
          "bot_profile": {
              "id": "B0101SYAB3R",
              "app_id": "A01001G1G7J",
              "name": "Paragon",
              "icons": {
                  "image_36": "https://avatars.slack-edge.com/2020-03-24/1022919802484_c4af0a8de9e9c25f4b58_36.png",
                  "image_48": "https://avatars.slack-edge.com/2020-03-24/1022919802484_c4af0a8de9e9c25f4b58_48.png",
                  "image_72": "https://avatars.slack-edge.com/2020-03-24/1022919802484_c4af0a8de9e9c25f4b58_72.png"
              },
              "deleted": false,
              "updated": 1587073960,
              "team_id": "TM7FL705V"
          },
          "blocks": [
              {
                  "type": "section",
                  "block_id": "iAHFB",
                  "text": {
                      "type": "mrkdwn",
                      "text": "test",
                      "verbatim": false
                  }
              }
          ]
      },
      "response_metadata": {
          "scopes": [
              "app_mentions:read",
              "chat:write",
              "chat:write.public",
              "channels:read",
              "reactions:write",
              "chat:write.customize",
              "im:read",
              "im:write",
              "users:read",
              "groups:read",
              "channels:manage",
              "groups:write",
              "mpim:write",
              "team:read",
              "channels:history",
              "users:read.email",
              "files:read",
              "files:write"
          ],
          "acceptedScopes": [
              "chat:write"
          ]
      }
  }
  ```
</Accordion>

<Accordion title="Example Error">
  ```json
  {
      "message": "Your authorization token has expired.",
      "code": "7203",
      "status": 401,
      "meta": {
          "projectId": "ddcd1f1a-440d-4d48-97ab-44878b77f800"
      }
  }
  ```
</Accordion>


# Getting Started
Source: https://docs.useparagon.com/actionkit/getting-started

Get started with the ActionKit API.

<Tip>
  **Need help getting started with ActionKit?** Schedule a personalized onboarding with our Product team [here](https://useparagon.com/book-demo-actionkit).
</Tip>

To use ActionKit, you will need to have set up the following:

### 1. Add the Paragon SDK to your app

See [Installing the SDK](/getting-started/installing-the-connect-sdk) for adding the Paragon SDK to your app. With the SDK, you can prompt users to connect their accounts inside of your app using the [Connect Portal](/connect-portal/connect-portal-customization).

Alternatively, you can use one of the below options for testing or development purposes:

* [Hosted Demo Environment](/demo): an in-browser implementation of the SDK to test connecting accounts to your integrations
* [ActionKit Playground](/actionkit/actionkit-playground): an open-source sandbox to test chatting with an agent that has access to ActionKit tools

### 2. Activate an integration in your Paragon project

You can add and configure an integration by visiting the Catalog page in your Paragon dashboard (see [Adding Integrations](/getting-started/adding-an-integration)).

See [Supported Integrations](/actionkit/supported-integrations) for integrations currently supported in ActionKit.

### 3. Connect an account

Use your app (or Playground or demo.useparagon.com) to connect an account (e.g. a Salesforce account) using the Connect Portal.

<Info>
  If you are having issues connecting an account, you may need to add your own OAuth app credentials.

  See [Connect your developer app to Paragon](/getting-started/adding-an-integration#connect-your-developer-app-to-paragon).
</Info>

Once an account is connected, you can start testing [the ActionKit API](/actionkit/api-reference) with the user ID that you are testing with.

If you are running the Playground locally, the ID is `playground.local-static-user`.

## Usage

ActionKit is available as an API, so you can use it directly from your app or with any LLM that supports tool/function calling:

<Card title="API Reference" icon="book" href="/actionkit/api-reference" arrow horizontal>
  See all available API endpoints in ActionKit
</Card>

ActionKit is also available as a self-hosted MCP for AI agent implementations. Learn more in the [open-source repo](https://github.com/useparagon/paragon-mcp).


# Experience Manager Create Asset Rendition
Source: https://docs.useparagon.com/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_CREATE_ASSET_RENDITION

actionkit/openapi.json post /projects/{project_id}/actions/#ADOBE_EXPERIENCE_MANAGER_CREATE_ASSET_RENDITION



# Experience Manager Create Folder
Source: https://docs.useparagon.com/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_CREATE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#ADOBE_EXPERIENCE_MANAGER_CREATE_FOLDER



# Experience Manager Delete Asset
Source: https://docs.useparagon.com/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_DELETE_ASSET

actionkit/openapi.json post /projects/{project_id}/actions/#ADOBE_EXPERIENCE_MANAGER_DELETE_ASSET



# Experience Manager Delete Asset Rendition
Source: https://docs.useparagon.com/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_DELETE_ASSET_RENDITION

actionkit/openapi.json post /projects/{project_id}/actions/#ADOBE_EXPERIENCE_MANAGER_DELETE_ASSET_RENDITION



# Experience Manager Delete Folder
Source: https://docs.useparagon.com/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_DELETE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#ADOBE_EXPERIENCE_MANAGER_DELETE_FOLDER



# Experience Manager Update Asset Rendition
Source: https://docs.useparagon.com/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_UPDATE_ASSET_RENDITION

actionkit/openapi.json post /projects/{project_id}/actions/#ADOBE_EXPERIENCE_MANAGER_UPDATE_ASSET_RENDITION



# Add Task To Section
Source: https://docs.useparagon.com/actionkit/integrations/asana/ASANA_ADD_TASK_TO_SECTION

actionkit/openapi.json post /projects/{project_id}/actions/#ASANA_ADD_TASK_TO_SECTION



# Create Comment
Source: https://docs.useparagon.com/actionkit/integrations/asana/ASANA_CREATE_COMMENT

actionkit/openapi.json post /projects/{project_id}/actions/#ASANA_CREATE_COMMENT



# Create Project
Source: https://docs.useparagon.com/actionkit/integrations/asana/ASANA_CREATE_PROJECT

actionkit/openapi.json post /projects/{project_id}/actions/#ASANA_CREATE_PROJECT



# Create Task
Source: https://docs.useparagon.com/actionkit/integrations/asana/ASANA_CREATE_TASK

actionkit/openapi.json post /projects/{project_id}/actions/#ASANA_CREATE_TASK



# Get Projects
Source: https://docs.useparagon.com/actionkit/integrations/asana/ASANA_GET_PROJECTS

actionkit/openapi.json post /projects/{project_id}/actions/#ASANA_GET_PROJECTS



# Get Project By ID
Source: https://docs.useparagon.com/actionkit/integrations/asana/ASANA_GET_PROJECT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#ASANA_GET_PROJECT_BY_ID



# Get Tasks
Source: https://docs.useparagon.com/actionkit/integrations/asana/ASANA_GET_TASKS

actionkit/openapi.json post /projects/{project_id}/actions/#ASANA_GET_TASKS



# Get Tasks By ID
Source: https://docs.useparagon.com/actionkit/integrations/asana/ASANA_GET_TASKS_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#ASANA_GET_TASKS_BY_ID



# Get Task By External ID
Source: https://docs.useparagon.com/actionkit/integrations/asana/ASANA_GET_TASK_BY_EXTERNAL_ID

actionkit/openapi.json post /projects/{project_id}/actions/#ASANA_GET_TASK_BY_EXTERNAL_ID



# Get Teams
Source: https://docs.useparagon.com/actionkit/integrations/asana/ASANA_GET_TEAMS

actionkit/openapi.json post /projects/{project_id}/actions/#ASANA_GET_TEAMS



# Get Workspaces
Source: https://docs.useparagon.com/actionkit/integrations/asana/ASANA_GET_WORKSPACES

actionkit/openapi.json post /projects/{project_id}/actions/#ASANA_GET_WORKSPACES



# Update Task
Source: https://docs.useparagon.com/actionkit/integrations/asana/ASANA_UPDATE_TASK

actionkit/openapi.json post /projects/{project_id}/actions/#ASANA_UPDATE_TASK



# Devops Create Workitem
Source: https://docs.useparagon.com/actionkit/integrations/azuredevops/AZURE_DEVOPS_CREATE_WORKITEM

actionkit/openapi.json post /projects/{project_id}/actions/#AZURE_DEVOPS_CREATE_WORKITEM



# Devops Delete Workitem
Source: https://docs.useparagon.com/actionkit/integrations/azuredevops/AZURE_DEVOPS_DELETE_WORKITEM

actionkit/openapi.json post /projects/{project_id}/actions/#AZURE_DEVOPS_DELETE_WORKITEM



# Devops Search Workitems
Source: https://docs.useparagon.com/actionkit/integrations/azuredevops/AZURE_DEVOPS_SEARCH_WORKITEMS

actionkit/openapi.json post /projects/{project_id}/actions/#AZURE_DEVOPS_SEARCH_WORKITEMS



# Devops Update Workitem
Source: https://docs.useparagon.com/actionkit/integrations/azuredevops/AZURE_DEVOPS_UPDATE_WORKITEM

actionkit/openapi.json post /projects/{project_id}/actions/#AZURE_DEVOPS_UPDATE_WORKITEM



# Hr Add List Field Value
Source: https://docs.useparagon.com/actionkit/integrations/bamboohr/BAMBOO_HR_ADD_LIST_FIELD_VALUE

actionkit/openapi.json post /projects/{project_id}/actions/#BAMBOO_HR_ADD_LIST_FIELD_VALUE



# Hr Adjust Time Off Balance For Employee
Source: https://docs.useparagon.com/actionkit/integrations/bamboohr/BAMBOO_HR_ADJUST_TIME_OFF_BALANCE_FOR_EMPLOYEE

actionkit/openapi.json post /projects/{project_id}/actions/#BAMBOO_HR_ADJUST_TIME_OFF_BALANCE_FOR_EMPLOYEE



# Hr Change Request Status
Source: https://docs.useparagon.com/actionkit/integrations/bamboohr/BAMBOO_HR_CHANGE_REQUEST_STATUS

actionkit/openapi.json post /projects/{project_id}/actions/#BAMBOO_HR_CHANGE_REQUEST_STATUS



# Hr Create Employee
Source: https://docs.useparagon.com/actionkit/integrations/bamboohr/BAMBOO_HR_CREATE_EMPLOYEE

actionkit/openapi.json post /projects/{project_id}/actions/#BAMBOO_HR_CREATE_EMPLOYEE



# Hr Create Time Off Request
Source: https://docs.useparagon.com/actionkit/integrations/bamboohr/BAMBOO_HR_CREATE_TIME_OFF_REQUEST

actionkit/openapi.json post /projects/{project_id}/actions/#BAMBOO_HR_CREATE_TIME_OFF_REQUEST



# Hr Get Employee By ID
Source: https://docs.useparagon.com/actionkit/integrations/bamboohr/BAMBOO_HR_GET_EMPLOYEE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#BAMBOO_HR_GET_EMPLOYEE_BY_ID



# Hr Get Employee Directory
Source: https://docs.useparagon.com/actionkit/integrations/bamboohr/BAMBOO_HR_GET_EMPLOYEE_DIRECTORY

actionkit/openapi.json post /projects/{project_id}/actions/#BAMBOO_HR_GET_EMPLOYEE_DIRECTORY



# Hr Get Field List
Source: https://docs.useparagon.com/actionkit/integrations/bamboohr/BAMBOO_HR_GET_FIELD_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#BAMBOO_HR_GET_FIELD_LIST



# Hr Get Time Off Requests For Employee
Source: https://docs.useparagon.com/actionkit/integrations/bamboohr/BAMBOO_HR_GET_TIME_OFF_REQUESTS_FOR_EMPLOYEE

actionkit/openapi.json post /projects/{project_id}/actions/#BAMBOO_HR_GET_TIME_OFF_REQUESTS_FOR_EMPLOYEE



# Hr Get Time Off Types
Source: https://docs.useparagon.com/actionkit/integrations/bamboohr/BAMBOO_HR_GET_TIME_OFF_TYPES

actionkit/openapi.json post /projects/{project_id}/actions/#BAMBOO_HR_GET_TIME_OFF_TYPES



# Hr Update Employee
Source: https://docs.useparagon.com/actionkit/integrations/bamboohr/BAMBOO_HR_UPDATE_EMPLOYEE

actionkit/openapi.json post /projects/{project_id}/actions/#BAMBOO_HR_UPDATE_EMPLOYEE



# Create Folder
Source: https://docs.useparagon.com/actionkit/integrations/box/BOX_CREATE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#BOX_CREATE_FOLDER



# Delete Folder
Source: https://docs.useparagon.com/actionkit/integrations/box/BOX_DELETE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#BOX_DELETE_FOLDER



# Get File By ID
Source: https://docs.useparagon.com/actionkit/integrations/box/BOX_GET_FILE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#BOX_GET_FILE_BY_ID



# Get Folder By ID
Source: https://docs.useparagon.com/actionkit/integrations/box/BOX_GET_FOLDER_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#BOX_GET_FOLDER_BY_ID



# List Files
Source: https://docs.useparagon.com/actionkit/integrations/box/BOX_LIST_FILES

actionkit/openapi.json post /projects/{project_id}/actions/#BOX_LIST_FILES



# Move Folder
Source: https://docs.useparagon.com/actionkit/integrations/box/BOX_MOVE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#BOX_MOVE_FOLDER



# Save File
Source: https://docs.useparagon.com/actionkit/integrations/box/BOX_SAVE_FILE

actionkit/openapi.json post /projects/{project_id}/actions/#BOX_SAVE_FILE



# Save File From Object
Source: https://docs.useparagon.com/actionkit/integrations/box/BOX_SAVE_FILE_FROM_OBJECT

actionkit/openapi.json post /projects/{project_id}/actions/#BOX_SAVE_FILE_FROM_OBJECT



# Search Folders
Source: https://docs.useparagon.com/actionkit/integrations/box/BOX_SEARCH_FOLDERS

actionkit/openapi.json post /projects/{project_id}/actions/#BOX_SEARCH_FOLDERS



# Cancel Event
Source: https://docs.useparagon.com/actionkit/integrations/calendly/CALENDLY_CANCEL_EVENT

actionkit/openapi.json post /projects/{project_id}/actions/#CALENDLY_CANCEL_EVENT



# Get Available Times For Event Type
Source: https://docs.useparagon.com/actionkit/integrations/calendly/CALENDLY_GET_AVAILABLE_TIMES_FOR_EVENT_TYPE

actionkit/openapi.json post /projects/{project_id}/actions/#CALENDLY_GET_AVAILABLE_TIMES_FOR_EVENT_TYPE



# Get Event By ID
Source: https://docs.useparagon.com/actionkit/integrations/calendly/CALENDLY_GET_EVENT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#CALENDLY_GET_EVENT_BY_ID



# Get Event Invitees
Source: https://docs.useparagon.com/actionkit/integrations/calendly/CALENDLY_GET_EVENT_INVITEES

actionkit/openapi.json post /projects/{project_id}/actions/#CALENDLY_GET_EVENT_INVITEES



# Get Event Types
Source: https://docs.useparagon.com/actionkit/integrations/calendly/CALENDLY_GET_EVENT_TYPES

actionkit/openapi.json post /projects/{project_id}/actions/#CALENDLY_GET_EVENT_TYPES



# Search Events
Source: https://docs.useparagon.com/actionkit/integrations/calendly/CALENDLY_SEARCH_EVENTS

actionkit/openapi.json post /projects/{project_id}/actions/#CALENDLY_SEARCH_EVENTS



# Create Task
Source: https://docs.useparagon.com/actionkit/integrations/clickup/CLICKUP_CREATE_TASK

actionkit/openapi.json post /projects/{project_id}/actions/#CLICKUP_CREATE_TASK



# Delete Task
Source: https://docs.useparagon.com/actionkit/integrations/clickup/CLICKUP_DELETE_TASK

actionkit/openapi.json post /projects/{project_id}/actions/#CLICKUP_DELETE_TASK



# Get All Fields In List
Source: https://docs.useparagon.com/actionkit/integrations/clickup/CLICKUP_GET_ALL_FIELDS_IN_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#CLICKUP_GET_ALL_FIELDS_IN_LIST



# Get Custom Fields In List
Source: https://docs.useparagon.com/actionkit/integrations/clickup/CLICKUP_GET_CUSTOM_FIELDS_IN_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#CLICKUP_GET_CUSTOM_FIELDS_IN_LIST



# Get Folders
Source: https://docs.useparagon.com/actionkit/integrations/clickup/CLICKUP_GET_FOLDERS

actionkit/openapi.json post /projects/{project_id}/actions/#CLICKUP_GET_FOLDERS



# Get List
Source: https://docs.useparagon.com/actionkit/integrations/clickup/CLICKUP_GET_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#CLICKUP_GET_LIST



# Get Member
Source: https://docs.useparagon.com/actionkit/integrations/clickup/CLICKUP_GET_MEMBER

actionkit/openapi.json post /projects/{project_id}/actions/#CLICKUP_GET_MEMBER



# Get Space
Source: https://docs.useparagon.com/actionkit/integrations/clickup/CLICKUP_GET_SPACE

actionkit/openapi.json post /projects/{project_id}/actions/#CLICKUP_GET_SPACE



# Get Task In List
Source: https://docs.useparagon.com/actionkit/integrations/clickup/CLICKUP_GET_TASK_IN_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#CLICKUP_GET_TASK_IN_LIST



# Search Tasks
Source: https://docs.useparagon.com/actionkit/integrations/clickup/CLICKUP_SEARCH_TASKS

actionkit/openapi.json post /projects/{project_id}/actions/#CLICKUP_SEARCH_TASKS



# Update Task
Source: https://docs.useparagon.com/actionkit/integrations/clickup/CLICKUP_UPDATE_TASK

actionkit/openapi.json post /projects/{project_id}/actions/#CLICKUP_UPDATE_TASK



# Create Document
Source: https://docs.useparagon.com/actionkit/integrations/coda/CODA_CREATE_DOCUMENT

actionkit/openapi.json post /projects/{project_id}/actions/#CODA_CREATE_DOCUMENT



# Delete Document
Source: https://docs.useparagon.com/actionkit/integrations/coda/CODA_DELETE_DOCUMENT

actionkit/openapi.json post /projects/{project_id}/actions/#CODA_DELETE_DOCUMENT



# Get Document By ID
Source: https://docs.useparagon.com/actionkit/integrations/coda/CODA_GET_DOCUMENT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#CODA_GET_DOCUMENT_BY_ID



# Get Table By ID
Source: https://docs.useparagon.com/actionkit/integrations/coda/CODA_GET_TABLE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#CODA_GET_TABLE_BY_ID



# Search Documents
Source: https://docs.useparagon.com/actionkit/integrations/coda/CODA_SEARCH_DOCUMENTS

actionkit/openapi.json post /projects/{project_id}/actions/#CODA_SEARCH_DOCUMENTS



# Search Tables
Source: https://docs.useparagon.com/actionkit/integrations/coda/CODA_SEARCH_TABLES

actionkit/openapi.json post /projects/{project_id}/actions/#CODA_SEARCH_TABLES



# Create Page
Source: https://docs.useparagon.com/actionkit/integrations/confluence/CONFLUENCE_CREATE_PAGE

actionkit/openapi.json post /projects/{project_id}/actions/#CONFLUENCE_CREATE_PAGE



# Delete Page
Source: https://docs.useparagon.com/actionkit/integrations/confluence/CONFLUENCE_DELETE_PAGE

actionkit/openapi.json post /projects/{project_id}/actions/#CONFLUENCE_DELETE_PAGE



# Get Blog Posts
Source: https://docs.useparagon.com/actionkit/integrations/confluence/CONFLUENCE_GET_BLOG_POSTS

actionkit/openapi.json post /projects/{project_id}/actions/#CONFLUENCE_GET_BLOG_POSTS



# Get Pages By Label
Source: https://docs.useparagon.com/actionkit/integrations/confluence/CONFLUENCE_GET_PAGES_BY_LABEL

actionkit/openapi.json post /projects/{project_id}/actions/#CONFLUENCE_GET_PAGES_BY_LABEL



# Get Pages In Space
Source: https://docs.useparagon.com/actionkit/integrations/confluence/CONFLUENCE_GET_PAGES_IN_SPACE

actionkit/openapi.json post /projects/{project_id}/actions/#CONFLUENCE_GET_PAGES_IN_SPACE



# Get Page By ID
Source: https://docs.useparagon.com/actionkit/integrations/confluence/CONFLUENCE_GET_PAGE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#CONFLUENCE_GET_PAGE_BY_ID



# Get Space By ID
Source: https://docs.useparagon.com/actionkit/integrations/confluence/CONFLUENCE_GET_SPACE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#CONFLUENCE_GET_SPACE_BY_ID



# Search Pages
Source: https://docs.useparagon.com/actionkit/integrations/confluence/CONFLUENCE_SEARCH_PAGES

actionkit/openapi.json post /projects/{project_id}/actions/#CONFLUENCE_SEARCH_PAGES



# Search Spaces
Source: https://docs.useparagon.com/actionkit/integrations/confluence/CONFLUENCE_SEARCH_SPACES

actionkit/openapi.json post /projects/{project_id}/actions/#CONFLUENCE_SEARCH_SPACES



# Update Page
Source: https://docs.useparagon.com/actionkit/integrations/confluence/CONFLUENCE_UPDATE_PAGE

actionkit/openapi.json post /projects/{project_id}/actions/#CONFLUENCE_UPDATE_PAGE



# Create An Envelope
Source: https://docs.useparagon.com/actionkit/integrations/docusign/DOCUSIGN_CREATE_AN_ENVELOPE

actionkit/openapi.json post /projects/{project_id}/actions/#DOCUSIGN_CREATE_AN_ENVELOPE



# Envelope Custom Field
Source: https://docs.useparagon.com/actionkit/integrations/docusign/DOCUSIGN_ENVELOPE_CUSTOM_FIELD

actionkit/openapi.json post /projects/{project_id}/actions/#DOCUSIGN_ENVELOPE_CUSTOM_FIELD



# Get Envelope By ID
Source: https://docs.useparagon.com/actionkit/integrations/docusign/DOCUSIGN_GET_ENVELOPE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#DOCUSIGN_GET_ENVELOPE_BY_ID



# Search Envelopes
Source: https://docs.useparagon.com/actionkit/integrations/docusign/DOCUSIGN_SEARCH_ENVELOPES

actionkit/openapi.json post /projects/{project_id}/actions/#DOCUSIGN_SEARCH_ENVELOPES



# Send An Envelope
Source: https://docs.useparagon.com/actionkit/integrations/docusign/DOCUSIGN_SEND_AN_ENVELOPE

actionkit/openapi.json post /projects/{project_id}/actions/#DOCUSIGN_SEND_AN_ENVELOPE



# Update Envelope
Source: https://docs.useparagon.com/actionkit/integrations/docusign/DOCUSIGN_UPDATE_ENVELOPE

actionkit/openapi.json post /projects/{project_id}/actions/#DOCUSIGN_UPDATE_ENVELOPE



# Create Folder
Source: https://docs.useparagon.com/actionkit/integrations/dropbox/DROPBOX_CREATE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#DROPBOX_CREATE_FOLDER



# Delete Folder
Source: https://docs.useparagon.com/actionkit/integrations/dropbox/DROPBOX_DELETE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#DROPBOX_DELETE_FOLDER



# Get Folder By ID
Source: https://docs.useparagon.com/actionkit/integrations/dropbox/DROPBOX_GET_FOLDER_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#DROPBOX_GET_FOLDER_BY_ID



# List Files
Source: https://docs.useparagon.com/actionkit/integrations/dropbox/DROPBOX_LIST_FILES

actionkit/openapi.json post /projects/{project_id}/actions/#DROPBOX_LIST_FILES



# Move Folder
Source: https://docs.useparagon.com/actionkit/integrations/dropbox/DROPBOX_MOVE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#DROPBOX_MOVE_FOLDER



# Search Folders
Source: https://docs.useparagon.com/actionkit/integrations/dropbox/DROPBOX_SEARCH_FOLDERS

actionkit/openapi.json post /projects/{project_id}/actions/#DROPBOX_SEARCH_FOLDERS



# Sign Cancel Incomplete Signature Request
Source: https://docs.useparagon.com/actionkit/integrations/dropboxsign/DROPBOX_SIGN_CANCEL_INCOMPLETE_SIGNATURE_REQUEST

actionkit/openapi.json post /projects/{project_id}/actions/#DROPBOX_SIGN_CANCEL_INCOMPLETE_SIGNATURE_REQUEST



# Sign Create And Send Signature Request
Source: https://docs.useparagon.com/actionkit/integrations/dropboxsign/DROPBOX_SIGN_CREATE_AND_SEND_SIGNATURE_REQUEST

actionkit/openapi.json post /projects/{project_id}/actions/#DROPBOX_SIGN_CREATE_AND_SEND_SIGNATURE_REQUEST



# Sign Get Signature Request By ID
Source: https://docs.useparagon.com/actionkit/integrations/dropboxsign/DROPBOX_SIGN_GET_SIGNATURE_REQUEST_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#DROPBOX_SIGN_GET_SIGNATURE_REQUEST_BY_ID



# Sign Search Signature Requests
Source: https://docs.useparagon.com/actionkit/integrations/dropboxsign/DROPBOX_SIGN_SEARCH_SIGNATURE_REQUESTS

actionkit/openapi.json post /projects/{project_id}/actions/#DROPBOX_SIGN_SEARCH_SIGNATURE_REQUESTS



# Sign Update Signature Request
Source: https://docs.useparagon.com/actionkit/integrations/dropboxsign/DROPBOX_SIGN_UPDATE_SIGNATURE_REQUEST

actionkit/openapi.json post /projects/{project_id}/actions/#DROPBOX_SIGN_UPDATE_SIGNATURE_REQUEST



# Business Central Create Payment Term
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_CREATE_PAYMENT_TERM

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_CREATE_PAYMENT_TERM



# Business Central Create Purchase Invoice
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_CREATE_PURCHASE_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_CREATE_PURCHASE_INVOICE



# Business Central Create Purchase Invoice Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_CREATE_PURCHASE_INVOICE_LINE_ITEM

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_CREATE_PURCHASE_INVOICE_LINE_ITEM



# Business Central Create Tax Group
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_CREATE_TAX_GROUP

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_CREATE_TAX_GROUP



# Business Central Create Vendor
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_CREATE_VENDOR

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_CREATE_VENDOR



# Business Central Delete Payment Term
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_DELETE_PAYMENT_TERM

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_DELETE_PAYMENT_TERM



# Business Central Delete Purchase Invoice
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_DELETE_PURCHASE_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_DELETE_PURCHASE_INVOICE



# Business Central Delete Purchase Invoice Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_DELETE_PURCHASE_INVOICE_LINE_ITEM

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_DELETE_PURCHASE_INVOICE_LINE_ITEM



# Business Central Delete Tax Group
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_DELETE_TAX_GROUP

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_DELETE_TAX_GROUP



# Business Central Delete Vendor
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_DELETE_VENDOR

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_DELETE_VENDOR



# Business Central Get Accounts
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_ACCOUNTS

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_GET_ACCOUNTS



# Business Central Get Account By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_ACCOUNT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_GET_ACCOUNT_BY_ID



# Business Central Get Payment Term By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_PAYMENT_TERM_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_GET_PAYMENT_TERM_BY_ID



# Business Central Get Purchase Invoice By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_BY_ID



# Business Central Get Purchase Invoice Lines
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_LINES

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_LINES



# Business Central Get Purchase Invoice Line Item By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_LINE_ITEM_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_LINE_ITEM_BY_ID



# Business Central Get Tax Group By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_TAX_GROUP_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_GET_TAX_GROUP_BY_ID



# Business Central Get Vendor By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_VENDOR_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_GET_VENDOR_BY_ID



# Business Central Post Purchase Invoice
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_POST_PURCHASE_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_POST_PURCHASE_INVOICE



# Business Central Search For Purchase Invoice
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_SEARCH_FOR_PURCHASE_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_FOR_PURCHASE_INVOICE



# Business Central Search Payment Term
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_SEARCH_PAYMENT_TERM

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_PAYMENT_TERM



# Business Central Search Purchase Invoice Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_SEARCH_PURCHASE_INVOICE_LINE_ITEM

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_PURCHASE_INVOICE_LINE_ITEM



# Business Central Search Tax Group
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_SEARCH_TAX_GROUP

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_TAX_GROUP



# Business Central Search Vendor
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_SEARCH_VENDOR

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_VENDOR



# Business Central Update Payment Term
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_UPDATE_PAYMENT_TERM

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_PAYMENT_TERM



# Business Central Update Purchase Invoice
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_UPDATE_PURCHASE_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_PURCHASE_INVOICE



# Business Central Update Purchase Invoice Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_UPDATE_PURCHASE_INVOICE_LINE_ITEM

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_PURCHASE_INVOICE_LINE_ITEM



# Business Central Update Tax Group
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_UPDATE_TAX_GROUP

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_TAX_GROUP



# Business Central Update Vendor
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_UPDATE_VENDOR

actionkit/openapi.json post /projects/{project_id}/actions/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_VENDOR



# Activate Campaign
Source: https://docs.useparagon.com/actionkit/integrations/eloqua/ELOQUA_ACTIVATE_CAMPAIGN

actionkit/openapi.json post /projects/{project_id}/actions/#ELOQUA_ACTIVATE_CAMPAIGN



# Create Campaign
Source: https://docs.useparagon.com/actionkit/integrations/eloqua/ELOQUA_CREATE_CAMPAIGN

actionkit/openapi.json post /projects/{project_id}/actions/#ELOQUA_CREATE_CAMPAIGN



# Create Contact
Source: https://docs.useparagon.com/actionkit/integrations/eloqua/ELOQUA_CREATE_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#ELOQUA_CREATE_CONTACT



# Create Email
Source: https://docs.useparagon.com/actionkit/integrations/eloqua/ELOQUA_CREATE_EMAIL

actionkit/openapi.json post /projects/{project_id}/actions/#ELOQUA_CREATE_EMAIL



# Get Campaign By ID
Source: https://docs.useparagon.com/actionkit/integrations/eloqua/ELOQUA_GET_CAMPAIGN_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#ELOQUA_GET_CAMPAIGN_BY_ID



# Search Campaigns
Source: https://docs.useparagon.com/actionkit/integrations/eloqua/ELOQUA_SEARCH_CAMPAIGNS

actionkit/openapi.json post /projects/{project_id}/actions/#ELOQUA_SEARCH_CAMPAIGNS



# Search Contacts
Source: https://docs.useparagon.com/actionkit/integrations/eloqua/ELOQUA_SEARCH_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#ELOQUA_SEARCH_CONTACTS



# Search Email
Source: https://docs.useparagon.com/actionkit/integrations/eloqua/ELOQUA_SEARCH_EMAIL

actionkit/openapi.json post /projects/{project_id}/actions/#ELOQUA_SEARCH_EMAIL



# Send Email Deployment
Source: https://docs.useparagon.com/actionkit/integrations/eloqua/ELOQUA_SEND_EMAIL_DEPLOYMENT

actionkit/openapi.json post /projects/{project_id}/actions/#ELOQUA_SEND_EMAIL_DEPLOYMENT



# Update Campaign
Source: https://docs.useparagon.com/actionkit/integrations/eloqua/ELOQUA_UPDATE_CAMPAIGN

actionkit/openapi.json post /projects/{project_id}/actions/#ELOQUA_UPDATE_CAMPAIGN



# Update Contact
Source: https://docs.useparagon.com/actionkit/integrations/eloqua/ELOQUA_UPDATE_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#ELOQUA_UPDATE_CONTACT



# Update Email
Source: https://docs.useparagon.com/actionkit/integrations/eloqua/ELOQUA_UPDATE_EMAIL

actionkit/openapi.json post /projects/{project_id}/actions/#ELOQUA_UPDATE_EMAIL



# Ads Build Ad Creative Object
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_BUILD_AD_CREATIVE_OBJECT

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_BUILD_AD_CREATIVE_OBJECT



# Ads Create Ad
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_CREATE_AD

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_CREATE_AD



# Ads Create Ad Creative
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_CREATE_AD_CREATIVE

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_CREATE_AD_CREATIVE



# Ads Create Ad Set
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_CREATE_AD_SET

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_CREATE_AD_SET



# Ads Create Campaign
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_CREATE_CAMPAIGN

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_CREATE_CAMPAIGN



# Ads Create Lead Gen Form
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_CREATE_LEAD_GEN_FORM

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_CREATE_LEAD_GEN_FORM



# Ads Get Ad By ID
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_GET_AD_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_GET_AD_BY_ID



# Ads Get Ad Sets
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_GET_AD_SETS

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_GET_AD_SETS



# Ads Get Ad Set By ID
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_GET_AD_SET_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_GET_AD_SET_BY_ID



# Ads Get Campaigns
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_GET_CAMPAIGNS

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_GET_CAMPAIGNS



# Ads Get Campaign By ID
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_GET_CAMPAIGN_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_GET_CAMPAIGN_BY_ID



# Ads Send Funnel Event
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_SEND_FUNNEL_EVENT

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_SEND_FUNNEL_EVENT



# Ads Send Lead Event
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_SEND_LEAD_EVENT

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_SEND_LEAD_EVENT



# Ads Send Purchase Event
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_SEND_PURCHASE_EVENT

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_SEND_PURCHASE_EVENT



# Ads Update Ad
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_UPDATE_AD

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_UPDATE_AD



# Ads Update Ad Set
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_UPDATE_AD_SET

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_UPDATE_AD_SET



# Ads Update Campaign
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/FACEBOOK_ADS_UPDATE_CAMPAIGN

actionkit/openapi.json post /projects/{project_id}/actions/#FACEBOOK_ADS_UPDATE_CAMPAIGN



# Create Comment
Source: https://docs.useparagon.com/actionkit/integrations/figma/FIGMA_CREATE_COMMENT

actionkit/openapi.json post /projects/{project_id}/actions/#FIGMA_CREATE_COMMENT



# Create Comment Reaction
Source: https://docs.useparagon.com/actionkit/integrations/figma/FIGMA_CREATE_COMMENT_REACTION

actionkit/openapi.json post /projects/{project_id}/actions/#FIGMA_CREATE_COMMENT_REACTION



# Delete Comments
Source: https://docs.useparagon.com/actionkit/integrations/figma/FIGMA_DELETE_COMMENTS

actionkit/openapi.json post /projects/{project_id}/actions/#FIGMA_DELETE_COMMENTS



# Delete Comment Reaction
Source: https://docs.useparagon.com/actionkit/integrations/figma/FIGMA_DELETE_COMMENT_REACTION

actionkit/openapi.json post /projects/{project_id}/actions/#FIGMA_DELETE_COMMENT_REACTION



# Get Comments By File
Source: https://docs.useparagon.com/actionkit/integrations/figma/FIGMA_GET_COMMENTS_BY_FILE

actionkit/openapi.json post /projects/{project_id}/actions/#FIGMA_GET_COMMENTS_BY_FILE



# Get Comment Reaction
Source: https://docs.useparagon.com/actionkit/integrations/figma/FIGMA_GET_COMMENT_REACTION

actionkit/openapi.json post /projects/{project_id}/actions/#FIGMA_GET_COMMENT_REACTION



# Get File By ID
Source: https://docs.useparagon.com/actionkit/integrations/figma/FIGMA_GET_FILE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#FIGMA_GET_FILE_BY_ID



# Get File Nodes
Source: https://docs.useparagon.com/actionkit/integrations/figma/FIGMA_GET_FILE_NODES

actionkit/openapi.json post /projects/{project_id}/actions/#FIGMA_GET_FILE_NODES



# Get Project
Source: https://docs.useparagon.com/actionkit/integrations/figma/FIGMA_GET_PROJECT

actionkit/openapi.json post /projects/{project_id}/actions/#FIGMA_GET_PROJECT



# Get Project Files
Source: https://docs.useparagon.com/actionkit/integrations/figma/FIGMA_GET_PROJECT_FILES

actionkit/openapi.json post /projects/{project_id}/actions/#FIGMA_GET_PROJECT_FILES



# Get Rendered Image
Source: https://docs.useparagon.com/actionkit/integrations/figma/FIGMA_GET_RENDERED_IMAGE

actionkit/openapi.json post /projects/{project_id}/actions/#FIGMA_GET_RENDERED_IMAGE



# Create Ticket
Source: https://docs.useparagon.com/actionkit/integrations/freshdesk/FRESHDESK_CREATE_TICKET

actionkit/openapi.json post /projects/{project_id}/actions/#FRESHDESK_CREATE_TICKET



# Delete Ticket
Source: https://docs.useparagon.com/actionkit/integrations/freshdesk/FRESHDESK_DELETE_TICKET

actionkit/openapi.json post /projects/{project_id}/actions/#FRESHDESK_DELETE_TICKET



# Get Ticket By ID
Source: https://docs.useparagon.com/actionkit/integrations/freshdesk/FRESHDESK_GET_TICKET_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#FRESHDESK_GET_TICKET_BY_ID



# Update Ticket
Source: https://docs.useparagon.com/actionkit/integrations/freshdesk/FRESHDESK_UPDATE_TICKET

actionkit/openapi.json post /projects/{project_id}/actions/#FRESHDESK_UPDATE_TICKET



# Create Account
Source: https://docs.useparagon.com/actionkit/integrations/front/FRONT_CREATE_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#FRONT_CREATE_ACCOUNT



# Create Contact
Source: https://docs.useparagon.com/actionkit/integrations/front/FRONT_CREATE_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#FRONT_CREATE_CONTACT



# Delete Account
Source: https://docs.useparagon.com/actionkit/integrations/front/FRONT_DELETE_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#FRONT_DELETE_ACCOUNT



# Delete Contact
Source: https://docs.useparagon.com/actionkit/integrations/front/FRONT_DELETE_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#FRONT_DELETE_CONTACT



# Get Account By ID
Source: https://docs.useparagon.com/actionkit/integrations/front/FRONT_GET_ACCOUNT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#FRONT_GET_ACCOUNT_BY_ID



# Get Contact By ID
Source: https://docs.useparagon.com/actionkit/integrations/front/FRONT_GET_CONTACT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#FRONT_GET_CONTACT_BY_ID



# Search Accounts
Source: https://docs.useparagon.com/actionkit/integrations/front/FRONT_SEARCH_ACCOUNTS

actionkit/openapi.json post /projects/{project_id}/actions/#FRONT_SEARCH_ACCOUNTS



# Search Contacts
Source: https://docs.useparagon.com/actionkit/integrations/front/FRONT_SEARCH_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#FRONT_SEARCH_CONTACTS



# Update Account
Source: https://docs.useparagon.com/actionkit/integrations/front/FRONT_UPDATE_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#FRONT_UPDATE_ACCOUNT



# Update Contact
Source: https://docs.useparagon.com/actionkit/integrations/front/FRONT_UPDATE_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#FRONT_UPDATE_CONTACT



# Create Issue
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_CREATE_ISSUE

actionkit/openapi.json post /projects/{project_id}/actions/#GITHUB_CREATE_ISSUE



# Create Release
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_CREATE_RELEASE

actionkit/openapi.json post /projects/{project_id}/actions/#GITHUB_CREATE_RELEASE



# Delete Release
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_DELETE_RELEASE

actionkit/openapi.json post /projects/{project_id}/actions/#GITHUB_DELETE_RELEASE



# Get Issue By Number
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_GET_ISSUE_BY_NUMBER

actionkit/openapi.json post /projects/{project_id}/actions/#GITHUB_GET_ISSUE_BY_NUMBER



# Get Release By ID
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_GET_RELEASE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#GITHUB_GET_RELEASE_BY_ID



# Get Release By Tag Name
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_GET_RELEASE_BY_TAG_NAME

actionkit/openapi.json post /projects/{project_id}/actions/#GITHUB_GET_RELEASE_BY_TAG_NAME



# Lock Issue
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_LOCK_ISSUE

actionkit/openapi.json post /projects/{project_id}/actions/#GITHUB_LOCK_ISSUE



# Search Issue
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_SEARCH_ISSUE

actionkit/openapi.json post /projects/{project_id}/actions/#GITHUB_SEARCH_ISSUE



# Update Issue
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_UPDATE_ISSUE

actionkit/openapi.json post /projects/{project_id}/actions/#GITHUB_UPDATE_ISSUE



# Update Release
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_UPDATE_RELEASE

actionkit/openapi.json post /projects/{project_id}/actions/#GITHUB_UPDATE_RELEASE



# Create A Contact
Source: https://docs.useparagon.com/actionkit/integrations/gmail/GMAIL_CREATE_A_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#GMAIL_CREATE_A_CONTACT



# Create Draft
Source: https://docs.useparagon.com/actionkit/integrations/gmail/GMAIL_CREATE_DRAFT

actionkit/openapi.json post /projects/{project_id}/actions/#GMAIL_CREATE_DRAFT



# Delete Contact
Source: https://docs.useparagon.com/actionkit/integrations/gmail/GMAIL_DELETE_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#GMAIL_DELETE_CONTACT



# Delete Email
Source: https://docs.useparagon.com/actionkit/integrations/gmail/GMAIL_DELETE_EMAIL

actionkit/openapi.json post /projects/{project_id}/actions/#GMAIL_DELETE_EMAIL



# Get Contact By Resource Name
Source: https://docs.useparagon.com/actionkit/integrations/gmail/GMAIL_GET_CONTACT_BY_RESOURCE_NAME

actionkit/openapi.json post /projects/{project_id}/actions/#GMAIL_GET_CONTACT_BY_RESOURCE_NAME



# Get Email By ID
Source: https://docs.useparagon.com/actionkit/integrations/gmail/GMAIL_GET_EMAIL_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#GMAIL_GET_EMAIL_BY_ID



# Search For Contact
Source: https://docs.useparagon.com/actionkit/integrations/gmail/GMAIL_SEARCH_FOR_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#GMAIL_SEARCH_FOR_CONTACT



# Search For Email
Source: https://docs.useparagon.com/actionkit/integrations/gmail/GMAIL_SEARCH_FOR_EMAIL

actionkit/openapi.json post /projects/{project_id}/actions/#GMAIL_SEARCH_FOR_EMAIL



# Send Email
Source: https://docs.useparagon.com/actionkit/integrations/gmail/GMAIL_SEND_EMAIL

actionkit/openapi.json post /projects/{project_id}/actions/#GMAIL_SEND_EMAIL



# Add Call
Source: https://docs.useparagon.com/actionkit/integrations/gong/GONG_ADD_CALL

actionkit/openapi.json post /projects/{project_id}/actions/#GONG_ADD_CALL



# Get Call By ID
Source: https://docs.useparagon.com/actionkit/integrations/gong/GONG_GET_CALL_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#GONG_GET_CALL_BY_ID



# Search Call
Source: https://docs.useparagon.com/actionkit/integrations/gong/GONG_SEARCH_CALL

actionkit/openapi.json post /projects/{project_id}/actions/#GONG_SEARCH_CALL



# Calendar Create Event
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_CREATE_EVENT

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_CALENDAR_CREATE_EVENT



# Calendar Delete Event
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_DELETE_EVENT

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_CALENDAR_DELETE_EVENT



# Calendar Get Availability
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_GET_AVAILABILITY

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_CALENDAR_GET_AVAILABILITY



# Calendar Get Contacts
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_GET_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_CALENDAR_GET_CONTACTS



# Calendar Get Event By ID
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_GET_EVENT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_CALENDAR_GET_EVENT_BY_ID



# Calendar List Directory People
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_LIST_DIRECTORY_PEOPLE

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_CALENDAR_LIST_DIRECTORY_PEOPLE



# Calendar List Events
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_LIST_EVENTS

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_CALENDAR_LIST_EVENTS



# Calendar List Other Contacts
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_LIST_OTHER_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_CALENDAR_LIST_OTHER_CONTACTS



# Calendar Search Contacts
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_SEARCH_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_CALENDAR_SEARCH_CONTACTS



# Calendar Search Directory People
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_SEARCH_DIRECTORY_PEOPLE

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_CALENDAR_SEARCH_DIRECTORY_PEOPLE



# Calendar Search Other Contacts
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_SEARCH_OTHER_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_CALENDAR_SEARCH_OTHER_CONTACTS



# Calendar Update Event
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_UPDATE_EVENT

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_CALENDAR_UPDATE_EVENT



# Drive Create Folder
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/GOOGLE_DRIVE_CREATE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_DRIVE_CREATE_FOLDER



# Drive Delete Folder
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/GOOGLE_DRIVE_DELETE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_DRIVE_DELETE_FOLDER



# Drive Export Doc
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/GOOGLE_DRIVE_EXPORT_DOC

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_DRIVE_EXPORT_DOC



# Drive Get File By ID
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/GOOGLE_DRIVE_GET_FILE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_DRIVE_GET_FILE_BY_ID



# Drive Get Folder By ID
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/GOOGLE_DRIVE_GET_FOLDER_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_DRIVE_GET_FOLDER_BY_ID



# Drive List Files
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/GOOGLE_DRIVE_LIST_FILES

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_DRIVE_LIST_FILES



# Drive Move Folder
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/GOOGLE_DRIVE_MOVE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_DRIVE_MOVE_FOLDER



# Drive Save File
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/GOOGLE_DRIVE_SAVE_FILE

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_DRIVE_SAVE_FILE



# Drive Search Folders
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/GOOGLE_DRIVE_SEARCH_FOLDERS

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_DRIVE_SEARCH_FOLDERS



# Search Console Create Site
Source: https://docs.useparagon.com/actionkit/integrations/googlesearchconsole/GOOGLE_SEARCH_CONSOLE_CREATE_SITE

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_SEARCH_CONSOLE_CREATE_SITE



# Search Console Get All Sites
Source: https://docs.useparagon.com/actionkit/integrations/googlesearchconsole/GOOGLE_SEARCH_CONSOLE_GET_ALL_SITES

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_SEARCH_CONSOLE_GET_ALL_SITES



# Search Console Inspect Index Info
Source: https://docs.useparagon.com/actionkit/integrations/googlesearchconsole/GOOGLE_SEARCH_CONSOLE_INSPECT_INDEX_INFO

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_SEARCH_CONSOLE_INSPECT_INDEX_INFO



# Search Console Query Search Data
Source: https://docs.useparagon.com/actionkit/integrations/googlesearchconsole/GOOGLE_SEARCH_CONSOLE_QUERY_SEARCH_DATA

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_SEARCH_CONSOLE_QUERY_SEARCH_DATA



# Sheets Create Row
Source: https://docs.useparagon.com/actionkit/integrations/googlesheets/GOOGLE_SHEETS_CREATE_ROW

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_SHEETS_CREATE_ROW



# Sheets Get Row
Source: https://docs.useparagon.com/actionkit/integrations/googlesheets/GOOGLE_SHEETS_GET_ROW

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_SHEETS_GET_ROW



# Sheets Update Row
Source: https://docs.useparagon.com/actionkit/integrations/googlesheets/GOOGLE_SHEETS_UPDATE_ROW

actionkit/openapi.json post /projects/{project_id}/actions/#GOOGLE_SHEETS_UPDATE_ROW



# Create Employee
Source: https://docs.useparagon.com/actionkit/integrations/gusto/GUSTO_CREATE_EMPLOYEE

actionkit/openapi.json post /projects/{project_id}/actions/#GUSTO_CREATE_EMPLOYEE



# Get Employee By ID
Source: https://docs.useparagon.com/actionkit/integrations/gusto/GUSTO_GET_EMPLOYEE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#GUSTO_GET_EMPLOYEE_BY_ID



# Get Employee Directory
Source: https://docs.useparagon.com/actionkit/integrations/gusto/GUSTO_GET_EMPLOYEE_DIRECTORY

actionkit/openapi.json post /projects/{project_id}/actions/#GUSTO_GET_EMPLOYEE_DIRECTORY



# Update Employee
Source: https://docs.useparagon.com/actionkit/integrations/gusto/GUSTO_UPDATE_EMPLOYEE

actionkit/openapi.json post /projects/{project_id}/actions/#GUSTO_UPDATE_EMPLOYEE



# Create Record Any
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_CREATE_RECORD_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_CREATE_RECORD_ANY



# Create Record Companies
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_CREATE_RECORD_COMPANIES

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_CREATE_RECORD_COMPANIES



# Create Record Contacts
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_CREATE_RECORD_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_CREATE_RECORD_CONTACTS



# Create Record Deals
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_CREATE_RECORD_DEALS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_CREATE_RECORD_DEALS



# Create Record Engagements
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_CREATE_RECORD_ENGAGEMENTS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_CREATE_RECORD_ENGAGEMENTS



# Delete Record Any
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_DELETE_RECORD_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_DELETE_RECORD_ANY



# Delete Record Companies
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_DELETE_RECORD_COMPANIES

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_DELETE_RECORD_COMPANIES



# Delete Record Contacts
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_DELETE_RECORD_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_DELETE_RECORD_CONTACTS



# Delete Record Deals
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_DELETE_RECORD_DEALS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_DELETE_RECORD_DEALS



# Delete Record Engagements
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_DELETE_RECORD_ENGAGEMENTS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_DELETE_RECORD_ENGAGEMENTS



# Describe Action Schema
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_DESCRIBE_ACTION_SCHEMA

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_DESCRIBE_ACTION_SCHEMA



# Get Contacts By List ID
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_GET_CONTACTS_BY_LIST_ID

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_GET_CONTACTS_BY_LIST_ID



# Get Records Any
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_GET_RECORDS_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_GET_RECORDS_ANY



# Get Records Companies
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_GET_RECORDS_COMPANIES

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_GET_RECORDS_COMPANIES



# Get Records Contacts
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_GET_RECORDS_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_GET_RECORDS_CONTACTS



# Get Records Deals
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_GET_RECORDS_DEALS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_GET_RECORDS_DEALS



# Get Records Engagements
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_GET_RECORDS_ENGAGEMENTS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_GET_RECORDS_ENGAGEMENTS



# Get Record By ID Any
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_GET_RECORD_BY_ID_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_GET_RECORD_BY_ID_ANY



# Get Record By ID Companies
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_GET_RECORD_BY_ID_COMPANIES

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_GET_RECORD_BY_ID_COMPANIES



# Get Record By ID Contacts
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_GET_RECORD_BY_ID_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_GET_RECORD_BY_ID_CONTACTS



# Get Record By ID Deals
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_GET_RECORD_BY_ID_DEALS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_GET_RECORD_BY_ID_DEALS



# Get Record By ID Engagements
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_GET_RECORD_BY_ID_ENGAGEMENTS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_GET_RECORD_BY_ID_ENGAGEMENTS



# Search Records Any
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_SEARCH_RECORDS_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_SEARCH_RECORDS_ANY



# Search Records Companies
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_SEARCH_RECORDS_COMPANIES

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_SEARCH_RECORDS_COMPANIES



# Search Records Contacts
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_SEARCH_RECORDS_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_SEARCH_RECORDS_CONTACTS



# Search Records Deals
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_SEARCH_RECORDS_DEALS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_SEARCH_RECORDS_DEALS



# Search Records Engagements
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_SEARCH_RECORDS_ENGAGEMENTS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_SEARCH_RECORDS_ENGAGEMENTS



# Update Record Any
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_UPDATE_RECORD_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_UPDATE_RECORD_ANY



# Update Record Companies
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_UPDATE_RECORD_COMPANIES

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_UPDATE_RECORD_COMPANIES



# Update Record Contacts
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_UPDATE_RECORD_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_UPDATE_RECORD_CONTACTS



# Update Record Deals
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_UPDATE_RECORD_DEALS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_UPDATE_RECORD_DEALS



# Update Record Engagements
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/HUBSPOT_UPDATE_RECORD_ENGAGEMENTS

actionkit/openapi.json post /projects/{project_id}/actions/#HUBSPOT_UPDATE_RECORD_ENGAGEMENTS



# Create Contact
Source: https://docs.useparagon.com/actionkit/integrations/intercom/INTERCOM_CREATE_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#INTERCOM_CREATE_CONTACT



# Get Contact By ID
Source: https://docs.useparagon.com/actionkit/integrations/intercom/INTERCOM_GET_CONTACT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#INTERCOM_GET_CONTACT_BY_ID



# Search Contacts
Source: https://docs.useparagon.com/actionkit/integrations/intercom/INTERCOM_SEARCH_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#INTERCOM_SEARCH_CONTACTS



# Send Message
Source: https://docs.useparagon.com/actionkit/integrations/intercom/INTERCOM_SEND_MESSAGE

actionkit/openapi.json post /projects/{project_id}/actions/#INTERCOM_SEND_MESSAGE



# Update Contact
Source: https://docs.useparagon.com/actionkit/integrations/intercom/INTERCOM_UPDATE_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#INTERCOM_UPDATE_CONTACT



# Create Issue
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_CREATE_ISSUE

actionkit/openapi.json post /projects/{project_id}/actions/#JIRA_CREATE_ISSUE



# Describe Action Schema
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_DESCRIBE_ACTION_SCHEMA

actionkit/openapi.json post /projects/{project_id}/actions/#JIRA_DESCRIBE_ACTION_SCHEMA



# Filter Issues
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_FILTER_ISSUES

actionkit/openapi.json post /projects/{project_id}/actions/#JIRA_FILTER_ISSUES



# Get All Assignees By Project
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_GET_ALL_ASSIGNEES_BY_PROJECT

actionkit/openapi.json post /projects/{project_id}/actions/#JIRA_GET_ALL_ASSIGNEES_BY_PROJECT



# Get Issue By Key
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_GET_ISSUE_BY_KEY

actionkit/openapi.json post /projects/{project_id}/actions/#JIRA_GET_ISSUE_BY_KEY



# Get Issue Status By Project
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_GET_ISSUE_STATUS_BY_PROJECT

actionkit/openapi.json post /projects/{project_id}/actions/#JIRA_GET_ISSUE_STATUS_BY_PROJECT



# Get Issue Types
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_GET_ISSUE_TYPES

actionkit/openapi.json post /projects/{project_id}/actions/#JIRA_GET_ISSUE_TYPES



# Get Issue Types By Project
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_GET_ISSUE_TYPES_BY_PROJECT

actionkit/openapi.json post /projects/{project_id}/actions/#JIRA_GET_ISSUE_TYPES_BY_PROJECT



# Get Projects
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_GET_PROJECTS

actionkit/openapi.json post /projects/{project_id}/actions/#JIRA_GET_PROJECTS



# Search By JQL
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_SEARCH_BY_JQL

actionkit/openapi.json post /projects/{project_id}/actions/#JIRA_SEARCH_BY_JQL



# Update Issue
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_UPDATE_ISSUE

actionkit/openapi.json post /projects/{project_id}/actions/#JIRA_UPDATE_ISSUE



# Update Issue Any
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_UPDATE_ISSUE_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#JIRA_UPDATE_ISSUE_ANY



# Add Subscriber To List
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_ADD_SUBSCRIBER_TO_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_ADD_SUBSCRIBER_TO_LIST



# Create Campaign
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_CREATE_CAMPAIGN

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_CREATE_CAMPAIGN



# Create List
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_CREATE_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_CREATE_LIST



# Create Template
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_CREATE_TEMPLATE

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_CREATE_TEMPLATE



# Get Campaign
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_GET_CAMPAIGN

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_GET_CAMPAIGN



# Get Lists
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_GET_LISTS

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_GET_LISTS



# Get List Subscriber
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_GET_LIST_SUBSCRIBER

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_GET_LIST_SUBSCRIBER



# Get Profile
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_GET_PROFILE

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_GET_PROFILE



# Get Segements
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_GET_SEGEMENTS

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_GET_SEGEMENTS



# Get Segment Subscribers
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_GET_SEGMENT_SUBSCRIBERS

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_GET_SEGMENT_SUBSCRIBERS



# Get Templates
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_GET_TEMPLATES

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_GET_TEMPLATES



# Send Campaign
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_SEND_CAMPAIGN

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_SEND_CAMPAIGN



# Unsubscribe From List
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_UNSUBSCRIBE_FROM_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_UNSUBSCRIBE_FROM_LIST



# Update Profile
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/KLAVIYO_UPDATE_PROFILE

actionkit/openapi.json post /projects/{project_id}/actions/#KLAVIYO_UPDATE_PROFILE



# Create Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/lever/LEVER_CREATE_OPPORTUNITY

actionkit/openapi.json post /projects/{project_id}/actions/#LEVER_CREATE_OPPORTUNITY



# Create Posting
Source: https://docs.useparagon.com/actionkit/integrations/lever/LEVER_CREATE_POSTING

actionkit/openapi.json post /projects/{project_id}/actions/#LEVER_CREATE_POSTING



# Get Contact By ID
Source: https://docs.useparagon.com/actionkit/integrations/lever/LEVER_GET_CONTACT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#LEVER_GET_CONTACT_BY_ID



# Get Opportunities
Source: https://docs.useparagon.com/actionkit/integrations/lever/LEVER_GET_OPPORTUNITIES

actionkit/openapi.json post /projects/{project_id}/actions/#LEVER_GET_OPPORTUNITIES



# Get Opportunity By ID
Source: https://docs.useparagon.com/actionkit/integrations/lever/LEVER_GET_OPPORTUNITY_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#LEVER_GET_OPPORTUNITY_BY_ID



# Get Postings
Source: https://docs.useparagon.com/actionkit/integrations/lever/LEVER_GET_POSTINGS

actionkit/openapi.json post /projects/{project_id}/actions/#LEVER_GET_POSTINGS



# Get Posting By ID
Source: https://docs.useparagon.com/actionkit/integrations/lever/LEVER_GET_POSTING_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#LEVER_GET_POSTING_BY_ID



# Update Contact
Source: https://docs.useparagon.com/actionkit/integrations/lever/LEVER_UPDATE_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#LEVER_UPDATE_CONTACT



# Update Posting
Source: https://docs.useparagon.com/actionkit/integrations/lever/LEVER_UPDATE_POSTING

actionkit/openapi.json post /projects/{project_id}/actions/#LEVER_UPDATE_POSTING



# Archive Issue
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_ARCHIVE_ISSUE

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_ARCHIVE_ISSUE



# Create Issue
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_CREATE_ISSUE

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_CREATE_ISSUE



# Create Project
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_CREATE_PROJECT

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_CREATE_PROJECT



# Create Sub Issue
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_CREATE_SUB_ISSUE

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_CREATE_SUB_ISSUE



# Delete Issue
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_DELETE_ISSUE

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_DELETE_ISSUE



# Delete Project
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_DELETE_PROJECT

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_DELETE_PROJECT



# Get Issue By ID
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_GET_ISSUE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_GET_ISSUE_BY_ID



# Get Issue By Issue Identifier
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_GET_ISSUE_BY_ISSUE_IDENTIFIER

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_GET_ISSUE_BY_ISSUE_IDENTIFIER



# Get Project By ID
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_GET_PROJECT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_GET_PROJECT_BY_ID



# Search Issue
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_SEARCH_ISSUE

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_SEARCH_ISSUE



# Search Teams
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_SEARCH_TEAMS

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_SEARCH_TEAMS



# Update Issue
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_UPDATE_ISSUE

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_UPDATE_ISSUE



# Update Project
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_UPDATE_PROJECT

actionkit/openapi.json post /projects/{project_id}/actions/#LINEAR_UPDATE_PROJECT



# Create Post
Source: https://docs.useparagon.com/actionkit/integrations/linkedin/LINKEDIN_CREATE_POST

actionkit/openapi.json post /projects/{project_id}/actions/#LINKEDIN_CREATE_POST



# Get Profile By ID
Source: https://docs.useparagon.com/actionkit/integrations/linkedin/LINKEDIN_GET_PROFILE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#LINKEDIN_GET_PROFILE_BY_ID



# Add Contact To List
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/MAILCHIMP_ADD_CONTACT_TO_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#MAILCHIMP_ADD_CONTACT_TO_LIST



# Create Campaign
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/MAILCHIMP_CREATE_CAMPAIGN

actionkit/openapi.json post /projects/{project_id}/actions/#MAILCHIMP_CREATE_CAMPAIGN



# Create List
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/MAILCHIMP_CREATE_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#MAILCHIMP_CREATE_LIST



# Delete Campaign By ID
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/MAILCHIMP_DELETE_CAMPAIGN_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#MAILCHIMP_DELETE_CAMPAIGN_BY_ID



# Get Campaign By ID
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/MAILCHIMP_GET_CAMPAIGN_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#MAILCHIMP_GET_CAMPAIGN_BY_ID



# Get Contacts From List
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/MAILCHIMP_GET_CONTACTS_FROM_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#MAILCHIMP_GET_CONTACTS_FROM_LIST



# Get List By ID
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/MAILCHIMP_GET_LIST_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#MAILCHIMP_GET_LIST_BY_ID



# Search Campaigns
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/MAILCHIMP_SEARCH_CAMPAIGNS

actionkit/openapi.json post /projects/{project_id}/actions/#MAILCHIMP_SEARCH_CAMPAIGNS



# Search Lists
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/MAILCHIMP_SEARCH_LISTS

actionkit/openapi.json post /projects/{project_id}/actions/#MAILCHIMP_SEARCH_LISTS



# Send Campaign
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/MAILCHIMP_SEND_CAMPAIGN

actionkit/openapi.json post /projects/{project_id}/actions/#MAILCHIMP_SEND_CAMPAIGN



# Update Campaign
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/MAILCHIMP_UPDATE_CAMPAIGN

actionkit/openapi.json post /projects/{project_id}/actions/#MAILCHIMP_UPDATE_CAMPAIGN



# Update Contact To List
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/MAILCHIMP_UPDATE_CONTACT_TO_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#MAILCHIMP_UPDATE_CONTACT_TO_LIST



# Add Leads To List
Source: https://docs.useparagon.com/actionkit/integrations/marketo/MARKETO_ADD_LEADS_TO_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#MARKETO_ADD_LEADS_TO_LIST



# Create Custom Object
Source: https://docs.useparagon.com/actionkit/integrations/marketo/MARKETO_CREATE_CUSTOM_OBJECT

actionkit/openapi.json post /projects/{project_id}/actions/#MARKETO_CREATE_CUSTOM_OBJECT



# Create Or Update Lead
Source: https://docs.useparagon.com/actionkit/integrations/marketo/MARKETO_CREATE_OR_UPDATE_LEAD

actionkit/openapi.json post /projects/{project_id}/actions/#MARKETO_CREATE_OR_UPDATE_LEAD



# Get Leads
Source: https://docs.useparagon.com/actionkit/integrations/marketo/MARKETO_GET_LEADS

actionkit/openapi.json post /projects/{project_id}/actions/#MARKETO_GET_LEADS



# Get Lead By ID
Source: https://docs.useparagon.com/actionkit/integrations/marketo/MARKETO_GET_LEAD_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#MARKETO_GET_LEAD_BY_ID



# Channel List
Source: https://docs.useparagon.com/actionkit/integrations/microsoftTeams/TEAMS_CHANNEL_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#TEAMS_CHANNEL_LIST



# Get User By Email
Source: https://docs.useparagon.com/actionkit/integrations/microsoftTeams/TEAMS_GET_USER_BY_EMAIL

actionkit/openapi.json post /projects/{project_id}/actions/#TEAMS_GET_USER_BY_EMAIL



# Joined Team List
Source: https://docs.useparagon.com/actionkit/integrations/microsoftTeams/TEAMS_JOINED_TEAM_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#TEAMS_JOINED_TEAM_LIST



# Member List
Source: https://docs.useparagon.com/actionkit/integrations/microsoftTeams/TEAMS_MEMBER_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#TEAMS_MEMBER_LIST



# Send Message In Channel
Source: https://docs.useparagon.com/actionkit/integrations/microsoftTeams/TEAMS_SEND_MESSAGE_IN_CHANNEL

actionkit/openapi.json post /projects/{project_id}/actions/#TEAMS_SEND_MESSAGE_IN_CHANNEL



# Send Message In Chat
Source: https://docs.useparagon.com/actionkit/integrations/microsoftTeams/TEAMS_SEND_MESSAGE_IN_CHAT

actionkit/openapi.json post /projects/{project_id}/actions/#TEAMS_SEND_MESSAGE_IN_CHAT



# Archive Item
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_ARCHIVE_ITEM

actionkit/openapi.json post /projects/{project_id}/actions/#MONDAY_ARCHIVE_ITEM



# Create Item
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_CREATE_ITEM

actionkit/openapi.json post /projects/{project_id}/actions/#MONDAY_CREATE_ITEM



# Create Subitem
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_CREATE_SUBITEM

actionkit/openapi.json post /projects/{project_id}/actions/#MONDAY_CREATE_SUBITEM



# Delete Item
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_DELETE_ITEM

actionkit/openapi.json post /projects/{project_id}/actions/#MONDAY_DELETE_ITEM



# Get Item By External ID With New Api Version
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_GET_ITEM_BY_EXTERNAL_ID_WITH_NEW_API_VERSION

actionkit/openapi.json post /projects/{project_id}/actions/#MONDAY_GET_ITEM_BY_EXTERNAL_ID_WITH_NEW_API_VERSION



# Get Item By ID With New Api Version
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_GET_ITEM_BY_ID_WITH_NEW_API_VERSION

actionkit/openapi.json post /projects/{project_id}/actions/#MONDAY_GET_ITEM_BY_ID_WITH_NEW_API_VERSION



# Search Items With New Api Version
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_SEARCH_ITEMS_WITH_NEW_API_VERSION

actionkit/openapi.json post /projects/{project_id}/actions/#MONDAY_SEARCH_ITEMS_WITH_NEW_API_VERSION



# Search Users
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_SEARCH_USERS

actionkit/openapi.json post /projects/{project_id}/actions/#MONDAY_SEARCH_USERS



# Update Item
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_UPDATE_ITEM

actionkit/openapi.json post /projects/{project_id}/actions/#MONDAY_UPDATE_ITEM



# Create Account
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_CREATE_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_CREATE_ACCOUNT



# Create Bill
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_CREATE_BILL

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_CREATE_BILL



# Create Tax Group
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_CREATE_TAX_GROUP

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_CREATE_TAX_GROUP



# Create Vendor
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_CREATE_VENDOR

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_CREATE_VENDOR



# Delete Account
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_DELETE_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_DELETE_ACCOUNT



# Delete Bill
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_DELETE_BILL

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_DELETE_BILL



# Delete Tax Group
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_DELETE_TAX_GROUP

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_DELETE_TAX_GROUP



# Delete Vendor
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_DELETE_VENDOR

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_DELETE_VENDOR



# Get Account By ID
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_GET_ACCOUNT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_GET_ACCOUNT_BY_ID



# Get Bill By ID
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_GET_BILL_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_GET_BILL_BY_ID



# Get Payment Term By ID
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_GET_PAYMENT_TERM_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_GET_PAYMENT_TERM_BY_ID



# Get Tax Group By ID
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_GET_TAX_GROUP_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_GET_TAX_GROUP_BY_ID



# Get Vendor By ID
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_GET_VENDOR_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_GET_VENDOR_BY_ID



# Search Accounts
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_SEARCH_ACCOUNTS

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_SEARCH_ACCOUNTS



# Search Bills
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_SEARCH_BILLS

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_SEARCH_BILLS



# Search Payment Terms
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_SEARCH_PAYMENT_TERMS

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_SEARCH_PAYMENT_TERMS



# Search Posting Periods
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_SEARCH_POSTING_PERIODS

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_SEARCH_POSTING_PERIODS



# Search Tax Codes
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_SEARCH_TAX_CODES

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_SEARCH_TAX_CODES



# Search Vendors
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_SEARCH_VENDORS

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_SEARCH_VENDORS



# Update Account
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_UPDATE_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_UPDATE_ACCOUNT



# Update Bill
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_UPDATE_BILL

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_UPDATE_BILL



# Update Tax Group
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_UPDATE_TAX_GROUP

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_UPDATE_TAX_GROUP



# Update Vendor
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_UPDATE_VENDOR

actionkit/openapi.json post /projects/{project_id}/actions/#NETSUITE_UPDATE_VENDOR



# Archive Page
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_ARCHIVE_PAGE

actionkit/openapi.json post /projects/{project_id}/actions/#NOTION_ARCHIVE_PAGE



# Create Page
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_CREATE_PAGE

actionkit/openapi.json post /projects/{project_id}/actions/#NOTION_CREATE_PAGE



# Create Page With Markdown
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_CREATE_PAGE_WITH_MARKDOWN

actionkit/openapi.json post /projects/{project_id}/actions/#NOTION_CREATE_PAGE_WITH_MARKDOWN



# Delete Block
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_DELETE_BLOCK

actionkit/openapi.json post /projects/{project_id}/actions/#NOTION_DELETE_BLOCK



# Get Block By ID
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_GET_BLOCK_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#NOTION_GET_BLOCK_BY_ID



# Get Page As Markdown
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_GET_PAGE_AS_MARKDOWN

actionkit/openapi.json post /projects/{project_id}/actions/#NOTION_GET_PAGE_AS_MARKDOWN



# Get Page By ID
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_GET_PAGE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#NOTION_GET_PAGE_BY_ID



# Get Page Content
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_GET_PAGE_CONTENT

actionkit/openapi.json post /projects/{project_id}/actions/#NOTION_GET_PAGE_CONTENT



# Search Pages
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_SEARCH_PAGES

actionkit/openapi.json post /projects/{project_id}/actions/#NOTION_SEARCH_PAGES



# Update Block
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_UPDATE_BLOCK

actionkit/openapi.json post /projects/{project_id}/actions/#NOTION_UPDATE_BLOCK



# Update Page
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_UPDATE_PAGE

actionkit/openapi.json post /projects/{project_id}/actions/#NOTION_UPDATE_PAGE



# Update Page With Markdown
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_UPDATE_PAGE_WITH_MARKDOWN

actionkit/openapi.json post /projects/{project_id}/actions/#NOTION_UPDATE_PAGE_WITH_MARKDOWN



# Create Folder
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_CREATE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#ONEDRIVE_CREATE_FOLDER



# Delete Folder
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_DELETE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#ONEDRIVE_DELETE_FOLDER



# Get File By ID
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_GET_FILE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#ONEDRIVE_GET_FILE_BY_ID



# Get Folder By ID
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_GET_FOLDER_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#ONEDRIVE_GET_FOLDER_BY_ID



# List Contents
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_LIST_CONTENTS

actionkit/openapi.json post /projects/{project_id}/actions/#ONEDRIVE_LIST_CONTENTS



# Move Folder
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_MOVE_FOLDER

actionkit/openapi.json post /projects/{project_id}/actions/#ONEDRIVE_MOVE_FOLDER



# Search Folders
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_SEARCH_FOLDERS

actionkit/openapi.json post /projects/{project_id}/actions/#ONEDRIVE_SEARCH_FOLDERS



# Create Event
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_CREATE_EVENT

actionkit/openapi.json post /projects/{project_id}/actions/#OUTLOOK_CREATE_EVENT



# Delete Event
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_DELETE_EVENT

actionkit/openapi.json post /projects/{project_id}/actions/#OUTLOOK_DELETE_EVENT



# Get Events
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_GET_EVENTS

actionkit/openapi.json post /projects/{project_id}/actions/#OUTLOOK_GET_EVENTS



# Get Event By ID
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_GET_EVENT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#OUTLOOK_GET_EVENT_BY_ID



# Get Messages
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_GET_MESSAGES

actionkit/openapi.json post /projects/{project_id}/actions/#OUTLOOK_GET_MESSAGES



# Send Message
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_SEND_MESSAGE

actionkit/openapi.json post /projects/{project_id}/actions/#OUTLOOK_SEND_MESSAGE



# Update Event
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_UPDATE_EVENT

actionkit/openapi.json post /projects/{project_id}/actions/#OUTLOOK_UPDATE_EVENT



# Add Prospect To Sequence
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_ADD_PROSPECT_TO_SEQUENCE

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_ADD_PROSPECT_TO_SEQUENCE



# Create Account
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_CREATE_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_CREATE_ACCOUNT



# Create Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_CREATE_OPPORTUNITY

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_CREATE_OPPORTUNITY



# Create Prospect
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_CREATE_PROSPECT

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_CREATE_PROSPECT



# Get Accounts
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_GET_ACCOUNTS

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_GET_ACCOUNTS



# Get Account By ID
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_GET_ACCOUNT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_GET_ACCOUNT_BY_ID



# Get Opportunities
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_GET_OPPORTUNITIES

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_GET_OPPORTUNITIES



# Get Opportunity By ID
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_GET_OPPORTUNITY_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_GET_OPPORTUNITY_BY_ID



# Get Prospects
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_GET_PROSPECTS

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_GET_PROSPECTS



# Get Prospect By ID
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_GET_PROSPECT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_GET_PROSPECT_BY_ID



# Update Account
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_UPDATE_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_UPDATE_ACCOUNT



# Update Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_UPDATE_OPPORTUNITY

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_UPDATE_OPPORTUNITY



# Update Prospect
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_UPDATE_PROSPECT

actionkit/openapi.json post /projects/{project_id}/actions/#OUTREACH_UPDATE_PROSPECT



# Doc Create Document
Source: https://docs.useparagon.com/actionkit/integrations/pandadoc/PANDA_DOC_CREATE_DOCUMENT

actionkit/openapi.json post /projects/{project_id}/actions/#PANDA_DOC_CREATE_DOCUMENT



# Doc Delete Document
Source: https://docs.useparagon.com/actionkit/integrations/pandadoc/PANDA_DOC_DELETE_DOCUMENT

actionkit/openapi.json post /projects/{project_id}/actions/#PANDA_DOC_DELETE_DOCUMENT



# Doc Get Document By ID
Source: https://docs.useparagon.com/actionkit/integrations/pandadoc/PANDA_DOC_GET_DOCUMENT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#PANDA_DOC_GET_DOCUMENT_BY_ID



# Doc Search Documents
Source: https://docs.useparagon.com/actionkit/integrations/pandadoc/PANDA_DOC_SEARCH_DOCUMENTS

actionkit/openapi.json post /projects/{project_id}/actions/#PANDA_DOC_SEARCH_DOCUMENTS



# Doc Send Document
Source: https://docs.useparagon.com/actionkit/integrations/pandadoc/PANDA_DOC_SEND_DOCUMENT

actionkit/openapi.json post /projects/{project_id}/actions/#PANDA_DOC_SEND_DOCUMENT



# Doc Update Document
Source: https://docs.useparagon.com/actionkit/integrations/pandadoc/PANDA_DOC_UPDATE_DOCUMENT

actionkit/openapi.json post /projects/{project_id}/actions/#PANDA_DOC_UPDATE_DOCUMENT



# Add Prospect To List
Source: https://docs.useparagon.com/actionkit/integrations/pardot/PARDOT_ADD_PROSPECT_TO_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#PARDOT_ADD_PROSPECT_TO_LIST



# Create Or Update Prospect
Source: https://docs.useparagon.com/actionkit/integrations/pardot/PARDOT_CREATE_OR_UPDATE_PROSPECT

actionkit/openapi.json post /projects/{project_id}/actions/#PARDOT_CREATE_OR_UPDATE_PROSPECT



# Delete Prospect By ID
Source: https://docs.useparagon.com/actionkit/integrations/pardot/PARDOT_DELETE_PROSPECT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#PARDOT_DELETE_PROSPECT_BY_ID



# Get Prospect By ID
Source: https://docs.useparagon.com/actionkit/integrations/pardot/PARDOT_GET_PROSPECT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#PARDOT_GET_PROSPECT_BY_ID



# Remove Prospect From List
Source: https://docs.useparagon.com/actionkit/integrations/pardot/PARDOT_REMOVE_PROSPECT_FROM_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#PARDOT_REMOVE_PROSPECT_FROM_LIST



# Search Prospects
Source: https://docs.useparagon.com/actionkit/integrations/pardot/PARDOT_SEARCH_PROSPECTS

actionkit/openapi.json post /projects/{project_id}/actions/#PARDOT_SEARCH_PROSPECTS



# Create Record Activities V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_ACTIVITIES_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_CREATE_RECORD_ACTIVITIES_V2



# Create Record Any
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_CREATE_RECORD_ANY



# Create Record Deals V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_DEALS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_CREATE_RECORD_DEALS_V2



# Create Record Leads V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_LEADS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_CREATE_RECORD_LEADS_V2



# Create Record Notes
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_NOTES

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_CREATE_RECORD_NOTES



# Create Record Organizations V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_ORGANIZATIONS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_CREATE_RECORD_ORGANIZATIONS_V2



# Create Record Persons V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_PERSONS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_CREATE_RECORD_PERSONS_V2



# Create Record Users
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_USERS

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_CREATE_RECORD_USERS



# Delete Record Activities V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_ACTIVITIES_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_DELETE_RECORD_ACTIVITIES_V2



# Delete Record Any
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_DELETE_RECORD_ANY



# Delete Record Deals V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_DEALS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_DELETE_RECORD_DEALS_V2



# Delete Record Leads V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_LEADS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_DELETE_RECORD_LEADS_V2



# Delete Record Notes
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_NOTES

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_DELETE_RECORD_NOTES



# Delete Record Organizations V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_ORGANIZATIONS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_DELETE_RECORD_ORGANIZATIONS_V2



# Delete Record Persons V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_PERSONS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_DELETE_RECORD_PERSONS_V2



# Delete Record Users
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_USERS

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_DELETE_RECORD_USERS



# Describe Action Schema
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DESCRIBE_ACTION_SCHEMA

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_DESCRIBE_ACTION_SCHEMA



# Get Records Activities V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_ACTIVITIES_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORDS_ACTIVITIES_V2



# Get Records Any
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORDS_ANY



# Get Records Deals V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_DEALS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORDS_DEALS_V2



# Get Records Leads V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_LEADS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORDS_LEADS_V2



# Get Records Notes
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_NOTES

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORDS_NOTES



# Get Records Organizations V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_ORGANIZATIONS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORDS_ORGANIZATIONS_V2



# Get Records Persons V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_PERSONS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORDS_PERSONS_V2



# Get Records Users
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_USERS

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORDS_USERS



# Get Record By ID Activities V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_ACTIVITIES_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORD_BY_ID_ACTIVITIES_V2



# Get Record By ID Any
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORD_BY_ID_ANY



# Get Record By ID Deals V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_DEALS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORD_BY_ID_DEALS_V2



# Get Record By ID Leads V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_LEADS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORD_BY_ID_LEADS_V2



# Get Record By ID Notes
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_NOTES

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORD_BY_ID_NOTES



# Get Record By ID Organizations V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_ORGANIZATIONS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORD_BY_ID_ORGANIZATIONS_V2



# Get Record By ID Persons V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_PERSONS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORD_BY_ID_PERSONS_V2



# Get Record By ID Users
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_USERS

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_GET_RECORD_BY_ID_USERS



# Update Record Activities V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_ACTIVITIES_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_UPDATE_RECORD_ACTIVITIES_V2



# Update Record Any
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_UPDATE_RECORD_ANY



# Update Record Deals V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_DEALS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_UPDATE_RECORD_DEALS_V2



# Update Record Leads V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_LEADS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_UPDATE_RECORD_LEADS_V2



# Update Record Notes
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_NOTES

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_UPDATE_RECORD_NOTES



# Update Record Organizations V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_ORGANIZATIONS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_UPDATE_RECORD_ORGANIZATIONS_V2



# Update Record Persons V2
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_PERSONS_V2

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_UPDATE_RECORD_PERSONS_V2



# Update Record Users
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_USERS

actionkit/openapi.json post /projects/{project_id}/actions/#PIPEDRIVE_UPDATE_RECORD_USERS



# Create Component
Source: https://docs.useparagon.com/actionkit/integrations/productboard/PRODUCTBOARD_CREATE_COMPONENT

actionkit/openapi.json post /projects/{project_id}/actions/#PRODUCTBOARD_CREATE_COMPONENT



# Create Feature
Source: https://docs.useparagon.com/actionkit/integrations/productboard/PRODUCTBOARD_CREATE_FEATURE

actionkit/openapi.json post /projects/{project_id}/actions/#PRODUCTBOARD_CREATE_FEATURE



# Delete Feature
Source: https://docs.useparagon.com/actionkit/integrations/productboard/PRODUCTBOARD_DELETE_FEATURE

actionkit/openapi.json post /projects/{project_id}/actions/#PRODUCTBOARD_DELETE_FEATURE



# Get Component By ID
Source: https://docs.useparagon.com/actionkit/integrations/productboard/PRODUCTBOARD_GET_COMPONENT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#PRODUCTBOARD_GET_COMPONENT_BY_ID



# Get Feature By ID
Source: https://docs.useparagon.com/actionkit/integrations/productboard/PRODUCTBOARD_GET_FEATURE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#PRODUCTBOARD_GET_FEATURE_BY_ID



# Get Product By ID
Source: https://docs.useparagon.com/actionkit/integrations/productboard/PRODUCTBOARD_GET_PRODUCT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#PRODUCTBOARD_GET_PRODUCT_BY_ID



# Update Component
Source: https://docs.useparagon.com/actionkit/integrations/productboard/PRODUCTBOARD_UPDATE_COMPONENT

actionkit/openapi.json post /projects/{project_id}/actions/#PRODUCTBOARD_UPDATE_COMPONENT



# Update Feature
Source: https://docs.useparagon.com/actionkit/integrations/productboard/PRODUCTBOARD_UPDATE_FEATURE

actionkit/openapi.json post /projects/{project_id}/actions/#PRODUCTBOARD_UPDATE_FEATURE



# Create Customer
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_CREATE_CUSTOMER

actionkit/openapi.json post /projects/{project_id}/actions/#QUICKBOOKS_CREATE_CUSTOMER



# Create Invoice
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_CREATE_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#QUICKBOOKS_CREATE_INVOICE



# Create Payment
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_CREATE_PAYMENT

actionkit/openapi.json post /projects/{project_id}/actions/#QUICKBOOKS_CREATE_PAYMENT



# Get Accounts
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_GET_ACCOUNTS

actionkit/openapi.json post /projects/{project_id}/actions/#QUICKBOOKS_GET_ACCOUNTS



# Get Customers
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_GET_CUSTOMERS

actionkit/openapi.json post /projects/{project_id}/actions/#QUICKBOOKS_GET_CUSTOMERS



# Get Invoices
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_GET_INVOICES

actionkit/openapi.json post /projects/{project_id}/actions/#QUICKBOOKS_GET_INVOICES



# Get Payments
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_GET_PAYMENTS

actionkit/openapi.json post /projects/{project_id}/actions/#QUICKBOOKS_GET_PAYMENTS



# Send Invoice
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_SEND_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#QUICKBOOKS_SEND_INVOICE



# Update Customer
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_UPDATE_CUSTOMER

actionkit/openapi.json post /projects/{project_id}/actions/#QUICKBOOKS_UPDATE_CUSTOMER



# Update Invoice
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_UPDATE_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#QUICKBOOKS_UPDATE_INVOICE



# Intacct Create Bill
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_CREATE_BILL

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_CREATE_BILL



# Intacct Create Vendor
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_CREATE_VENDOR

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_CREATE_VENDOR



# Intacct Delete Bill
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_DELETE_BILL

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_DELETE_BILL



# Intacct Delete Vendor
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_DELETE_VENDOR

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_DELETE_VENDOR



# Intacct Get Account By ID
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_GET_ACCOUNT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_GET_ACCOUNT_BY_ID



# Intacct Get Bills By ID
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_GET_BILLS_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_GET_BILLS_BY_ID



# Intacct Get Dimensions
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_GET_DIMENSIONS

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_GET_DIMENSIONS



# Intacct Get Payment Term By ID
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_GET_PAYMENT_TERM_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_GET_PAYMENT_TERM_BY_ID



# Intacct Get Vendor By ID
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_GET_VENDOR_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_GET_VENDOR_BY_ID



# Intacct Search Accounts
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_ACCOUNTS

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_SEARCH_ACCOUNTS



# Intacct Search Bills
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_BILLS

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_SEARCH_BILLS



# Intacct Search Payment Terms
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_PAYMENT_TERMS

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_SEARCH_PAYMENT_TERMS



# Intacct Search Vendors
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_VENDORS

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_SEARCH_VENDORS



# Intacct Search Vendor Types
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_VENDOR_TYPES

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_SEARCH_VENDOR_TYPES



# Intacct Update Bill
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_UPDATE_BILL

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_UPDATE_BILL



# Intacct Update Vendor
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_UPDATE_VENDOR

actionkit/openapi.json post /projects/{project_id}/actions/#SAGE_INTACCT_UPDATE_VENDOR



# Create Custom Field Account
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_CUSTOM_FIELD_ACCOUNT



# Create Custom Field Any
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_CUSTOM_FIELD_ANY



# Create Custom Field Contact
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_CUSTOM_FIELD_CONTACT



# Create Custom Field Lead
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_LEAD

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_CUSTOM_FIELD_LEAD



# Create Custom Field Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY



# Create Custom Field Task
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_TASK

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_CUSTOM_FIELD_TASK



# Create Custom Object
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_OBJECT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_CUSTOM_OBJECT



# Create Record Account
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_RECORD_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_RECORD_ACCOUNT



# Create Record Any
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_RECORD_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_RECORD_ANY



# Create Record Contact
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_RECORD_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_RECORD_CONTACT



# Create Record Lead
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_RECORD_LEAD

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_RECORD_LEAD



# Create Record Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_RECORD_OPPORTUNITY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_RECORD_OPPORTUNITY



# Create Record Task
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_RECORD_TASK

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_CREATE_RECORD_TASK



# Describe Action Schema
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_DESCRIBE_ACTION_SCHEMA

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_DESCRIBE_ACTION_SCHEMA



# Get Record By ID Account
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_ID_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_GET_RECORD_BY_ID_ACCOUNT



# Get Record By ID Any
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_ID_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_GET_RECORD_BY_ID_ANY



# Get Record By ID Contact
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_ID_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_GET_RECORD_BY_ID_CONTACT



# Get Record By ID Lead
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_ID_LEAD

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_GET_RECORD_BY_ID_LEAD



# Get Record By ID Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_ID_OPPORTUNITY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_GET_RECORD_BY_ID_OPPORTUNITY



# Get Record By ID Task
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_ID_TASK

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_GET_RECORD_BY_ID_TASK



# Get Record By View ID Account
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_VIEW_ID_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_GET_RECORD_BY_VIEW_ID_ACCOUNT



# Get Record By View ID Any
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_VIEW_ID_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_GET_RECORD_BY_VIEW_ID_ANY



# Get Record By View ID Contact
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_VIEW_ID_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_GET_RECORD_BY_VIEW_ID_CONTACT



# Get Record By View ID Lead
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_VIEW_ID_LEAD

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_GET_RECORD_BY_VIEW_ID_LEAD



# Get Record By View ID Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_VIEW_ID_OPPORTUNITY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_GET_RECORD_BY_VIEW_ID_OPPORTUNITY



# Get Record By View ID Task
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_VIEW_ID_TASK

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_GET_RECORD_BY_VIEW_ID_TASK



# Search Records Account
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_SEARCH_RECORDS_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_SEARCH_RECORDS_ACCOUNT



# Search Records Any
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_SEARCH_RECORDS_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_SEARCH_RECORDS_ANY



# Search Records Contact
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_SEARCH_RECORDS_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_SEARCH_RECORDS_CONTACT



# Search Records Lead
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_SEARCH_RECORDS_LEAD

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_SEARCH_RECORDS_LEAD



# Search Records Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_SEARCH_RECORDS_OPPORTUNITY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_SEARCH_RECORDS_OPPORTUNITY



# Search Records Task
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_SEARCH_RECORDS_TASK

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_SEARCH_RECORDS_TASK



# Update Record Account
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_UPDATE_RECORD_ACCOUNT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_UPDATE_RECORD_ACCOUNT



# Update Record Any
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_UPDATE_RECORD_ANY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_UPDATE_RECORD_ANY



# Update Record Contact
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_UPDATE_RECORD_CONTACT

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_UPDATE_RECORD_CONTACT



# Update Record Lead
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_UPDATE_RECORD_LEAD

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_UPDATE_RECORD_LEAD



# Update Record Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_UPDATE_RECORD_OPPORTUNITY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_UPDATE_RECORD_OPPORTUNITY



# Update Record Task
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_UPDATE_RECORD_TASK

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_UPDATE_RECORD_TASK



# Write SOQL Query
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_WRITE_SOQL_QUERY

actionkit/openapi.json post /projects/{project_id}/actions/#SALESFORCE_WRITE_SOQL_QUERY



# Create Supplier Invoice
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_CREATE_SUPPLIER_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#SAP_CREATE_SUPPLIER_INVOICE



# Delete Supplier Invoice
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_DELETE_SUPPLIER_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#SAP_DELETE_SUPPLIER_INVOICE



# Get Customer By ID
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_GET_CUSTOMER_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#SAP_GET_CUSTOMER_BY_ID



# Get Supplier By ID
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_GET_SUPPLIER_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#SAP_GET_SUPPLIER_BY_ID



# Get Supplier Invoice By ID
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_GET_SUPPLIER_INVOICE_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#SAP_GET_SUPPLIER_INVOICE_BY_ID



# Search Customers
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_SEARCH_CUSTOMERS

actionkit/openapi.json post /projects/{project_id}/actions/#SAP_SEARCH_CUSTOMERS



# Search Suppliers
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_SEARCH_SUPPLIERS

actionkit/openapi.json post /projects/{project_id}/actions/#SAP_SEARCH_SUPPLIERS



# Search Supplier Invoices
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_SEARCH_SUPPLIER_INVOICES

actionkit/openapi.json post /projects/{project_id}/actions/#SAP_SEARCH_SUPPLIER_INVOICES



# Update Customer
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_UPDATE_CUSTOMER

actionkit/openapi.json post /projects/{project_id}/actions/#SAP_UPDATE_CUSTOMER



# Update Supplier
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_UPDATE_SUPPLIER

actionkit/openapi.json post /projects/{project_id}/actions/#SAP_UPDATE_SUPPLIER



# Create Ticket
Source: https://docs.useparagon.com/actionkit/integrations/servicenow/SERVICENOW_CREATE_TICKET

actionkit/openapi.json post /projects/{project_id}/actions/#SERVICENOW_CREATE_TICKET



# Get Tickets
Source: https://docs.useparagon.com/actionkit/integrations/servicenow/SERVICENOW_GET_TICKETS

actionkit/openapi.json post /projects/{project_id}/actions/#SERVICENOW_GET_TICKETS



# Get Ticket By ID
Source: https://docs.useparagon.com/actionkit/integrations/servicenow/SERVICENOW_GET_TICKET_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#SERVICENOW_GET_TICKET_BY_ID



# Update Ticket
Source: https://docs.useparagon.com/actionkit/integrations/servicenow/SERVICENOW_UPDATE_TICKET

actionkit/openapi.json post /projects/{project_id}/actions/#SERVICENOW_UPDATE_TICKET



# Create Item
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_CREATE_ITEM

actionkit/openapi.json post /projects/{project_id}/actions/#SHAREPOINT_CREATE_ITEM



# Create List
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_CREATE_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#SHAREPOINT_CREATE_LIST



# Delete Item
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_DELETE_ITEM

actionkit/openapi.json post /projects/{project_id}/actions/#SHAREPOINT_DELETE_ITEM



# Get Items In A List
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_GET_ITEMS_IN_A_LIST

actionkit/openapi.json post /projects/{project_id}/actions/#SHAREPOINT_GET_ITEMS_IN_A_LIST



# Get Item By ID
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_GET_ITEM_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#SHAREPOINT_GET_ITEM_BY_ID



# Get Lists
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_GET_LISTS

actionkit/openapi.json post /projects/{project_id}/actions/#SHAREPOINT_GET_LISTS



# Get List By ID
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_GET_LIST_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#SHAREPOINT_GET_LIST_BY_ID



# Get List Columns
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_GET_LIST_COLUMNS

actionkit/openapi.json post /projects/{project_id}/actions/#SHAREPOINT_GET_LIST_COLUMNS



# Update Item
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_UPDATE_ITEM

actionkit/openapi.json post /projects/{project_id}/actions/#SHAREPOINT_UPDATE_ITEM



# Create Customer
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_CREATE_CUSTOMER

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_CREATE_CUSTOMER



# Create Order
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_CREATE_ORDER

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_CREATE_ORDER



# Create Product
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_CREATE_PRODUCT

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_CREATE_PRODUCT



# Create Product GRAPHQL
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_CREATE_PRODUCT_GRAPHQL

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_CREATE_PRODUCT_GRAPHQL



# Get Abandoned Carts
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_GET_ABANDONED_CARTS

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_GET_ABANDONED_CARTS



# Get Customers
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_GET_CUSTOMERS

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_GET_CUSTOMERS



# Get Orders
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_GET_ORDERS

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_GET_ORDERS



# Get Products
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_GET_PRODUCTS

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_GET_PRODUCTS



# Get Products GRAPHQL
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_GET_PRODUCTS_GRAPHQL

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_GET_PRODUCTS_GRAPHQL



# Search Customers
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_SEARCH_CUSTOMERS

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_SEARCH_CUSTOMERS



# Update Customer
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_UPDATE_CUSTOMER

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_UPDATE_CUSTOMER



# Update Order
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_UPDATE_ORDER

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_UPDATE_ORDER



# Update Product
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_UPDATE_PRODUCT

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_UPDATE_PRODUCT



# Update Product GRAPHQL
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_UPDATE_PRODUCT_GRAPHQL

actionkit/openapi.json post /projects/{project_id}/actions/#SHOPIFY_UPDATE_PRODUCT_GRAPHQL



# Get Users By Name
Source: https://docs.useparagon.com/actionkit/integrations/slack/SLACK_GET_USERS_BY_NAME

actionkit/openapi.json post /projects/{project_id}/actions/#SLACK_GET_USERS_BY_NAME



# Get User By Email
Source: https://docs.useparagon.com/actionkit/integrations/slack/SLACK_GET_USER_BY_EMAIL

actionkit/openapi.json post /projects/{project_id}/actions/#SLACK_GET_USER_BY_EMAIL



# List Channels
Source: https://docs.useparagon.com/actionkit/integrations/slack/SLACK_LIST_CHANNELS

actionkit/openapi.json post /projects/{project_id}/actions/#SLACK_LIST_CHANNELS



# List Members
Source: https://docs.useparagon.com/actionkit/integrations/slack/SLACK_LIST_MEMBERS

actionkit/openapi.json post /projects/{project_id}/actions/#SLACK_LIST_MEMBERS



# Search Messages
Source: https://docs.useparagon.com/actionkit/integrations/slack/SLACK_SEARCH_MESSAGES

actionkit/openapi.json post /projects/{project_id}/actions/#SLACK_SEARCH_MESSAGES



# Send Direct Message
Source: https://docs.useparagon.com/actionkit/integrations/slack/SLACK_SEND_DIRECT_MESSAGE

actionkit/openapi.json post /projects/{project_id}/actions/#SLACK_SEND_DIRECT_MESSAGE



# Send Message
Source: https://docs.useparagon.com/actionkit/integrations/slack/SLACK_SEND_MESSAGE

actionkit/openapi.json post /projects/{project_id}/actions/#SLACK_SEND_MESSAGE



# Create Customer
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_CREATE_CUSTOMER

actionkit/openapi.json post /projects/{project_id}/actions/#STRIPE_CREATE_CUSTOMER



# Create Product
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_CREATE_PRODUCT

actionkit/openapi.json post /projects/{project_id}/actions/#STRIPE_CREATE_PRODUCT



# Create Subscription
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_CREATE_SUBSCRIPTION

actionkit/openapi.json post /projects/{project_id}/actions/#STRIPE_CREATE_SUBSCRIPTION



# Get Balance Transactions
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_GET_BALANCE_TRANSACTIONS

actionkit/openapi.json post /projects/{project_id}/actions/#STRIPE_GET_BALANCE_TRANSACTIONS



# Get Customers
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_GET_CUSTOMERS

actionkit/openapi.json post /projects/{project_id}/actions/#STRIPE_GET_CUSTOMERS



# Get Customer By ID
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_GET_CUSTOMER_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#STRIPE_GET_CUSTOMER_BY_ID



# Get Plans
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_GET_PLANS

actionkit/openapi.json post /projects/{project_id}/actions/#STRIPE_GET_PLANS



# Get Products
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_GET_PRODUCTS

actionkit/openapi.json post /projects/{project_id}/actions/#STRIPE_GET_PRODUCTS



# Get Product By ID
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_GET_PRODUCT_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#STRIPE_GET_PRODUCT_BY_ID



# Get Subscriptions
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_GET_SUBSCRIPTIONS

actionkit/openapi.json post /projects/{project_id}/actions/#STRIPE_GET_SUBSCRIPTIONS



# Update Customer
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_UPDATE_CUSTOMER

actionkit/openapi.json post /projects/{project_id}/actions/#STRIPE_UPDATE_CUSTOMER



# Create Card
Source: https://docs.useparagon.com/actionkit/integrations/trello/TRELLO_CREATE_CARD

actionkit/openapi.json post /projects/{project_id}/actions/#TRELLO_CREATE_CARD



# Delete Card
Source: https://docs.useparagon.com/actionkit/integrations/trello/TRELLO_DELETE_CARD

actionkit/openapi.json post /projects/{project_id}/actions/#TRELLO_DELETE_CARD



# Get Boards Member Belong To
Source: https://docs.useparagon.com/actionkit/integrations/trello/TRELLO_GET_BOARDS_MEMBER_BELONG_TO

actionkit/openapi.json post /projects/{project_id}/actions/#TRELLO_GET_BOARDS_MEMBER_BELONG_TO



# Get Cards In Board
Source: https://docs.useparagon.com/actionkit/integrations/trello/TRELLO_GET_CARDS_IN_BOARD

actionkit/openapi.json post /projects/{project_id}/actions/#TRELLO_GET_CARDS_IN_BOARD



# Get Lists In Board
Source: https://docs.useparagon.com/actionkit/integrations/trello/TRELLO_GET_LISTS_IN_BOARD

actionkit/openapi.json post /projects/{project_id}/actions/#TRELLO_GET_LISTS_IN_BOARD



# Search Boards
Source: https://docs.useparagon.com/actionkit/integrations/trello/TRELLO_SEARCH_BOARDS

actionkit/openapi.json post /projects/{project_id}/actions/#TRELLO_SEARCH_BOARDS



# Search Cards
Source: https://docs.useparagon.com/actionkit/integrations/trello/TRELLO_SEARCH_CARDS

actionkit/openapi.json post /projects/{project_id}/actions/#TRELLO_SEARCH_CARDS



# Update Card
Source: https://docs.useparagon.com/actionkit/integrations/trello/TRELLO_UPDATE_CARD

actionkit/openapi.json post /projects/{project_id}/actions/#TRELLO_UPDATE_CARD



# Create Customer
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_CREATE_CUSTOMER

actionkit/openapi.json post /projects/{project_id}/actions/#XERO_CREATE_CUSTOMER



# Create Invoice
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_CREATE_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#XERO_CREATE_INVOICE



# Create Payment
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_CREATE_PAYMENT

actionkit/openapi.json post /projects/{project_id}/actions/#XERO_CREATE_PAYMENT



# Get Accounts
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_GET_ACCOUNTS

actionkit/openapi.json post /projects/{project_id}/actions/#XERO_GET_ACCOUNTS



# Get Contacts
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_GET_CONTACTS

actionkit/openapi.json post /projects/{project_id}/actions/#XERO_GET_CONTACTS



# Get Invoices
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_GET_INVOICES

actionkit/openapi.json post /projects/{project_id}/actions/#XERO_GET_INVOICES



# Get Payments
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_GET_PAYMENTS

actionkit/openapi.json post /projects/{project_id}/actions/#XERO_GET_PAYMENTS



# Send Invoice
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_SEND_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#XERO_SEND_INVOICE



# Update Customer
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_UPDATE_CUSTOMER

actionkit/openapi.json post /projects/{project_id}/actions/#XERO_UPDATE_CUSTOMER



# Update Invoice
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_UPDATE_INVOICE

actionkit/openapi.json post /projects/{project_id}/actions/#XERO_UPDATE_INVOICE



# Add Comment To Ticket
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_ADD_COMMENT_TO_TICKET

actionkit/openapi.json post /projects/{project_id}/actions/#ZENDESK_ADD_COMMENT_TO_TICKET



# Create Ticket
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_CREATE_TICKET

actionkit/openapi.json post /projects/{project_id}/actions/#ZENDESK_CREATE_TICKET



# Create User
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_CREATE_USER

actionkit/openapi.json post /projects/{project_id}/actions/#ZENDESK_CREATE_USER



# Get Ticket Audits
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_GET_TICKET_AUDITS

actionkit/openapi.json post /projects/{project_id}/actions/#ZENDESK_GET_TICKET_AUDITS



# Get Ticket By ID
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_GET_TICKET_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#ZENDESK_GET_TICKET_BY_ID



# Get Ticket Fields
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_GET_TICKET_FIELDS

actionkit/openapi.json post /projects/{project_id}/actions/#ZENDESK_GET_TICKET_FIELDS



# Get User By ID
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_GET_USER_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#ZENDESK_GET_USER_BY_ID



# Search Tickets
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_SEARCH_TICKETS

actionkit/openapi.json post /projects/{project_id}/actions/#ZENDESK_SEARCH_TICKETS



# Search Users
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_SEARCH_USERS

actionkit/openapi.json post /projects/{project_id}/actions/#ZENDESK_SEARCH_USERS



# Update Ticket
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_UPDATE_TICKET

actionkit/openapi.json post /projects/{project_id}/actions/#ZENDESK_UPDATE_TICKET



# Update User
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_UPDATE_USER

actionkit/openapi.json post /projects/{project_id}/actions/#ZENDESK_UPDATE_USER



# Add Meeting Registrant
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_ADD_MEETING_REGISTRANT

actionkit/openapi.json post /projects/{project_id}/actions/#ZOOM_ADD_MEETING_REGISTRANT



# Create Meeting
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_CREATE_MEETING

actionkit/openapi.json post /projects/{project_id}/actions/#ZOOM_CREATE_MEETING



# Delete Meeting
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_DELETE_MEETING

actionkit/openapi.json post /projects/{project_id}/actions/#ZOOM_DELETE_MEETING



# Delete Meeting Registrant
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_DELETE_MEETING_REGISTRANT

actionkit/openapi.json post /projects/{project_id}/actions/#ZOOM_DELETE_MEETING_REGISTRANT



# Get Meeting
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_GET_MEETING

actionkit/openapi.json post /projects/{project_id}/actions/#ZOOM_GET_MEETING



# Get Meeting By ID
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_GET_MEETING_BY_ID

actionkit/openapi.json post /projects/{project_id}/actions/#ZOOM_GET_MEETING_BY_ID



# Get Meeting Registrant
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_GET_MEETING_REGISTRANT

actionkit/openapi.json post /projects/{project_id}/actions/#ZOOM_GET_MEETING_REGISTRANT



# Get Recording By Meeting ID
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_GET_RECORDING_BY_MEETING_ID

actionkit/openapi.json post /projects/{project_id}/actions/#ZOOM_GET_RECORDING_BY_MEETING_ID



# Search Recording
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_SEARCH_RECORDING

actionkit/openapi.json post /projects/{project_id}/actions/#ZOOM_SEARCH_RECORDING



# Update Meeting
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_UPDATE_MEETING

actionkit/openapi.json post /projects/{project_id}/actions/#ZOOM_UPDATE_MEETING



# ActionKit
Source: https://docs.useparagon.com/actionkit/overview

ActionKit is an API to give your agentic AI product access to Paragon's catalog of pre-built Integration Actions as tools.

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/ActionKit%20Header.png?maxW=2798&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=2285cd5de7a3ae0a014cb005df5af581" alt="Page cover image" width="2798" height="874" data-path="assets/ActionKit Header.png" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/ActionKit%20Header.png?w=280&maxW=2798&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=fb355fce93fa8ac51e7412f9b712303d 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/ActionKit%20Header.png?w=560&maxW=2798&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=a31af0ecb9544988280fb3b4b38b26ff 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/ActionKit%20Header.png?w=840&maxW=2798&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=c53bfe8525f586f68b4a8deb74e0ed79 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/ActionKit%20Header.png?w=1100&maxW=2798&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=17b7edfe3ed0240addee84440fb66228 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/ActionKit%20Header.png?w=1650&maxW=2798&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=6b008934e9ca3fff3cf8437da08142dc 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/ActionKit%20Header.png?w=2500&maxW=2798&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=1e4645d3abd7e666b69e668bb5921093 2500w" data-optimize="true" data-opv="2" />
</Frame>

**ActionKit** exposes thousands of pre-built operations (Actions) across integrations through *one* consistent interface and a synchronous (real-time) endpoint.

The main use cases for ActionKit include:

1. **AI agent tool calling**: Expose all actions as function tools to your AI agent over the API or MCP server, with agent-optimized descriptions for tool calling accuracy.
2. **Front-end functions**: For use cases where your users interact with integration data in your app, like displaying a table of Salesforce opportunities or a button to send a Slack notification.
3. **Integrations for your workflow product**: Expose all actions as integration nodes in your workflow automation product/feature by wrapping ActionKit’s input schemas.

ActionKit is built for real-life use cases, providing much deeper abstractions that simply wrapping each 3rd-party API. As a result, this comes with benefits including:

* A universal filter schema that works across all list/search operations in any 3rd-party application (ie. "contains", "equals", "greater\_than")
* A `reload_fields` configuration that can re-pull each of your users’ dynamic fields at query-time, ensuring you have full access to their custom fields in the 3rd-party applications
* [Use case-specific schema formats](/actionkit/schema-formats) purpose-built for AI agent use cases and workflow builder implementations


# Schema Formats
Source: https://docs.useparagon.com/actionkit/schema-formats



export function Td({children}) {
  return <td style={{
    verticalAlign: 'top',
    padding: '8px'
  }}>{children}</td>;
}


ActionKit supports multiple formats for accessing Action definitions from the API, for different use cases:

* **JSON Schema** `format=json_schema`
  * For tool-calling agent use cases - in most cases, you can pass Action schemas directly in JSON Schema format to your LLM.
  * To learn more about JSON Schema, reference the [official specification](https://json-schema.org/draft/2020-12/json-schema-core). Paragon does not implement any of the non-standard fields in `draft-*` versions of JSON Schema at this time.
* **Paragon** `format=paragon`
  * For frontend configuration use cases - for example, if you are adding Actions to your product's workflow builder.
  * Learn more about the Paragon format below.

You can request a specific format in the [List Actions](/actionkit/overview#list-actions) API endpoint with the `format` query parameter.

# Paragon Format

## Overview

The Paragon format is the same schema used internally to power our Workflow Editor. It is designed to render input fields to allow end users to configure Actions.

When using the Paragon format, you will need to support the following types of inputs in Paragon:

<table style={{ width: '100%', borderCollapse: 'collapse' }} id="top-aligned-table">
  <thead>
    <tr>
      <th style={{ textAlign: 'left', verticalAlign: 'top', padding: '8px', borderBottom: '2px solid #ddd' }}>Input Type</th>
      <th style={{ textAlign: 'left', verticalAlign: 'top', padding: '8px', borderBottom: '2px solid #ddd' }}>Key(s)</th>
      <th style={{ textAlign: 'left', verticalAlign: 'top', padding: '8px', borderBottom: '2px solid #ddd' }}>Example</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td><strong>Enum input</strong> (dropdown)</td>
      <td><code>ENUM</code> | <code>DYNAMIC\_ENUM</code></td>

      <td>
        <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-input.png?maxW=1156&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=688cbfe467252f46dc8b90e2f7a7d8db" width="1156" height="220" data-path="assets/enum-input.png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-input.png?w=280&maxW=1156&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ae8e8697c3b83fd7c3587a93aee5f026 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-input.png?w=560&maxW=1156&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=d466bb121b4cca65c082f860719a9f70 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-input.png?w=840&maxW=1156&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=c8f315539de6faa90276faffc854441b 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-input.png?w=1100&maxW=1156&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=5c192a65e987e2a57ef825f01d21a198 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-input.png?w=1650&maxW=1156&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=dad911ead686bc54465e1aa97cb20345 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-input.png?w=2500&maxW=1156&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=3f88428c5a48ff932601021023d4a601 2500w" data-optimize="true" data-opv="2" />
      </td>
    </tr>

    <tr>
      <td>
        <strong>Enum input with free text support</strong><br />
        The user should be able to add their own option, if unavailable in the list
      </td>

      <td><code>EDITABLE\_ENUM</code></td>

      <td>
        <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/editable-enum.png?maxW=1152&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=dc8999a51f88fb45282e4e7e7b2f388a" width="1152" height="750" data-path="assets/editable-enum.png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/editable-enum.png?w=280&maxW=1152&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=f5673701fd177ec02717c32349b583bd 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/editable-enum.png?w=560&maxW=1152&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=d5e3cc7c02862245afb51d730efa318b 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/editable-enum.png?w=840&maxW=1152&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=135503d8b14881c7639a4dcac9babc72 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/editable-enum.png?w=1100&maxW=1152&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ce9948beb4f95860c793f7fcb792762d 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/editable-enum.png?w=1650&maxW=1152&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=e21a87ab345030464fa742e1963c5ce7 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/editable-enum.png?w=2500&maxW=1152&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=f530f92bf2ef11aa4ef0f33ec33cee27 2500w" data-optimize="true" data-opv="2" />
      </td>
    </tr>

    <tr>
      <td>
        <strong>Enum input with text area</strong><br />
        A text input should appear to the right of the dropdown.
      </td>

      <td><code>EnumTextAreaPairInput</code></td>

      <td>
        <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-textarea-pair.png?maxW=1166&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=662938951b2951a05997b1be1975d3b5" width="1166" height="290" data-path="assets/enum-textarea-pair.png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-textarea-pair.png?w=280&maxW=1166&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=7031c67bc76d3f80d788cc9816a038ab 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-textarea-pair.png?w=560&maxW=1166&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=65020cfe40bf8c908cf3ee9462bce78b 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-textarea-pair.png?w=840&maxW=1166&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=7f0df63f67971a8d5f9263b908a6eac4 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-textarea-pair.png?w=1100&maxW=1166&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=87ca1bcbfdb96c3ae2d6ec17af77b27f 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-textarea-pair.png?w=1650&maxW=1166&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=fb4b7a983888697f57daf54692d476d5 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/enum-textarea-pair.png?w=2500&maxW=1166&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=80919c32de2b095b99f4324bed2fcdbe 2500w" data-optimize="true" data-opv="2" />
      </td>
    </tr>

    <tr>
      <td>**Text input**</td>
      <td><code>TEXT</code> | <code>TEXT\_NO\_VARS</code></td>

      <td>
        <img src="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/text.png?maxW=1146&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=4d147f24eb829ef0e9e439d3c60e898b" width="1146" height="272" data-path="assets/text.png" srcset="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/text.png?w=280&maxW=1146&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=488b10b92f23f6129af70616b3c4e499 280w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/text.png?w=560&maxW=1146&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=aa61099f5707cb4a492552004f479498 560w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/text.png?w=840&maxW=1146&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=128dfcdec0881539ac0ecf36735f5123 840w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/text.png?w=1100&maxW=1146&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=e3f8a4d3e6381e314f19cc837dba0cf3 1100w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/text.png?w=1650&maxW=1146&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=4cdf48f574f06d6f16ee7777b73fa5d1 1650w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/text.png?w=2500&maxW=1146&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=4348fc2ace0cf5f26efff06291513541 2500w" data-optimize="true" data-opv="2" />
      </td>
    </tr>

    <tr>
      <td>**Textarea input**<br />Note that by default, lines = 1 (in this case, this input should look identical to a text input).</td>
      <td><code>TEXTAREA</code> | <code>TEXTAREA\_NO\_VARS</code></td>

      <td>
        <img src="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/textarea-input.png?maxW=1166&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=c4fa48f41225a47b76cfcd76e86ee18f" width="1166" height="534" data-path="assets/textarea-input.png" srcset="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/textarea-input.png?w=280&maxW=1166&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=8577e54456fe5657a182636075b87436 280w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/textarea-input.png?w=560&maxW=1166&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=8f571f95eab747962cd3355bd591aee3 560w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/textarea-input.png?w=840&maxW=1166&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=dfe956e304e8a01b954d799dbc4d080d 840w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/textarea-input.png?w=1100&maxW=1166&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=b99f2962c156f60f2435c637c8d8751e 1100w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/textarea-input.png?w=1650&maxW=1166&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=11d4f03971ae37d6e6f1bc47a3265887 1650w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/textarea-input.png?w=2500&maxW=1166&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=ac7a51e51b1469a3de6ad3411691c594 2500w" data-optimize="true" data-opv="2" />
      </td>
    </tr>

    <tr>
      <td>**Code input**</td>
      <td><code>CODE</code></td>

      <td>
        <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/code-input.png?maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=13a59a0693fe4109b7b86bf8eb1a82a8" width="1146" height="444" data-path="assets/code-input.png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/code-input.png?w=280&maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=8a2e7e6374c6978e40324cc89fa10a33 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/code-input.png?w=560&maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=b9960348601932c9b0138f69074bf184 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/code-input.png?w=840&maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=06b5c56d1acfcff8a0d98f59c32e45a4 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/code-input.png?w=1100&maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=c2b3286252c51bd23aa4de6386befe21 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/code-input.png?w=1650&maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=03d0d43d57beadcac50028d964d20581 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/code-input.png?w=2500&maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=81c45cc728163f8ed2d6cd929c8aef1d 2500w" data-optimize="true" data-opv="2" />
      </td>
    </tr>

    <tr>
      <td>**Boolean input** (switch / toggle)</td>
      <td><code>BOOLEAN\_INPUT</code> | <code>SWITCH</code></td>

      <td>
        <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/boolean-input.png?maxW=1152&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=fa2beb1241fd6b635cd4b8297eccf612" width="1152" height="324" data-path="assets/boolean-input.png" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/boolean-input.png?w=280&maxW=1152&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=eb6b7435c36e73f69a7ff6521ebb10d8 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/boolean-input.png?w=560&maxW=1152&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=f275379bc841b47f4131db702e8cd092 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/boolean-input.png?w=840&maxW=1152&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=746837c34921476315f86b3f637895f3 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/boolean-input.png?w=1100&maxW=1152&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=eea894c88e532383f7e55197e7a945d6 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/boolean-input.png?w=1650&maxW=1152&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=ebf509667de5486966ba40ec91a27edb 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/boolean-input.png?w=2500&maxW=1152&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=7d4e3b39a12b9d7acc79538ac9226f21 2500w" data-optimize="true" data-opv="2" />
      </td>
    </tr>

    <tr>
      <td>**Filter / conditional input**</td>
      <td><code>CONDITIONAL</code> | <code>DYNAMIC\_CONDITIONAL</code></td>

      <td>
        <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/conditional-input.png?maxW=1360&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ef1f5782593c6ea71257f5232e98e2d1" width="1360" height="710" data-path="assets/conditional-input.png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/conditional-input.png?w=280&maxW=1360&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=14702781a07aa15d4fd31861ae150c1a 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/conditional-input.png?w=560&maxW=1360&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=fec172fe355d89b87eeb8ca20020ebf6 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/conditional-input.png?w=840&maxW=1360&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=b1a1882d60c66fe3585fda6ad2e309b1 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/conditional-input.png?w=1100&maxW=1360&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=53b85ffb5e3d2834851a17f67e8aa522 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/conditional-input.png?w=1650&maxW=1360&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=94d02d658abf1647f5d23cac879bdfcc 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/conditional-input.png?w=2500&maxW=1360&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=aab25bc62d694d34477f6f28af39e219 2500w" data-optimize="true" data-opv="2" />
      </td>
    </tr>
  </tbody>
</table>

## Action polymorphism

To best support tool calling, the `json_schema` format automatically breaks down polymorphism in Actions as individual tools.

For example, `SALESFORCE_CREATE_RECORD` splits into distinct Actions:

* `SALESFORCE_CREATE_OPPORTUNITY`
* `SALESFORCE_CREATE_CONTACT`
* `SALESFORCE_CREATE_ACCOUNT`
* `SALESFORCE_CREATE_LEAD`
* `SALESFORCE_CREATE_ANY`
  * For non-standard objects, whose fields can be discovered with `SALESFORCE_DESCRIBE_ACTION_SCHEMA`

In the `paragon` format, polymorphic schemas are not broken into individual Actions and instead will be represented as `dependentInputs` within the API (see below example).

When calling [Run Action](/actionkit/overview#run-action), you can reference either the specific Action (e.g. `SALESFORCE_CREATE_OPPORTUNITY`) or the generic Action (e.g. `SALESFORCE_CREATE_RECORD`), as long as the required parameters are supplied.

```json
// Example format=paragon Action Schema:
{
    "name": "SALESFORCE_CREATE_RECORD",
    "title": "Create record",
    "inputs": [
        {
            "id": "recordType",
            "title": "Record type",
            "type": "ENUM",
            "required": true,
            "values": [
                {
                    "value": "Opportunity",
                    // When recordType = "Opportunity", show inputs:
                    "dependentInputs": [...]
                },
                {
                    "value": "Contact",
                    // When recordType = "Contact", show inputs:
                    "dependentInputs": [...]
                },
                ...
            ]
        }
    ]
}
```


# Supported Integrations
Source: https://docs.useparagon.com/actionkit/supported-integrations



View a list of all the integrations that are currently supported by ActionKit.

Available Actions are also listed in the [Reference](/actionkit/integrations) section under each integration name.

<Info>
  We are rapidly expanding support for ActionKit across the Integrations Catalog. If you have a request to add a specific integration, please [contact us](mailto:support@useparagon.com).
</Info>

* Adobe Experience Manager
* Asana
* Azure DevOps
* BambooHR
* Box
* Calendly
* ClickUp
* Coda
* Confluence
* DocuSign
* Dropbox
* Dropbox Sign
* Dynamics 365 Business Central
* Facebook Ads
* Figma
* Freshdesk
* Front
* GitHub
* Gmail
* Gong
* Google Calendar
* Google Drive
* Google Search Console
* Google Sheets
* Gusto
* HubSpot
* Intercom
* Jira
* Klaviyo
* Lever
* Linear
* LinkedIn
* Mailchimp
* Marketo
* Microsoft Outlook
* Microsoft Teams
* Monday.com
* NetSuite
* Notion
* OneDrive
* Oracle Eloqua
* Outreach
* PandaDoc
* Pardot
* Pipedrive
* Productboard
* QuickBooks
* Sage Intacct
* Salesforce
* SAP S/4HANA
* ServiceNow
* SharePoint
* Shopify
* Slack
* Stripe
* Trello
* Xero
* Zendesk
* Zoom


# SDK / API Reference
Source: https://docs.useparagon.com/apis/api-reference



## Paragon SDK and API Methods

Below are all the public functions exposed on the Paragon SDK global, accessible at `window.paragon`, and/or the Paragon REST API.

**For **[on-premise](/on-premise/hosting-paragon-on-premise)**/single-tenant users:**

If you are using an on-prem/single-tenant instance of Paragon, you can call the `.configureGlobal` function to point the SDK to use the base hostname of your Paragon instance.

```js
import { paragon } from "@useparagon/connect";

// If your login URL is https://dashboard.mycompany.paragon.so:
paragon.configureGlobal({
  host: "mycompany.paragon.so",
});
```

### .authenticate(projectId: string, userToken: string)

`.authenticate` should be called at the beginning of your application's lifecycle in all cases. This is to make sure that the `userToken` is always as fresh as possible, with respect to your user's existing session on your own site.

```js JavaScript SDK
await paragon.authenticate(
  // You can find your project ID in the Overview tab of any Integration
  "38b1f170-0c43-4eae-9a04-ab85325d99f7",

  // See Setup for how to encode your user token
  "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.ey..."
);
```

Once `.authenticate` has been called, you can access the user's integration state with `.getUser()`. `.authenticate()` only needs to be called when using the Paragon SDK - when making requests to the Paragon REST API, you should instead provide the Paragon User Token in the Authorization header.

### .connect(integrationType: string, installOptions?: InstallOptions)

Call `.connect` to launch your Connect Portal for a specific integration provider. You can find the `integrationType` identifier you need in the Overview page for the integration.

```js JavaScript SDK
paragon.connect("salesforce");
```

This function must be called after the Paragon SDK has completed authentication. You can `await` the Promise returned by `#.authenticate-projectid-string-usertoken-string` to show a loading state before users are able to access the Connect Portal.

You *must* have an integration configured of this `integrationType` in your Paragon project for the Connect Portal to appear. Otherwise, this function does nothing.

<Accordion title="Optional `installOptions`">
  * `onSuccess` Callback invoked when an integration is successfully enabled.

  - `onError` Callback if an unexpected error occurs.

  - `accountType` For integrations that support multiple account types, you can optionally designate a specific `accountType` to skip the account selection dialog.

    * `default`

    * `sandbox`

  **Example**

  ```js
  paragon.connect("salesforce", {
    // Only allow production-type Salesforce accounts to connect
    accountType: "default",
  });
  ```
</Accordion>

You can also connect multiple accounts for the same integration.

<Card title="Multi Account Authorization" href="/apis/api-reference/multi-account-authorization" horizontal />

### .disableWorkflow(workflowId: string) -> Promise

Call `.disableWorkflow` to turn off a workflow for a user by ID.

<CodeGroup>
  ```javascript JavaScript SDK
  paragon.disableWorkflow("<Workflow ID>");
  ```

  REST API

  ```bash REST API
  DELETE https://api.useparagon.com/projects/<Project ID>/sdk/workflows/<Workflow ID>

  Authorization: Bearer <Paragon User Token>
  ```
</CodeGroup>

### .enableWorkflow(workflowId: string) -> Promise

Call `.enableWorkflow` to turn on a workflow for a user by ID.

<CodeGroup>
  ```javascript JavaScript SDK
  paragon.enableWorkflow("<Workflow ID>");
  ```

  REST API

  ```bash REST API
  POST https://api.useparagon.com/projects/<Project ID>/sdk/workflows/<Workflow ID>

  Authorization: Bearer <Paragon User Token>
  ```
</CodeGroup>

### .getIntegrationMetadata(integrationType: string?)

Call `.getIntegrationMetadata` to get the `name`, `brandColor`, and `icon`, for any of your active integration providers. This is a great way to create your integrations page!

<CodeGroup>
  ```JS JavaScript SDK
  paragon.getIntegrationMetadata();

  // Response
  {
      [
          {
              type: 'salesforce',
              name: 'Salesforce',
              brandColor: '#057ACF',
              icon: 'https://cdn.useparagon.com/2.35.0/dashboard/public/integrations/salesforce.svg'
          },
          {
              type: 'hubspot',
              name: 'Hubspot',
              brandColor: '#F67600',
              icon: 'https://cdn.useparagon.com/2.35.0/dashboard/public/integrations/hubspot.svg'
          },
          {
              type: 'slack',
              name: 'Slack',
              brandColor: '#4A154B',
              icon: 'https://cdn.useparagon.com/2.35.0/dashboard/public/integrations/slack.svg'
          }
      ]
  }
  ```

  ```bash REST API
  GET https://api.useparagon.com/projects/<Paragon Project ID>/sdk/metadata

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json

  // Response
  {
      [
          {
              type: 'salesforce',
              name: 'Salesforce',
              brandColor: '#057ACF',
              icon: 'https://cdn.useparagon.com/2.35.0/dashboard/public/integrations/salesforce.svg'
          },
          {
              type: 'hubspot',
              name: 'Hubspot',
              brandColor: '#F67600',
              icon: 'https://cdn.useparagon.com/2.35.0/dashboard/public/integrations/hubspot.svg'
          },
          {
              type: 'slack',
              name: 'Slack',
              brandColor: '#4A154B',
              icon: 'https://cdn.useparagon.com/2.35.0/dashboard/public/integrations/slack.svg'
          }
      ]
  }
  ```
</CodeGroup>

### .getUser() → ParagonUser

Call `.getUser` to retrieve the currently authenticated user and their connected integration state.

A **ParagonUser** is an object shaped like:

<CodeGroup>
  ```javascript JavaScript SDK
  paragon.getUser();

  // Response
  {
  	authenticated: true,
  	userId: "xyz", // The user ID you specified in the signed JWT
  	integrations: {
  		salesforce: {
  			configuredWorkflows: {},
  			credentialId: "987654-56a7-89b1-cd23-456789abcdef",
  			credentialStatus: "VALID",
  			enabled: true
  			providerData: {
  				instanceURL: "https://mycompany.my.salesforce.com"
  			},
  			providerId: "1234567890"
  		},
  		shopify: {
  			configuredWorkflows: {},
  			enabled: false
  		}
  	}
  }
  ```

  ```bash REST API
  GET https://api.useparagon.com/projects/<Paragon Project ID>/sdk/me

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json

  // Response
  {
  	authenticated: true,
  	userId: "xyz", // The user ID you specified in the signed JWT
  	integrations: {
  		salesforce: {
  			configuredWorkflows: {},
  			credentialId: "987654-56a7-89b1-cd23-456789abcdef",
  			credentialStatus: "VALID",
  			enabled: true
  			providerData: {
  				instanceURL: "https://mycompany.my.salesforce.com"
  				},
  			providerId: "1234567890"
  		},
  		shopify: {
  			configuredWorkflows: {},
  			enabled: false
  		}
  	}
  }
  ```
</CodeGroup>

If the user is not authenticated, you'll receive back only `{ authenticated: false }` instead. Please check the `authenticated` property before using the `user.integrations` field.

### .event(name: string, json: JSON)

App Events can be sent from your application using the Paragon SDK or REST API. In both cases, you must pass two parameters:

* **name** - the event name defined in your App Event

* **payload** - the event payload that should match the event schema defined in your App Event

See the code examples below for how to send App Events using the Paragon SDK or API.

<CodeGroup>
  ```javascript JavaScript SDK
  var eventName = "Contact Created";
  var eventPayload = { "name": "Brandon", "email": "b@useparagon.com" };

  // Called once during your user's session
  paragon.authenticate("project-id", <Paragon User Token>);

  // Trigger the "Contact Created" App Event
  paragon.event(eventName, eventPayload);
  ```

  ```bash REST API
  // Trigger the "Contact Created" App Event
  POST https://api.useparagon.com/projects/<Paragon Project ID>/sdk/events/trigger

  // Headers
  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json

  // Body
  {
      "name": "Contact Created",
      "payload": {
          "name": "Brandon",
          "email": "b@useparagon.com"
      }
  }
  ```
</CodeGroup>

When sending live events from your application, Paragon will not validate that your event payload matches the defined event schema.

### .installIntegration(integrationType: string, installOptions?: InstallOptions) -> Promise\<IntegrationInstallEvent>

<Info>
  This function should be used only if you are using your own components to show connected integrations and their status, instead of the Connect Portal.

  Otherwise, you can use [the `.connect` function](/apis/api-reference#connect-integrationtype%3A-string%2C-installoptions%3F%3A-installoptions).
</Info>

The `.installIntegration` can be used to start the connection process for an integration *without* the Connect Portal appearing over your user interface. You can find the `integrationType` identifier you need in the Overview page for the integration.

This function resolves with the `IntegrationInstallEvent` in the same format available in `paragon.subscribe`. You can use this to get the newly created credential by awaiting the returned Promise.

This function rejects the returned Promise if the integration is already installed for the authenticated user.

```js JavaScript SDK
const { credential } = await paragon.installIntegration("googledrive");
```

**Note**: If the integration specified by `integrationType` requires API keys or post-authentication options, the Connect Portal will still appear to capture those values from your user at that time. The Connect Portal will automatically be dismissed after those values are entered.

This function accepts the same optional install options as [#.connect-integration](/apis/api-reference#connect-integrationtype%3A-string%2C-installoptions%3F%3A-installoptions).

### .subscribe(eventName: string, handler: Function)

Call `.subscribe` to subscribe to different events and changes from the Paragon SDK. You can find the possible `eventNames` below:

| Event Type                | Usage in `.subscribe()`    | Usage in `.connect()` |
| ------------------------- | -------------------------- | --------------------- |
| **Integration enabled**   | `"onIntegrationInstall"`   | `"onInstall"`         |
| **Integration disabled**  | `"onIntegrationUninstall"` | `"onUninstall"`       |
| **Workflow state change** | `"onWorkflowChange"`       | `"onWorkflowChange"`  |
| **Connect Portal opened** | `"onPortalOpen"`           | `"onOpen"`            |
| **Connect Portal closed** | `"onPortalClose"`          | `"onClose"`           |

Subscribing to SDK Events applies to all integrations *globally*. Specifying callbacks to `.connect()` only applies to a currently open Connect Portal *locally*.

See the code examples below for how to subscribe to events using the Paragon SDK.

<CodeGroup>
  ```typescript Integration Enabled / Disabled
  type IntegrationInstallEvent = {
    integrationId: string;
    integrationType: VisibleConnectAction;
    credential: Credential;
    credentialId: string;
  };

  // Using global subscribe
  paragon.subscribe(
    "onIntegrationInstall",
    (event: IntegrationInstallEvent, user: AuthenticatedConnectUser) => { /* ... */ }
  );
  ```

  ```typescript Workflow State Changed
  type WorkflowStateChangeEvent = {
    integrationId: string;
    workflowId: string;
  };

  // Using global subscribe
  paragon.subscribe(
    "onWorkflowChange",
    (event: WorkflowStateChangeEvent, user: AuthenticatedConnectUser) => { /* ... */ }
  );
  ```

  ```typescript Connect Portal Opened / Closed
  type PortalOpenEvent = {
    integrationId: string;
    integrationType: VisibleConnectAction;
  };

  type PortalCloseEvent = {
    integrationId: string;
    integrationType: VisibleConnectAction;
  };

  // Using global subscribe
  paragon.subscribe(
    "onPortalOpen",
    (event: PortalOpenEvent, user: AuthenticatedConnectUser) => { /* ... */ }
  );
  paragon.subscribe(
    "onPortalClose",
    (event: PortalCloseEvent, user: AuthenticatedConnectUser) => { /* ... */ }
  );
  ```
</CodeGroup>

Alternatively, you can subscribe `onOpen`, `onClose`, `onUninstall` , and `onWorkflowChange` as a one-time event locally.

<CodeGroup>
  ```typescript Integration Enabled / Disabled
  type IntegrationInstallEvent = {
    integrationId: string;
    integrationType: VisibleConnectAction;
    credential: Credential;
    credentialId: string;
  };

  // Using local call to paragon.connect
  paragon.connect("<integration>", {
    onInstall: (event: IntegrationInstallEvent, user: AuthenticatedConnectUser) => { /* ... */ }
  });
  ```

  ```typescript Workflow State Changed
  type WorkflowStateChangeEvent = {
    integrationId: string;
    workflowId: string;
  };

  // Using local call to paragon.connect
  paragon.connect("<integration>", {
    onWorkflowChange: (event: WorkflowStateChangeEvent, user: AuthenticatedConnectUser) => {/* ... */}
  });
  ```

  ```typescript Connect Portal Opened / Closed
  type PortalOpenEvent = {
    integrationId: string;
    integrationType: VisibleConnectAction;
  };

  type PortalCloseEvent = {
    integrationId: string;
    integrationType: VisibleConnectAction;
  };

  // Using local call to paragon.connect
  paragon.connect("<integration>", {
    onOpen: (event: PortalOpenEvent, user: AuthenticatedConnectUser) => {/* ... */},
    onClose: (event: PortalCloseEvent, user: AuthenticatedConnectUser) => {/* ... */}
  });
  ```
</CodeGroup>

### .request(integrationType: string, path: string, requestOptions: RequestInit ) → Promise

Call `.request` to send an API request to a third-party integration on behalf of one of your users.

Every integration in your dashboard has a code example of using `paragon.request`, which takes three arguments:

* `integrationType`: The short name for the integration. i.e. "salesforce" or "googleCalendar". You can find this string on the Overview tab of the integration you want to access, on your Paragon dashboard.

* `path`: The path (without the hostname) of the API request you are trying to access. An example might be: "/v1/charges" for Stripe's charge API or "chat.postMessage" for Slack's Web API.

* `requestOptions`: Request options to include, such as:

  * `body`: An object representing JSON contents of the request.

  * `method`: An HTTP verb such as "GET" or "POST". Defaults to GET.

The function returns a promise for the request output, which will have a shape that varies depending on the integration and API endpoint.

<CodeGroup>
  ```typescript JavaScript SDK
  await paragon.request('slack', '/chat.postMessage', {
  	method: 'POST',
  	body: {
  		channel: 'CXXXXXXX0' // Channel ID,
  		text: 'This message was sent with Paragon Connect :exploding_head:'
  	}
  });

  // -> Responds with { ok: true }, and sends a message :)
  ```

  ```bash REST API
  POST https://proxy.useparagon.com/projects/<Paragon Project ID>/sdk/proxy/slack/chat.postMessage

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json

  {
      "channel": "CXXXXXXX0",
      "text": "This message was sent with Paragon Connect :exploding_head:"
  }

  // -> Responds with { output: { ok: true }}, and sends a message :)
  ```
</CodeGroup>

### .setUserMetadata(meta: object)

Call `.setUserMetadata()` to associate the authenticated user with metadata from your application. This metadata can be accessed with `.getUser()` or retrieved over the API.

<CodeGroup>
  ```typescript JavaScript SDK
  paragon.setUserMetadata({
      Name: "Sean V",
      Email: "sean@useparagon.com",
      apiKey: "key_Y0kBVldPFInxK"
  });
  ```

  **Request**

  ```bash REST API
  PATCH https://api.useparagon.com/projects/<Project ID>/sdk/me

  // Headers
  Authorization: <Paragon User Token>
  Content-Type: application/json

  // Body
  { "meta": { "Email": "sean@useparagon.com", "apiKey": "key_Y0kBVldPFInxK" } }
  ```
</CodeGroup>

### .uninstallIntegration(integrationType: string) -> Promise

Call `.uninstallIntegration()` to disconnect an integration for the authenticated user.

When an integration is disconnected, workflows for that integration will stop running for the authenticated user and any saved User Settings will be cleared.

<CodeGroup>
  ```typescript JavaScript SDK
  // Use the integration name, as used in paragon.connect();
  await paragon.uninstallIntegration("salesforce");
  ```

  Get the ID of the integration you want to disconnect, with the `/sdk/integrations` endpoint:

  **Request**

  ```bash REST API
  GET https://api.useparagon.com/projects/<Project ID>/sdk/integrations

  // Headers
  Authorization: Bearer <Paragon User Token>

  // Response
  [
      { "id": "<Integration ID>", "type": "salesforce", ... },
      {...}
  ]

  // The <Integration ID> can be used to disconnect the integration for the user:

  DELETE https://api.useparagon.com/projects/<Project ID>/sdk/integrations/<Integration ID>

  // Headers
  Authorization: Bearer <Paragon User Token>
  ```
</CodeGroup>

### .workflow(workflowId: string, options: FetchOptions)

Call `.workflow()` to trigger a Paragon workflow that sends a custom response back to your app. Note: The workflow must be enabled and use a Request-type trigger.

<CodeGroup>
  ```javascript Javascript SDK
  // Called once during your user's session
  paragon.authenticate("project-id", <Paragon User Token>)

  // Trigger the "Lead Created" workflow
  await paragon.workflow("<workflow_id>", {
    "body": {
      "email": "bowie@useparagon.com",
      "first_name": "Bowie",
      "last_name": "Foo"
    }
  });

  ```

  ```bash REST API
  // Trigger the "Lead Created" Workflow
  POST https://api.useparagon.com/projects/<Paragon Project ID>/sdk/triggers/<Workflow ID>

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json

  {
    "email": "bowie@useparagon.com",
    "first_name": "Bowie",
    "last_name": "Foo
  }
  ```
</CodeGroup>

### Get project's integrations

Returns a list of the integrations enabled for the Paragon project by the ID in the URL.

* Includes the Connect Portal configuration for each integration (as `.configs`) and the Workflows associated with each integration (as `.workflows`)

* The **providerId** is the authenticated user's ID assigned by their integration provider (e.g. for a Salesforce integration, this would be the user's Salesforce user ID)

This method is currently available via REST API only.

```bash REST API
GET https://api.useparagon.com/projects/<Paragon Project ID>/sdk/integrations

Authorization: Bearer <Paragon User Token>
Content-Type: application/json

// Example response (may include more than is in this list):

[{
  "id": "2f08e65f-d924-42ab-9618-b6023d82ffbd",
  "dateCreated": "2021-03-02T00:22:33.166Z",
  "dateUpdated": "2021-03-02T00:22:33.166Z",
  "projectId": "908f4c5e-6394-46a5-9355-3f729edbd160",
  "customIntegrationId": null,
  "type": "slack",
  "isActive": true,
  "configs": [
        {
        "id": "3ebcc179-a1a6-447f-8dc9-5017f40f08ef",
        "dateCreated": "2021-03-02T00:22:33.166Z",
        "dateUpdated": "2023-05-15T21:01:00.260Z",
        "integrationId": "2f08e65f-d924-42ab-9618-b6023d82ffbd",
        "values": {
          "overview": "####Our Slack integration enables you to:\n   \n\n• Receive alerts and notifications in your Slack workspace\n• Notify or DM specific team members based on certain activity",
          "sharedMeta": {},
          "accentColor": "#4A154B",
          "description": "Send notifications to Slack",
          "workflowMeta": {}
        }
    },
  ],
  "workflows" [
        {
        "id": "1b22193b-e355-458d-b6a3-5e5516edb588",
        "dateCreated": "2021-06-02T23:17:05.714Z",
        "dateUpdated": "2021-07-13T20:55:41.895Z",
        "description": "Send Updates to Slack",
        "projectId": "908f4c5e-6394-46a5-9355-3f729edbd160",
        "teamId": "2116f794-07c7-4dfe-a302-e816a2f7ed72",
        "isOnboardingWorkflow": false,
        "integrationId": "2f08e65f-d924-42ab-9618-b6023d82ffbd",
        "steps": []
      },
  ],
  "customIntegration": null,
  "hasCredential": true,
  "connectedUserLimitOnDevCred": 0,
  "connectedUserLimitReached": true,
  "name": "Slack",
  "brandColor": "#4A154B",
  "needPreOauthInputs": false,
  "providerType": "slack",
  "authenticationType": "oauth"
}]
```

### Get user's Connect credentials

Returns a list of the user's Connect credentials (i.e., the accounts connected and authorized by the end user).

This method is currently available via REST API only.

```bash REST API
GET https://api.useparagon.com/projects/<Paragon Project ID>/sdk/credentials

Authorization: Bearer <Paragon User Token>
Content-Type: application/json

// Example response (may include more than is in this list):

[{
  "id": "00da4146-7ac4-4253-a8f7-96849b8137d9",
  "dateCreated": "2021-03-24T12:19:21.511Z",
  "dateUpdated": "2021-03-24T12:19:28.512Z",
  "dateDeleted": null,
  "projectId": "db06d291-ba2c-41c5-9a12-9362abfd6228",
  "integrationId": "95bedc9f-6a22-4855-b08d-e68dc073ad91",
  "personaId": "0563109f-5e71-46c5-8483-1ac8c0913d6c",
  "config": {
    "configuredWorkflows": {
      "3eb95154-3c7b-413c-bf14-ba367d95b53f": {
        "enabled": true,
        "settings": {
					"example-input-id": "example value"
				}
      }
    }
  },
  "isPreviewCredential": false,
  "providerId": "50150244515"
}]
```

### Update user's Connect credential

Updates the user's connected integration account, including any settings and configured workflows.

This endpoint updates by replacement with respect to the `config` property, so this endpoint should only be used after retrieving the existing value (which can be done by using the above endpoint: [Get user's Connect credentials](/apis/api-reference#get-user’s-connect-credentials)).

This method is currently available via REST API only.

```bash REST API
PATCH https://api.useparagon.com/projects/<Paragon Project ID>/sdk/credentials/<Connect Credential ID>

Authorization: Bearer <Paragon User Token>
Content-Type: application/json

// Body: Example showing <Workflow ID> being enabled
{
    "config": {
        "configuredWorkflows": {
            ...
            "<Workflow ID>": {
                "enabled": true,
                "settings": {}
            }
        },
        "sharedSettings": {...}
    }
}
```

**Note**: In the above example, the existing value for `config` must be provided in full, with the intended changes applied. This is because `config` will be updated by replacement.

## ExternalFilePicker

You can use the Paragon SDK to allow your user to select files from a File Storage integration in your app.

The SDK provides an `ExternalFilePicker` class to load any necessary JavaScript dependencies into your page and authenticate with your user's connected account.

#### Supported integrations for ExternalFilePicker

* [Google Drive](/resources/integrations/google-drive#using-the-google-drive-file-picker)
* [OneDrive](/resources/integrations/onedrive#using-the-onedrive-file-picker)
* [SharePoint](/resources/integrations/sharepoint#using-the-sharepoint-file-picker)

### new paragon.ExternalFilePicker(integrationType, options)

Construct a new instance of an ExternalFilePicker for an integration given by `integrationType`. Any required JS dependencies do not start loading until [`.init`](/apis/api-reference#picker-init-initconfig) is called.

**Example:**

```javascript
const picker = new paragon.ExternalFilePicker("googledrive", {
  allowedTypes: ["application/pdf"],
  allowMultiSelect: false,
  onFileSelect(files) {
    console.log("User picked files", files);
  }
});
```

#### Options

* `allowedTypes` (default: `undefined`)

  * An array of MIME types to allow for file selection, e.g. `["application/pdf", "image/jpeg"]`

  * If `undefined`, all types will be allowed.

* `allowMultiSelect` (default: `false`)

  * If `true`, allow multiple files to be selected.

* `allowFolderSelect` (default: `false`)

  * If `true`, allow folders to be selected.

* `onOpen()`

  * Called when a Picker successfully appears in the app.

* `onClose()`

  * Called when a Picker gets closed.

* `onFileSelect(files)`

  * Called when a Picker file selection is made.

  * `files` is an Array of objects with the selected file objects from the 3rd-party picker script.

* `onCancel()`

  * Called when a Picker gets closed without any files selected.

### picker.init(initConfig)

Initialize a file picker with required configuration `initConfig`. Required configuration varies per integration; see [integration-specific documentation](/apis/api-reference#supported-integrations-for-externalfilepicker) for specific details.

This function loads required JS dependencies into the page, if they have not already been loaded. Other methods, like `.open` and `.getInstance`, cannot be called until the Promise returned by `.init` is resolved.

**Example:**

```js
await picker.init({
  // Google Developer Key
  developerKey: "AIzaS..."
});
```

### picker.open()

Presents the file picker in your app.

Selected files or other events will be received in the [callbacks](/apis/api-reference#options) you specified in the constructor.

**Example:**

```js
picker.open();
```

### picker.getInstance()

Returns a reference to the third-party JS library object that this file picker is using. This object can be used for additional integration-specific customization.


# Multi Account Authorization
Source: https://docs.useparagon.com/apis/api-reference/multi-account-authorization

Use the SDK to connect multiple accounts for the same integration.

Multiple Account Authorizations is a set of SDK options that enables you to connect multiple accounts of the same integration type for a Connected User.

For example, one Connected User can connect a Google Calendar integration for both their Google Workspace account and personal Google account.

## Getting Started

**Connecting new accounts**

To get started with Multiple Account Authorizations, you can pass in `allowMultipleCredentials` to `paragon.installIntegration`:

```javascript
// Connect a new Google Calendar account
paragon.installIntegration("googleCalendar", {
    allowMultipleCredentials: true,

    // Set to true to show User Settings after installation:
    showPortalAfterInstall: true
});
```

This function starts the connection process for a new account of an integration. After the user has connected, you can optionally show the Connect Portal for presenting any User Settings that are used to configure the integration.

**Listing accounts**

Your UI must be able to render a list of each account your user has connected for an integration. Use `paragon.getUser` to retrieve this list:

```javascript
const user = paragon.getUser();

// An array of all Google Calendar accounts the user has connected:
user.integrations.googleCalendar.allCredentials;
```

Each account ("credential") will have an ID that can be used to present the Connect Portal for the account, remove the account, or route requests to the account.

Use `paragon.subscribe` to listen for change events to the Paragon user object, if your UI updates dynamically.

**Managing existing accounts**

You can allow your users to manage User Settings for a specific account using the Connect Portal by passing `selectedCredentialId` to `paragon.connect`:

```javascript
// Modify User Settings for an existing Google Calendar account
paragon.connect("googleCalendar", {
    selectedCredentialId: "a5e995c2-7709-43fd-9cdf-f759faa52497"
});
```

**Removing existing accounts**

You can disconnect an existing account by passing `selectedCredentialId` to `paragon.uninstallIntegration`:

```javascript
// Disconnect an existing Google Calendar account
paragon.uninstallIntegration("googleCalendar", {
    selectedCredentialId: "a5e995c2-7709-43fd-9cdf-f759faa52497" 
});
```

## Usage

A subset of SDK functions can be passed an additional parameter for Multiple Account Authorizations, as outlined below.

In general, to use Multiple Account Authorizations, you will need to:

* Use `user.integrations.[integration].allCredentials` (a field returned in [`getUser`](/apis/api-reference/multi-account-authorization#getuser->-paragonuser)) to display multiple connected accounts in your Integrations UI.
* Update references to [`connect`](/apis/api-reference#connect-integrationtype%3A-string%2C-installoptions%3F%3A-installoptions) (or [`installIntegration`](/apis/api-reference/multi-account-authorization#installintegration-integrationtype%3A-string%2C-options%3F%3A-integrationinstalloptions->-promise) and [`uninstallIntegration`](/apis/api-reference/multi-account-authorization#.uninstallintegration-integrationtype%3A-string%2C-options%3F%3A-integrationuninstalloptions->-promise)) to use the SDK with Multiple Account Authorizations enabled.
* Update references to [`paragon.request`](/apis/api-reference/multi-account-authorization#request-integrationtype%3A-string%2C-path%3A-string%2C-requestoptions%3A-requestoptions-→-promise) and [`paragon.workflow`](/apis/api-reference/multi-account-authorization#workflow-workflowid%3A-string%2C-options%3A-fetchoptions) (and API equivalents) to make sure that a specific account is targeted for a given integration type.

App Events and Workflows do not need to be updated to support Multiple Account Authorizations.

## Reference

### .getUser() -> ParagonUser

Call `.getUser` to retrieve the currently authenticated user and their connected integration state.

With Multiple Account Authorizations, the `getUser()` method additionally returns `allCredentials`, an array of connected accounts for a given integration.

<CodeGroup>
  ```javascript JavaScript SDK
  paragon.getUser();

  {
    authenticated: true,
    userId: "xyz", // The user ID you specified in the signed JWT
    integrations: {
      salesforce: {
        enabled: true,
        allCredentials: [
          {
            id: "a5e995c2-7709-43fd-9cdf-f759faa52497",
            dateCreated: "2023-05-30T22:33:20.349Z",
            dateUpdated: "2023-05-30T22:33:20.349Z",
            projectId: "d1f142cd-1dfe-4d76-ab4c-8f64901a9c5c",
            integrationId: "8aaad9ff-5adb-433c-a17b-da093f9d4528",
            personaId: "30975f6a-c50c-4e74-914a-3eb700db8b05",
            config: { configuredWorkflows: { ... } },
            isPreviewCredential: false,
            providerId: "1223115691",
            providerData: {},
            status: "VALID",
            dateRefreshed: "2023-05-30T22:33:20.349Z",
            dateValidUntil: "2023-05-30T23:33:17.809Z",
            refreshFailureCount: 0,
            isRefreshing: false,
          },
        ],
        configuredWorkflows: {},
        credentialId: "a5e995c2-7709-43fd-9cdf-f759faa52497",
        credentialStatus: "VALID",
        providerId: "1223115691",
        providerData: {},
      },
      shopify: {
        enabled: false,
      },
    },
  };
  ```

  ```bash REST API
  GET https://api.useparagon.com/projects/<Paragon Project ID>/sdk/me

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json

  {
    authenticated: true,
    userId: "xyz", // The user ID you specified in the signed JWT
    integrations: {
      salesforce: {
        enabled: true,
        allCredentials: [
          {
            id: "a5e995c2-7709-43fd-9cdf-f759faa52497",
            dateCreated: "2023-05-30T22:33:20.349Z",
            dateUpdated: "2023-05-30T22:33:20.349Z",
            projectId: "d1f142cd-1dfe-4d76-ab4c-8f64901a9c5c",
            integrationId: "8aaad9ff-5adb-433c-a17b-da093f9d4528",
            personaId: "30975f6a-c50c-4e74-914a-3eb700db8b05",
            config: { configuredWorkflows: {} },
            isPreviewCredential: false,
            providerId: "1223115691",
            providerData: {},
            status: "VALID",
            dateRefreshed: "2023-05-30T22:33:20.349Z",
            dateValidUntil: "2023-05-30T23:33:17.809Z",
            refreshFailureCount: 0,
            isRefreshing: false,
          }
        ],
        configuredWorkflows: {},
        credentialId: "a5e995c2-7709-43fd-9cdf-f759faa52497",
        credentialStatus: "VALID",
        providerId: "1223115691",
        providerData: {},
      },
      shopify: {
        enabled: false,
      }
    }
  }
  ```
</CodeGroup>

### .installIntegration(integrationType: string, options?: IntegrationInstallOptions) -> Promise

* **Full docs**: [.installIntegration(integrationType: string, installOptions?: InstallOptions) -> Promise\<IntegrationInstallEvent>](/apis/api-reference#installintegration-integrationtype%3A-string%2C-installoptions%3F%3A-installoptions->-promise\<integrationinstallevent>)
* **Additional options**: If `allowMultipleCredentials` is specified as `true` in the `options` object, this function will not throw an error if the user already has this integration installed.

You can use the resulting Promise to get the newly created credential.

```js JavaScript SDK
const { credential } = await paragon.installIntegration("googledrive", {
    allowMultipleCredentials: true
});
```

**Replacing an account**

You can replace one of your user's existing connected accounts with the `selectedCredentialId` property. This option replaces the underlying connected account, keeping their enabled workflows and settings intact.

```js JavaScript SDK
paragon.installIntegration("googledrive", {
    allowMultipleCredentials: true,
    selectedCredentialId: "0d2cca60-268b-45f1-ac5e-af6aad403d8c"
});
```

### .uninstallIntegration(integrationType: string, options?: IntegrationUninstallOptions) -> Promise

Call `.uninstallIntegration()` to disconnect an integration for the authenticated user.

* **Full docs**: [.uninstallIntegration(integrationType: string) -> Promise](/apis/api-reference#uninstallintegration-integrationtype%3A-string->-promise)
* **Additional options:** `selectedCredentialId` (SDK) or `X-Paragon-Credential` (API) can be used to select a specific account to uninstall.

<CodeGroup>
  ```javascript JavaScript SDK
  paragon.uninstallIntegration("googledrive", {
      selectedCredentialId: "de06dea8-8680-483c-95ea-cfcf66582c96"
  });
  ```

  ```bash REST API
  DELETE https://api.useparagon.com/projects/<Project ID>/sdk/integrations/<Integration ID>

  Authorization: Bearer <Paragon User Token>
  X-Paragon-Credential: de06dea8-8680-483c-95ea-cfcf66582c96
  ```
</CodeGroup>

### .connect(integrationType: string, options: IntegrationInstallOptions) -> Promise

With Multiple Account Authorizations, use `.connect` to present the Connect Portal for an *existing* account for the intended integration. [`.installIntegration`](/apis/api-reference/multi-account-authorization#installintegration-integrationtype%3A-string%2C-options%3F%3A-integrationinstalloptions->-promise) is used to connect *new* accounts.

* The Connect Portal can show the settings and workflows enabled for one account at a time, set by the `selectedCredentialId` property. If `selectedCredentialId` is not defined, the Connect Portal will use the first account available.
* When the Connect Portal appears, a user can enable or disable workflows, update User Settings, and disconnect the account that is selected.

```js JavaScript SDK
// Connect a new account for this integration.
// NOTE: You must use `.installIntegration` rather than `.connect`.
paragon.installIntegration("salesforce", {
    allowMultipleCredentials: true
})

// Show the Connect Portal to configure an existing account for this integration.
paragon.connect("salesforce", {
    selectedCredentialId: "de06dea8-8680-483c-95ea-cfcf66582c96"
});
```

### .request(integrationType: string, path: string, requestOptions: RequestOptions) → Promise

Call `.request` to send an API request to a third-party integration on behalf of one of your users.

* **Full docs**: [#.request-integrationtype-string-path-string-requestoptions-requestinit-promise](/apis/api-reference#request-integrationtype%3A-string%2C-path%3A-string%2C-requestoptions%3A-requestinit-→-promise)
* **Additional options:** `selectedCredentialId` (SDK) or `X-Paragon-Credential` (API) can be used to select a specific account to use with the [Proxy API](/apis/proxy).

<CodeGroup>
  ```js JavaScript SDK
  await paragon.request('slack', '/chat.postMessage', {
  	method: 'POST',
  	body: {
  		channel: 'CXXXXXXX0' // Channel ID,
  		text: 'This message was sent with Paragon Connect :exploding_head:'
  	},
  	selectedCredentialId: "de06dea8-8680-483c-95ea-cfcf66582c96"
  });
  ```

  ```bash REST API
  POST https://proxy.useparagon.com/projects/<Paragon Project ID>/sdk/proxy/slack/chat.postMessage

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json
  X-Paragon-Credential: de06dea8-8680-483c-95ea-cfcf66582c96

  { 
      "channel": "CXXXXXXX0", 
      "text": "This message was sent with Paragon Connect :exploding_head:" 
  }
  ```
</CodeGroup>

### .workflow(workflowId: string, options: FetchOptions)

Call `.workflow()` to trigger a Paragon workflow that sends a custom response back to your app. Note: The workflow must be enabled and use a Request-type trigger.

* **Full docs**: [.workflow(workflowId: string, options: FetchOptions)](/apis/api-reference##workflow-workflowid%3A-string%2C-options%3A-fetchoptions)
* **Additional options:** `selectedCredentialId` (SDK) or `X-Paragon-Credential` (API) can be used to select a specific account to trigger a workflow for. The Credential ID that is used will be recorded for viewing in [Task History](/monitoring/viewing-task-history).

<CodeGroup>
  ```javascript JavaScript SDK
  // Trigger the "Lead Created" workflow
  await paragon.workflow("<workflow_id>", {
    body: {
      "email": "bowie@useparagon.com",
      "first_name": "Bowie",
      "last_name": "Foo"
    },
    selectedCredentialId: "de06dea8-8680-483c-95ea-cfcf66582c96"
  });
    
  ```

  ```bash REST API
  // Trigger the "Lead Created" Workflow
  POST https://api.useparagon.com/projects/<Paragon Project ID>/sdk/triggers/<Workflow ID>

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json
  X-Paragon-Credential: de06dea8-8680-483c-95ea-cfcf66582c96

  {
    "email": "bowie@useparagon.com",
    "first_name": "Bowie",
    "last_name": "Foo
  }
  ```
</CodeGroup>


# Proxy API
Source: https://docs.useparagon.com/apis/proxy

Send requests directly to an integration provider, on behalf of Connected Users.

<Info>
  Proxy API was formerly known as the Connect API.
</Info>

## Introduction

Once your users have connected their third-party app accounts in the Connect Portal, you can access their app account via the Proxy API.

The Proxy API allows you to directly access any of the third-party provider's API methods. With the SDK, you can use [`paragon.request`](/apis/api-reference#.request-integrationtype-string-path-string-requestoptions-requestinit-promise-less-than-unknown-gre) to send an API request to a third-party app on behalf of one of your Connected Users.

Along with [Workflows](/workflows/building-workflows), the Proxy API is one of two primary ways to build integrations with Paragon.

## When to use the Proxy API

The Proxy API is the most flexible way to interact with your users' third-party apps, and is a useful code-based approach for situations including:

* Performing a simple one-off request (e.g. fetching a list of Salesforce contacts)
* Accessing API methods that may not be available in Workflow [Integration Actions](/workflows/integration-actions)
* Writing custom code for complex or unique integration use cases
* Migrating existing integration code to Paragon

## Making requests with the Proxy API

Every integration in your dashboard has a code example of using `paragon.request`, which takes three arguments:

* `integrationType`: The short name for the integration. i.e. "salesforce" or "googleCalendar". You can find this string on the Overview tab of the integration you want to access, on your Paragon dashboard.
  * When using a custom integration, the `integrationType` name is prefixed with `"custom."` For example, a custom integration titled "TaskLab" would be called `"custom.tasklab"`.
* `path`: The path (without the hostname) of the API request you are trying to access. An example might be "/v1/charges" for Stripe's charge API or "chat.postMessage" for Slack's Web API.
* `requestOptions`: Request options to include, such as:
  * `body`: An object representing JSON contents of the request.
  * `method`: An HTTP verb such as "GET" or "POST". Defaults to GET.

The function returns a Promise for the request output, which will have a shape that varies depending on the integration and API endpoint.

### Client-side SDK Usage

```js JavaScript SDK
await paragon.request('slack', '/chat.postMessage', {
	method: 'POST',
	body: {
		channel: 'CXXXXXXX0' // Channel ID,
		text: 'This message was sent with Paragon Connect :exploding_head:'
	}
});

// -> Responds with { ok: true }, and sends a Slack message :)
```

### Server-side Usage

**Base URL:**

* Cloud: `https://proxy.useparagon.com`
* [On-premise environments](/on-premise/hosting-paragon-on-premise): `https://worker-proxy.`\[your on-prem host name]

If you'd like to issue a request from your server to an integration on behalf of an end-user, you can make a request to one of the following paths:

* `/projects/<Project ID>/sdk/proxy/<Integration Type>/<API Path>`
* or `/projects/<Project ID>/sdk/proxy/custom/<Integration ID>/<API Path>` for [Custom Integrations](/resources/custom-integrations).

<Tabs>
  <Tab title="REST API">
    ```bash
    https://proxy.useparagon.com/projects/<Paragon Project ID>/sdk/proxy
      /<Integration name>/<API path>

    Authorization: Bearer <Paragon User Token>
    ```

    * A Bearer token must also be specified with a Paragon User Token.

    * This endpoint accepts any HTTP verb you want to use with the API.

    * Body contents must be specified as `application/json`.

    **Example**:

    ```bash
    POST https://proxy.useparagon.com/projects/19d...012/sdk/proxy/slack/chat.postMessage

    Authorization: Bearer eyJ...
    Content-Type: application/json

    { 
        "channel": "CXXXXXXX0", 
        "text": "This message was sent with Paragon Connect :exploding_head:" 
    }
    ```
  </Tab>

  <Tab title="REST API (Custom Integrations)">
    When sending Proxy API requests for Custom Integrations, the request path differs slightly. Use the `/custom/` path to send requests as shown:

    ```bash
    https://proxy.useparagon.com/projects/<Paragon Project ID>/sdk/proxy
      /custom/<Integration ID>/<API path>

    Authorization: Bearer <Paragon User Token>
    ```

    * A Bearer token must also be specified with a Paragon User Token.

    * This endpoint accepts any HTTP verb you want to use with the API.

    * The Integration ID can be found in the dashboard (`/.../integrations/<Integration ID>`) or with the [Get project's integrations](/apis/api-reference#get-projects-integrations) API endpoint.

    **Example:**

    ```bash
    POST https://proxy.useparagon.com/projects/19d...012/sdk/proxy
        /fb243b75-35e7-46b3-ba6c-967ccebeb449/notifications

    Authorization: Bearer eyJ...
    Content-Type: application/json

    { 
        "title": "This notification was created from your app"
    }
    ```
  </Tab>
</Tabs>

## Requesting files or binary response data

By default, the Proxy API will attempt to parse the response data from the integration API as JSON. To receive the raw response data (including all HTTP headers that were received from the integration API), you can pass the `X-Paragon-Use-Raw-Response` header to the request.

This can be used when downloading binary/file data, such as images or PDF files, where the response cannot be encoded as JSON.

*The JavaScript SDK currently does not support returning non-JSON payloads. As an alternative, you can use your preferred request client to make the below API request.*

Below is an example of using the Proxy API to download a file from Google Drive using their [`files.get`](https://developers.google.com/drive/api/v3/reference/files/get) endpoint.

```curl REST API
GET https://proxy.useparagon.com/projects/19d...012/sdk/proxy/googledrive/files/<File ID>/?alt=media

Authorization: Bearer eyJ...
X-Paragon-Use-Raw-Response: 1
```

## Changing the Base URL

In some cases, the Base URL included automatically in the Proxy API isn't the one you want to send requests to.

To change the Base URL of a Proxy request, simply use a fully-qualified URL rather than a relative path:

```bash
https://proxy.useparagon.com/projects/[Project ID]/sdk/proxy/googledrive/https://sheets.googleapis.com/v4/spreadsheets
```

In this example, the URL that will be requested is **`https://sheets.googleapis.com/v4/spreadsheets`**.

<Note>
  **Note**: Integrations have a permitted list of hosts that can be reached with the Proxy API. If you get the error "This domain is invalid for the current integration", you may be using an unpermitted host.
</Note>


# Task History API
Source: https://docs.useparagon.com/apis/task-history



## Introduction

The Task History API allows you to query your users' usage of integration workflows and access data from historical workflow executions.

<Info>
  **Task History API is available for Paragon customers on Enterprise plans.** To learn more, contact your Customer Success Manager or [sales@useparagon.com](mailto:sales@useparagon.com).
</Info>

### When to use the Task History API

The Task History API can be used to analyze integration usage or pull information about historical workflow executions into your application. For example, you can use the Task History API to:

* Query the number of workflow executions that ran last week for the Salesforce integration
* Query all failed workflow executions for a specific user
* Export all tasks that occurred in a specific month into Google BigQuery

You can find example queries in the request format below.

### Generating API Keys

The Task History API authorizes with a project-level API Key, instead of the Paragon User Token.

API Keys provide access to *all Connected Users* in the project they are created in and can be rotated or deleted after being generated.

<Frame>
    <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(60).png?maxW=1499&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=e063a2b528b9663f3f75af768bb2b4e8" alt="" width="1499" height="469" data-path="assets/image (60).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(60).png?w=280&maxW=1499&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=1aaa23825fbdb41fe803e04346649a28 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(60).png?w=560&maxW=1499&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=d2ac6b3b9b3509b7d635d32df9ebb8fd 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(60).png?w=840&maxW=1499&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=5db0cb68c6f628668cee8989803c702e 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(60).png?w=1100&maxW=1499&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=c4033aacc71476d4e913abfd56c3236c 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(60).png?w=1650&maxW=1499&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=409229b8f52e3c2d0f2fef62a450ac1c 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(60).png?w=2500&maxW=1499&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=2845b22e185844f4de45e68ce0735fdd 2500w" data-optimize="true" data-opv="2" />
</Frame>

To generate a new project-level API Key:

1. Visit your Project's Settings > API Keys.

2. Click "**Create API Key**". Provide a meaningful name for the API Key for your reference.

3. The API Key will appear on a one-time basis for you to save in a secure place.

## Examples

### Querying Salesforce workflow executions run during a week's time period

```bash REST API
GET /projects/<Paragon Project ID>/task-history/workflow-executions?integration=salesforce&afterDate=2023-02-16T00:00:00&beforeDate=2023-02-23T00:00:00

Authorization: Bearer <Paragon API Key>
```

**Response example:**

```json
{
    "workflowExecutions": [
        {
            "id": "c70cafa5-4f80-45c7-b5b3-71454f6d638d",
            "userId": "d1f142cd-1dfe-4d76-ab4c-8f64901a9c5c",
            "taskCount": 1,
            "runDuration": 1477,
            "workflowId": "c395c170-4541-499c-afd1-0eccfaae49c9",
            "status": "SUCCEEDED",
            "dateEnded": "2023-02-20T06:21:43.751Z",
            "dateStarted": "2023-02-20T06:21:42.274Z"
        },
        ...
    ],
    "nextLink": "https://zeus.useparagon.com/projects/d1f142cd-1dfe-4d76-ab4c-8f64901a9c5c/task-history/workflow-executions?integration=salesforce&afterDate=2023-02-16T00:00:00&beforeDate=2023-02-23T00:00:00&sortBy=ASC&offset=100",
    "total": 14295
}
```

### Querying failed workflow executions for a user

```bash REST API
GET /projects/<Paragon Project ID>/task-history/workflow-executions?userId=test@example.com&status=FAILED

Authorization: Bearer <Paragon API Key>
```

**Response example:**

```json
{
    "workflowExecutions": [
        {
            "id": "317a396c-7dc8-4a1f-8ceb-b39d5ad845da",
            "userId": "123456",
            "taskCount": 0,
            "runDuration": 3847,
            "workflowId": "24cf377b-c7f5-40e7-9b10-6cc5d811266a",
            "status": "FAILED",
            "dateEnded": "2023-03-01T11:15:04.051Z",
            "dateStarted": "2023-03-01T11:15:00.204Z"
        },
        ...
    ],
    "nextLink": "https://zeus.useparagon.com/projects/d1f142cd-1dfe-4d76-ab4c-8f64901a9c5c/task-history/workflow-executions?userId=test@example.com&status=FAILED&sortBy=ASC&offset=100",
    "total": 180
}
```

## Endpoint Reference

### Base URL

The Base URL of the Task History API endpoints begin with the same origin as the [Proxy](/apis/proxy) and [Users APIs](/apis/users).

* For cloud customers who sign in to `dashboard.useparagon.com`, the Base URL is `https\://api.useparagon.com/projects/\<Project ID>/task-history`
* For on-premise customers who sign in to `dashboard.<On-Premise URL>`, the base URL is `https\://zeus.\<On-Premise URL>/projects/\<Project ID>/task-history`

### Authorization

Requests to the Task History API must provide an API Key as a Bearer-type `Authorization` header in the request:

```bash
GET /projects/<Paragon Project ID>/task-history/workflow-executions

Authorization: Bearer <Paragon API Key>
```

### Pagination

API responses that include multiple objects will be provided in page size of 100. In the case that there are additional pages of data available, the API response will include a URL to get the next 100 records.

### Rate Limits

The Task History API has a rate limit of 1,000 requests per 10 minutes. If you need higher rate limits, please reach out to our team at [support@useparagon.com](mailto:support@useparagon.com)

### API Methods

## Get workflow executions

`GET` `[Base URL]/workflow-executions`

Search through historical workflow executions with the below filtering options as query parameters.

#### Query Parameters

| Name        | Type          | Description                                                                                                                                                                                                  |
| ----------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| userId      | String        | Filter executions by a specific Connected User ID.                                                                                                                                                           |
| workflowId  | UUID          | Filter executions for a specific workflow ID.                                                                                                                                                                |
| integration | String        | Filter executions for a specific integration, for example, `salesforce`. The integration name is in the same format as provided to [`paragon.connect`](/apis/api-reference#.connect-integrationtype-string). |
| status      | String        | Filter executions by a status: <br /> `EXECUTING` / `FAILED` / `SUCCEEDED` / `DELAYED`                                                                                                                       |
| beforeDate  | String (Date) | Filter executions that began before a certain timestamp, in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) (for example, `2023-02-22`).                                                           |
| afterDate   | String (Date) | Filter executions that began after a certain timestamp, in ISO 8601 format.                                                                                                                                  |
| offset      | Number        | Offset results by a fixed number of records.                                                                                                                                                                 |
| sortBy      | String        | Sort by execution time: `ASC` / `DESC`. Defaults to `DESC`.                                                                                                                                                  |

```json 200: OK
{
    "workflowExecutions": [
        {
            "id": "c70cafa5-4f80-45c7-b5b3-71454f6d638d",
            "userId": "d1f142cd-1dfe-4d76-ab4c-8f64901a9c5c",
            "taskCount": 1,
            "runDuration": 1477,
            "workflowId": "c395c170-4541-499c-afd1-0eccfaae49c9",
            "status": "SUCCEEDED",
            "dateEnded": "2023-02-20T06:21:43.751Z",
            "dateStarted": "2023-02-20T06:21:42.274Z"
        },
        // ...
    ],
    // nextLink is `null` if there are no more results
    "nextLink": "https://zeus.useparagon.com/projects/d1f142cd-1dfe-4d76-ab4c-8f64901a9c5c/task-history/workflow-executions?integration=salesforce&afterDate=2023-02-16T00:00:00&beforeDate=2023-02-23T00:00:00&sortBy=ASC&offset=100",
    "total": 14295
}
```

## Get workflow execution by ID

`GET` `[Base URL]/workflow-executions/:executionID`

Get details for a specific workflow execution by its Execution ID.

#### Path Parameters

| Name          | Type | Description                                 |
| ------------- | ---- | ------------------------------------------- |
| executionID\* | UUID | The ID of the execution to get details for. |

```json 200: OK
{
    "id": "daff08e3-c299-4005-9799-be69090ebae1",
    "userId": "test",
    "taskCount": 1,
    "runDuration": 8,
    "workflowId": "88d20d69-e585-4eea-aac4-5b7aea0521e8",
    "status": "FAILED",
    "dateEnded": "2022-11-25T22:15:07.987Z",
    "dateStarted": "2022-11-25T22:15:00.038Z",
    "stepExecutions": [
        {
            "id": "5fec7d78-7e10-4b4a-bdfc-292f629774bf",
            "stepId": "0f7cce44-d292-4555-bae8-5b904a0c4ac9",
            "workflowExecutionId": "daff08e3-c299-4005-9799-be69090ebae1",
            "status": "SUCCEEDED",
            "type": "TRIGGER/CRON",
            "start": "2022-11-25T22:15:00.075Z",
            "end": "2022-11-25T22:15:00.084Z",
            "next": [
                "29e675eb-0910-4d5c-8a5c-a4a4c1895605"
            ],
            "prev": null,
            "inputSize": "220",
            "outputSize": "76"
        },
        {
            "id": "29e675eb-0910-4d5c-8a5c-a4a4c1895605",
            "stepId": "7459bbf5-e55b-49e8-9390-084cf86752e5",
            "workflowExecutionId": "daff08e3-c299-4005-9799-be69090ebae1",
            "status": "FAILED",
            "type": "ACTION/REQUEST",
            "start": "2022-11-25T22:15:07.850Z",
            "end": "2022-11-25T22:15:07.873Z",
            "next": [],
            "prev": "5fec7d78-7e10-4b4a-bdfc-292f629774bf",
            "inputSize": "712",
            "outputSize": "824"
        }
    ]
}
```

## Get details for step of workflow execution

`GET` `[Base URL]/workflow-executions/:executionID/step-executions/:stepExecutionID`

Get details for a specific step of a workflow execution, by its Execution ID *and* Step Execution ID. These details include step input/output and run duration for the specific step.

#### Path Parameters

| Name              | Type | Description                                      |
| ----------------- | ---- | ------------------------------------------------ |
| executionID\*     | UUID | The ID of the execution to get details for.      |
| stepExecutionID\* | UUID | The ID of the step execution to get details for. |

```json 200: OK
{
    "isLargeInput": false,
    "isLargeOutput": false,
    "input": {},
    "output": "Error: no auth mechanism defined"
}
```

`POST` `[Base URL]/workflow-executions/:executionID/replay`

Replay a specific workflow execution, using the same version of the workflow that the execution originally ran with.

*This endpoint is in beta and may not be suitable for use in your production application. Please send any feedback you have about this endpoint to *[*support@useparagon.com*](mailto:support@useparagon.com)*!*

```json 201: Created undefined
```

### Get workflow executions

`GET` `[Base URL]/workflow-executions`

### Get workflow execution by ID

`GET` `[Base URL]/workflow-executions/:executionID`

#### Query Parameters

| Name        | Type          | Description                                                                                                                                                                                                  |
| ----------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| userId      | String        | Filter executions by a specific Connected User ID.                                                                                                                                                           |
| workflowId  | UUID          | Filter executions for a specific workflow ID.                                                                                                                                                                |
| integration | String        | Filter executions for a specific integration, for example, `salesforce`. The integration name is in the same format as provided to [`paragon.connect`](/apis/api-reference#.connect-integrationtype-string). |
| status      | String        | Filter executions by a status: <br /> `EXECUTING` / `FAILED` / `SUCCEEDED` / `DELAYED`                                                                                                                       |
| beforeDate  | String (Date) | Filter executions that began before a certain timestamp, in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601) (for example, `2023-02-22`).                                                           |
| afterDate   | String (Date) | Filter executions that began after a certain timestamp, in ISO 8601 format.                                                                                                                                  |
| offset      | Number        | Offset results by a fixed number of records.                                                                                                                                                                 |
| sortBy      | String        | Sort by execution time: `ASC` / `DESC`. Defaults to `DESC`.                                                                                                                                                  |

### Get details for step of workflow execution

`GET` `[Base URL]/workflow-executions/:executionID/step-executions/:stepExecutionID`

### Replay workflow execution

`POST` `[Base URL]/workflow-executions/:executionID/replay`

Replay a specific workflow execution, using the same version of the workflow that the execution originally ran with.

*This endpoint is in beta and may not be suitable for use in your production application. Please send any feedback you have about this endpoint to *[*support@useparagon.com*](mailto:support@useparagon.com)*!*

#### Path Parameters

| Name          | Type | Description                                 |
| ------------- | ---- | ------------------------------------------- |
| executionID\* | UUID | The ID of the execution to get details for. |


# Users API
Source: https://docs.useparagon.com/apis/users



## Introduction

The Users API allows you to query and modify the state of your Connected Users and their integrations.

The API includes REST endpoints (and matching SDK functions) for identifying what integrations your user has enabled, disconnecting integrations, and disabling workflows. The API also allows your application to associate metadata with a Connected User.

<Tip>
  ✨ User Metadata is included in the **Pro Plan** and above. [Contact us](mailto:sales@useparagon.com) to schedule a demo of User Metadata or upgrade your account.
</Tip>

### When to use the Users API

The Users API can be used for integration usage analysis or maintenance of Connected Users. For example, using the API methods, you can...

* Automatically disconnect integrations when a user deletes or downgrades their account in your application
* Enrich your Connected Users' profile information with email, name, and other metadata
* Check if a user has enabled a certain integration and view account connection status

## Authorization

Requests to the Users API are authorized with a Bearer-type `Authorization` header using a Paragon User Token:

```bash
https://api.useparagon.com/projects/<Paragon Project ID>/sdk/...

Authorization: Bearer <Paragon User Token>
```

In the SDK, the Users API can be called directly after calling `paragon.authenticate`:

```js
// Authenticate the user
await paragon.authenticate("<Paragon Project ID>", "<Paragon User Token>");

// Call a Users API method, like setUserMetadata
paragon.setUserMetadata({ ... });
```

## Examples

### Associate Connected User with metadata

You can associate your user with metadata by including it in your existing SDK call to `paragon.authenticate`, as an additional parameter:

```js
await paragon.authenticate("<Paragon Project ID>", "<Paragon User Token>", {
    metadata: {
        Name: user.fullName,
        Email: user.email,
        AccountType: user.plan,
    }
});
```

<Note>
  **Note:** `Name` and `Email` are special parameters that you can view within the [Connected Users Dashboard](/monitoring/users). They are also case-sensitive.
</Note>

Alternatively, you can supply the metadata from your application after authenticating:

<CodeGroup>
  ```js JavaScript SDK
  paragon.setUserMetadata({
      Name: "Sean V",
      Email: "sean@useparagon.com",
      AccountType: "Pro",
  });
  ```

  ```bash REST API
  // REQUEST
  PATCH https://api.useparagon.com/projects/<Project ID>/sdk/me

  // Headers
  Authorization: <Paragon User Token>
  Content-Type: application/json

  // Body
  { "meta": { "Email": "sean@useparagon.com" } }
  ```
</CodeGroup>

#### Using Metadata in Workflows

Metadata properties are available for use in workflows in the variable menu of the Workflow Editor. To select a metadata property in a workflow, you'll first need to set a sample metadata object.

From any workflow, click the Options menu in the top navigation and select **Set User Metadata**:

<Frame>
    <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(41).png?maxW=558&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=77f91473a45694355f32dae8489febd0" alt="" width="558" height="578" data-path="assets/image (41).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(41).png?w=280&maxW=558&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=cfd24cfd03d3566669f614dc66252cf5 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(41).png?w=560&maxW=558&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=b8dde40310a36fc1b5cba61f0f6385a2 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(41).png?w=840&maxW=558&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=3fab66c42bc492650bf348c1a335526f 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(41).png?w=1100&maxW=558&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=d4f54e64ff65c61d6e06e9649348cac4 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(41).png?w=1650&maxW=558&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=f340518babbb9bcf2e5f94e31a184eb9 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(41).png?w=2500&maxW=558&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=48f72a82f4664e7d83dee0af4c76305e 2500w" data-optimize="true" data-opv="2" />
</Frame>

A dialog will appear to set a sample metadata object that represents the object you will pass through to the API or SDK as shown above in [Associate Connected User with metadata](/apis/users#associate-connected-user-with-metadata).

Any properties set in this sample object will be available for selection in the variable menu, in the "User Info" section:

<Frame>
    <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(43).png?maxW=924&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=8d3384c9767179e3639ba3edc23780b9" alt="" width="924" height="820" data-path="assets/image (43).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(43).png?w=280&maxW=924&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=5a7210e019234a1363c10309994e5d9e 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(43).png?w=560&maxW=924&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=565bfb3843232a70233d15b02a2ee785 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(43).png?w=840&maxW=924&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=73f7640a808100ce70baa0d8915b6d64 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(43).png?w=1100&maxW=924&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=9a64f7052de41272303f2d05cf108caf 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(43).png?w=1650&maxW=924&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=3a0ae275e21bc3a4608844ae209a2045 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(43).png?w=2500&maxW=924&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=defeb83a06b9143dac3fea40736c5a87 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Get Connected User info and integration state

You can access Connected User info (including any associated metadata) using `paragon.getUser` or with the REST API.

<CodeGroup>
  ```js JavaScript SDK
  paragon.getUser();

  // Returns:
  {
      authenticated: true,
      integrations: {
          salesforce: {
              enabled: true,
              credentialStatus: "VALID",  // "INVALID" if account is unreachable
              providerData: {...},        // Account details for integration
              providerId: "00502000..."   // Account's unique ID for integration
          }
      },
      meta: {...}, // Metadata provided by your application
      userId: "12345" // User ID specified in "sub" field of Paragon User Token
  }
  ```

  ```bash REST API
  // REQUEST
  GET https://api.useparagon.com/projects/<Project ID>/sdk/me

  // Headers
  Authorization: Bearer <Paragon User Token>

  // RESPONSE
  {
    "authenticated": true,
    "integrations": {
      "salesforce": {
        "enabled": true,
        "credentialStatus": "VALID",
        "providerData": {...},
        "providerId": "00502000..."
      }
    },
    "meta": {...},
    "userId": "12345"
  }
  ```
</CodeGroup>

#### Validating account status with the `credentialStatus` property

If a previously connected account is unreachable (e.g. your user revokes access from the integration), the Connect Portal will show a warning and prompt your user to reconnect their account:

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Portal%20with%20invalid%20credential%20status.png?maxW=600&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=2b313d61a2849d620e4daba3e22caa3d" alt="" width="600" height="686" data-path="assets/Portal with invalid credential status.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Portal%20with%20invalid%20credential%20status.png?w=280&maxW=600&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=34c797025c540b76e142a32605dfce4b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Portal%20with%20invalid%20credential%20status.png?w=560&maxW=600&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=9075296eba4c4416389aaa8f3a286fe9 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Portal%20with%20invalid%20credential%20status.png?w=840&maxW=600&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f7f298607bc0bf894d240e56cf4bd6ce 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Portal%20with%20invalid%20credential%20status.png?w=1100&maxW=600&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=2f3e928022b6d04e8c4b555650397dec 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Portal%20with%20invalid%20credential%20status.png?w=1650&maxW=600&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=b257581cb4badec70deda80f6d02c939 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Portal%20with%20invalid%20credential%20status.png?w=2500&maxW=600&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d9dc98f0f67f71f3ddc8bf77f18a2a52 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can check for this condition with the SDK with the `credentialStatus` property. For example:

```js
paragon.getUser();

// Returns:
{
    integrations: {
        salesforce: {
            enabled: false,
            credentialStatus: "INVALID",
            ...
        }
    },
    ...
}
```

If you are using the [Headless Connect Portal](/connect-portal/headless-connect-portal), you should show a reconnection prompt when `credentialStatus` is not `"VALID"`. You can initiate a reconnection flow with the same function used to start a connection flow: [.installIntegration(integrationType: string, installOptions?: InstallOptions) -> Promise\<IntegrationInstallEvent>](/apis/api-reference#installintegration).

### Disconnecting integrations

Integrations can be disconnected using `paragon.uninstallIntegration` or with the REST API.

When an integration is disconnected, workflows for that integration will stop running for the authenticated user and any saved User Settings will be cleared.

<Tabs>
  <Tab title="JavaScript SDK">
    ```js
    // Use the integration name, as used in paragon.connect();
    await paragon.uninstallIntegration("salesforce");
    ```
  </Tab>

  <Tab title="REST API">
    Get the ID of the integration you want to disconnect, with the `/sdk/integrations` endpoint:

    **Request**

    ```bash
    GET https://api.useparagon.com/projects/<Project ID>/sdk/integrations

    // Headers
    Authorization: Bearer <Paragon User Token>
    ```

    **Response**

    ```json
    [
        { "id": "<Integration ID>", "type": "salesforce", ... },
        {...}
    ]
    ```

    The `<Integration ID>` can be used to disconnect the integration for the user:

    **Request**

    ```bash
    DELETE https://api.useparagon.com/projects/<Project ID>/sdk/integrations/<Integration ID>

    // Headers
    Authorization: Bearer <Paragon User Token>
    ```
  </Tab>
</Tabs>


# Concurrency SLA
Source: https://docs.useparagon.com/billing/concurrency-limits

Learn how concurrency is calculated in Paragon.

Paragon's concurrency SLA is the number of [step executions](/monitoring/viewing-task-history#detailed-task-execution) that can run at a given time across all of your [Connected Users](/billing/connected-users). For example, if you have a concurrency SLA of 20, you can have up to 20 step executions running in the background at a given time.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7b8a80c72d6c34a64187ebfd070fc689" alt="" width="3212" height="1128" data-path="assets/Viewing Task History in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=280&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=1df7559bbc63f67a421126484057a7b6 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=560&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=544ece058c61167627944214a787aa64 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=840&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7fb503c79e3d40a800f96ec9393ebe37 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=1100&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=bea92f72acc6685733eec38887b2be0b 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=1650&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=02931ddcb429ad91b3839ea35217785d 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=2500&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=de98f14834fff6de7e9ff595415d0ed4 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Concurrency Levels

Our Concurrency SLA for our standard plans is as follows:

| Plan           | Concurrency SLA        |
| -------------- | ---------------------- |
| **Trial**      | **5** step executions  |
| **Pro**        | **20** step executions |
| **Enterprise** | **50** step executions |

If you have any other questions regarding your concurrency SLA, please contact your Customer Success Manager.

### What happens if I reach my Concurrency SLA?

When you exceed this SLA, new step executions will be queued up for execution and show as `Not Started` in [Task History](/monitoring/viewing-task-history). Paragon accepts and stores all executions and will only execute them once the concurrent workflows drop below the SLA limit.

<Tip>
  To upgrade your Paragon subscription to a higher usage tier for concurrent workflows, [contact Sales](mailto:sales@useparagon.com) or reach out to your Customer Success Manager.
</Tip>


# Connected Users
Source: https://docs.useparagon.com/billing/connected-users

Learn how Connected Users are counted in Paragon.

Connected Users represent your customers that are connected to integrations in Paragon. A Connected User typically represents an organization, but can be implemented to represent any entity, such as an individual user.

Each Connected User is a **unique User ID connected to at least 1 integration.** A User ID is the subject (`sub`) field of the Paragon User Token used to [authenticate to the API or SDK](/getting-started/installing-the-connect-sdk#3.-call-paragon.authenticate).

You can view and manage your Connected Users in the Paragon dashboard. Learn more in [Managing Connected Users](/monitoring/users).

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?maxW=2884&auto=format&n=867oBBVpxd2C3zc4&q=85&s=312c5e58319077af99bb64a60605add4" alt="" width="2884" height="1040" data-path="assets/Viewing Connected Users in the Connected Users Dashboard in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=280&maxW=2884&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7fa17831acb42711a5b8c0c1bcec619a 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=560&maxW=2884&auto=format&n=867oBBVpxd2C3zc4&q=85&s=1dcce4fabc18e55a2e2d3faa31f22029 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=840&maxW=2884&auto=format&n=867oBBVpxd2C3zc4&q=85&s=d10ff99f19874dbc9fc9fe828deedc0a 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=1100&maxW=2884&auto=format&n=867oBBVpxd2C3zc4&q=85&s=836df519ab22b669d7db32edf58c0d41 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=1650&maxW=2884&auto=format&n=867oBBVpxd2C3zc4&q=85&s=264943e135cd5f0c5d15313171e154eb 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=2500&maxW=2884&auto=format&n=867oBBVpxd2C3zc4&q=85&s=dc04c1ec897327cceabe933757a22411 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connected User limits and pricing

Your Paragon subscription includes a limit on Connected Users. You can view this limit and current usage in the header of the [Connected Users Dashboard](/monitoring/users).

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Finding%20Conencted%20Users%20Limits%20in%20Paragon%20Connect.png?maxW=2884&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=a7453d34e1ef11887cc9028438110c31" alt="" width="2884" height="1040" data-path="assets/Finding Conencted Users Limits in Paragon Connect.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Finding%20Conencted%20Users%20Limits%20in%20Paragon%20Connect.png?w=280&maxW=2884&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=26f953c54cd10e628a850140d05df205 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Finding%20Conencted%20Users%20Limits%20in%20Paragon%20Connect.png?w=560&maxW=2884&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=e27a09226f1530ba3a704478c9257f0e 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Finding%20Conencted%20Users%20Limits%20in%20Paragon%20Connect.png?w=840&maxW=2884&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b03ac63830eaa30d0a91a239f46640b5 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Finding%20Conencted%20Users%20Limits%20in%20Paragon%20Connect.png?w=1100&maxW=2884&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=e7146c95debe671cc01d61b166800954 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Finding%20Conencted%20Users%20Limits%20in%20Paragon%20Connect.png?w=1650&maxW=2884&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=0f671b90f4d446e65d54ba31d4567177 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Finding%20Conencted%20Users%20Limits%20in%20Paragon%20Connect.png?w=2500&maxW=2884&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b111d47cca71d4d4dc92460e1564d1cd 2500w" data-optimize="true" data-opv="2" />
</Frame>

All [Admin users](/managing-account/teams#managing-roles-and-permissions) in your organization will receive automated email notifications when your usage reaches 70%, 85%, and 100% of your Connected Users limit.

### What happens if I reach my Connected Users limit?

When you exceed this limit, new Connected Users will be unable to connect integrations. **Existing Connected Users will *****not***** be impacted**, and Workflows for existing Connected Users will continue to run.

You can reduce your usage of Connected Users by deleting inactive users from the [Connected Users Dashboard](/monitoring/users).

<Tip>
  To upgrade your Paragon subscription to a higher usage tier for Connected Users, [contact Sales](mailto:sales@useparagon.com) or reach out to your Account Manager.
</Tip>


# Task Usage
Source: https://docs.useparagon.com/billing/tasks

Learn how tasks are counted in Paragon.

A task is a unit of work that occurs in the Paragon platform on behalf of your Connected User.

* In [Workflows](/workflows/building-workflows), each successful Action, Request, and Function are counted as tasks. You can see which steps succeeded in the workflow execution view of the Task History page (see screenshot below).
* All [Proxy API](/apis/proxy) requests are counted as tasks.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Steps%20in%20Paragon%20Workflow.png?maxW=1650&auto=format&n=867oBBVpxd2C3zc4&q=85&s=4cb617ee519a51f7a5fee0b85a694f0f" alt="" width="1650" height="850" data-path="assets/Viewing Steps in Paragon Workflow.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Steps%20in%20Paragon%20Workflow.png?w=280&maxW=1650&auto=format&n=867oBBVpxd2C3zc4&q=85&s=46ea467cf1aa34c28e331cb52204e2f8 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Steps%20in%20Paragon%20Workflow.png?w=560&maxW=1650&auto=format&n=867oBBVpxd2C3zc4&q=85&s=87e9f06c929174b6aecf2484840621d8 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Steps%20in%20Paragon%20Workflow.png?w=840&maxW=1650&auto=format&n=867oBBVpxd2C3zc4&q=85&s=4cbb1f8d7232c600704c75f653613a15 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Steps%20in%20Paragon%20Workflow.png?w=1100&maxW=1650&auto=format&n=867oBBVpxd2C3zc4&q=85&s=4e971c96d61ce19acff10de5b157555d 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Steps%20in%20Paragon%20Workflow.png?w=1650&maxW=1650&auto=format&n=867oBBVpxd2C3zc4&q=85&s=36402f4d5c45635b6042126756cb5a79 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Steps%20in%20Paragon%20Workflow.png?w=2500&maxW=1650&auto=format&n=867oBBVpxd2C3zc4&q=85&s=383b9e9dc66d5f057e9faffcb77c8577 2500w" data-optimize="true" data-opv="2" />
</Frame>

## How workflow steps count towards tasks

The following steps count as tasks:

* [Integrations](/resources/integrations) (e.g. Salesforce, Slack, Google Sheets)
* [Request](/workflows/requests)
* [Function](/workflows/functions)

The following steps **do not** count as tasks:

* [Triggers](/workflows/triggers)
* [Conditional](/workflows/using-conditionals)
* [Fan Out](/workflows/using-fan-out)
* Response
* Delay

<Note>
  **Note:** While the Fan Out itself doesn't count as a task, the contents within Fan Outs count as tasks per iteration.
</Note>

## Task limits

The task limit is the maximum number of tasks you can run before your workflows stop executing during the current billing cycle.

## How task usage resets

Task usage resets at the beginning of your billing period each month. Unused tasks will not roll over to the next billing period.

### What happens if I reach my task limit?

If you are on a legacy plan that bills by task usage, you'll receive notification emails from Paragon as you get closer to your task limit.

We'll send an email notifying you that your workflows have stopped executing. Users on any of our [paid plans](https://www.useparagon.com/pricing) have a five-day grace period to upgrade before workflows stop executing.

Any unfinished tasks will show up in your [Task History](/monitoring/viewing-task-history) as a failed workflow. You can [replay stopped workflows](/monitoring/viewing-task-history#editing-and-replaying) when your billing cycle restarts or you upgrade your plan.

<Tip>
  Need more tasks? Upgrade to a [paid plan](https://useparagon.com/pricing) today!
</Tip>


# API Release Notes
Source: https://docs.useparagon.com/changelog/api

Release notes for new versions of the Paragon REST API.

<Update label="2025-07" description="Scheduled for release July 7, 2025">
  ## Updates to GET /sdk/integrations and Proxy API

  To improve the ergonomics of the API, we are introducing a few changes to the GET `/projects/:projectId/sdk/integrations` and Proxy API endpoints for Custom Integrations.

  We are also removing some unnecessary fields from the response of the GET `/projects/:projectId/sdk/integrations` endpoint to improve performance. Please review these changes to ensure that your application is not using any of the fields scheduled for removal.

  **Affected endpoints:**

  * GET `/projects/:projectId/sdk/integrations`
  * [Proxy API](/apis/proxy)

  **Breaking changes:**

  * In GET `/projects/:projectId/sdk/integrations`, the `type` field of Custom Integrations will now be the full slug that is used in `paragon.connect()` calls.
    <Expandable title="Example">
      ```diff
      {
          "id": "77210f70-4f20-4eac-bded-825732b229c3",
          "projectId": "1ea8024c-23a7-4885-b925-c50d0faf9318",
          "customIntegrationId": "d8fe6169-8119-4cb0-a7a9-c2b18aff2c07",
          "name": "Example",
      -   "type": "custom",
      +   "type": "custom.example",
          "isActive": true,
          "configs": [...],
          "workflows": [...],
          "customIntegration": {
              "id": "d8fe6169-8119-4cb0-a7a9-c2b18aff2c07",
              "projectId": "1ea8024c-23a7-4885-b925-c50d0faf9318",
              "name": "Example",
              "isPublished": true,
              "slug": "custom.example"
          },
          "hasCredential": true,
          "connectedUserLimitOnDevCred": 0,
          "connectedUserLimitReached": false,
          "brandColor": "#000000",
          "needPreOauthInputs": false,
          "authenticationType": "oauth",
          "sdkIntegrationConfig": null
      }
      ```
    </Expandable>

  * In GET `/projects/:projectId/sdk/integrations`, some unnecessary fields are being removed from Integrations:

    * To optimize the performance of this endpoint, some fields of Integrations are being removed. Please ensure that the following fields are not in use by your application:
      * `integration.dateCreated`
      * `integration.dateUpdated`
      * `integration.resourceId`
      * `integration.configs[].dateCreated`
      * `integration.configs[].dateUpdated`
      * `integration.configs[].integrationId`
      * `integration.workflows[].dateCreated`
      * `integration.workflows[].dateUpdated`
      * `integration.workflows[].teamId`
      * `integration.workflows[].isOnboardingWorkflow`
      * `integration.workflows[].workflowVersion`
      * `integration.customIntegration.dateCreated`
      * `integration.customIntegration.dateUpdated`
      * `integration.customIntegration.projectId`
      * `integration.customIntegration.oauthScopes`
      * `integration.customIntegration.oauthIncludeClientAuthorizationHeader`
      * `integration.customIntegration.usePKCEInCodeExchange`
      * `integration.customIntegration.apiBaseUrl`
      * `integration.customIntegration.testEndpointPath`
      * `integration.customIntegration.isTestEndpointVerified`
      * `integration.customIntegration.apiAuthorization`
      * `integration.customIntegration.userProfileConfig`

    <Expandable title="Example">
      ```diff
      {
          "id": "f02dba2f-d149-4664-958d-138d546d987b",
      -   "dateCreated": "2023-10-23T17:03:16.211Z",
      -   "dateUpdated": "2023-10-23T17:03:16.211Z",
          "projectId": "1ea8024c-23a7-4885-b925-c50d0faf9318",
          "customIntegrationId": "208d5d99-bbb4-4147-b991-83e220da192c",
      -   "resourceId": null,
          "type": "custom.spotify",
          "isActive": false,
          "configs": [
              {
                  "id": "70c9c3f6-f68c-4e06-921e-0ee678bc6a9f",
      -           "dateCreated": "2023-10-23T17:03:16.211Z",
      -           "dateUpdated": "2023-10-23T17:03:16.211Z",
      -           "integrationId": "f02dba2f-d149-4664-958d-138d546d987b",
                  "values": {
                      "accentColor": "#000000",
                      "description": "play music",
                      "workflowMeta": {}
                  }
              }
          ],
          "workflows": [
              {
                  "id": "0d6660ac-2396-4442-98a3-4321fa6ce42b",
      -           "dateCreated": "2024-06-04T13:16:32.660Z",
      -           "dateUpdated": "2024-06-04T13:17:03.374Z",
                  "description": "Example Workflow",
                  "projectId": "1ea8024c-23a7-4885-b925-c50d0faf9318",
      -           "teamId": "72c5150b-6bfa-4972-9845-1350f3ee18bc",
      -           "isOnboardingWorkflow": false,
                  "integrationId": "b62baf56-5030-4105-9c78-dbf307e1ee94",
      -           "workflowVersion": 1,
                  "steps": []
              }
          ],
          "customIntegration": {
              "id": "208d5d99-bbb4-4147-b991-83e220da192c",
      -       "dateCreated": "2023-10-23T17:03:16.211Z",
      -       "dateUpdated": "2023-10-23T17:03:16.211Z",
      -       "projectId": "1ea8024c-23a7-4885-b925-c50d0faf9318",
              "name": "Spotify",
              "authenticationType": "oauth",
              "inputFields": [],
              "oauthAuthorizationUrl": { "type": "TOKENIZED", "parts": [{ "type": "VALUE", "value": "https://accounts.spotify.com/authorize", "dataType": "STRING" }], "dataType": "STRING" },
              "oauthAccessTokenUrl": { "type": "TOKENIZED", "parts": [{ "type": "VALUE", "value": "https://accounts.spotify.com/api/token", "dataType": "STRING" }], "dataType": "STRING" },
      -       "oauthScopes": "user-read-private",
      -       "oauthIncludeClientAuthorizationHeader": true,
      -       "usePKCEInCodeExchange": false,
      -       "apiBaseUrl": { "type": "TOKENIZED", "parts": [ { "type": "VALUE", "value": "https://api.spotify.com/v1", "dataType": "STRING" } ], "dataType": "STRING" },
      -       "testEndpointPath": { "type": "TOKENIZED", "parts": [], "dataType": "STRING" },
      -       "isTestEndpointVerified": false,
      -       "apiAuthorization": { "type": "bearer", "token": { "type": "TOKENIZED", "parts": [ { "type": "CONNECT_CREDENTIAL_FIELD", "fieldType": "OAUTH_ACCESS_TOKEN" } ] } },
              "isPublished": true,
      -       "userProfileConfig": {},
              "slug": "custom.spotify"
          },
          "hasCredential": true,
          "connectedUserLimitOnDevCred": 0,
          "connectedUserLimitReached": false,
          "name": "Spotify",
          "brandColor": "#000000",
          "needPreOauthInputs": false,
          "authenticationType": "oauth",
          "sdkIntegrationConfig": null
      }
      ```
    </Expandable>

  **Other non-breaking changes:**

  * Proxy API now supports using the `custom.name` format when sending Proxy requests for Custom Integrations
    * Instead of passing in a `customIntegrationId`, you will now be able to pass in `custom.name` (the same slug used for `paragon.connect`) directly to the Proxy API.
    * Example:

      ```diff
      - https://proxy.useparagon.com/projects/:projectId/sdk/proxy/custom/:customIntegrationId/:path
      + https://proxy.useparagon.com/projects/:projectId/sdk/proxy/custom.integrationName/:path

      ```

  ## What do I need to do?

  * Verify that your use of `integrations.type` for Custom Integrations does not rely on the value being exactly `"custom"`. The new `type` field will include the full slug value, e.g. `custom.integrationName`.
  * Verify that you are not using any of the fields scheduled for removal from the API.

  ## When are these changes being released?

  * These changes will be released on July 7, 2025.
</Update>


# Paragraph Release Notes
Source: https://docs.useparagon.com/changelog/paragraph

Release notes for new versions of the Paragraph SDK and CLI.

### Updating to the latest version

To update your Paragraph project to the latest version, run the following commands in your terminal:

```bash
# Update the CLI
npm install -g @useparagon/cli
# Update the core libraries in your project
para install --sync-versions
```

## Release Notes

<Update label="v1.0.23">
  * Fixes a compilation issue that could occur when using the `para pull` command in projects that have a Pipedrive integration.
  * Fixes an issue where pushing new projects initialized with Paragraph could result in a "Failed to get project comparison." error.
  * Fixes an issue where Request Step Pagination used in Custom Integrations could result in a compilation error.
  * Adds support for referencing combination inputs, such as the Azure DevOps State input.
  * Adds support for using numeric values in Custom Dropdown inputs defined in Paragraph projects.
</Update>

<Update label="v1.0.22">
  * Fixes an issue where nested step variables in a Request Step JSON body could create invalid references when pushing to a Paragon project.
  * Adds support for new Field Mapping input types, now supported for any integration. [Learn more here](/connect-portal/field-mapping).
</Update>

<Update label="v1.0.21">
  * Fixes an issue where `para pull` could fail if the workflow name contains a `/` character.
  * Adds support for Password-type inputs in the Connect Portal configuration.
</Update>

<Update label="v1.0.20">
  * Fixes an issue where Request steps without query parameters could cause an extra `?=` to be added to the URL after pulling/pushing.
</Update>

<Update label="v1.0.19">
  * Adds full support for pulling Resource Request steps.
  * Fixes type issues for App Event triggers using Field Mapping.
  * Fixes an issue where a nested object in the Request body could be pulled incorrectly as `[object Object]`.
</Update>


# Product Updates
Source: https://docs.useparagon.com/changelog/product-updates

Monthly updates on new features and improvements to the Paragon platform.

<Update label="April 2025">
  ## ActionKit MCP: available and open source

  We have released an MCP server for ActionKit, an API supported by Paragon that provides access to pre-built actions for 130+ integrations to your users’ SaaS applications.

  The MCP includes a few optional extensions to the ActionKit API:

  * Automatically prompt users to authorize integrations with the [Connect Portal](https://docs.useparagon.com/getting-started/displaying-the-connect-portal) when their account isn't yet connected
  * Define [Custom Actions](https://github.com/useparagon/paragon-mcp#adding-custom-actions-with-openapi) with OpenAPI files
  * Allow [direct API access](https://github.com/useparagon/paragon-mcp#using-experimental-proxy-api-tool) to your agent as a tool

  📖 View the repository [here](https://github.com/useparagon/paragon-mcp).
</Update>

<Update label="March 2025">
  ## New Developer Docs

  <Frame>
    <img className="block" src="https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/666-c450721e0d2ff4a39389bd277558da19572f3265.png?maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=fcd9ee4314ea9a11c1c894579d88106a" alt="" width="1120" height="441" data-path="assets/changelog/666-c450721e0d2ff4a39389bd277558da19572f3265.png" srcset="https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/666-c450721e0d2ff4a39389bd277558da19572f3265.png?w=280&maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=c7a7f3c2af047b015237978c0f533ed3 280w, https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/666-c450721e0d2ff4a39389bd277558da19572f3265.png?w=560&maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=fbf280fa24618f8011a4c9e602c0ea85 560w, https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/666-c450721e0d2ff4a39389bd277558da19572f3265.png?w=840&maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=552976052290de6ac98ec1ac299c8320 840w, https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/666-c450721e0d2ff4a39389bd277558da19572f3265.png?w=1100&maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=e910a6c61544ec49c685cfb0ab4ade76 1100w, https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/666-c450721e0d2ff4a39389bd277558da19572f3265.png?w=1650&maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=301ae707f733d2cb436a30d982be4598 1650w, https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/666-c450721e0d2ff4a39389bd277558da19572f3265.png?w=2500&maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=50836b9f72ca8dfc6672544bb854624d 2500w" data-optimize="true" data-opv="2" />
  </Frame>

  Find answers and API references faster with our new developer documentation site. Releasing improved content search, AI search, and navigation helping surface answers faster.

  📖 See the new [docs here](/overview).
</Update>

<Update label="February 2025">
  ## ActionKit and ActionKit Logs

  <Frame>
    <img className="block" src="https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/462-4bf88754b564a1011254bfe883314c44ff61b59c.png?maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=e4fa6ee48892586b7b5e135d06490dc7" alt="" width="1120" height="396" data-path="assets/changelog/462-4bf88754b564a1011254bfe883314c44ff61b59c.png" srcset="https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/462-4bf88754b564a1011254bfe883314c44ff61b59c.png?w=280&maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=c08347b1b16bf029b4b318f3aeb6cdee 280w, https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/462-4bf88754b564a1011254bfe883314c44ff61b59c.png?w=560&maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=a0dbd0397142d273b74a734c729af6cb 560w, https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/462-4bf88754b564a1011254bfe883314c44ff61b59c.png?w=840&maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=a882519c1859a7aa429b85363056a5c7 840w, https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/462-4bf88754b564a1011254bfe883314c44ff61b59c.png?w=1100&maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=e928a1bb600870f7c2e9495c07134c29 1100w, https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/462-4bf88754b564a1011254bfe883314c44ff61b59c.png?w=1650&maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=9fc5f3148611d9380b97a7b11fec2762 1650w, https://mintcdn.com/paragon/-vnjBTRJYwsmjo2U/assets/changelog/462-4bf88754b564a1011254bfe883314c44ff61b59c.png?w=2500&maxW=1120&auto=format&n=-vnjBTRJYwsmjo2U&q=85&s=a0e03173bd23b79b40dfc92af14f1d54 2500w" data-optimize="true" data-opv="2" />
  </Frame>

  With ActionKit, AI Agents can dynamically use Paragon to connect to their users' third-party applications like CRMs, email, calendars, and ticketing systems, and pick from dozens of ActionKit’s supported actions within each application.

  📖 Learn more at [docs here.](/actionkit)

  You can now search, view, and trace your ActionKit calls with ActionKit Logs in Task History.

  * Understand how your AI agent is performing ActionKit calls on behalf of your users.
  * Investigate why Action calls fail for particular Connected Users.
  * Discover which ActionKit requests your users are utilizing and the parameters used to make those requests.

  📖 Learn more at [docs here.](/actionkit/actionkit-logs)
</Update>

<Update label="January 2025">
  ## Custom Authentication Server Support

  You can now configure your own authentication server with a JSON Web Key Set (JWKS) endpoint to generate and manage Paragon User Tokens.

  📖 Learn more at the [docs here.](https://docs-prod.useparagon.com/getting-started/installing-the-connect-sdk#setup-with-a-managed-authentication-service)
</Update>

<Accordion title="2024">
  <Update label="December 2024">
    ## Custom Dropdowns in Connect Portal

    You can now configure *Custom Dropdowns* to prompt users to select application values in the Paragon Connect Portal.

    📖 Learn more at the [docs here.](/connect-portal/workflow-user-settings/custom-dropdowns)
  </Update>

  <Update label="November 2024">
    ## Platform Usability Updates

    Released usability updates for long text inputs and JSON views copy buttons within the Dashboard.
  </Update>

  <Update label="October 2024">
    ## Integration Usability Improvements

    * Released Field Mapping inputs for the Jira integration.
    * Improved error messaging for Google Calendar and Google Drive integrations.
    * Improved authentication stability for NetSuite and Airtable integrations.
  </Update>

  <Update label="September 2024">
    ## Custom Webhook Support

    You can now trigger your Paragon workflows from any event in any integration that has a HTTP Webhook API with the new Custom Webhooks feature! Paragon enables you to configure webhooks to subscribe to real-time events in your users' integration applications. For example, you can now subscribe to any event in the Slack Events webhook API and trigger your Paragon workflows.

    📖 Learn more in [our docs](/resources/custom-webhooks).

    👉 Join the [beta here](https://share.hsforms.com/19sUGNAW8TGqotRJPx92AwAdhpe2).

    ## Usability, Workflow Optimizations, Security Improvements

    * Allow Paragon developers ability to change how sensitive inputs appear in the Connect Portal.
    * Display and stability improvements to the Connect Portal and workflow editor.
    * Improvements to fanout step performance and stability.

    ## 🔒 Security Update

    * A CSRF vulnerability related to OAuth was discovered and patched in early September.
  </Update>

  <Update label="July 2024">
    ## 🚀 New Features

    ✨ **[Vimeo](/resources/integrations/vimeo) Integration!**

    You can now connect to your users' Vimeo accounts to manage their videos and video metadata. Paragon enables you to sync data between your app and your users’ Vimeo. For example, you can manage folders of videos or access video talk tracks in Vimeo. Learn more in [our docs](/resources/integrations/vimeo).

    ## 🛠 Improvements

    * Adds further support for different types of user authentication in NetSuite.
    * Improves internal handling of environment secrets.
    * Internal improvements to the Paragon dashboard.
    * Improvements to Google Calendar trigger instantiation and deletion.

    ## 🐛 Bug Fixes

    * Fixes a connection issue with the Custom Integration builder.
  </Update>

  <Update label="May 2024">
    ## 🛠 Improvements

    * Adds a loading state on the Disconnect button in the Connect Portal.
    * Dark mode Connect Portal UI improvements.
    * Whitelists `*.googleapis.com` domains in the Integration Request Step.
    * Improved error messages for the Paragon SDK and Connect Proxy API.
    * Improved UX for Marketo connection experience.
    * Improvements to Jira Connect Portal user settings.
    * Internal security and performance upgrades.
    * Improved error user interface for Connect Portal authentication errors.
    * Improvements to the ClickUp *New Comment on Task* workflow trigger.

    ## 🐛 Bug Fixes

    * Fixes an SDK issue with `paragon.connect()`.
    * Fixes an issue with Salesforce's textarea input field for the *Deploy Custom Field* action in the workflow editor.
    * Fixes an authentication issue for Google.
    * Fixes an issue around textArea inputs for Salesforce custom fields.
    * Fixes a UX issue with closing the Connect Portal and maintaining state.
    * Fixes an authentication issue for the External File Picker SDK feature.
    * Fixes an issue with uploading Files via the Integration Request Step in the workflow editor.
    * Fixes a display issue with the Connect Portal in the Jira integration.
    * Fixes an issue with the *Integration Enabled* trigger firing before required workflow values are entered.
  </Update>

  <Update label="February 2024">
    ## 🚀 New Features

    ✨ **Intellum Integration!**\
    You can now connect to your users' Intellum accounts to manage their courses, enrollments, and users. Paragon enables you to sync data between your app and your users’ Intellum. For example, you can manage courses or update enrollments in your users' Intellum. Learn more in our docs.

    ✨ **LinkedIn Marketing Updates!**\
    We've recategorized LinkedIn Marketing under the 'Advertising' category alongside Google Ads and TikTok Ads for better organization and updated the LinkedIn logo to maintain consistency across our platform.

    ✨ **ServiceNow User Settings!**

    Enhanced ServiceNow integrations by allowing users to specify statuses of incidents and tasks, improving the configuration options available in the Connect Portal.

    ✨ **Integration Enhancements!**

    * **Adobe AEM:** Improved authentication experience in the Connect Portal, streamlining user interactions and connections.
    * **PagerDuty:** Added default scopes for Classic OAuth type to facilitate better access control.
    * **Monday.com:** Updated the Item Updated trigger to include name change events.

    ✨ **Data Source Extensions:**

    * **Trello, ServiceNow, Linear:** We've extended our data sources for Trello (Member data), ServiceNow (Status data), and Linear (Assignee data), providing richer integration capabilities.

    **✨ LinkedIn Marketing Integration!**

    You can now connect to your users' LinkedIn Marketing accounts to manage their ad campaigns, audiences, and insights. Paragon enables you to sync data between your app and your users’ LinkedIn Marketing. For example, you can create ad campaigns or manage audiences in LinkedIn Marketing. Learn more in our docs.

    ✨ **Gmail Enhancements:**

    * **Send Message with Attachments:** We've updated our Gmail actions to include an attachment field in the "Send Message" action, enabling you to send emails with attachments seamlessly through our platform.

    ✨ **Slack Integration Enhancements:**

    * **Message Interactivity Triggers:** We’ve added support for message interactivity triggers in Slack, enabling you to create dynamic, interactive workflows based on user interactions with messages.

    ✨ **Integration Error Handling Improvements:**

    * Comprehensive error handling updates have been implemented across multiple platforms for the following integrations to enhance stability and user experience: Jira, HubSpot, Salesforce, Sage Intacct, Pipedrive, AWS S3.

    ## 🛠 Improvements

    * **Asana Integration - Archived Projects:** We have updated our Asana integration to allow users to filter out archived projects from their data sources, ensuring only active projects are visible and selectable.
    * **Expose Connect Credentials via SDK for Box**: Provides Connected User credentials for the Box integration to allow you to use the Box File Picker with Paragon.
    * **Task History Clarity:** Resolved an issue in Task History where preview user executions appeared to run, now ensuring accurate display and status reporting.

    ## 🐛 Bug Fixes

    * **Connection Error Handling:** Fixed an issue where integration errors were incorrectly thrown from `getConnectOptions` across multiple integrations like Pipedrive and Salesforce.

    * **Salesforce API Error Handling:** Resolved an error in Salesforce custom API requests that caused a failure when trying to read properties of an undefined object, ensuring smoother operation and data handling.

    * **Workflow Execution Replay Reliability:** Addressed an issue where workflow replays were failing due to incorrect handling of input data.

    * **Fix for Sage Intacct Integration**: Resolved an issue where passing JSON as a return format caused errors, ensuring smoother integrations with Sage Intacct.

    * **Fix HubSpot Actions Copy**: Updated text elements and fixed UI issues in the HubSpot integration, improving usability and consistency across the platform.

    * **Delete Associated Connect Credentials on Integration Deletion**: Ensured that deleting an integration also deletes associated connect credentials, preventing orphaned data and maintaining data integrity.

    * **Integration Error Handling Improvements:** Multiple updates to standardize and improve error handling across integrations:
      * Improved error messaging for User Settings and during authentication failures.
      * Resolved issues with capturing and displaying errors outside of integrations.
      * Fixed bugs related to improper error displays in test data for triggers and actions.

    * **Miscellaneous Fixes:**
      * Fixed a bug where project lists were not displayed in the intended order within our platform.
      * Addressed a critical bug where duplicate identifiers and a blocker in opening the Custom Integration Builder caused interruptions in user workflows.
      * Fixed issues across multiple stages of the LinkedIn Ads integration lifecycle for more reliable connections.

    * **Workflow and Integration Stability Fixes:**
      * **Zendesk Updates:** Improved the "Search Tickets" step and fixed trigger tests for "ticket created" and "ticket updated," ensuring more accurate and reliable ticket handling.
      * **Test Workflow Record Handling:** Fixed an issue where test workflows were incorrectly adding new records in the task history executions, ensuring cleaner and more accurate execution logs.

    * **Stability and Reliability Fixes:**
      * **Custom Integration Builder Stability:** Fixed a crash issue in the Custom Integration Builder on load in release environments, enhancing the stability and reliability of integration setup.

    * **Release and Environment Management:**
      * Fixed an issue where creating environments would inadvertently create two releases, streamlining the release management process.

    * **Error Handling and Stability Fixes:**
      * **Amazon S3 & Workday:** Addressed issues where errors were being returned as generic 500s, now providing more specific error messages.
      * **Asana:** Resolved issues where a bad client ID could cause 504 errors or stall worker-actions, enhancing system reliability.
      * **Zendesk:** Updated the "Search tickets" step and fixed trigger tests for "Ticket Created" and "Ticket Updated," ensuring more accurate and reliable ticket handling.
      * **LinkedIn Marketing:** Resolved connection issues to improve reliability and user experience.
      * **File Handling:** Fixed an issue where xlsx and text files were getting corrupted during upload, ensuring data integrity during file transfers.

    * **User Metadata Fix in SDK:** Resolved a bug where user metadata passed into `paragon.authenticate` for new connected users was returning `null` values. Metadata now persists correctly after initial creation.

    * **Asana Integration - Archived Projects:** Improved the Asana integration to allow users to exclude archived projects from project lists in data sources and workflow steps.

    * **Zendesk Action Field Update:** Enhanced the Zendesk 'Create Ticket' action with dynamically editable fields for Status, Priority, and Type fields, providing more flexibility in ticket creation.

    * **Linear Authentication Tooltip Corrected:** Updated the tooltip for "Authenticate as Application" in Linear integration to provide clearer guidance on its usage.

    * **Intellum Integration Warning Fixed:** Fixed an issue in the Intellum integration where development credentials warnings were incorrectly displayed.
  </Update>

  <Update label="January 2024">
    ## 🐛 Bug Fixes

    * **Salesforce Access Token Refresh Issue:** Resolved an issue where connect proxy requests in Salesforce did not refresh access tokens, ensuring continuous and secure access to Salesforce resources.
    * **UI Fixes in Task History:** Addressed an issue where the integration enable trigger UI was distorting in Task History, ensuring a cleaner and more user-friendly interface.
    * **npm Route Access Restored:** Resolved a critical issue where the `actions/configs` route in npm was being erroneously blocked by immutable message in release environments, restoring full functionality.
    * **Monday.com Task History Accuracy:** Fixed discrepancies between Task History and test step responses in Monday.com integrations, ensuring data consistency and reliability.
    * **Localhost Address Usage for Redirect URLs:** Resolved an issue in the `completeInstall` method that prevented the use of localhost addresses for the `redirectUrl` option, enhancing flexibility in development environments.
    * **Salesforce Connection Stability:** Addressed a bug in Salesforce integration where proxy requests did not properly refresh access tokens.
    * **Airtable Token Issue Resolved:** Fixed a bug where connections to Airtable would fail due to token issues, ensuring smoother integrations.
    * **Task Limit Error Correction:** Corrected an erroneous "Task Limit Reached" error for users on Trial plans using the Proxy APIs, enhancing the trial experience.
    * **Integration Request Limit Increased:** We've resolved an issue where custom integration requests with a body size greater than 10 MB would fail, now supporting larger data payloads.
    * **Fix for Hubspot Get Record By ID Issue:** Resolved a bug where the Get Record By ID action
      in Hubspot failed due to a large Request URI, ensuring seamless integration workflows.

    ## 🚀 New Features

    **✨ SAP Emarsys Integration!**

    You can now connect to your users' SAP Emarsys accounts to manage their contacts, segments, and campaigns. Paragon enables you to sync data between your app and your users’ SAP Emarsys. For example, you can create contacts or manage campaigns in SAP Emarsys. Learn more in our docs.

    * **Monday.com API Migration:** We've successfully migrated all actions, triggers, and data sources to the latest Monday.com API, ahead of the January 15th deprecation deadline. This ensures our platform remains compatible and fully functional with Monday.com services.

    ✨ **Shopify Trigger Enhancements!**

    We’ve expanded our Shopify integration with new triggers that enhance your ability to manage customer and shop data privacy:

    * **Customer Data Request:** You can now automate the fulfillment of customer data requests directly within our platform.
    * **Customer Data Erasure Request:** Easily handle requests for customer data deletion, ensuring compliance with privacy regulations.

    ✨ **Google Drive Picker Support:** With the new Google Drive Picker integration, you can now easily access and manage your files directly within Paragon. This feature is perfect for users who need to quickly incorporate documents into their workflows without leaving the platform.

    ## 🛠 Improvements

    * **Salesforce Integration Enhancements:** Updated our Salesforce integration to handle token expiration more effectively by including `403` status code checks. This improvement ensures more reliable connectivity by handling token renewals proactively.
    * **Salesforce Credential Refresh Optimization:** Enhanced credential refresh optimization has been implemented for Salesforce integrations, ensuring smoother and more efficient authentication processes.
    * **Improved Monday.com Integration Stability:** Resolved unexpected errors related to webhook unsubscriptions, providing a smoother experience for integrating with Monday.com.

    ## Updates

    Our [SDK](https://www.npmjs.com/package/@useparagon/connect) has been updated to version 1.0.3, which includes the following changes:

    * Support for `paragon.completeInstall` function ([docs](/resources/integrations/shopify)), required for Redirect Pages in published Shopify and Pipedrive integrations
    * Support for `allowMultipleCredentials` parameters in Headless Connect Portal functions

    ***

    You can update the SDK by running:

    ```
    npm install @useparagon/connect
    ```

    If you are currently using the script tag installation, these updates have been published in version 2.93.1.
  </Update>
</Accordion>

<Accordion title="2023">
  <Update label="December 2023">
    ## 🚀 New Features

    ✨ **[Amazon S3](/resources/integrations/amazon-s3) Actions!**

    You can now access the following actions when building workflows for Amazon S3:

    * Upload File
    * List Files
    * Download File
    * Create Folder
    * Delete Folder

    ✨ **[Dynamics 365 Business Central](/resources/integrations/dynamicsbusinesscentral) Triggers!**

    You can now trigger Dynamics 365 Business Central workflows when records are created, updated, and deleted in your users' Dynamics 365 Business Central accounts, making it easy to sync data in real-time between your users' Dynamics 365 Business Central and your app. Learn more in our docs.

    **✨ DocuSign Integration!**

    You can now connect to your users' DocuSign accounts to manage their documents and signatures. Paragon enables you to sync data between your app and your users’ DocuSign. For example, you can create contracts or manage signatures in DocuSign. Learn more in our docs.

    * **OAuth Client Credentials Authorization:** Enhanced security by adding OAuth client credentials authorization type, allowing more robust and secure integration capabilities for your applications.

    ## 🛠 Improvements

    * **Notion Integration Upgrade:** Optimized the credential refresh process for Notion, ensuring smoother and more reliable integration performance.
    * Improvements to our token syncing mechanism for HubSpot.
    * Improvements to our token syncing mechanism for OneNote.

    ## 🐛 Bug Fixes

    * **Azure DevOps Integration:** Resolved an issue where actions to create work items were failing.
    * **Microsoft Dynamics Credential Handling:** Fixed a bug in credential type management, ensuring smoother authentication and connection stability.
    * Fixes a bug where users were redirected to a blank page instead when deleting users from the Connected Users Dashboard.
    * **Gusto Integration Link Correction:** Updated the 'Update Employee Action' in Gusto to correctly redirect to the 'API Versioning' guide, ensuring accurate and helpful documentation access.
  </Update>

  <Update label="November 2023">
    ## 🚀 New Features

    ✨ **[PagerDuty](/resources/integrations/pagerduty) Integration!**

    You can now connect to your users' PagerDuty accounts to manage their incidents and on-call schedules. Paragon enables you to sync incident data between your app and your users’ PagerDuty. For example, you can add new incidents or manage on-call schedules in PagerDuty. Learn more in [our docs](/resources/integrations/pagerduty).

    ✨ **New [Notion](/resources/integrations/notion) Triggers!**

    You can now access the following triggers when building workflows for Notion:

    * Page Created
    * Page Updated

    ## 🐛 Bug Fixes

    * Fixes an authentication issue for Google Drive.
    * Fixes an authentication issue for the Workday integration.
  </Update>

  <Update label="October 2023">
    ## 🛠 Improvements

    * Internal improvements
    * You can now add attachments when sending messages in Microsoft Outlook!

    ## 🚀 New Features

    ✨ **Default Account Types!**

    You can now choose which type of account you would like to connect to programmatically! This is great for cases where you want to your customers to only connect a production Salesforce account.

    To default the Connect Portal to a certain type of account, define the `accountType` parameter:

    ```js
    paragon.connect("salesforce", {
      accountType: "default"
    });
    ```

    ## 🐛 Bug Fixes

    * Fixes an issue where Fan In values were concatenated to a string rather than an array of results.
    * Fixes an issue where users were unable to filter Task History by specific integrations.
  </Update>

  <Update label="September 2023">
    ## 🚀 New Features

    ✨ **[Wordpress](/resources/integrations/wordpress) Integration!**

    You can now connect to your users' Wordpress accounts to manage their pages, posts, and stats. Paragon enables you to sync data between your app and your users’ Wordpress. For example, you can create new posts or fetch post stats and insights in Wordpress.

    Learn more in [our docs](/resources/integrations/wordpress).

    ✨ **[Google Analytics GA4](/resources/integrations/googleanalyticsga4) Integration!**

    You can now connect to your users' Google Analytics GA4 accounts to manage their reports and analytics. Paragon enables you to sync data between your app and your users’ Google Analytics. For example, you can create new reports or periodically fetch new analytics in Google Analytics GA4 properties.

    Learn more in [our docs](/resources/integrations/googleanalyticsga4).

    ✨ **[ADP Workforce Now](/resources/integrations/adp-workforce-now) Integration!**

    You can now connect to your users' ADP Workforce Now accounts to manage their staffing and payroll. Paragon enables you to sync data between your app and your users’ ADP Workforce Now. For example, you can add new employees or sync payroll in ADP Workforce Now.

    Learn more in [our docs](/resources/integrations/adp-workforce-now).

    ✨ **New [Google Calendar](/resources/integrations/google-calendar) Triggers!**

    You can now access the following native, webhook-based triggers when building workflows for Google Calendar:

    * New Event
    * Event Updated
    * Event Cancelled

    ⚠️ These new webhook-based triggers introduce the *Legacy* label on existing Workflow triggers. There is no affect to deployed workflows with these legacy triggers. They will continue to execute as expected.

    ✨ **New [Close](/resources/integrations/close) Triggers!**

    You can now access the following triggers when building workflows for Close CRM:

    * Record Created
    * Record Updated
    * Record Deleted

    These triggers support subscribing to changes around `Leads`, `Opportunities`, `Contacts`, and `Tasks` within Close CRM.

    ✨ **[Apollo.io](/resources/integrations/apollo-io) Integration!**

    You can now connect to your users' Apollo.io accounts to manage their accounts, contacts, and sequences. Paragon enables you to sync data between your app and your users’ Apollo.io. For example, you can add new contacts or manage sequence stages in Apollo.io. Learn more in [our docs](/resources/integrations/apollo-io).

    ✨ **[Google Drive](/resources/integrations/google-drive) Actions!**

    You can now *Export a File* to a raw file blob when building workflows for Google Drive.

    ## 🛠 Improvements

    * Internal improvements
    * Internal improvements to the Paragon Proxy API
    * Adds support for OAuth-based authentication to the AirTable integration
    * Adds support for the `googleapis.com` domain in the proxy API for the Gmail integration
    * Allows developers to receive a download token for Zoom meeting recording workflow actions in payload responses
    * Improvements to Zoho CRM workflow triggers
    * Improvements to Klaviyo error messaging on empty action inputs
    * Improvements to Paragon SDK loading efficiencies
    * Improvements to pagination performance
    * Improvements to Event Destinations payloads
    * Adds a `completeInstall` function to the SDK for installing integrations that originate from an Application Marketplace ([Read more](/apis/api-reference))
    * Internal improvements to memory build-up
    * Internal codebase efficiencies
    * UI updates to Asana workflow triggers
    * Internal improvements to our integration authentication manager
    * UI improvements for workflow triggers for Monday.com and Quickbooks
    * Provides more specific errors for Klayvio *Send Campaign* action
    * Improves error handling for the Marketo integration now returning a JSON-parsable error message

    ## 🐛 Bug Fixes

    * Fixes an authentication issue for the Gmail integration
    * Internal improvements to integration credential caching
    * Fixes Paragon Connect proxy request issues
    * Fixes a issue with generating new Signing Keys
    * Fixes an issue with Salesforce's *Create Record Custom Object*
    * Fixes an issue related to workflow trigger payload filtering in Zoho CRM
    * Fixes an issue related to the Azure DevOps Connect Portal
  </Update>

  <Update label="August 2023">
    ## 🚀 New Features

    ✨ **[Quip](/resources/integrations/quip) Integration!**

    You can now connect to your users' Quip accounts to manage their documents and spreadsheets. Paragon enables you to sync data between your app and your users’ Quip. For example, you can create documents or manage existing Sheets and Threads in Quip. Learn more in [our docs](/resources/integrations/quip).

    ✨ **[Shortcut](/resources/integrations/shortcut) Actions!**

    You can now access the following actions when building workflows for Shortcut:

    * Create Story
    * Update Story
    * Get Story by ID
    * Get Stories by Project
    * Get Stories by Epic
    * Search Stories
    * Create Epic
    * Update Epic
    * Get Epic by ID
    * Delete Epic
    * Create Project
    * Update Project
    * Get Project by ID
    * Delete Project

    ✨ **New [Asana](/resources/integrations/asana) Trigger!**

    You can now trigger workflows whenever an Asana task is deleted.

    ✨ **[Adobe Acrobat Sign](/resources/integrations/adobe-acrobat-sign) Integration!**

    You can now connect to your users' Adobe Acrobat Sign accounts to manage their lists, subscribers, and campaigns. Paragon enables you to sync data between your app and your users’ Adobe Acrobat Sign. For example, you can add new subscribers to lists or campaigns or manage lists or campaigns in Adobe Acrobat Sign. Learn more in [our docs](/resources/integrations/adobe-acrobat-sign).

    ✨ **New [Slack](/resources/integrations/slack) Trigger!**

    You can now access a *File Deleted* trigger when building workflows for Slack.

    🚀 **Other New Features**

    * Adds ability for a developer to specify a token-type from the Slack Integration Request Step.

    ✨ **[Miro](/resources/integrations/miro) Integration**!

    You can now connect to your users' Miro accounts to manage their boards and documents. Paragon enables you to sync data between your app and your users’ Miro accounts. For example, you can create new documents and manage items within boards in Miro.

    ✨ **[Freshsales](/resources/integrations/freshsales) Integration**!

    You can now connect to your users' Freshsales accounts to manage their deals, contacts, and leads. Paragon enables you to sync data between your app and your users’ Freshsales accounts. For example, you can add new contacts or update deal stages in Freshsales.

    ✨ **[Figma](/resources/integrations/figma) Actions!**

    You can now access the following actions when building workflows for Figma:

    * Get File by ID
    * Get File Nodes
    * Get Rendered Image from File
    * Get Users' Projects
    * Get Project Files
    * Create Comment
    * Get Comments by File
    * Delete Comment
    * Create Comment Reaction
    * Get Comment Reactions by File
    * Delete Comment Reaction

    ✨ **[Coda](/resources/integrations/coda) Actions!**

    You can now access the following actions when building workflows for Coda:

    * Create Document
    * Get Document by ID
    * Search Documents
    * Delete Document
    * Get Table by ID
    * Search Tables

    ✨ **[Adobe Experience Manager](/resources/integrations/adobe-experience-manager) Actions!**

    You can now access the following actions when building workflows for Adobe Experience Manager:

    * Create Folder
    * Delete Folder
    * Create an Asset Rendition
    * Update an Asset Rendition
    * Delete an Asset Rendition
    * Delete an Asset

    ## 🛠 Improvements

    * Allows Paragon developers to author Outlook integrations enabling the connection and additional privileges of Microsoft organization administrators. Allows a Paragon developer to use Microsoft's *application permission types*
    * UI improvements to the Marketo integration
    * Improvements to workflow engine monitoring
    * UI improvements for Zoom and Asana triggers
    * Added a saving indicator to the Connect Portal
    * Improvements to Shopify trigger payload date accuracy
    * Improvements to pagination for Shopify actions
    * Improvements to Pipedrive workflow trigger record filtering

    ## 🐛 Bug Fixes

    * Fixes a dashboard-level bug preventing Paragon developers from viewing their integrations' settings under certain circumstances
    * Fixes an issue with URL query parameters not appearing in the received request payload
    * Fixes issues related to *Fan In* values in the workflow editor
    * Fixes an invalid URL for the Connect Portal image assets
    * Fixes an issue with multiple-account authorization and the Connect Portal
    * Fixes an issue with User names in the Task History dashboard
    * Fixes an issue where Jira triggers were not detecting new records under certain circumstances
    * Fixes an issue with parameter parsing for the *Update Items* workflow action in the Monday.com integration
    * Fixes an issue where Google Sheets and Google Drive triggers were firing too frequently
    * Fixes an issue with certain HubSpot records having truncated payloads
    * Fixes a visual issue with the Preview Portal and workflow editor inputs
    * Fixes an issue where workflows were resolving data from test workflows
    * Fixes an issue with the Pardot Connect Portal
    * Fixes an issue with the Azure DevOps integration authentication mechanism
    * Fixes an issue with HubSpot error state when an optional payload parameter is not passed
    * Fixes an issue with Fan Out and "Fan-in" workflow steps incorrectly resolving as empty arrays
    * Fixes an issue with the Paragon dashboard log-in process on Safari browsers

    ## New

    ## 🛠 Improvements

    ⚠️ **HubSpot Workflow Triggers Reverted** ⚠️

    This release reverts recent work to improve the HubSpot webhook triggers. **No action is required from developers to maintain their currently deployed workflows.**

    🛠 **Other Platform Improvements**

    * Improvements to the Google Drive trigger test step experience
    * Improvements to the Gmail integration error object
    * Exposes a request header for the Proxy API allowing developers to specify token-type for the Slack integration

    ## 🐛 Bug Fixes

    * Fixes a visual issue with integration logo icons
    * Fixes an issue with certain workflows not completing properly
    * Fixes extraneous executions for Marketo's workflow trigger configured for Leads
  </Update>

  <Update label="July 2023">
    ## 🛠 Improvements

    * Adds the Connected User ID to the workflow execution view in Task History.
    * Provides more accurate statuses to workflow executions.
    * Improvements to workflow execution efficiencies.
    * Provides more specific error details for the Jira integration.
    * Adds a new Data Source for Projects for the Asana integration.
    * Adds support for accepting JSON as input for creating Issues in the Jira integration.

    ⚠️ **HubSpot Trigger Improvements**

    * Adds more performant, webhook-based triggers for the HubSpot integration.
    * Developers may notice their HubSpot `Record Created`, `Record Updated`, and `Record Deleted` workflow triggers have `(Legacy)` appended to their labels.
    * **No action is required to maintain stability of existing deployed workflows.** These workflows will remain stable as there is no change to existing deployed workflows.
    * Developers may choose to opt-in to using the new workflows by selecting the new `Record Created` and `Record Deleted` triggers in the workflow editor which will configure webhook-based notifications in their HubSpot applications.

    ⚠️ **Outlook Trigger Improvements**

    * Adds more performant, webhook-based triggers for the Outlook integration.
    * Developers may notice their Outlook `Event Created`, `Event Updated`, `Event Removed`, and `New Message` workflow triggers have `(Legacy)` appended to their labels.
    * Developers may choose to opt-in to using the new workflows by selecting the new `Event Created`, `Event Updated`, `Event Removed`, and `New Message` triggers in the workflow editor which will configure webhook-based notifications in their Outlook applications.

    🛠 **Other Platform Improvements**

    * Adds improvements to Test Step payloads for triggers in the Intercom integration.

    ## 🐛 Bug Fixes

    * Fixes issues with triggers not showing up in Task History.
    * Fixes issues with conditional operators in the Salesforce integration
    * Fixes an issue where *Test Step* fails to execute when the workflow is not deployed.
    * Fixes an issue where the Outlook integration `Event Created` trigger would fire for duplicate events.
    * Fixes validation errors in the Front integration.
    * Fixes UI issues for the Monday.com integration.
    * Fixes an issue with the Custom Integration Builder API key inputs.
    * Fixes issues with OneDrive user settings not loading.
    * Fixes an issue with API-key-based authentication for the Azure DevOps integration.
    * Fixes an issue where Google Calendar trigger runs for duplicate events.
    * Fixes and issue with searching for records for the DocuSign integration

    ## 🚀 New Features

    ✨ **New [Workday](/resources/integrations/workday) Integration!**

    You can now connect to your users' Workday accounts to manage their employees. Paragon enables you to sync data between your app and your users’ Workday. For example, you can add new employees to lists or manage PTO requests in Workday.

    ✨ **New [Box](/resources/integrations/box) Actions!**

    You can now access the following actions when building workflows for Box:

    * Save File
    * Get File by ID
    * List Files
    * Create Folder
    * Move Folder
    * Get Folder by ID
    * Search Folders
    * Delete Folders

    ✨ **New [Intercom](/resources/integrations/intercom) Triggers!**

    You can now access the following triggers when building workflows for Intercom:

    * Company Created
    * Company Updated
    * Contact Created
    * Contact Updated

    ✨ **New [OneDrive](/resources/integrations/onedrive) Actions!**

    You can now access the following actions when building workflows for OneDrive:

    ✨ **New [Google Drive](/resources/integrations/google-drive) Actions!**

    You can now access the following actions when building workflows for Google Drive:

    * Delete Folder

    ✨ **New [Dropbox](/resources/integrations/dropbox) Action!**

    You can now access the `Get Folder by ID` action when building workflows for Dropbox.
  </Update>

  <Update label="June 2023">
    ## 🚀 New Features

    ✨ **Project Manager!**

    We've given the top portion of Paragon a new coat of paint! You can now switch between projects by clicking your project's name in the top-left corner and selecting one from the drop-down.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/876-8952bee8db645d893b2e09077e77231a6aaf4573.png" alt="" />
    </Frame>

    Clicking the "Manage Projects" button will take you straight to the **Project Manager**, where you can switch between projects or rename any previously named project.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/877-0872cff148f29cf86d36c6de1e7c66506b7918f8.png" alt="" />
    </Frame>

    ✨ **New [HubSpot](/resources/integrations/hubspot) Trigger!**

    You can now access the `Record Deleted for Privacy (GDPR)` trigger for HubSpot. This allows you to trigger workflows when a record is deleted for privacy reasons.

    ✨ **New [GitHub](/resources/integrations/github) Triggers!**

    You can now access the following triggers when building workflows for GitHub:

    * Issue Created
    * Issue Updated
    * PR Created
    * PR Updated
    * Project Created
    * Project Updated

    ✨ **[Dropbox Sign](/resources/integrations/dropboxsign) Actions!**

    You can now access the following actions when building workflows for Dropbox Sign:

    * Create and Send Signature Request
    * Update Signature Request
    * Get Signature Request by ID
    * Search Signature Requests
    * Cancel Incomplete Signature Request
    * Download Files

    ✨ **[Todoist](/resources/integrations/todoist) Actions!**

    You can now access the following actions when building workflows for Todoist:

    * Create Project
    * Update Project
    * Get Project by ID
    * Get All Projects
    * Delete Project
    * Create Task
    * Update Task
    * Get Task by ID
    * Search Tasks
    * Close Task
    * Delete Task

    ✨ **More [GitHub](/resources/integrations/github) Triggers!**

    ✨ **More [Google Drive](/resources/integrations/google-drive) Actions!**

    You can now access the `Search Folders` action for Google Drive. This allows you to create workflows that are capable of searching folders at different depths on Paragon.

    ## 🛠 Improvements

    * The Hubspot `Search for Custom Object` types previously returned `null` values for every unset field. Changed the behavior so that they are filtered the same as other `Search record` types.
    * Adds support for the `archiver` npm library.
    * Adds filter search for Pipedrive's `Record Created` and `Record Updated` triggers.

    ## 🐛 Bug Fixes

    * Fixes an issue where workflows with Delay steps would have actions appear in the wrong order when viewing their Task History executions.
    * Fixes an issue where the `Search Records` action for HubSpot fails when attempting to search over 10k records.
    * Configuration settings when adding data sources no longer disappears after a few seconds
    * Fixes an issue where the `Record Deleted` trigger for HubSpot did not properly support Custom Objects.
    * Fixes an issue with the `Search Contacts` action for Intercom.
    * Fixes an issue where the Connect Portal could potentially crash when passing field mapping options from the Connect SDK.
    * Fixes an issue with the token refresh mechanism for Dropbox Sign.
  </Update>

  <Update label="May 2023">
    ## 🚀 New Features

    ✨ **[Microsoft Teams](/resources/integrations/microsoft-teams) Triggers!**

    You can now trigger Microsoft Teams workflows when chats and channels are created or updated in your users' Microsoft Teams accounts, making it easy to sync data in real-time between your users' Microsoft Teams and your app. Learn more in our docs.

    ✨ **More [ClickUp](/resources/integrations/clickup) Triggers!**

    You can now access the following triggers when building workflows for ClickUp:

    * New Folder Created
    * Folder Updated
    * New List Created
    * List Updated
    * New Space Created
    * Space Updated

    ✨ **More [Google Drive](/resources/integrations/google-drive) Triggers!**

    You can now trigger workflows when Files are deleted from your users' Google Drive accounts!

    ✨ **More [Gmail](/resources/integrations/gmail) Triggers!**

    You can now access the following triggers when building workflows for Gmail:

    * Thread Modified

    ✨ **[Sharepoint](/resources/integrations/sharepoint) Triggers!**

    You can now trigger Sharepoint workflows when items are created or updated in your users' Sharepoint accounts, making it easy to sync data in real-time between your users' Sharepoint and your app. Learn more in [our docs](/resources/integrations/sharepoint).

    ✨ **[Adobe Experience Manager](/resources/integrations/adobe-experience-manager) Integration!**

    You can now connect to your users' Adobe Experience Manager accounts to manage their digital assets. Paragon enables you to sync data between your app and your users’ Adobe Experience Manager. For example, you can create or manage digital assets in Adobe Experience Manager. Learn more in [our docs](/resources/integrations/adobe-experience-manager).

    ✨ **More [Google Drive](/resources/integrations/google-drive) Actions!**

    You can now access the following actions when building workflows for Google Drive:

    * Get File by ID

    ✨ **[npm](https://www.npmjs.com/package/@useparagon/connect) Support for Paragon's SDK!**

    You can now install the Paragon SDK with npm! Just type `npm install @useparagon/connect` in your application's console to get started. Learn more in [our docs](/getting-started/installing-the-connect-sdk).

    ✨ **[Front](/resources/integrations/front) Actions!**

    You can now access the following actions when building workflows for Front:

    * Create Account
    * Update Account
    * Get Account by ID
    * Search Accounts
    * Delete Account
    * Create Contact
    * Update Contact
    * Get Contact by ID
    * Search Contacts
    * Delete Contact

    ✨ **More [Asana](/resources/integrations/asana) Actions!**

    You can now access the following actions when building workflows for Asana:

    * Get Task by External ID
    * Add Task to Section

    ✨ **[Confluence](/resources/integrations/confluence) Actions!**

    You can now access the following actions when building workflows for Confluence:

    * Create Page
    * Update Page
    * Get Page by ID
    * Get Pages in Space
    * Get Pages by Label
    * Search Pages
    * Delete Page
    * Get Space By ID
    * Search Spaces

    ✨ **[Salesloft](/resources/integrations/salesloft) Actions!**

    You can now access the following actions when building workflows for Salesloft:

    * Create an Account
    * Update an Account
    * Get an Account
    * Delete an Account
    * Create a Custom Field
    * Update a Custom Field
    * Get a Custom Field
    * Delete a Custom Field
    * Search Custom Fields
    * Create a Call
    * Get a Call
    * Search Calls
    * Create a Person
    * Update a Person
    * Get a Person
    * Delete a Person
    * Search Persons
    * Create a Task
    * Update a Task
    * Get a Task
    * Search Tasks

    ✨ **[Salesloft](/resources/integrations/salesloft) Triggers!**

    You can now trigger Salesloft workflows when people and accounts are created and updated in your users' Salesloft accounts, making it easy to sync data in real-time between your users' Salesloft and your app. Learn more in our docs.

    ✨ **[Slack](/resources/integrations/slack) Triggers!**

    You can now trigger Slack workflows when direct, group, and channel messages are sent or updated in your users' Slack accounts, making it easy to sync data in real-time between your users' Slack and your app. Learn more in our docs.

    ✨ **[Greenhouse](/resources/integrations/greenhouse) Triggers!**

    You can now trigger Greenhouse workflows when candidates and jobs are created and updated in your users' Greenhouse accounts, making it easy to sync data in real-time between your users' Greenhouse and your app. Learn more in our docs.

    ✨ **[Sailthru](/resources/integrations/sailthru) Integration!**

    You can now connect to your users' Sailthru accounts to manage their lists, subscribers, and campaigns. Paragon enables you to sync data between your app and your users’ Sailthru. For example, you can add new subscribers to lists or campaigns or manage lists or campaigns in Sailthru. Learn more in [our docs](/resources/integrations/sailthru).

    ✨ **[Todoist](/resources/integrations/todoist) Integration!**

    You can now connect to your users' Todoist accounts to manage their projects and tasks. Paragon enables you to sync data between your app and your users’ Todoist. For example, you can create items or manage tasks and issues in Todoist. Learn more in [our docs](/resources/integrations/todoist).

    ✨ **[Dropbox](/resources/integrations/dropbox) Triggers!**

    You can now trigger Dropbox workflows when files are created, updated, and deleted in your users' Dropbox accounts, making it easy to sync data in real-time between your users' Dropbox and your app. Learn more in our docs.

    ✨ **[Gmail](/resources/integrations/gmail) Triggers!**

    You can now trigger Gmail workflows when threads are created and updatedm in your users' Gmail accounts, making it easy to sync data in real-time between your users' Gmail and your app. Learn more in our docs.

    ## 🐛 Bug Fixes

    * Fixes an issue where User and Workflow Settings picklists are not searchable when there's an error in the input.
    * Resolves an issue where filters did not appear properly when using the `Record Deleted` trigger for Companies in HubSpot.
    * Fixes an issue where workflows that are enabled by default were not working for integrations that had extra configuration settings after authenticating.
    * Fixes an authentication issue for the Klaviyo Request step.

    ## 🛠 Improvements

    * Updates the Pardot Connect Portal to help end users find their Business Unit ID.
    * You can now access `https://www.googleapis.com` in Google Sheets.
    * Updates the error responses for ClickUp, Asana, and Trello to parsed JSON.
    * Adds support for GitHub apps and OAuth apps to the GitHub integration.
  </Update>

  <Update label="April 2023">
    ## 🚀 New Features

    ✨ **[Google Docs](/resources/integrations/googledocs) Integration!**

    You can now connect to your users' Google Docs accounts to manage their documents. Paragon enables you to sync data between your app and your users’ Google Docs. For example, you can create documents or sync documents in Google Docs. Learn more in [our docs](/resources/integrations/googledocs).

    ✨ **[Workable](/resources/integrations/workable) Integration!**

    You can now connect to your users' Workable accounts to manage their applications, candidates, and resumes. Paragon enables you to sync data between your app and your users’ Workable. For example, you can get resumes or manage candidates' applications in Workable. Learn more in [our docs](/resources/integrations/workable).

    ✨ **[Gainsight](/resources/integrations/gainsight) Integration!**

    You can now connect to your users' Gainsight accounts to manage their records. Paragon enables you to sync data between your app and your users’ Gainsight. For example, you can create records or manage records in Gainsight. Learn more in [our docs](/resources/integrations/gainsight).

    ✨ **[Google Drive](/resources/integrations/google-drive) Triggers!**

    You can now trigger Google Drive workflows when files are created and updated in your users' Google Drive accounts, making it easy to sync data in real-time between your users' Google Drive and your app. Learn more in [our docs](/resources/integrations/google-drive).

    ✨ **[Zendesk Sell](/resources/integrations/zendesksell) Actions!**

    You can now access the following actions when building workflows for Zendesk Sell:

    * Create Record
    * Update Record
    * Get Record by ID
    * Search Records
    * Delete Record

    ✨ **More [Slack](/resources/integrations/slack) Actions!**

    You can now access the following actions when building workflows for Slack:

    * Search Messages

    ✨ **[Keap](/resources/integrations/keap) Integration!**

    You can now connect to your users' Keap accounts to create, access, and update records. Paragon enables you to sync data between your app and your users’ Keap. For example, you can create records or sync records in Keap. Learn more in [our docs](/resources/integrations/keap).

    ✨ **[TikTok Ads](/resources/integrations/tiktokads) Integration!**

    You can now connect to your users' TikTok Ads accounts to manage their campaigns, groups, and ads. Paragon enables you to sync data between your app and your users’ TikTok Ads. For example, you can create ad creatives or take action on your customers' ad conversions in TikTok Ads. Learn more in [our docs](/resources/integrations/tiktokads) Integration!).

    ✨ **[Figma](/resources/integrations/figma) Integration!**

    You can now connect to your users' Figma accounts to manage their files. Paragon enables you to sync data between your app and your users’ Figma. For example, you can create files or manage files in Figma. Learn more in [our docs](/resources/integrations/figma).

    ✨ **[OneNote](/resources/integrations/onenote) Integration!**

    You can now connect to your users' OneNote accounts to manage their notebooks and pages. Paragon enables you to sync data between your app and your users’ OneNote. For example, you can create pages or manage notebooks in OneNote. Learn more in [our docs](/resources/integrations/onenote).

    ✨ **[Zoho People](/resources/integrations/zohopeople) Integration!**

    You can now connect to your users' Zoho People accounts to manage their employees, time off, and timesheets. Paragon enables you to sync data between your app and your users’ Zoho People. For example, you can create employee time off requests or manage employee information in Zoho People. Learn more in [our docs](/resources/integrations/zohopeople).

    ✨ **[Google Sheets](/resources/integrations/google-sheets) Triggers!**

    You can now trigger Google Sheets workflows when files and rows are created and updated in your users' Google Sheets accounts, making it easy to sync data in real-time between your users' Google Sheets and your app. Learn more in our docs.

    ✨ **[Notion](/resources/integrations/notion) Actions!**

    You can now access the following actions when building workflows for Notion:

    * Create a Page
    * Update a Page
    * Get a Page
    * Archive a Page
    * Update a Block
    * Retrieve a Block
    * Delete a Block

    ✨ **[Front](/resources/integrations/front) Integration!**

    You can now connect to your users' Front accounts to manage their conversations, messages, and contacts. Paragon enables you to sync data between your app and your users’ Front. For example, you can create or update contacts or send messages to contacts in Front. Learn more in [our docs](/resources/integrations/front).

    ✨ **[Confluence](/resources/integrations/confluence) Integration!**

    You can now connect to your users' Confluence accounts to access, create, and update their documents. Paragon enables you to sync data between your app and your users’ Confluence. For example, you can create and update documents or manage documents in Confluence. Learn more in [our docs](/resources/integrations/confluence).

    ✨ **[OneDrive](/resources/integrations/onedrive) Actions!**

    You can now access the following actions when building workflows for OneDrive:

    * Save File
    * Get File
    * List Files

    ✨ **[Shortcut](/resources/integrations/shortcut) Integration!**

    You can now connect to your users' Shortcut accounts to manage their items and epics. Paragon enables you to sync data between your app and your users’ Shortcut. For example, you can create or update items or manage epics in Shortcut. Learn more in [our docs](/resources/integrations/shortcut).

    ✨ **[Amplitude](/resources/integrations/amplitude) Integration!**

    You can now connect to your users' Amplitude accounts to upload, export, and query event data. Paragon enables you to sync data between your app and your users’ Amplitude. For example, you can create event data or export event data in Amplitude. Learn more in [our docs](/resources/integrations/amplitude).

    ✨ **[OneDrive](/resources/integrations/onedrive) Triggers!**

    You can now trigger OneDrive workflows when files are changed in your users' OneDrive accounts, making it easy to sync data in real-time between your users' OneDrive and your app. Learn more in [our docs](/resources/integrations/onedrive).

    ✨ **[Coda](/resources/integrations/coda) Integration!**

    You can now connect to your users' Coda accounts to manage their documents and tables. Paragon enables you to sync data between your app and your users’ Coda. For example, you can create new documents or update rows in Coda. Learn more in [our docs](/resources/integrations/coda).

    ✨ **More [Trello](/resources/integrations/trello) Triggers!**

    You can now trigger workflows when Boards are created and updated in your users' Trello accounts!

    ✨ **More [Jira](/resources/integrations/jira) Triggers!**

    You can now trigger workflows when Projects are created and updated in your users' Trello accounts!

    ✨ **Role-Based Access Control!**

    Role-Based Access Control allows you to give team members different levels of visibility to your Paragon projects. For example, you can:

    * Assign support team members with **Support** roles for access to the Connected Users and Task History pages only
    * Designate specific users with **Admin** roles to manage global settings, including team member access and billing information

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/809-83771d305e3d22451e69de46c2d63959a55db522.png" alt="" />
    </Frame>

    We recommend giving team members the minimal level of access they need, according to the principle of least privilege. While Admin and Member roles are available on all plans, Role-Based Access Control, such as the Support role, is available for Paragon customers on Enterprise plans. To learn more, contact your Customer Success Manager or [sales@useparagon.com](mailto:sales@useparagon.com).

    ✨ **[OneNote](/resources/integrations/onenote) Actions!**

    You can now access the following actions when building workflows for OneNote:

    * Update Page
    * Get Page by ID
    * Delete Page
    * Search Pages

    ✨ **[Lever](/resources/integrations/lever) Triggers!**

    You can now trigger Lever workflows when candidates and postings are created or updated in your users' Lever accounts, making it easy to sync data in real-time between your users' Lever and your app. Learn more in our docs.

    ## 🛠 Improvements

    * Adds support for filters for HubSpot triggers.
    * Adds access to the NetSuite account ID and provider data to the Dynamic Variable Menu.
    * Removes `https://www.googleapis.com/auth/drive` as one of the required scopes of the Google Drive integration.
    * Updates the error code for triggering workflows that aren't enabled to `Workflow not enabled for this user.`
    * Adds the `jsforce` npm library to the Function step.
    * Fixes an issue with Asana that results in blank fields causing other fields to become unset unexpectedly.

    ## 🐛 Bug Fixes

    * Fixes an issue where the workflow execution status in Task History get stuck on `Running`.
    * Fixes an issue where calling `paragon.authenticate()` with metadata would cause a `500` error.
    * Resolves an issue where workflow executions would not match the contents of their tasks.
    * Fixes an issue where custom integration icons would not appear correctly in the Custom Integration Builder.
    * Fixes a display issue that causes the Test Shelf to only appear once a workflow test has finished executing.
  </Update>

  <Update label="March 2023">
    ## 🚀 New Features

    ✨ **[Copper](/resources/integrations/copper) Integration!**

    You can now connect to your users' Copper accounts to manage their records. Paragon enables you to sync data between your app and your users’ Copper. For example, you can create new records or manage records in Copper. Learn more in [our docs](/resources/integrations/copper).

    ✨ **[Box](/resources/integrations/box) Integration!**

    You can now connect to your users' Box accounts to manage, create, and update files. Paragon enables you to sync data between your app and your users’ Box account. For example, you can create files or sync files in Box. Learn more in [our docs](/resources/integrations/box).

    ✨ **[Task History API](/apis/task-history)!**

    The [Task History API](/apis/task-history) allows you to query your users' usage of integration workflows and access data from historical workflow executions. The Task History API can be used to analyze integration usage or pull information about historical workflow executions into your application. For example, you can use the Task History API to:

    * Query the number of workflow executions that ran last week for the Salesforce integration
    * Query all failed workflow executions for a specific user
    * Export all tasks that occurred in a specific month into Google BigQuery

    ✨ **[Notion](/resources/integrations/notion) Integration!**

    You can now connect to your users' Notion accounts to manage their pages and databases. Paragon enables you to sync data between your app and your users’ Notion. For example, you can create pages or manage databases in Notion. Learn more in [our docs](/resources/integrations/notion).

    ✨ **[Hive](/resources/integrations/hive) Integration!**

    You can now connect to your users' Hive accounts to manage their tasks and issues. Paragon enables you to sync data between your app and your users’ Hive. For example, you can create tasks or manage items in Hive. Learn more in [our docs](/resources/integrations/hive).

    ✨ **[OneDrive](/resources/integrations/onedrive) Integration!**

    You can now connect to your users' OneDrive accounts to manage their files. Paragon enables you to sync data between your app and your users’ OneDrive. For example, you can create files or manage files in OneDrive. Learn more in [our docs](/resources/integrations/onedrive).

    ✨ **[Dropbox Sign](/resources/integrations/dropboxsign) Integration!**

    You can now connect to your users' Dropbox Sign accounts to manage their files. Paragon enables you to sync data between your app and your users’ Dropbox Sign. For example, you can create files or manage files in Dropbox Sign. Learn more in [our docs](/resources/integrations/dropboxsign).

    ✨ **[Microsoft Excel](/resources/integrations/microsoftexcel) Integration!**

    You can now connect to your users' Microsoft Excel accounts to access, create, and update their spreadsheets. Paragon enables you to sync data between your app and your users’ Microsoft Excel. For example, you can create and update rows or sync row data from Microsoft Excel. Learn more in [our docs](/resources/integrations/microsoftexcel).

    ✨ **[LinkedIn](/resources/integrations/linkedin) Actions!**

    You can now access the following actions when building workflows for LinkedIn:

    * Get Profile by ID
    * Create Post

    ## 🐛 Bug Fixes

    * Fixes an issue where manually typed JSON would appear as a `string` instead of an `Object` in the Integration Request step.
    * Fixes an issue where manually typed boolean values would appear as a `string` instead of a `boolean` object.
    * Fixes a bug where the workflow settings sidebar would disappear after viewing the preview Connect Portal.
    * Fixes a bug where moving between the preview Connect Portal and the Workflow Editor causes the step reference display to appear with the UUID instead of the step index.
    * Fixes a bug where the Dynamic Variable Menu would unexpectedly close when used in filters.
    * Fixes a bug where you couldn't use Environment Secrets as parameters in Function steps.
    * Fixes an issue where some Request-triggered workflows would occasionally fail to send a response for some users.

    ## 🛠 Improvements

    * Exposes the API Base URL for Zoho CRM as a variable in the Dynamic Variable Menu.
  </Update>

  <Update label="February 2023">
    ## 🐛 Bug Fixes

    * Fixes issues when copying workflows between projects
    * Fixes an issue with the Salesforce `Search Records` action where Paragon may not paginate more than 2000 records.
    * Fixes an issue with the Salesforce `Search Records` step where users may see an error message when a search with filters returns no results.
    * Fixes an issue where User and Workflow Settings are not saving properly in the Connect Portal Preview.
    * Fixes an issue where Greenhouse would not allow you to select any users to use after connecting to your Greenhouse account in the Connect Portal.

    ## 🚀 New Features

    ✨ **[Mixpanel](/resources/integrations/mixpanel) Integration!**

    You can now connect to your users' Mixpanel accounts to manage their events, reports, and data. Paragon enables you to sync data between your app and your users’ Mixpanel. For example, you can send event or profile data or perform custom JQL Queries in Mixpanel. Learn more in [our docs](/resources/integrations/mixpanel).

    ✨ **Marketo Webhook Triggers!**

    You can now trigger Marketo workflows when a **Lead is added to a List**!

    ✨ **[OpenAI](/resources/integrations/openai) Integration!**

    You can now connect to your users' OpenAI accounts to perform completions and run queries. Paragon enables you to sync data between your app and your users’ OpenAI accounts. For example, you can create images or run queries in OpenAI. Learn more in [our docs](/resources/integrations/openai).

    ✨ **[WhatsApp](/resources/integrations/whatsapp) Integration!**

    You can now connect to your users' WhatsApp accounts to send and receive messages and notifications. Paragon enables you to sync data between your app and your users’ WhatsApp. For example, you can send messages or receive notifications when a message status changes in WhatsApp. Learn more in [our docs](/resources/integrations/whatsapp).

    ✨ **[Zendesk Sell](/resources/integrations/zendesksell) Integration!**

    You can now connect to your users' Zendesk Sell accounts to manage their opportunities, contacts, and leads. Paragon enables you to sync data between your app and your users’ Zendesk Sell. For example, you can create new records or manage existing records in Zendesk Sell. Learn more in [our docs](/resources/integrations/zendesksell).

    ✨ **[Snowflake](/resources/integrations/snowflake) Integration!**

    You can now connect to your users' Snowflake accounts to manage their records and data. Paragon enables you to sync data between your app and your users’ Snowflake accounts. For example, you can create new records or manage existing records in Snowflake. Learn more in [our docs](/resources/integrations/snowflake).

    ✨ **[PandaDoc](/resources/integrations/pandadoc) Actions!**

    You can now access the following actions when building workflows for PandaDoc:

    * Create a Document
    * Update a Document
    * Get a Document by ID
    * Delete Document
    * Send a Document
    * Search Documents

    ✨ **[Segment](/resources/integrations/segment) Integration!**

    You can now connect to your users' Segment accounts to manage their workspaces, sources, and destinations. Paragon enables you to sync data between your app and your users’ Segment. For example, you can create and maintain destination filters or configure warehouses and sources in Segment. Learn more in [our docs](/resources/integrations/segment).

    ✨ **[Facebook Pages](/resources/integrations/facebook-pages) Integration!**

    You can now connect to your users' Facebook Pages accounts to manage their pages, content, and messages. Paragon enables you to sync data between your app and your users’ Facebook Pages. For example, you can create content or manage messages in Facebook Pages. Learn more in [our docs](/resources/integrations/facebook-pages).

    ✨ **Single Sign-On (SSO) Support!**

    Paragon now supports Single Sign-On for companies on Enterprise installations!

    ✨ **[LinkedIn](/resources/integrations/linkedin) Integration!**

    You can now connect to your users' LinkedIn accounts to manage their posts and profiles. Paragon enables you to sync data between your app and your users’ LinkedIn. For example, you can share content or retrieve profiles in LinkedIn. Learn more in [our docs](/resources/integrations/linkedin).

    ✨ **[Mailchimp](/resources/integrations/mailchimp) Triggers!**

    You can now trigger Mailchimp workflows when people are added to lists in your users' Mailchimp accounts, making it easy to sync data in real-time between your users' Mailchimp and your app. Learn more in our docs.

    ## 🛠 Improvements

    * Adds support for the [`neo4j-driver`](https://www.npmjs.com/package/neo4j-driver) library in the Function step.
    * Adds an option to opt-out of recurring event updates for Google Calendar triggers.
    * Updates the API version for Facebook Ads from `v12` to `v14`.
  </Update>

  <Update label="January 2023">
    ## 🛠 Improvements

    * Improved general processing speeds by over 5x
    * Increased upper processing limit by over 20x
    * Adds the Social Media category to the Catalog.
    * Updates the Gong logo.
    * Adds pagination support to the Marketo Lists User Setting such that the dropdown displays all the lists available to the user in their account.
    * Adds the `refresh_token` scope as a default scope when setting up a Pardot integration.
    * Adds the `url` library to the Function step.

    ## 🚀 New Features

    ✨ **[PandaDoc](/resources/integrations/pandadoc) Integration!**

    You can now connect to your users' PandaDoc accounts to manage their documents, contacts, and templates. Paragon enables you to sync data between your app and your users’ PandaDoc. For example, you can send documents or manage agreements in PandaDoc. Learn more in [our docs](/resources/integrations/pandadoc).

    ✨ **[Gusto](/resources/integrations/gusto) Integration!**

    You can now connect to your users' Gusto accounts to manage their employees, payroll, and jobs. Paragon enables you to sync data between your app and your users’ Gusto. For example, you can update employee payroll or sync employee information in Gusto. Learn more in [our docs](/resources/integrations/gusto).

    ✨ **[WooCommerce](/resources/integrations/woocommerce) Actions!**

    You can now access the following actions when building workflows for WooCommerce:

    * Create Customer
    * Get Customer by ID
    * Search Customers
    * Update Customer
    * Delete Customer
    * Create Order
    * Get Order by ID
    * Search Orders
    * Update Order
    * Delete Order
    * Create Product
    * Get Product by ID
    * Search Products
    * Update Product
    * Delete Product

    ✨ **[Close](/resources/integrations/close) Integration!**
    You can now connect to your users' Close accounts to manage their opportunities, contacts, and leads. Paragon enables you to sync data between your app and your users’ Close. For example, you can create and update records or sync records in Close. Learn more in [our docs](/resources/integrations/close).

    ✨ **[DocuSign](/resources/integrations/docusign) Actions!**
    You can now access the following actions when building workflows for DocuSign:

    * Create an Envelope
    * Get Envelope by ID
    * Update Envelope
    * Send an Envelope
    * Search Envelopes
    * Envelope Custom Fields (CRUD)

    ✨ **[Greenhouse](/resources/integrations/greenhouse) Actions!**
    You can now access the following actions when building workflows for Greenhouse:

    * Create Application
    * Update Application
    * Get Application by ID
    * Delete Application
    * Create Candidate
    * Update Candidate
    * Get Candidate by ID
    * Delete Candidate
    * Create Job Opening
    * Update Job Opening
    * Get Job Opening by ID

    ✨ **[SAP S/4HANA](/resources/integrations/saps4hana) Actions!**
    You can now access the following actions when building workflows for SAP S/4HANA:

    * Create Supplier Invoice
    * Get Supplier Invoice by ID
    * Search Supplier Invoices
    * Delete Supplier Invoice
    * Get Supplier by ID
    * Search Suppliers
    * Update Supplier
    * Search Customer

    I guess you can say this release is *action-packed* 😏

    ✨ **[Calendly](/resources/integrations/calendly) Triggers!**

    You can now trigger Calendly workflows when invitees are created or canceled in your users' Calendly accounts, making it easy to sync data in real-time between your users' Calendly and your app. Learn more in [our docs](/resources/integrations/calendly).

    ## 🐛 Bug Fixes

    * Fixes an issue with the copy for the `Insert Document` action for the Firebase integration in Paragon Automate
    * Fixes an issue where authentication tokens might not refresh for Microsoft Outlook workflows using the Microsoft Outlook Request step.
  </Update>
</Accordion>

<Accordion title="2022">
  <Update label="December 2022">
    ## 🚀 New Features

    ✨ **Twitter Integration!**

    You can now connect to your users' Twitter accounts to manage their datasets, dataflows, and reports. Paragon enables you to sync data between your app and your users’ Twitter account. For example, you can create tweets on behalf of your user or get a list of tweets by user or topic on Twitter.

    ✨ **[Power BI](/resources/integrations/powerbi) Integration!**

    You can now connect to your users' Power BI accounts to manage their content and perform admin operations. Paragon enables you to sync data between your app and your users’ Power BI. For example, you can embed Power BI content or perform admin operations in Power BI. Learn more in [our docs](/resources/integrations/powerbi).

    ✨ **[SAP SuccessFactors](/resources/integrations/sapsuccessfactors) Integration!**

    You can now connect to your users' SAP SuccessFactors accounts to manage their employees, time off, and benefits. Paragon enables you to sync data between your app and your users’ SAP SuccessFactors. For example, you can create employee time off requests or sync employee information in SAP SuccessFactors. Learn more in [our docs](/resources/integrations/sapsuccessfactors).

    ✨ **[Amazon S3](/resources/integrations/amazon-s3) Integration!**

    You can now connect to your users' Amazon S3 accounts to manage their buckets, objects, and jobs. Paragon enables you to sync data between your app and your users’ Amazon S3. For example, you can create publish or update metadata or run specific jobs and tasks in Amazon S3. Learn more in [our docs](/resources/integrations/amazon-s3).

    ✨ **[Tableau](/resources/integrations/tableau) Integration!**

    You can now connect to your users' Tableau accounts to manage their data sources, projects, and workbooks. Paragon enables you to sync data between your app and your users’ Tableau. For example, you can publish and update metadata or refresh the extract of a data source of a site in Tableau. Learn more in [our docs](/resources/integrations/tableau).

    ✨ **[Enable Workflows by Default](/connect-portal/connect-portal-customization)!**

    You can now default workflows to “enabled” without hiding the workflow from the Connect Portal! This is great for times when you want the functionality to be enabled by default and want to give your customer control over whether it stays enabled. Access these new settings in the **Connect Portal Configuration** menu.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/742-82b997ab035b4f199e96a58f90522bd5f18739d4.png" alt="" />
    </Frame>

    ✨ **[Lever](/resources/integrations/lever) Actions!**

    You can now access the following actions when building workflows for Lever:

    * Create an Opportunity
    * Get Opportunity by ID
    * Get Opportunities
    * Update Contact
    * Get Contact by ID
    * Create a Posting
    * Update Posting
    * Get Postings by ID
    * Get Postings

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/327-263c2b56a54057cfcbe2a0305613c6e5d415e3ee.png" alt="" />
    </Frame>

    ✨ **[Dropbox](/resources/integrations/dropbox) Actions!**

    You can now access the following actions when building workflows for Dropbox:

    * Get File by ID
    * Save File
    * List Files

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/326-c7b503147b192e576c5e2eb357deaa4cec860cef.png" alt="" />
    </Frame>

    ✨ **[Magento](/resources/integrations/magento) Actions!**

    You can now access the following actions when building workflows for Magento:

    * Create Customer
    * Update Customer
    * Get Customer by ID
    * Search Customers
    * Delete Customer
    * Create Order
    * Update Order
    * Get Order by ID
    * Search Orders
    * Create Product
    * Update Product
    * Get Product by SKU
    * Search Products
    * Delete Product

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/325-e38a53fd0c82de943ee72b077dd3734e5ed8bd15.png" alt="" />
    </Frame>

    ## 🛠 Improvements

    * Updates to the description for the `Merge Fields` action for Mailchimp.
    * User metadata can now be accessed in the Workflow Editor if there is not an active connection in the Connect Portal Preview.
    * Adds support for European Mailgun accounts in Paragon Automate.
    * Task usage is now visible within the Paragon dashboard.
    * Adds a JSON input for attachments in Microsoft Teams.
    * Improvements to Pipedrive's token refreshing mechanism.

    ## 🐛 Bug Fixes

    * Fixes an issue where hidden workflows get enabled by default, even after being deleted.
    * Fixes an issue where calling `paragon.installIntegration()` may not dismiss the portal after a successful authentication for basic authentication.
    * Fixes an issue where sidebar inputs would not show the full list of options available from dropdowns in Paragon Automate.
    * Fixes an issue where failed workflow emails wouldn't include a direct link to workflow executions.
    * Fixes an issue where Google Sheets filters do not work for users in non-US locales.
    * Fixes an issue for `Enterprise` users where they are unable to remove the "Powered by Paragon" watermark from the Connect Portal.
    * Fixes an issue with timeouts when disconnecting Pipedrive integrations with Webhook-triggered workflows.
    * Fixes an issue where the field mapping input for Microsoft Dynamics 365 Sales would not include all entity types.
    * Fixes an issue where `&` characters were not correctly encoded when using the `Write SOQL` step for Salesforce.
    * Fixes an issue where successfully replayed workflows appear as `Errored` in Task History.
    * Fixes an issue where users are unable to switch between Paragon Connect and Paragon Automate while viewing Task History.
  </Update>

  <Update label="November 2022">
    ## 🚀 New Features

    ✨ **[Greenhouse](/resources/integrations/greenhouse) Integration!**

    You can now connect to your users' Greenhouse accounts to manage their candidates and jobs Paragon enables you to sync data between your app and your users’ Greenhouse. For example, you can sync candidates or manage jobs in Greenhouse. Learn more in [our docs](/resources/integrations/greenhouse).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/321-3572bca01f2537f3fe42ee7383ff6c428db63295.jpg" alt="" />
    </Frame>

    ✨ **[Zoho CRM](/resources/integrations/zohocrm) Actions!**

    You can now access the following actions when building workflows for Zoho CRM:

    * Create Record
    * Update Record
    * Get Record by ID
    * Search Records
    * Delete Record
    * Search Records by COQL Query

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/322-5023ff28d1c81641660c5aa357bc97d2e15e9fb0.png" alt="" />
    </Frame>

    ✨ **[Workflow Monitoring](/monitoring/event-destinations)!**

    We’re excited to announce that we’ve released new [Monitoring](/monitoring/event-destinations) capabilities for Paragon projects!

    **[Event Destinations](/monitoring/event-destinations)** allow you to send Workflow Failure events to your logging, analytics, or APM tools for further alerting or querying. We have templates for setting up [Slack](/monitoring/event-destinations/slack), [Datadog](/monitoring/event-destinations/datadog), [New Relic](/monitoring/event-destinations/new-relic), and [Sentry](/monitoring/event-destinations/sentry), but you can configure them to be sent to any other service over webhooks. Find it in your dashboard under **Settings > Monitoring** to get started. Learn more about workflow monitoring in our docs.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/028-adfd3e4939f7985d58ac4ea2887649b8a192c09b.png" alt="" />
    </Frame>

    ✨ **[BigQuery](/resources/integrations/bigquery) Integration!**

    You can now connect to your users' BigQuery accounts to manage their datasets, tables, and jobs. Paragon enables you to sync data between your app and your users’ BigQuery. For example, you can create and update datasets or perform job queries in BigQuery. Learn more in [our docs](/resources/integrations/bigquery).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/324-078b793cbc2fc56707430dc4be35a98f7c6422e8.png" alt="" />
    </Frame>

    ✨ **[Calendly](/resources/integrations/calendly) Actions!**

    You can now access the following actions when building workflows for Calendly:

    * Get Event Type Details
    * Get Available Times for Event Type
    * Search Events
    * Get Event by ID
    * Get Event Invitees
    * Cancel Event

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/323-8b3ad1651ea4d4ca0c6212464335fdbf96de3f71.png" alt="" />
    </Frame>

    ✨ **[Headless Connect Portal](/connect-portal/headless-connect-portal)!**

    Want to create your own integration page with the added benefits of Paragon's fully managed authentication? Now you can!

    The `paragon.installIntegration` method can be used to start the connection process for an integration without the Connect Portal appearing over your user interface. You can find the integrationType identifier you need in the Overview page for the integration. Learn more in [our docs](/apis/api-reference).

    ✨ **[Airtable](/resources/integrations/airtable) Integration!**

    You can now connect to your users' Airtable accounts to manage their tables and invites. Paragon enables you to sync data between your app and your users’ Airtable. For example, you can create invites or manage event types in Airtable. Learn more in [our docs](/resources/integrations/airtable).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/491-70f7db65a408cbe12f24aae97d02450c28a36d91.png" alt="" />
    </Frame>

    ✨ **[Lever](/resources/integrations/lever) Integration!**

    You can now connect to your users' Lever accounts to manage their events and invites. Paragon enables you to sync data between your app and your users’ Lever. For example, you can create invites or manage event types in Lever. Learn more in [our docs](/resources/integrations/lever).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/492-07e5ab8b7f41db0bdb66fd03f363857e76f8efb6.png" alt="" />
    </Frame>

    ✨ **[Metadata Properties](/apis/users) in the Workflow Editor!**

    You can now access metadata properties for your Connected Users within the Workflow Editor. For example, you can associate an API Key with your Connected User and use that specific API Key when authenticating requests back to your application.

    Open the Connect Portal Preview in the Workflow Editor and press "**Set User Metadata**" to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/415-813c125fcb196a383dc1c712ad73a685cfbabd30.png" alt="" />
    </Frame>

    ✨ **[Linear](/resources/integrations/linear) Triggers!**

    You can now trigger Linear workflows when issues and labels are created or updated in your users' Linear accounts, making it easy to sync data in real-time between your users' Linear and your app. Learn more in [our docs](/resources/integrations/linear).

    * Issue Created
    * Issue Status Updated
    * Label Added or Removed from Issue
    * Issue Deleted

    ✨ **ServiceNow Actions!**

    You can now access the following actions when building workflows for ServiceNow:

    * Get Ticket by ID
    * Create Ticket
    * Update Ticket

    ✨ **[Calendly](/resources/integrations/calendly) Integration!**

    You can now connect to your users' Calendly accounts to manage their events and invites. Paragon enables you to sync data between your app and your users’ Calendly. For example, you can create invites or manage event types in Calendly. Learn more in [our docs](/resources/integrations/calendly).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/144-1a2008593fcba736c846d4fba3baeb5c20211239.png" alt="" />
    </Frame>

    ✨ **[Freshdesk](/resources/integrations/freshdesk) Integration!**

    You can now connect to your users' Freshdesk accounts to manage records. Paragon enables you to sync data between your app and your users’ Freshdesk. For example, you can create new records or sync records between your app and Freshdesk. Learn more in [our docs](/resources/integrations/freshdesk).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/143-53f607ed4f6a10f1ffe970a7c009a5a62090060f.png" alt="" />
    </Frame>

    ## 🛠 Improvements

    * Adds Product and Component User Settings for Productboard.
    * Request triggers now support file-type payloads: Files can be uploaded directly into a workflow, with no changes required, using a Request trigger. This can be used for workflows that accept a file and forward it into file storage integrations like Google Drive and Dropbox.
    * Support for non-US accounts in Zoho CRM.

    ## 🐛 Bug Fixes

    * Fixes an issue where the integration metadata icon link for Monday.com was broken.
    * Fixes an issue where users were unable to select Assignee and Team name from the Preview Connect Portal for Asana.
    * Updates the logo for Freshdesk.
    * Fixes issues with Custom Object Mapping input clearing behavior.
    * Fixes an issue where users were unable to login to SAP S/4HANA from the Connect Portal.
  </Update>

  <Update label="October 2022">
    ## 🚀 New Features

    ✨ **[SAP S/4HANA](/resources/integrations/saps4hana) Integration!**

    You can now connect to your users' SAP S/4HANA accounts to manage their accounts payable, accounts receivable, and general ledger items. Paragon enables you to sync data between your app and your users’ SAP S/4HANA. For example, you can create and update invoices or manage customer or supplier details from SAP S/4HANA. Learn more in [our docs](/resources/integrations/saps4hana).

    ✨ **[Productboard](/resources/integrations/productboard) Actions!**

    You can now access the following actions when building workflows for Productboard:

    * Create Feature
    * Update Feature
    * Get Feature by ID
    * Delete Feature
    * Create Component
    * Update Component
    * Get Component by ID
    * Get Product by ID

    ✨ **[Dynamics 365 Finance](/resources/integrations/dynamics-finance) Actions!**

    One of our largest integrations yet! You can now connect to your users' Dynamics 365 Finance accounts to access, create, and update customers, payments, invoices, and more. Paragon enables you to sync data between your app and your users’ Dynamics 365 Finance. For example, you can create customers or sync invoices from Dynamics 365 Finance. Learn more in [our docs](/resources/integrations/dynamics-finance).

    * Get Accounts
    * Create Vendor
    * Update Vendor
    * Get Vendor by ID
    * Search for Vendor
    * Create Bill
    * Update Bill
    * Get Bill by ID
    * Search for Bill
    * Delete Bill
    * Create Bill Line Item
    * Update Bill Line Item
    * Get Bill Line Item by ID
    * Search for Bill Line Item
    * Delete Bill Line Item
    * Create Customer
    * Update Customer
    * Get Customer by ID
    * Search for Customer
    * Delete Customer
    * Create Invoice
    * Update Invoice
    * Get Invoice by ID
    * Search for Invoice
    * Delete Invoice
    * Create Payment Journal
    * Update Payment Journal
    * Get Payment Journal by ID
    * Search for Payment Journal
    * Delete Payment Journal
    * Create Payment Journal Line Item
    * Update Payment Journal Line Item
    * Get Payment Journal Line Item by ID
    * Search for Payment Journal Line Item
    * Delete Payment Journal Line Item

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/231-c259e6be388448506637d908824e7d8d319768bd.png" alt="" />
    </Frame>

    ✨ **[Google Ads](/resources/integrations/googleads) Integration!**

    You can now connect to your users' Google Ads accounts to manage their ads, campaigns, and conversions. Paragon enables you to sync data between your app and your users’ Google Ads. For example, you can create and update ad creatives or manage ads and ad campaigns from Google Ads. Learn more in [our docs](/resources/integrations/googleads).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/011-6df327c739fb374e65eaf6309f91c264328d2080.png" alt="" />
    </Frame>

    ✨ **[Google Ad Manager](/resources/integrations/google-ad-manager) Integration!**

    You can now connect to your users' Google Ad Manager accounts to manage their ad inventory, orders, reports, and more. Paragon enables you to sync data between your app and your users’ Google Ad Manager. For example, you can create orders or sync ad inventory from Google Ad Manager. Learn more in [our docs](/resources/integrations/google-ad-manager).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/012-6c5e6c6fd2d1eaca16edaa600fe87bbd49501dae.png" alt="" />
    </Frame>

    ✨ **[Zoho CRM](/resources/integrations/zohocrm) Integration!**

    You can now connect to your users' Zoho CRM accounts to manage their accounts, contacts, leads, and opportunities. Paragon enables you to sync data between your app and your users’ Zoho CRM. For example, you can create and update records or sync new records from Zoho CRM. Learn more in [our docs](/resources/integrations/zohocrm).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/014-4a0c311939295fb37110fa3e133f6d9f3a735dde.png" alt="" />
    </Frame>

    ✨ **[Docusign](/resources/integrations/docusign) Integration!**

    You can now connect to your users' Docusign accounts to manage their signatures, agreements, and documents. Paragon enables you to sync data between your app and your users’ Docusign. For example, you can manage agreements or sync documents from Docusign. Learn more in [our docs](/resources/integrations/docusign).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/015-550acb8de0f0eb71a90a2ff1edcfc6226d9079f5.png" alt="" />
    </Frame>

    ✨ **[Connected Users Dashboard](/monitoring/users)!**

    The Connected Users Dashboard is your one-stop shop for viewing and managing the users connected to your integrations and the integrations they have enabled. For example, you can view which workflows your customers enable or disconnect integrations if they stop paying. Learn more in [our docs](/monitoring/users).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/026-212e151823501d71e3b12c74f4918cbbb518e710.png" alt="" />
    </Frame>

    ✨ **GitHub Integration!**

    You can now connect to your users' GitHub accounts to manage their issues, releases, and repositories. Paragon enables you to sync data between your app and your users’ GitHub. For example, you can create and sync issues or tag issues and automate creating comments in GitHub. Learn more in our docs.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/452-febd23cef0a2caab79a3a802346337c9e43cab10.png" alt="" />
    </Frame>

    ✨ **Dynamic Timezone Selection for Schedulers!**

    You can now choose a timezone to run your Scheduler-triggered workflows. This is great for use cases where you want to send messages in your customer's morning or run a nightly sync at midnight. Learn more about Schedulers [here](/workflows/triggers).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/456-e9242cb8cb534c37fee0d5a9ca9848193f38ebfc.png" alt="" />
    </Frame>

    ✨ **[Dynamic Object Mapping](/connect-portal/field-mapping) for CRMs!**

    The day is finally here…you can now dynamically map objects between your app and your users' integration!
    Use a [Custom Object Mapping](/connect-portal/field-mapping) User Setting to allow your users to define a mapping between objects in your application and their integration.

    [Custom Object Mapping](/connect-portal/field-mapping) settings can be added by visiting the "Customize Connect Portal" screen from a supported integration in your project, under the User Settings section. Learn more in our docs.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/843-da18fcb57127d0ff5c5368242d76c669e5962451.png" alt="" />
    </Frame>

    ## 🛠 Improvements

    * Improved the runtime for the Function step for on-premise environments.
    * You can now choose a team, status, and label for updates in Linear.
    * Adds the `Get Team by ID` action to Linear.
    * You can now send Slack messages as your authenticated user! Just enable the "Send as authenticated user" toggle to get started.
    * Enhances the token refresh mechanism for Microsoft Teams.
    * Adds support for filtering by custom fields to the `Record Updated` Salesforce webhook trigger.
    * Users will now see an `Invalid Credentials` message when trying to login to their ServiceNow accounts from the Connect Portal if the credentials are invalid.
    * Improves the experience of copying workflows between projects.
    * The Custom Object Mapping field inputs for Salesforce now show *all* fields available in the record schema, not only writeable ones.
    * Adds support for `File` types from responses.
    * Support for downloading files from request steps! Request and Integration Request steps will now download `File` objects in the Workflow Editor for all non-text payloads by default. This allows you to skip the Function step to convert the string into a `File` object when downloading images or PDF files from an API!
    * Adds support for Sandbox credentials for DocuSign.

    ## 🐛 Bug Fixes

    * Fixes an issue where new `Calls` show up as `Tasks` inside Salesforce.
    * Fixes an issue where issues could not be created in Jira for users with 50+ projects.
    * Fixes a bug where users could not get test data in the Workflow Editor when trying to create or update `Deals` in HubSpot.
    * Fixes a bug where hidden fields when searching for custom objects in HubSpot would not appear.
    * Fixes an issue where the integration domain base URL could not be used when making requests with the Paragon Proxy API.
    * Fixes an issue where the Project + Assignee combination User Setting for Jira would not display more than 100 results.
    * Fixes an issue in the Request and Integration Request steps where some responses would return `[object Object]` instead of the actual payload.
    * Fixes an issue where missing scopes for the Zoom integration would cause an `undefined` error after authenticating in the Connect Portal.
    * Fixes an issue where deleting and re-creating an environment secret would cause workflow validation to fail.
    * Fixes an issue where users were not able to make requests to `docs.google.com` from the Google Drive integration.
  </Update>

  <Update label="September 2022">
    ## 🚀 New Features

    ✨ **[Gong](/resources/integrations/gong) Actions!**

    You can now access the following actions when building workflows for Gong:

    * Add a new Call
    * Get Call by ID
    * Search for Call

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/985-ebcc5e4c4f99b5656eaed5267d03884d07e95700.png" alt="" />
    </Frame>

    ✨ **[Dropbox](/resources/integrations/dropbox) Integration!**

    You can now connect to your users' Dropbox accounts to access, create, and update files. Paragon enables you to sync data between your app and your users’ Dropbox. For example, you can save files or sync files from Dropbox. Learn more in [our docs](/resources/integrations/dropbox).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/322-5d5171f8e1e3a58d251bcdccb27f90a5fa830f1b.png" alt="" />
    </Frame>

    ✨ **[Productboard](/resources/integrations/productboard) Integration!**

    You can now connect to your users' Productboard accounts to manage their features, components, and releases. Paragon enables you to sync data between your app and your users’ Productboard. For example, you can automatically create and update releases or sync features and components from Productboard. Learn more in [our docs](/resources/integrations/productboard).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/329-d99e7b6b18505ebe2c878d4ad1358376f750ad68.png" alt="" />
    </Frame>

    ✨ **[Users API](/apis/users)!**

    The Users API allows you to query and modify the state of your Connected Users and their integrations. The API includes REST endpoints (and matching SDK functions) for identifying what integrations your user has enabled, disconnecting integrations, and disabling workflows. The API also allows your application to associate metadata with a Connected User.

    You can use the new [Users API](/apis/users) to:

    * Automatically disconnect integrations when a user deletes or downgrades their account in your application
    * Enrich your Connected Users' profile information with email, name, and other metadata
    * Associate Connected Users with an API key for your application, which can be used in workflows to send requests
    * Poll to check if a user has enabled a certain integration and view account connection status

    ✨ **[Magento](/resources/integrations/magento) Integration!**

    You can now connect to your users' Magento account to access, create, and update records in their Magento stores. Paragon enables you to sync data between your app and your users’ Magento. For example, you can create customers or sync orders from Magento. Learn more in [our docs](/resources/integrations/magento).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/774-86ec3f8fbb0ea3b17171456aed7fa2222526daaa.png" alt="" />
    </Frame>

    ## 🐛 Bug Fixes

    * Fixes an issue in Google Calendar where leaving the calendar option blank would result in `Not Found` instead of using the default calendar for the connected user.
    * Fixes an issue where the Connect Portal would not show all items available in User Settings for assignees in Jira.
    * Fixes a bug where the icon for the Integration Enabled trigger went missing.
    * Fixes a bug where Google Calendar would request Google Drive scopes by default.
    * Fixes a regression for pagination support in Salesforce and Slack User Settings.
    * Fixes an issue where workflows hidden in the Connect Portal were not automatically enabled by default.
    * Fixes an issue where uploaded icons for the Custom Integration Builder would not automatically resize correctly.
    * Fixes an issue where the Connect Portal would not show all items available in User Settings with many items in Salesforce or Slack.

    ## 🛠 Improvements

    * You can now access important information, like workspace IDs, instance URLs, and team names within the Workflow Editor and Paragon SDK! These
    * Adds support to filter by List ID when searching Records in Salesforce.
  </Update>

  <Update label="August 2022">
    ## 🚀 New Features

    ✨ **[Gmail](/resources/integrations/gmail) Integration!**

    You can now connect to your users' Gmail accounts to manage their emails and drafts. Paragon enables you to sync data between your app and your users’ Gmail. For example, you can send emails and drafts or sync incoming emails from Gmail. Learn more in [our docs](/resources/integrations/gmail).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/233-7d18de0ae9b0416e39e826e2acf6b23e9e345626.png" alt="" />
    </Frame>

    ✨ **[Linear](/resources/integrations/linear) Actions!**

    You can now access the following actions when building workflows for Linear:

    * Create Issue
    * Update Issue
    * Get Issue by ID
    * Get Issue by Issue Identifier
    * Search Issues
    * Delete Issue
    * Archive Issue
    * Create Sub-Issue
    * Create Project
    * Update Project
    * Get Project by ID
    * Delete Project

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/535-b7ec4097d6682039c690e79bb0250fff53d2ba06.png" alt="" />
    </Frame>

    ✨ **[Gmail](/resources/integrations/gmail) Actions!**

    You can now access the following actions when building workflows for Gmail:

    * Send Email
    * Get Email by ID
    * Search for Email
    * Delete Email
    * Create a Contact
    * Get Contact by Resource Name
    * Search for Contact
    * Delete Contact

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/232-1b5f68a8892ccf499807048d845da1f357e074e8.png" alt="" />
    </Frame>

    ✨ **[BambooHR](/resources/integrations/bamboohr) Integration!**

    You can now connect to your users' BambooHR accounts to manage their employees, time off, and benefits. Paragon enables you to sync data between your app and your users’ BambooHR. For example, you can create time off requests or sync employee information from BambooHR. Learn more in [our docs](/resources/integrations/bamboohr).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/001-c01de0241874e0f24cd1efd15c4087d20a287d31.png" alt="" />
    </Frame>

    ## 🛠 Improvements

    * You can now search for permissions by keyword, like `events`, instead of searching for the full permission in your Integration Settings.
    * Removes the deprecated `contacts` scope from HubSpot in favor of `crm.objects.contacts.read` and `crm.objects.contacts.write`.

    ## 🐛 Bug Fixes

    * Fixes an issue where calling `paragon.authenticate()` with no integrations in your account would result in a `500` error.
    * Fixes an issue where the Environment Secrets Manager wouldn’t refresh correctly after switching between projects.
    * Fixes an issue where shared User Settings changes do not update workflow deployments.
    * Fixes an issue with the token refreshing mechanism for Google Campaign Manager and Google Calendar.
    * Fixes an issue with the token refresh mechanism for NetSuite.
    * Fixes an issue where the Record ID was not available when updating `Engagements` in HubSpot.
    * Fixes an issue where some executions may result in `socket hang up` errors.
    * Fixes an issue where Google credentials may become invalid for integrations in Paragon Automate.
    * Fixes a bug where users could create multiple App Events with the same name.
    * Fixes an issue where required Boolean User Settings could not be set to `false` without disabling the rest of the Connect Portal's options.
  </Update>

  <Update label="July 2022">
    ## 🚀 New Features

    ✨ **[NetSuite](/resources/integrations/netsuite) Actions!**

    You can now access the following actions when building workflows for NetSuite:

    * Create Vendor
    * Update Vendor
    * Get Vendor by ID
    * Search Vendors
    * Delete Vendor
    * Create Bill
    * Update Bill
    * Get Bill by ID
    * Search Bills
    * Delete Bill
    * Create Account
    * Update Account
    * Get Account by ID
    * Search Accounts
    * Delete Account
    * Create Tax Group
    * Update Tax Group
    * Get Tax Group by ID
    * Delete Tax Group
    * Search Payment Terms
    * Get Payment Term by ID

    ✨ **[Gong](/resources/integrations/gong) Integration!**

    You can now connect to your users' Gong accounts to manage their call data. Paragon enables you to sync data between your app and your users’ Gong. For example, you can add and sync calls from Gong. Learn more in [our docs](/resources/integrations/gong).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/389-a149db477035d95e173d2c98461bc2ef21bd7049.png" alt="" />
    </Frame>

    ✨ **[Sage Accounting](/resources/integrations/sage-accounting) Integration!**

    You can now connect to your users' Sage Accounting accounts to manage their payments and invoices. Paragon enables you to sync data between your app and your users’ Sage Accounting. For example, you can create and manage payments or sync invoices from Sage Accounting. Learn more in [our docs](/resources/integrations/sage-accounting).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/753-99e2604fe3c5edeb0ba2db767852eda02fc3dca1.png" alt="" />
    </Frame>

    ✨ **[Dynamics 365 Business Central](/resources/integrations/dynamicsbusinesscentral) Actions!**

    You can now access the following actions when building workflows for Dynamics 365 Business Central:

    * Search for Vendor
    * Create Purchase Invoice
    * Update Purchase Invoice
    * Post a Purchase Invoice
    * Get a Purchase Invoice by ID
    * Search for Purchase Invoice
    * Delete Purchase Invoice
    * Create Purchase Invoice Line Item
    * Update Purchase Invoice Line Item
    * Get Purchase Invoice Lines
    * Get Purchase Invoice Line Item by ID
    * Search for Purchase Invoice Line Item
    * Delete Purchase Invoice Line Item
    * Get Accounts
    * Search for Tax Group
    * Create Payment Term
    * Update Payment Term
    * Search for Payment Term
    * Delete Payment Term

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/275-113c5658d41e823af2e6a177ba986eaa2fb56c5a.png" alt="" />
    </Frame>

    ✨ **[iManage](/resources/integrations/imanage) Integration!**

    You can now connect to your users' iManage accounts to manage their files. Paragon enables you to sync data between your app and your users’ iManage. For example, you can create and manage documents or sync files from iManage. Learn more in [our docs](/resources/integrations/imanage).

    ## 🐛 Bug Fixes

    * Fixes an issue where replaying a workflow would only show the actions for previously successful steps.
    * Fixes an issue where the billing dashboard would not display payment information.
    * Fixes an issue where users were not able to sign into production Pardot accounts.
    * Fixes an issue with the token refreshing mechanism for Xero.
    * Fixes an issue where copying workflows between projects breaks step references.
    * Fixes an update where users were not able to update cells to `null` in Google Sheets.
    * Fixes an issue where the Jira Issue Status input does not use the correct ID as the value.
    * Fixes an issue where users were not able to sign into QuickBooks Sandbox accounts.
    * Fixes an issue where deploying multiple custom fields in a row for Salesforce would result in slow action times.

    ## 🛠 Improvements

    * You can now copy the entire `paragon.event()` call when copying App Events from the App Event dashboard.
    * You can now filter Asana projects by Workspace in User Settings.
    * Google integrations now support Sign-in with Google.
    * Adds support to filter by List ID when searching Records in HubSpot.
    * Adds support for Get Abandoned Carts in Shopify.
    * Adds support for native integration icons in on-prem environments.
  </Update>

  <Update label="June 2022">
    ## 🚀 New Features

    ✨ **[NetSuite](/resources/integrations/netsuite) Integration!**

    You can now connect to your users' NetSuite ERP system to manage their vendors and purchase orders. Paragon enables you to sync data between your app and your users’ NetSuite. For example, you can create and manage vendors or sync purchase orders from NetSuite. Learn more in [our docs](/resources/integrations/netsuite).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/779-8224101fc062884131463878b392533892bf65f4.png" alt="" />
    </Frame>

    ✨ **Redesigned [Environment Secrets](/workflows/environment-secrets) Manager!**

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/725-efedcd844e88ecfad45e79b9615dedc5f8bcc63f.gif" alt="" />
    </Frame>

    Environment Secrets can now be updated and revealed by `Admin` users! Updated environment secrets will automatically be used in future workflow executions.

    ✨ **[Sage Intacct](/resources/integrations/sage-intacct) Integration!**

    You can now connect to your users' Sage Intacct account to manage their accounts payable, vendors, and purchase orders. Paragon enables you to sync data between your app and your users’ Sage Intacct. For example, you can create and manage vendors or sync purchase orders from Sage Intacct. Learn more in [our docs](/resources/integrations/sage-intacct).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/724-e7174bd624c12343a42fe7cf4743970acdef95cb.png" alt="" />
    </Frame>

    ✨ **[Pipedrive](/resources/integrations/pipedrive) Actions!**

    You can now access the following actions when building workflows for Pipedrive:

    * Create Record
    * Update Record
    * Get Record by ID
    * Get Records
    * Delete Record

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/723-d4cbda6d509037ee96a361750029e76974e58579.png" alt="" />
    </Frame>

    ✨ **[Dynamics 365 Finance](/resources/integrations/dynamics-finance) Integration!**

    You can now connect to your users' Dynamics 365 Finance account to manage their customers, payments, invoices, and more. Paragon enables you to sync data between your app and your users’ Dynamics 365 Finance. For example, you can create and manage payments or sync invoices from Dynamics 365 Finance. Learn more in [our docs](/resources/integrations/dynamics-finance).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/330-09130b5881dfaf1d06e4a38438a9607c15543f9c.png" alt="" />
    </Frame>

    ✨ **[Record Deleted](/resources/integrations/salesforce) Salesforce Trigger!**

    You can now trigger Connect workflows when records are deleted in your users' Salesforce, making it easy to sync data in real-time between your users' Salesforce and your app. Learn more in [our docs](/resources/integrations/salesforce).

    ✨ **[Dynamics 365 Business Central](/resources/integrations/dynamicsbusinesscentral) Integration!**

    You can now connect to your users' Dynamics 365 Business Central accounts to manage their accounts payable, vendors, and purchase orders. Paragon enables you to sync data between your app and your users’ Dynamics 365 Business Central. For example, you can create and manage vendors or sync purchase orders from Dynamics 365 Business Central. Learn more in [our docs](/resources/integrations/dynamicsbusinesscentral).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/326-dd898ba8ece9b6840e45e4b2ae42899423693267.png" alt="" />
    </Frame>

    ✨ **[Linear](/resources/integrations/linear) Integration!**

    You can now connect to your users' Linear accounts to manage their software projects, sprints, and tasks. Paragon enables you to sync data between your app and your users’ Linear. For example, you can create and manage tasks or sync sprints from Linear. Learn more in [our docs](/resources/integrations/linear).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/328-924d30ded51ad2a2a483f7629d4304d8659d449c.png" alt="" />
    </Frame>

    ✨ **[Woocommerce](/resources/integrations/woocommerce) Integration!**

    You can now connect to your users' Woocommerce accounts to manage their customers, products, and orders. Paragon enables you to sync data between your app and your users’ Woocommerce. For example, you can create and manage customers or sync purchase orders from Woocommerce. Learn more in [our docs](/resources/integrations/woocommerce).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/603-d0664fc68dd5e3dc8677ba9f861c2981302abc5a.png" alt="" />
    </Frame>

    ## 🛠 Improvements

    * Paragon sends a `404` status code when trying to trigger a workflow with the Request trigger that isn't deployed.
    * Added support for dynamic variable menu inputs to the Delay step.
    * You can now quickly make changes to the App Event your workflow uses right from the Workflow Editor.
    * Added support for `Get User by Email` in Slack.
    * Added support for the full payload in Trello's `Comment Created` trigger.
    * Added support for `Contact Lead Status` in HubSpot.
    * You can copy App Events easily with the copy button to the code preview.
    * When deleting environment secrets from Paragon, the Environment Secrets Manager informs you which other workflows it appears in and may need to be reconfigured.

    ## 🐛 Bug Fixes

    * Fixed an issue where User Settings with a search bar were not searchable if they had a tooltip enabled.
    * Fixed an issue where the Function step could not display more than 20 variables.
    * Fixed an issue where `Members` would not have access to the same account plan as `Admins`.
    * Resolved issues with the token refresh mechanism for Zoom.
    * Resolved issues with the token refresh mechanism for Facebook Ads.
    * Fixed a bug where dynamic variables in filters for workflow actions would resolve as `undefined`.
    * Fixed a bug where users were unable to filter accounts from Outreach by `name`.
    * Fixed an issue where new users accepting team invites were not automatically redirected to their Paragon account.
    * Fixed an issue where users were unable to authenticate into Mailchimp, resulting in a `500` error.
    * Fixed an issue where SDK authorizations in quick succession could result in duplicate Connected Users.
    * Fixes an issue where the Function step editor did not resize properly.
    * Fixes a bug where specifying the issue type when trying to create an issue in Jira would fail for accounts with multiple projects.
    * Fixes an issue where a user's name would hyperlinked in the welcome email.
    * Fixes an issue where `0` or `null` values show up as empty instead of their literal values in databases.
    * Fixes an issue for Jira where errors that occur in triggers do not update refresh token values.
    * Fixes a bug where users were unable to get account data in Sage Intacct.
  </Update>

  <Update label="May 2022">
    ## 🚀 New Features

    ✨ **[Pipedrive](/resources/integrations/pipedrive) Integration!**

    You can now connect to your users' Pipedrive account to manage their records and contacts. Paragon enables you to sync data between your app and your users’ Pipedrive. For example, you can create and manage records in Pipedrive or sync contacts from Pipedrive. Learn more in [our docs](/resources/integrations/pipedrive).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/549-79db4c637b2fa191c9cb5ee67cbc0e5c62b42b9f.png" alt="" />
    </Frame>

    ✨ **[Oracle Eloqua](/resources/integrations/eloqua) Actions!**

    You can now access the following actions when building workflows for Oracle Eloqua:

    * Create Campaign
    * Update Campaign
    * Active Campaign
    * Search Campaigns
    * Get Campaign by ID
    * Create Email
    * Update Email
    * Search Emails
    * Send Email Deployment
    * Create Contact
    * Update Contact
    * Search Contacts

    ✨ **[Microsoft Outlook](/resources/integrations/outlook) Triggers!**

    You can now trigger Connect workflows when events are created or updated in your users' Microsoft Outlook, making it easy to sync data in real-time between your users' Microsoft Outlook and your app. Learn more in [our docs](/resources/integrations/outlook).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/003-b1cffdf6c11f3db2257681a5a191f678d7eb0dec.png" alt="" />
    </Frame>

    ✨ **Comment Created Trigger!**

    You can now trigger Connect workflows when comments are created in your users' Asana, Jira, and Trello accounts!

    ## 🛠 Improvements

    * `Comment Created` triggers have been added for Asana, Jira, and Trello.
    * Added support for uploading different file types through the Connect SDK and API.
    * Connect Proxy responses can now receive binary-encoded/raw responses.
    * We've added an integration indicator for `Added` and `API` integrations.
    * You can now manage integration settings from the Integration Catalog.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/004-ba9af8763532f30a2408e9c763a38c218d26b611.png" alt="" />
    </Frame>

    ## 🐛 Bug Fixes

    * Fixed a bug where the Function step wouldn't load for users with on-premise installations.
    * Fixed an issue where `providerData` would be missing from the Connect User object after an OAuth callback.
    * Fixed an issue where large Fan Outs would work intermittently.
  </Update>

  <Update label="April 2022">
    ## 🚀 New Features

    ✨ **[Oracle Eloqua](/resources/integrations/eloqua) Integration!**

    You can now connect to your users' Oracle Eloqua account to manage their campaigns and contacts. Paragon enables you to sync data between your app and your users’ Oracle Eloqua account.For example, you can create and manage campaigns in Oracle Eloqua or sync contacts from Oracle Eloqua. Learn more in [our docs](/resources/integrations/eloqua).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/960-43bf71932028c458ac3fbd48bbc8e05d811ce2a0.png" alt="" />
    </Frame>

    ✨ **[ServiceNow](/resources/integrations/servicenow) Integration!**

    You can now connect to your users’ ServiceNow accounts to create, access, and update records in their ServiceNow account. Paragon enables you to sync data between your app and your users’ ServiceNow account. For example, you can create or update records in your users’ ServiceNow account or sync records from your users’ ServiceNow account. You can also receive webhooks when records are created or updated in your users’ ServiceNow account. Learn more in [our docs](/resources/integrations/servicenow).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/961-27956c04bb260355f02f4a529a6862379e38d6fe.png" alt="" />
    </Frame>

    ✨ **[QuickBooks](/resources/integrations/quickbooks) Triggers!**

    You can now trigger Connect workflows when Accounts, Customers, and Invoices are created in your users' QuickBooks accounts, making it easy to sync data in real-time between your users' QuickBooks and your app. Learn more in [our docs](/resources/integrations/quickbooks).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/436-50d3bc0d677cbed4c6d82294ca06fbcb5cfc0d6e.png" alt="" />
    </Frame>

    ✨ **[Microsoft Outlook](/resources/integrations/outlook) Integration!**

    You can now connect to your users' Microsoft Outlook account to manage their events and send messages. Paragon enables you to sync data between your app and your users’ Microsoft Outlook account. For example, you can create and manage events in Microsoft Outlook or sync messages from Microsoft Outlook. Learn more in [our docs](/resources/integrations/outlook).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/962-264efd33496a141c6ed9e1f77b0a499939f9141c.png" alt="" />
    </Frame>

    ✨ **[Google Analytics](/resources/integrations/google-analytics) Integration!**

    You can now integrate your Google Analytics application to get real-time data and run reports in Google Analytics! This integration also supports OAuth, allowing you to connect with your users' Google Analytics accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/google-analytics) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/780-71a894c201db2ebc5b4dc6584c8a797af98b0a98.png" alt="" />
    </Frame>

    ✨ **[Google Calendar](/resources/integrations/google-calendar) Triggers!**

    You can now trigger Connect workflows when events are created or updated in your users' Google Calendar, making it easy to sync data in real-time between your users' Google Calendar and your app. Learn more in [our docs](/resources/integrations/google-calendar).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/959-cc23ecf81ea3461b691d1571f0091acd4334568b.png" alt="" />
    </Frame>

    ## 🐛 Bug Fixes

    * Fixed a bug where error messages wouldn’t be sent back if you enabled “Continue workflow if request fails” for an Integration Request step.
    * Fixed an issue where tokenized strings representing objects were not sent as objects from Request step JSON bodies.
    * Fixed an issue where users would sometimes see a `Too many concurrent calls` error from the Function step.
    * Fixed an issue where the "Create or Update Lead" action in the Marketo integration would overwrite lead data with blanks if users chose to update a lead.
    * Fixed an issue where duplicate Salesforce entries may appear when searching over long lists.

    ## 🛠 Improvements

    * Added support for API Key validation for Klaviyo.
    * Added support for query parameters in Authorization URL when using the Custom Integration Builder.
    * Improved stability when switching between different Paragon projects.
  </Update>

  <Update label="March 2022">
    ## 🚀 New Features

    ✨ **[Google Search Console](/resources/integrations/google-search-console) Integration!**

    You can now integrate your Google Search Console application to run queries on their Google Search results data! This integration also supports OAuth, allowing you to connect with your users' Google Search Console accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/google-search-console) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/729-c090aa31b3312c8be86bf318d9b4ce01c5585bd8.png" alt="" />
    </Frame>

    ✨ **[Monday.com](/resources/integrations/monday) Integration!**

    You can now integrate your Monday.com application to create, update, and manage Items in Monday.com! This integration also supports OAuth, allowing you to connect with your users' Monday.com accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/monday) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/097-acd3a242ac7baf52933c1f9497d65f738f70048c.png" alt="" />
    </Frame>

    ✨ **[Shopify](/resources/integrations/shopify) Triggers!**

    You can now trigger Connect workflows when Orders, Customers, or Products, are created or updated in your users' Shopify account, making it easy to sync data in real-time between your users' Shopify and your app. Learn more in [our docs](/resources/integrations/shopify).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/448-2f8ac64c59336faf1f6983497134ff64303c0ba4.png" alt="" />
    </Frame>

    ✨ **[Monday.com](/resources/integrations/monday) Triggers!**

    You can now trigger Connect workflows when Items are created or updated in your users' Monday.com accounts, making it easy to sync data in real-time between your users' Monday.com and your app. Learn more in [our docs](/resources/integrations/monday).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/447-7feca263dd070e9902659efbd6a39ed59c64e15e.png" alt="" />
    </Frame>

    ✨ **[ClickUp](/resources/integrations/clickup) Integration!**

    You can now integrate your ClickUp application to create, update, and manage Tasks in ClickUp! This integration also supports OAuth, allowing you to connect with your users' ClickUp accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/clickup) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/776-3dabee8188a9611a3c823e62195bb69dbf71d77e.png" alt="" />
    </Frame>

    ✨ **[ClickUp](/resources/integrations/clickup) Triggers!**

    You can now trigger Connect workflows when tasks are created or updated in your users' ClickUp account, making it easy to sync data in real-time between your users' ClickUp and your app. Learn more in [our docs](/resources/integrations/clickup).

    ✨ **[SharePoint](/resources/integrations/sharepoint) Integration!**

    You can now integrate your SharePoint application to create, update, and manage sites and lists in SharePoint! This integration also supports OAuth, allowing you to connect with your users' SharePoint accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/sharepoint) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/746-a161be9f0745809a1758f1aa537e880c4df365f9.png" alt="" />
    </Frame>

    ✨ **[OAuth Client Credentials](/resources/custom-integrations) Authentication Support!**

    Specify the URL that this integration uses to exchange an authorization code for access tokens, also known as the **Access Token URL**. The Paragon Connect Portal prompt your user for their Client ID and Client Secret needed to validate the authentication.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/748-1c7142cdc50e2413db134c7a4fbe496a332a0f21.png" alt="" />
    </Frame>

    ## 🛠 Improvements

    * Added line numbers to error messages from the Function step to help debug them.

    ## 🐛 Bug Fixes

    * Fixed an issue where direct URLs to different Paragon projects would not load properly.
    * Fixed a bug where switching between projects wouldn't properly refresh the data in the dashboard.
    * Fixed an issue where the ClickUp Request step didn't use the correct URL.
    * Fixed an issue where users were unable to select password from the dynamic variable menu for Basic auth in the Request step.
    * Fixed an issue where environment secrets didn't properly resolve when sent through a Request step.
  </Update>

  <Update label="February 2022">
    ## 🚀 New Features

    ✨ **Request Triggers!**

    You can now trigger workflows for your customers using HTTP Requests! This means you can now trigger workflows and send custom responses to your app.

    **✨[Trello](/resources/integrations/trello) Integration!**

    You can now integrate your Trello application to create, update, and manage Cards and Lists in Trello! This integration also supports OAuth, allowing you to connect with your users' Trello accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/trello) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/617-2b79aabe3931b111a5d99a01a6486d6cbc383571.png" alt="" />
    </Frame>

    **✨[Oracle Financials Cloud](/resources/integrations/oracle-financials-cloud) Integration!**

    You can now integrate your Oracle Financials Cloud application to create, update, and manage Invoices in Oracle Financials Cloud! This integration also supports OAuth, allowing you to connect with your users' Oracle Financials Cloud accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/oracle-financials-cloud) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/616-78214877a302b7568b2e6e02f685541e079f413f.png" alt="" />
    </Frame>

    **✨[Azure DevOps](/resources/integrations/azure-devops) Integration!**

    You can now integrate your Azure DevOps application to create, update, and manage Work Items in Azure DevOps! This integration also supports OAuth, allowing you to connect with your users' Azure DevOps accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/azure-devops) to get started!

    ✨**Global User Settings!**

    You can now share workflow settings across different workflows.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/667-55bdc688ec38d345d0d4f7028d8506938bdf25de.png" alt="" />
    </Frame>

    **✨[Trello](/resources/integrations/trello) Triggers!**

    You can now trigger Connect workflows when Cards are created or updated in your users' Trello account, making it easy to sync data in real-time between your users' Trello and your app. Learn more in [our docs](/resources/integrations/trello).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/458-57d34e912fd139fc9b575b6df6b9da2765bab330.png" alt="" />
    </Frame>

    ## 🐛 Bug Fixes

    * Fixed copy issues
    * Fixed an issue where failed workflow emails were not sent.
    * Fixed an issue in the Workflow Editor where steps would incorrectly duplicate when moving them upstream.
    * Fixed an issue where users were unable to filter Outreach using `Before` or `After` time filters.
    * Fixed an issue where the users could not select data from the dynamic variable menu in Paragon Automate.
    * Fixed an issue where users were unable to access `/v1/` of Klaivyo’s API.
    * Fixed an edge case where your users may quickly subscribe to a workflow then close the Connect Portal, which previously prevented the `onWorkflowChange` event from reaching your application.
    * Fixed some copy issues in the Integration Dashboard.
    * Fixed an issue for Enterprise customers where the number of connected users allowed was incorrectly set to `0`.
    * Fixed an issue where users could not add additional fields from the Dynamic Variable Menu when specifying any object directly to the "Additional Fields" input of the `Create Record` action in the Salesforce integration.

    ## 🛠 Improvements

    * Added an item to the Workflow Editor context menu called “Edit Connect Portal Workflow Settings” which takes you directly to the Workflow Settings part of the “Customize Connect Portal” page, for this workflow, allowing you to customize the settings for this workflow.
    * Added `aws-sdk` to the list of supported JavaScript libraries.
    * When creating App Events from the Workflow Editor, the App Event is now automatically selected.
    * You can now access your customer's base URL for Salesforce by calling `paragon.getUser()`
    * Added Profile ID support to the Connect Portal authorization flow for Google Campaign Manager 360.
    * Added support for the `cloudflare` npm library in the Function step.
    * You can now load the Paragon Connect SDK in an iframe or when using `localhost`!
  </Update>

  <Update label="January 2022">
    ## 🐛 Bug Fixes

    * Fixed an issue where headers supplied to the step input for Integration Request steps were not being sent in the outgoing HTTP request.
    * Fixed an issue where users could only add property labels to User Settings in Salesforce one letter at a time.
    * Fixed an issue where Workflows with an empty App Event selection were not able to be deleted.
    * Fixed an error in the Salesforce Connect API sample code.
    * Fixed a bug where clicking "What's New?" would not open the changelog.
    * Fixed an issue where filtering on the `Name` property when getting customers in Xero consistently failed if the comparison value contained `&`.
    * Fixed an issue where Salesforce and Zendesk `Record Updated` triggers may not fire as expected.
    * Fixed an issue in the Workflow Builder preventing large workflows from deploying successfully.
    * Fixed an issue where input values would get erased if the page refreshed while typing the input.
    * Fixed an issue in Paragon Automate where Tasks Usage would always show as `0`.
    * Fixed an issue where custom Google-based integrations would not refresh tokens properly.
    * Fixed an issue where some accounts on Pro or Enterprise plans were not able to see their Task History properly.

    ## 🛠 Improvements

    * The Create Record and Update Record actions for HubSpot now include a JSON input for **Additional Fields**, in the case that you want to specify the inclusion of custom properties in the create/update payloads.
    * Links in Connect Portal descriptions for your integrations now open in new tabs.
    * Added a new type of input to Connect Portal Workflow Settings for Jira that allows your users to select an issue field type.
    * Added an “Additional Fields” JSON input to Jira that allows you to specify fields that aren’t represented in the UI as JSON.
    * Users won't be subscribed to workflows until all required fields are filled out.
    * Added support for `Text Area (Rich)` field type when deploying custom objects on Salesforce.
    * You can now view integration metadata from the Connect API and SDK! This includes the integration's name, icon, and brand color.

    ## 🚀 New Features

    **✨[Asana](/resources/integrations/asana) Triggers!**

    You can now trigger Connect workflows when projects or tasks are created or updated in your users' Asana account, making it easy to sync data in real-time between your users' Asana and your app. Learn more in [our docs](/resources/integrations/asana).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/898-3d2e82e50ee943f84f6571a5df8aaf21e8518ba7.png" alt="" />
    </Frame>

    **✨[Facebook Ads](/resources/integrations/facebook-ads) Integration!**

    You can now integrate your Facebook Ads application to create, update, and manage Campaigns and Lists in Facebook Ads! This integration also supports OAuth, allowing you to connect with your users' Facebook Ads accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/facebook-ads) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/071-5eb132baaf79838f1a99316c6069252a79d74ceb.png" alt="" />
    </Frame>

    ✨**Integration Icons in the Connect API and SDK!**

    You can now find integration icons and brand names inside the Connect API and SDK.

    **✨[Mailchimp](/resources/integrations/mailchimp) Integration!**

    You can now integrate your Mailchimp application to create, update, and manage Campaigns and Lists in Mailchimp! This integration also supports OAuth, allowing you to connect with your users' Mailchimp accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/mailchimp) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/848-5ec56cb8140bbf12938d416cdd120efac42204dc.png" alt="" />
    </Frame>

    ✨ **HubSpot [Custom Objects and Fields](/resources/integrations/hubspot)!**

    Our HubSpot integration now allows your users to choose their own custom object and field mapping in the Connect Portal, so you can sync data from your app to any objects or fields in your users' HubSpot instance. You can also deploy your own custom objects and fields to your users' HubSpot instance. Learn more in [our docs](/resources/integrations/hubspot).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/558-086178863e183dffef9b64ffdd8443a97036b6d0.png" alt="" />
    </Frame>
  </Update>
</Accordion>

<Accordion title="2021">
  <Update label="December 2021">
    ## 🚀 New Features

    ✨**Free-form Scope Support!**

    We've redesigned the scope inputs in your integration's dashboard to allow you to add *any* scope.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/142-50fd32150a3f62e27c71a557b43a99b379886a7c.gif" alt="" />
    </Frame>

    ✨**Multiple Project Support**

    You can now create multiple Paragon environments for your dev, staging, and production environments inside of Paragon! 🎉 Each one has its own workflows and authentication methods so you can test out new changes before going live to your customers. You can get started by checking out the Projects tab in the dropdown menu!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/452-29435ea16518fafa5b04066ee299931326b37791.png" alt="" />
    </Frame>

    ✨**Enhanced Authentication**

    If you use a third-party provider for user authentication, like Auth0 or Firebase, you can now it within Paragon! Just go to **Settings > User Authentication** to get started.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/319-373d5fe3626e6aae742645f2c8e1139099877e0e.png" alt="" />
    </Frame>

    ✨**Outreach Triggers!**

    You can now trigger Connect workflows when records are created or updated in your users' Outreach CRM, making it easy to sync data in real-time between your users' Outreach and your app. Learn more in [our docs](/resources/integrations/outreach).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/917-c11ca09b687129ba5fe9c9f349397a0a341e4dd3.png" alt="" />
    </Frame>

    ✨**HubSpot Contact Deleted Trigger!**

    You can now trigger workflows to run when records are deleted in your user's HubSpot account!

    ✨**Boolean User Setting!**

    You can now allow your users to select a `true` / `false` statement from the Connect Portal! [Customize your Connect Portal](/connect-portal/connect-portal-customization) to get started.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/311-ee034f2558451b1af8d830732adb5bf95e6ac3d1.png" alt="" />
    </Frame>

    ## New

    ## 🛠 Improvements

    * You can now use dynamic variables when referencing phone numbers in Twilio.
    * You can now filter records when creating New Records and Record Updated triggers in Salesforce.
    * Optimized the Connect Portal layout on devices with smaller screens.
    * URLs in the Connect Portal are now automatically hyperlinked.
    * Migrated our Jira application to use rotating refresh tokens.
    * You can now include tooltips for each and any of the inputs in the workflow settings of your Connect Portal.

    ## 🐛 Bug Fixes

    * Fixed a UI bug when viewing previous workflow versions in Version History where navigation buttons get shifted to the left.
    * Fixed a UI bug when using the Salesforce Object Mapper to display a list of Salesforce Objects.
    * Fixed an inconsistency between Asana Connect Proxy API and Asana Request step.
    * Fixed a bug with Custom Integrations that prevents the interpolation of variables into the API Base URL.
    * Fixed a bug where the integration icon would not appear for Integration-Enabled triggers for Custom Integrations.
    * Fixed an issue where users couldn't change the icon for a custom integration after it was initially configured.
    * Fixed a bug where testing workflows or sending App Events may not fire properly.
    * Fixed a bug where the Workflow Editor would prompt users to enable their integration in the Connect Portal preview after already doing so.
    * Fixed an issue where the Contact Properties User Setting for HubSpot would not save the user's input.
    * Fixed an issue for Outreach where default scopes would always be used instead of credential-defined scopes.
  </Update>

  <Update label="November 2021">
    ## 🚀 New Features

    **✨[Google Campaign Manager 360](/resources/integrations/google-campaign-manager-360) Integration!**

    You can now integrate your Google Campaign Manager 360 application to create, update, and manage ads and campaigns in Google Campaign Manager 360! This integration also supports OAuth, allowing you to connect with your users' Google Campaign Manager 360 accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/google-campaign-manager-360) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/363-f51f67f8cdc369b9edf6d65d796d80d6090d8b82.png" alt="" />
    </Frame>

    ✨**Salesforce Campaign Triggers!**

    You can now trigger Paragon Connect workflows when Opportunities or Members are added your users' Salesforce Campaigns, making it easy to sync data in real-time between your users' CRM and your app. Learn more in [our docs](/resources/integrations/salesforce).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/642-1baddff2dfed40d2770a59f8a5dd1fff87a81026.png" alt="" />
    </Frame>

    ## 🛠 Improvements

    * Inactive custom integrations now appear at the top of the Integrations dashboard.
    * When an App Event is deleted, all related workflows will become undeployed.
    * Removed the required validation for scopes when creating your own integrations. This means you can now build integrations with services that do not provide a list of scopes.
    * Added a `Custom` tag next to custom integrations in the Integration Dashboard
    * Long base URLS in the Custom Integration Request step are now visually truncated.
    * You can now specify the Reference field when creating invoices in Xero.
    * Added access to the `crm.object.owners.read` scope in HubSpot.
    * Added access to the `accounting.reports.read` scope in Xero.

    ## 🐛 Bug Fixes

    * Fixed an issue where using the integration name as a query parameter would result in the query not being recognized in the Paragon SDK or Paragon Proxy API.
    * Fixed an issue where creating meetings in Zoom would use the current timestamp instead of a supplied one.
    * Fixed an issue where the number of connected workflows to an App Event could be incorrect.
      Fixed an issue where users couldn't update rows in Google Sheets if their worksheet contained more than 26 columns.
    * Fixed an issue where deleting an integration wouldn't delete associated workflows and credentials.
    * Fixed an issue where custom integrations would not show up in the Paragon SDK.
    * The workflow name is no longer automatically highlighted when opening workflows in the Workflow Builder.
    * Fixed missing Field Inputs for the `Note` object in Salesforce Custom Objects.
    * Fixed an issue in Paragon Automate where the Integrations Manager would crash if the user didn't have any integrations connected.
    * Fixed an issue where the Workflow Builder would crash when trying to reference a trigger variable from the Delay step.
    * Fixed an issue where the page wouldn’t scroll if your cursor was above an input in the Workflow Builder.
    * Fixed an issue where some users were not able to add Meeting Registrants to Zoom when testing Zoom steps in the Workflow Builder.
    * Fixed an issue where the "Continue workflow if step fails" toggle wouldn't work on custom integration requests.
    * Fixed an issue in the Paragon Connect SDK where custom integrations would show up as `custom` instead of `custom.name` when calling `paragon.getUser()`.

    ## New

    **✨[Outreach](/resources/integrations/outreach) Integration!**

    You can now integrate your Outreach application to create, update, and manage contacts and opportunities in Outreach! This integration also supports OAuth, allowing you to connect with your users' Outreach accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/outreach) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/569-1d9a55abf91898a230c2d3e0efed864a546b931d.png" alt="" />
    </Frame>
  </Update>

  <Update label="October 2021">
    ## 🚀 New Features

    ✨**Salesforce Pardot Triggers!**

    You can now trigger Connect workflows when members or prospects are created in your users' Salesforce Pardot account, making it easy to sync data in real-time between your users' Salesforce Pardot and your app. Learn more in [our docs](/resources/integrations/pardot).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/919-ac655b7ac5220752077e3fc9240fb2392aca0afe.png" alt="" />
    </Frame>

    ✨**Integration Requests!**

    Don't see an action you need for an integration? Try using our Integration Request step! This step allows you to make API requests to your integration provider from the Workflow Builder. This is especially useful when you need access to an action we don't yet support.

    It works similarly to the API Request step: just input the API endpoint, fill out any parameters, and you're good to go! Paragon Connect takes care of the authentication so you don't have to 😉

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/746-8410dc3b0ce8289982a998d2b919b5154542d165.png" alt="" />
    </Frame>

    ✨**HubSpot Engagements!**

    You can now create the following engagements for HubSpot in the Workflow Builder:

    * Email
    * Task
    * Call
    * Meeting
    * Note

    ✨**Jira Triggers!**

    You can now trigger Connect workflows when issues are created or updated in your users' Jira account, making it easy to sync data in real-time between your users' Jira and your app. Learn more in our docs.

    **✨[Microsoft Dynamics 365](/resources/integrations/microsoft-dynamics-365) Integration!**

    You can now integrate your Microsoft Dynamics 365 application to create, update, and manage recrods in Microsoft Dynamics 365! This integration also supports OAuth, allowing you to connect with your users' Microsoft Dynamics 365 accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/microsoft-dynamics-365) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/992-2c560255ecbf360c622ecb0a2a6f5cc96e6a5405.png" alt="" />
    </Frame>

    ## 🛠 Improvements

    * You can now choose the following scopes within the HubSpot integration:
      * `crm.objects.companies.read`
      * `crm.objects.companies.write`
      * `crm.objects.deals.read`
      * `crm.objects.deals.write`
      * `crm.lists.read`
      * `crm.lists.write`

    * You can now access your user's `providerId` within the Workflow Builder. This feature was previously exclusive to the Paragon Connect SDK.

    * Added support for `Phone` types for Xero contacts.

    * Added support for `AccountCode` when creating or updating invoices in Xero.

    ## 🐛 Bug Fixes

    * Updated Asana's description in the Workflow Builder.
    * Fixed an issue where users were unable to send a `DELETE` request without sending an empty `body` to Stripe through the Connect Proxy API.
  </Update>

  <Update label="September 2021">
    ## 🚀 New Features

    **✨[Zoom](/resources/integrations/zoom) Triggers!**
    You can now trigger Connect workflows when meetings are created or updated in your users' Zoom account, making it easy to sync data in real-time between your users' Zoom and your app. Learn more in our docs.

    **✨[Xero](/resources/integrations/xero) Triggers!**
    You can now trigger Connect workflows when new accounts, customers, or invoices, are created in your users' Xero account, making it easy to sync data in real-time between your users' Xero and your app. Learn more in our docs.

    **✨[Xero](/resources/integrations/xero) Integration!**

    You can now integrate your Xero application to create, update, and manage invoices in Xero! This integration also supports OAuth, allowing you to connect with your users' Xero accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/xero) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/687-cc546ab84dc24b482486027b1578e10fc95dfe0d.png" alt="" />
    </Frame>

    **✨[Pardot](/resources/integrations/pardot) Integration!**

    You can now integrate your Pardot application to create, update, and manage prospects in Pardot! This integration also supports OAuth, allowing you to connect with your users' Pardot accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/pardot) to get started!

    **✨[Custom Integrations!](/resources/custom-integrations)**

    Custom Integrations allow you to build your own custom integration with any app provider on Paragon, even if it's not natively supported by our integration catalog.

    Similar to natively supported integration on Paragon, Custom Integrations provide the following features:

    * **Embedded Connect Portal** for your customers to activate and configure the integration in your app.
    * **Fully managed authentication** with OAuth 2.0 or API Keys.
    * **Visual workflow editor** for creating custom integration logic.
    * **Access to any API methods** provided by the application's API.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/719-4ff51d1bd755352063c87ba710a08f23d37ef004.png" alt="" />
    </Frame>

    Custom Integrations are included in the **Pro Plan** and above. **[Contact us](https://calendly.com/useparagon/demo)** to schedule a demo of Custom Integrations or upgrade your account.

    ## 🛠 Improvements

    * It's now easier to add User Settings when configuring the Connect Portal.
    * The icon for invalid workflow steps has been updated
    * Added `fast-xml-parser` npm module to the Function editor.

    ## 🐛 Bug Fixes

    * Fixed an issue where the code samples for Slack were incorrect.
    * Fixed an issue where switching from Connect to Automate incorrectly redirects to the Integrations Catalog.
    * Fixed a bug where clicking the background in the Connect Portal Preview causes the Portal to disappear.
    * Fixed an issue where Line Items in Xero would not accept a tokenized array.
    * Fixed an issue where users could not make API requests to Microsoft Teams through the Connect Proxy API.
    * Fixed an issue where dropdown icons in the Connect Portal wouldn't load for some users.
    * Updated the endpoint in the Salesforce code sample from `/query/Account` to `/query`.
    * Fixed an issue where an `a.trim is not a function` error would prevent users from deploying workflows.
    * Fixed an issues where users were not able to enable the QuickBooks integration from the Connect Portal.
    * Fixed an issue where users were unable to select a Zendesk account to use with the Zendesk triggers on Paragon Automate.
  </Update>

  <Update label="August 2021">
    ## 🛠 Improvements

    * App Events are now ordered alphabetically. This should make it easier to find your events from the App Events page.
    * You can now see the deployment status of the workflows connected to App Events via the App Events page.
    * Salesforce Webhook triggers now support all Salesforce Editions with API access.
    * We now present loading states in the Connect Portal for loading values.
    * It's now easier to access the User Setting editing panel.
    * You can now access all of Slack's scopes when creating your Slack integration.
    * You can now call `Paragon.getUser()` to access the **providerId** of any integrations that user has connected!
    * The Paragon Connect API now supports file uploads.
    * Users are redirected to the `Configuration` tab to select your workflows upon enabling an integration.
    * Inputs in the Connect Portal are now searchable.
    * Inputs in the Connect Portal now show loading states.
    * The following scopes have been added to Slack: `channels:history`, `groups:history`, `im:history`, `mpim:history`.
    * Improved workflow validation for function steps.

    ## 🚀 New Features

    ✨**`.subscribe()` to Paragon SDK Events!**

    Developers rejoice! You can now subscribe to different events that occur within the SDK:

    * **Integration enabled** (`"onIntegrationInstall"`)
    * **Integration disabled** (`"onIntegrationUninstall"`)
    * **Workflow state change** (`"onWorkflowChange"`)
    * **Connect Portal opened** (`"onPortalOpen"`)
    * **Connect Portal closed** (`"onPortalClose"`)

    Learn more about subscribing to SDK events and SDK callbacks in [our documentation](/apis/api-reference).

    ✨**Salesforce Sandbox Account Support!**

    Salesforce Sandbox accounts are now supported in the Connect Portal! You can learn more about our Salesforce integration in our documentation [here](/resources/integrations/salesforce).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/275-cd6d2a2a48bbbbd1b9746b832afc3a5764bfd602.png" alt="" />
    </Frame>

    ✨**Workflow Validation!**

    The Workflow Builder became a little bit more sentient with this update and now informs you of misconfigured or empty fields. This is great for those times a workflow doesn't run as you'd expect it to.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/494-3de9f58d021b46c91ba6b659102518cabc0cd6f0.png" alt="" />
    </Frame>

    ✨**Zendesk Webhook Triggers!**

    You can now trigger workflows when tickets are created or updated in Zendesk Support, making it easy to sync data in real-time between your users' Zendesk accounts and your app. Learn more in [our docs](/resources/integrations/zendesk).

    ## 🐛 Bug Fixes

    * Slack OAuth scope options now includes `chat:write.public`
    * Fixed an issue where the `Custom Object Map` user setting in Salesforce would result in a `500` error for some users.
    * Fixed a UI bug where the App Events page would display the incorrect connected workflows.
    * Fixed a bug where App Credentials for integrations weren't deleted properly when the integration was removed.
    * Fixed an issue where workflow validation may apply to unused steps.
    * Fixed an issue where some users were unable to deploy Paragon Connect workflows with Connect credentials.
    * Fixed an issue where Salesforce would return an error if a record type had too many fields.
    * Fixed an issue where API requests issued from the Paragon Connect SDK are always "application/json".
    * Fixed an issue where users could pause workflows that have already finished.
    * Fixed an issue where some users wouldn't see their list of Slack channels.
    * Fixed an issue where headers passed into a Connect API request weren't forwarded to the end provider.
    * Fixed a bug where Task History periodically "flashes" if empty.
  </Update>

  <Update label="July 2021">
    ## 🚀 New Features

    ✨**Auto-refreshing Task History!**

    You heard right -- no more refreshing your Task History page to view your latest workflow executions! Any workflows that were previously running also update to succeeded to failed if they've been updated.

    **✨[Microsoft Teams](/resources/integrations/microsoft-teams) Integration**
    You can now integrate your Microsoft Teams account to send messages to channels and chats!
    Check out [our docs](/resources/integrations/microsoft-teams) to get started.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/849-74d1019fec930f9bc49e742ee1602cdbe6f0b99e.png" alt="" />
    </Frame>

    ✨**Marketo Custom Object support!** You can now create and map custom objects in your Marketo workflows.

    ## 🛠 Improvements

    * Added loading animations to the Workflow dashboard and Task History in Paragon Automate.
    * QuickBooks now accepts `JSON` input for line items.
    * You can now view custom properties in HubSpot.
    * All actions now support the "continue if request fails" option.
    * Deleting a workflow redirects to the integration page instead of the top-level integration dashboard.
    * Improved Connect Portal alignment when using Safari.

    ## 🐛 Bug Fixes

    * Fixed spelling for Microsoft Teams
    * Fixed an issue where the OAuth Authentication window would appear twice when enabling the Shopify and Zendesk integrations.
    * Fixed a UI issue where `topic`, `start time`, `duration`, and `timezone` were not marked as *optional* when updating meetings in Zoom.
    * Fixed an issue where enabling the "Sent from a Paragon workflow" message in Slack would send an incomplete link to the workflow execution.
    * Fixed an issue where App Event data may show up as `undefined` in the Workflow Editor.
    * Fixed an issue where switching between Paragon Connect and Paragon Automate would show all Automate workflows as "undeployed".
    * Fixed a UI bug where the Connect Portal styling would apply to the main window.
    * Fixed an issue with Google Sheets where creating rows with numbers or dates puts a `'` character before the value.
    * Fixed spelling in App Events.
    * Fixed an issue where users would not be able to navigate between Paragon Connect and Paragon Automate when viewing Task History.
    * Fixed an issue where sending invitations to Team members to join Paragon would show up in the Spam inbox for some users.
    * Fixed a spelling error in the default description for the Zoom integration.
    * Fixed an issue where the `Create Invoice Line Item` action for QuickBooks wouldn't accept values from the dynamic variable menu.
  </Update>

  <Update label="June 2021">
    ## 🚀 New Features

    **✨[Zoom](/resources/integrations/zoom) Integration**

    You can now integrate your Zoom application to create, update, and manage meetings in Zoom! This integration also supports OAuth, allowing you to connect with your users' Zoom accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/zoom) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/191-198edb97de43c7168c9754c127a11a9dbdd8dba1.png" alt="" />
    </Frame>

    **✨[Marketo](/resources/integrations/marketo) Integration**

    You can now integrate your Marketo account to create, update, and manage leads and lists in Marketo! This integration also supports User Credentials, allowing you to connect with your users' Marketo accounts and integrate them with your workflows. Check out [our docs](/resources/integrations/marketo) to get started!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/475-5c0f57c96757bebdbd275078213ea711a8c83c48.png" alt="" />
    </Frame>

    ✨**Integration Enabled Triggers!**

    Paragon Connect workflows can now be triggered when a user initially activates your integration. This is great for syncing contacts between your app and your user's CRM. Learn more about Integration Enabled triggers in [our docs](https://app.gitbook.com/@paragon-1/s/docs/workflows/triggers#integration-enabled).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/190-b647c33eb4c368234fc5ba0be5c90c4c043ab3a9.png" alt="" />
    </Frame>

    ✨**Whitelabel your Connect Portal!**

    To remove the Paragon branding from your Connect Portal, visit the **Appearance tab** in your customization settings.

    *This feature is available on our* ***[Pro plan](https://www.useparagon.com/pricing)*** *and above.*

    ## 🛠 Improvements

    * The step-timeout limit for users on the `Premium` Tier increased from `60` to `120` seconds.
    * Newly created Slack channels will appear in the dropdown menu when selecting a channel in Paragon Automate.
    * You can now create and edit App Event JSON without wrapping the `keys` in quotation marks `"`.
    * The Paragon Connect SDK can be loaded in the `<head>` tag of your application.

    ## 🐛 Bug Fixes

    * Fixed an issue where the Salesforce OAuth token may expire.
    * Fixed an issue where Paragon Connect workflows could not be paused.
    * Fixed a bug where steps inside of a Fan Out would continue to execute if the workflow was paused during the Fan Out.
    * Fixed an issue where the OAuth window for integration providers would be blocked on Firefox.
    * Updated documentation references.
    * Fixed an issue where failed workflow emails wouldn't send for Paragon Connect workflows.
    * Fixed an issue where recently undeployed App Event-triggered workflows would still execute when the App Event was triggered.
    * Fixed a bug where the "Enable workflow" prompt may appear after it's already enabled.
    * Fixed an issue where editing a step from the Task History in Paragon Connect would lead to the Integrations Dashboard
  </Update>

  <Update label="May 2021">
    ## 🚀 New Features

    ✨**Webhook Triggers!**

    You can now trigger Connect workflows when records are created or updated in your users' Salesforce or HubSpot accounts, making it easy to sync data in real-time between your users' CRM and your app. Learn more in [our docs](/workflows/triggers).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/195-0e770e316fd18a5bd8956d155dcf0098f9979e77.png" alt="" />
    </Frame>

    ✨ **Salesforce Custom Objects and Fields!**

    Our Salesforce integration now allows your users to choose their own custom object and field mapping in the Connect Portal, so you can sync data from your app to any objects or fields in your users' Salesforce instance. You can also deploy your own custom objects and fields to your users' Salesforce instance. Learn more in [our docs](/resources/integrations/salesforce).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/282-f82ce0f20a8c7014be093b6551a75fdba352e615.gif" alt="" />
    </Frame>

    ## 🐛 Bug Fixes

    * **Paragon Connect:** The Salesforce SDK proxy now works for requests with an HTTP body.

    ## New

    ## 🛠 Improvements

    * You can now update a Slack notification preview when using Block Kit JSON.
    * Preview credentials are no longer required to display App Event test data in Paragon Connect.
    * You can now access the `jsonwebtoken` npm module in the Function step.

    ## 🐛 Bug Fixes

    * **Paragon Connect:** Shopify `read_users` scope is now off by default.

    ✨ **New Feature: Task History on Connect!** You can view your **[Task History](/monitoring/viewing-task-history)** in the sidebar of your Paragon Connect dashboard.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/342-1edb0544b31850fe8ae1b3b6a3129dc1d9204212.png" alt="" />
    </Frame>

    Task History keeps track of your workflow executions and lives on the left side of the dashboard. It serves as a timeline and an easy way to navigate through your workflow history, revisit any failed workflows, and get a step-by-step breakdown of the executed tasks in each one.

    * Fixed an issue where Asana would only show 50 projects.
  </Update>

  <Update label="April 2021">
    ## New

    ## 🐛 Bug Fixes

    * Salesforce "Search records by SOQL query" now displays the query interface.
    * Fixed an issue where saving a version in Version History would use the incorrect timestamp.
    * Fixed an issue where the start time for updating a Google Calendar event was not marked as *optional*

    ## 🛠 Improvements

    * Version History is now supported for Paragon Connect workflows!
    * Fixed a bug preventing users from editing Delay steps.
    * Fixed a UI issue where the Task Usage would disappear after refreshing the page when viewing Task History.
    * Fixed an issue where Fan Outs would give an incorrect preview reference: `Preview data (1 of 1)`

    Great news everyone! We made some major improvements to the user experience of building workflows. You can now right-click on any step to bring up the context menu.

    The **context menu** allows you to add steps in those hard-to-reach places, like in-between two Fan Outs or before a Conditional step.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/390-c798e4c1fc0804b11b3f2ec6102e270ff7b36018.png" alt="" />
    </Frame>

    * Workflow steps can be moved from anywhere, just drag and drop to rearrange your workflows!
    * Added "Add to Step" to the context menu when right-clicking on a step in the Workflow Editor.
    * Fixed "Please specify a project type" error when creating a new account with `Personal` project type.
  </Update>

  <Update label="March 2021">
    ## New

    ## 🛠 Improvements

    * You can now access the [`snowflake-sdk`](https://www.npmjs.com/package/snowflake-sdk) npm module in the Function step!

    ## 🐛 Bug Fixes

    * Fixed an issue where duplicating a workflow wouldn't open the duplicate.
    * Workflow executions in Task History replay properly if the workflow is currently undeployed.
    * App icons no longer clip in Workflow steps.

    ## ✨ Paragon Connect

    Paragon Connect allows developers to embed user-facing SaaS integrations into their product in minutes. Setup the Paragon SDK once and instantly integrate your product with popular SaaS apps like Salesforce, HubSpot, Slack, JIRA, and more. Learn more about Connect [here](/).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/068-be18abfd4dd179de96114aaef53e7ad82ddf82de.jpg" alt="" />
    </Frame>

    You can now access **Paragon Connect** in your sidebar menu of your Paragon dashboard.

    * Higher resolution app icons.
    * Premium Tier deployed workflow limit has been increased from 100 to 250 deployed workflows.
    * Fixed keyboard navigation when tagging workflows in the workflow dashboard.
  </Update>

  <Update label="February 2021">
    ## New

    ## New Features

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/100-2a567faa2fa384b599f3823640ff3d5f7310fea6.png" alt="" />
    </Frame>

    **✨Workflow Search** Can't find that workflow you've been working on? Well, look no further! You can now search and filter workflows in the Workflow menu!

    **✨Workflow Tags** You can now create and sort your workflows by tags! Just click the triple-dot menu and select **"Tag"**.

    ***

    It wouldn't be an update without bug fixes and improvements!
  </Update>

  <Update label="January 2021">
    ## Integrations

    **✨New Integration: [Asana](automate/resources/integrations-catalog/asana)** You can now query, add, and update projects and tasks in Asana.

    **✨New Integration: [Zendesk](automate/resources/integrations-catalog/zendesk)** You can now query, add, and update support tickets in Zendesk Support.

    Both integrations also support OAuth, allowing you to connect with your users' Asana or Zendesk Support accounts and integrate them with your workflows. Check out [our docs](automate/resources/oauth) to get started!

    ***

    ## Triggers

    **✨New Event-based Trigger: [MongoDB](automate/resources/integrations-catalog/mongodb)** You can now trigger workflows when a record is created or updated in your MongoDB database.

    As usual, we added a bunch of bug fixes and improvements!
  </Update>
</Accordion>

<Accordion title="2020">
  <Update label="November 2020">
    ## Updates

    **Updated the Request Step** with native support for different body types (JSON, multipart/form-data, x-www-form-urlencoded, raw) and authentication (Bearer Token or Basic auth). We also added support for tokenized variables in the Request parameters in addition to a few other quality of life improvements!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/946-c12693ecb720b62d3845e1604faae3ed071b1eb9.png" alt="" />
    </Frame>

    As usual, we added bunch of bug fixes and improvements!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/237-f279a801d3c1c3254eb904d1e8d693523734283c.png" alt="" />
    </Frame>

    **✨New Feature: [Version History](automate/building-workflows/version-history)!** You can now save versions of your workflows so that you can easily view or restore to previous versions! A version is automatically created every 10th auto-save, or you can save manually with ⌘⇧S (CTRL+Shift+S on Windows).

    **✨New Integration: [Quickbooks](automate/resources/integrations-catalog/quickbooks)!** You can now access and manage Quickbooks accounts, bills, customers, invoices, and payments.

    **✨New Integration: [Klaviyo](automate/resources/integrations-catalog/klaviyo)!** You can now create and manage Klaviyo campaigns, lists, subscribers, and templates.

    **✨New Integration: [Tableau](automate/resources/integrations-catalog/tableau)** You can now query, add, and update data quality warnings in Tableau.

    Made significant updates to the overall performance and speed of Paragon's web app.
  </Update>

  <Update label="October 2020">
    ## Updates

    **✨ New Feature: Integrations Manager!** You can now view, edit, and manage all the integrations connected to your Paragon account! Navigate to the **Integrations** tab in your dashboard sidebar to check it out!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/331-64c78069fcae20ac1f1dd5a68a762dc817b71a49.png" alt="" />
    </Frame>

    **Released [Paragon On-Prem](https://github.com/useparagon/on-prem)**, allowing you to
    deploy and run Paragon entirely on your own infrastructure! If you're interested in Paragon On-Prem, email us at [sales@useparagon.com](mailto:sales@useparagon.com).

    Improved performance when Fanning Out large arrays, among other bug fixes and improvements.

    **✨New Integration: JIRA!** You can now integrate with your JIRA account to create, update, and manage issues in your JIRA projects! You can also use our JIRA OAuth integration to allow your users to connect their JIRA accounts to your app. Check out [our docs](automate/resources/integrations-catalog/jira) for more.

    Made some major improvements to workflow performance - workflows now execute as much as 10x faster than before!

    Our Google Calendar integration now supports adding conference data to calendar events.

    Our AirTable integration now supports filtering columns by date when fetching records from a base.
  </Update>

  <Update label="September 2020">
    **✨New Feature: Auto-retries!** Workflow steps that perform a request now automatically retry if the request fails. When Auto-retry is enabled, Paragon will re-attempt failed requests up to several times, waiting after each attempt before performing the next retry. Auto-retries are available on our [Business plan](https://www.useparagon.com/pricing) and above

    **✨New Feature: MySQL Trigger!** You can now trigger workflows when a record is created or updated in your MySQL database!

    As always, a number bug fixes and performance improvements!

    **✨New Integration: Google Calendar!** You can now connect Paragon with Google Calendar to create, updates, and retrieve calendar events! Our new Google Calendar integration also supports OAuth-enabled apps, so you can integrate with your users' Google Calendar accounts, too. [Read more in our docs](automate/resources/integrations-catalog/google-calendar).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/153-664602088c808f24f5bc3f8f4b47c3bbb7595514.png" alt="" />
    </Frame>

    **✨New Integration: FTP/SFTP!** You can now connect to an FTP or SFTP server from Paragon to download or upload files! [Read more in our docs](automate/resources/integrations-catalog/ftp).

    A bunch of performance improvements and bug fixes.

    **✨New Integration: Hubspot!** You can now integrate with Hubspot to create, update, and search Hubspot CRM records! Our Hubspot integration also supports OAuth, allowing you to connect with your users' Hubspot accounts and integrate them with your workflows. Check out [our docs](automate/resources/integrations-catalog/hubspot) for more.

    As always, numerous bug fixes and performance improvements.

    **✨ New Integration: OneSignal!** You can now send your users push notifications with our new OneSignal Integration! [Read more in our docs](automate/resources/integrations-catalog/onesignal).

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/214-02b9d6effba82b6ad521f11da0acf11ab213bd45.gif" alt="" />
    </Frame>

    **You can now send rich, interactive Slack messages with Paragon** - our Slack integration now supports Slack's Block Kit JSON Builder!

    Improved performance when displaying integrations with a large number of input fields.

    Fixed a bug where Task History workflow executions sometimes couldn't be paused.

    **✨New Feature: Variable menu search and keyboard controls!** When inserting variables with `{{`, you can now search the variable menu by typing the step number and variable name. You can also navigate the menu by using the ⬆⬇ arrow keys and the Return key to select.

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/642-ba05fb04a2fc1918a66666b6372f7976e6444238.gif" alt="" />
    </Frame>

    **✨New Feature: Slack Block Kit support!** Our Slack integration now supports rich, interactive Slack messages created with the [Slack Block Kit Builder](https://app.slack.com/block-kit-builder) by simply copying the JSON payload from the Block Kit Builder into Paragon.

    Added a "Clear rows" action to our Google Sheets integration, allowing you to clear the contents of a row without deleting the row itself.

    Improved the composing experience of our Sendgrid integration.

    Improved performance when performing a Fan Out on a large array.
  </Update>

  <Update label="August 2020">
    ## Updates

    To make it easier to access javascript libraries within Functions, new functions will automatically come with the `libraries` parameter.

    You can now access the `s3` library in the Function step!

    Bug fixes and performance improvements!

    Added a "What's New" tab in the dashboard to showcase our latest release notes and product updates. You might even be reading this there! 🙃

    You can now access the `lodash` npm module in the Function step!

    And of course…. bug fixes and performance improvements!

    ✨**New Feature: PostgreSQL Database Trigger!** You can now trigger workflows when a record is created or updated in your PostgreSQL database! Check out [our docs](automate/building-workflows/triggers) to learn more.

    ✨**New Feature: OAuth Integration!** You can now authenticate and build workflows with your users' Slack and Google accounts! Check out [our docs](automate/building-workflows/configuring-oauth) to learn more.

    Bug Fixes and performance improvements!

    **✨New Feature: Salesforce Integration!** Our most requested feature is here… you can now build workflows that create, update, and access records in Salesforce! What's more, our new Salesforce integration also supports OAuth, so you can integrate with your users' Salesforce accounts. Check out [our docs](automate/resources/integrations-catalog/salesforce) to learn more.
  </Update>

  <Update label="July 2020">
    ## Enhacements

    **✨New Feature: Onboarding Tutorial!** New users are now greeted with an onboarding tutorial that guides them through how to build a user re-engagement workflow.

    Task History now displays the number of [tasks](/billing/tasks) that were run in each execution.

    Failed workflow execution email alerts now include a link to their respective Task History execution.

    Improved app performance when viewing very large workflow executions in Task History.

    Added "Does not equal" as an operator to the Conditional step.

    ✨ **New Feature: Stripe Integration!** Connect your Stripe account to Paragon to build workflows with your customer and subscription data from Stripe!

    Check out our [documentation](automate/resources/integrations-catalog/stripe) to learn more about using Stripe with Paragon!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/Image%202020-07-15%20at%208.41.17%20AM.png" alt="" />
    </Frame>

    **You can now right click on steps** to duplicate or delete them!

    As always, many bug fixes and performance improvements.

    ✨ **Paragon now has a brand new sign up experience**! If you haven't signed up already, check it out [here](https://app.useparagon.com/signup).

    You can now open Workflows and Task History executions in a new tab!

    Fixed an issue where string variable references would cause a step to fail if its value was null or undefined.

    Fixed an issue where completed workflows would sometimes appear to be still running in Task History.

    Bug fixes and improvements!
  </Update>

  <Update label="June 2020">
    ## Updates

    🚀**Improved workflow performance** when using Fan Out on a large set of data.

    ✨ **New Feature: Replay Tasks**. You can now replay failed workflow executions from the Task History page!

    Task History now displays workflow executions in real time.

    You can now access the `https` npm module in Functions.

    You can now access the `slack`, `luxon`, `ramda`, and `date-fns` in the Function Step! Note that `date-fns` is accessed as `libraries.dateFns`.

    ✨ **New Feature: Task History Filters**. To help you navigate your Task History more easily, you can now filter executions by workflow, status, and date range!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/693-7029c757db6c45f0c3cee985229844b8343b2cd1.png" alt="" />
    </Frame>

    We made some **huge improvements** to Fan Out performance. Any Fan Out over 50 items now executes serially (instead of in parallel), making it far more resilient - especially if you need to avoid hitting API rate limits.

    The Airtable step now allows you to **select your Airtable Base and View**, rather than having to type them in! We also improved how we show your Airtable fields when creating or updating records.

    You can now access the `csv` and `redis` npm modules in the Function step!
  </Update>

  <Update label="May 2020">
    **New Feature: Environment Secrets**. You can now securely store and use environment secrets like API Keys in your workflows!

    <Frame>
      <img className="block" src="https://mintlify.s3.us-west-1.amazonaws.com/paragon/changelog/assets/changelog/068-b537797f0702544b5037ec9a32c752856ce9cf45.gif" alt="" />
    </Frame>

    Our MongoDB integration now supports writing raw Mongo queries.

    You can now view your task usage in the dashboard sidebar.

    You can now manage your Paragon subscription and billing information.

    Redesigned the dashboard sidebar to be a little more visually consistent with the rest of the app.
  </Update>
</Accordion>


# Customizing the Connect Portal
Source: https://docs.useparagon.com/connect-portal/connect-portal-customization

Control your end-user integration experience by customizing Connect Portal.

The **Connect Portal** is a ready-made interface that lets your users connect their third-party app accounts to your application.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=b73e3e76bfbdb2f71048141ed7766030" alt="Paragon's out-of-the-box Connect Portal" width="1584" height="1366" data-path="assets/image (59).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?w=280&maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6e7562f1cc0d681e52a1d850af96bbab 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?w=560&maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=bf0482ad0226d2b20453eb448a9bda03 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?w=840&maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=4a9fa18f800f2262af648a5c678c7b02 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?w=1100&maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=2efb8831edb9f227ea7963688ca329f7 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?w=1650&maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=942bc40f8368b3e3a3cc727355e05804 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?w=2500&maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6ff70aad02f5e37862b562857da86a68 2500w" data-optimize="true" data-opv="2" />
</Frame>

To customize the Connect Portal for a specific integration, go to the Integration Overview page and click **Customize Connect Portal**. This opens the **Connect Portal Editor**.

Within the Connect Portal Editor, you can tailor several aspects of the user experience:

* **[Overview](#overview):** Update the integration's description shown in the Overview tab.
* **[Configuration](#configuration):** Adjust how workflows and workflow settings appear in the Configuration tab.
* **[Appearance](#appearance):** Change the visual style of the Connect Portal.

## Overview

There are two options you can edit in the **Overview** tab:

* **Short description:** a one-line description of your integration that appears at the top of the Connect Portal.
* **Overview**: a long-form description of your integration. This description is the first thing your users see when opening the Connect Portal, so this is the best place to describe and showcase your integration's benefits in detail to your users.

<Info>
  You can use [Markdown formatting](https://commonmark.org/help/) in the Overview section.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Markdown%20in%20Paragon%20Connect%20Portal%20(1).png?maxW=2358&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=aca31b64e3863308e22c8bcdfba7536b" alt="" width="2358" height="904" data-path="assets/Using Markdown in Paragon Connect Portal (1).png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Markdown%20in%20Paragon%20Connect%20Portal%20(1).png?w=280&maxW=2358&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=af6e16a1b6341cd0b4d760440bebff30 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Markdown%20in%20Paragon%20Connect%20Portal%20(1).png?w=560&maxW=2358&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=a759b542d394d937f1d956964e826ba9 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Markdown%20in%20Paragon%20Connect%20Portal%20(1).png?w=840&maxW=2358&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=dd0b3f126ecb778345f4a95a25e4afbb 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Markdown%20in%20Paragon%20Connect%20Portal%20(1).png?w=1100&maxW=2358&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=c93d621a2f53a568d452b567b1556f85 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Markdown%20in%20Paragon%20Connect%20Portal%20(1).png?w=1650&maxW=2358&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=75c347b1e3a6666d3dab978b95cb3dc7 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Markdown%20in%20Paragon%20Connect%20Portal%20(1).png?w=2500&maxW=2358&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=183d8bf1a902eb990c55e267d52a856d 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Configuration

### Settings

Under the **Settings** section of the Configuration tab, you'll be able to create user-facing settings that allow your users to configure parameters of their workflows from the Connect Portal.

Some example use cases of User Settings include:

* **Slack:** choosing which channel that messages should be sent in
* **Salesforce:** choosing a custom opportunity stage that new opportunities created in
* **Hubspot:** choosing a custom lead status that new leads should be created with
* **Jira:** choosing which Jira user that new issues should be assigned to

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(76).png?maxW=2730&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=fbccb08a231cf49714f82a683535ad1f" alt="" width="2730" height="1312" data-path="assets/image (76).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(76).png?w=280&maxW=2730&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6045e094b85f6fe060450a9585b81364 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(76).png?w=560&maxW=2730&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=ae3e9b0f6e8472058acccee2d8be3542 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(76).png?w=840&maxW=2730&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=0c9b7f6d55e6c78d5ce7cfca41b08c83 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(76).png?w=1100&maxW=2730&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=c6e3963ccb2d72e1c6c0a56abc9765cf 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(76).png?w=1650&maxW=2730&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=cc9f56e8680e66f5a3d642e7dc1936b4 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(76).png?w=2500&maxW=2730&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=bb81b73f5cfc78b261b9c18cbbe47a13 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Card title="User Settings" href="/connect-portal/workflow-user-settings" horizontal icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right-icon lucide-arrow-right"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg>}>
  Learn more about adding and configuring User Settings to let your users customize their integration and workflows.
</Card>

### Workflows

Under the **Workflows** section of the Configuration tab, you can control the visibility and customize the description of workflows that appear in the Connect Portal.

<Card title="Displaying Workflows" href="/connect-portal/displaying-workflows" horizontal icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right-icon lucide-arrow-right"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg>}>
  Learn more about controlling which workflows appear in the Connect Portal and how they are displayed to your users.
</Card>

## Appearance

### Theme

The Connect Portal supports both light and dark themes, allowing you to choose a theme that matches your application's overall theme. The Connect Portal can also detect and match your user's system theme settings by selecting "Match System Theme" from the theme dropdown.

#### Light

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Light%20Mode.png?maxW=3038&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=2942ae0483612663805a75bb296843c3" alt="" width="3038" height="1454" data-path="assets/Paragon Connect Portal in Light Mode.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Light%20Mode.png?w=280&maxW=3038&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c5de0456a1e80099186ee462ddce34be 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Light%20Mode.png?w=560&maxW=3038&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=398d5621ec03986dc3811a2fac010a9d 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Light%20Mode.png?w=840&maxW=3038&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=17e3ab2f8cadb648cfdc736ee4ff1f5b 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Light%20Mode.png?w=1100&maxW=3038&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=79e8b6aeaa426f93c1bf656c278d4894 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Light%20Mode.png?w=1650&maxW=3038&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=5929fad87574d80d0934d7e75bb6e84f 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Light%20Mode.png?w=2500&maxW=3038&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e176f8212634dc3f37434bbd2d1e11d9 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### Dark

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Dark%20Mode.png?maxW=3074&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=9d24309c99ef84d6ab1e0074d679761d" alt="" width="3074" height="1446" data-path="assets/Paragon Connect Portal in Dark Mode.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Dark%20Mode.png?w=280&maxW=3074&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=61fd0af8d02de01442f84abd2f725083 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Dark%20Mode.png?w=560&maxW=3074&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=98c1dcd00e151fdbf76c0642cd727d9e 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Dark%20Mode.png?w=840&maxW=3074&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=dd0419ae1a56f59f823aa4ae76bbeab8 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Dark%20Mode.png?w=1100&maxW=3074&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ca5a58973ad150b4c7ac4a1fa5e06766 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Dark%20Mode.png?w=1650&maxW=3074&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=90b38f060197cffcff5a0e512cca4770 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20in%20Dark%20Mode.png?w=2500&maxW=3074&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e6a329e375f8ee8217ef2fe849b7d05b 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Paragon Branding

You can optionally turn off the Paragon-branded footer in your Connect Portal.

<Note>
  Whitelabeling the Connect Portal, which allows you to remove Paragon branding, is available on our **Pro plan** and above. Please [contact us](mailto:sales@useparagon.com) to enable this option on your account.
</Note>

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Whitelabelling%20the%20Connect%20Portal%20in%20Paragon%20Connect.gif?maxW=1510&auto=format&n=867oBBVpxd2C3zc4&q=85&s=10eca323f787660085270039af40b0cd" alt="" width="1510" height="754" data-path="assets/Whitelabelling the Connect Portal in Paragon Connect.gif" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Whitelabelling%20the%20Connect%20Portal%20in%20Paragon%20Connect.gif?w=280&maxW=1510&auto=format&n=867oBBVpxd2C3zc4&q=85&s=b4090212966ae33fb8108e3110139306 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Whitelabelling%20the%20Connect%20Portal%20in%20Paragon%20Connect.gif?w=560&maxW=1510&auto=format&n=867oBBVpxd2C3zc4&q=85&s=1d997b567e0ee981f181eb810ed45121 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Whitelabelling%20the%20Connect%20Portal%20in%20Paragon%20Connect.gif?w=840&maxW=1510&auto=format&n=867oBBVpxd2C3zc4&q=85&s=41f67cf14055b54a48c223b5e33ce6e7 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Whitelabelling%20the%20Connect%20Portal%20in%20Paragon%20Connect.gif?w=1100&maxW=1510&auto=format&n=867oBBVpxd2C3zc4&q=85&s=59157350a5c609da944a3ce914e09ccb 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Whitelabelling%20the%20Connect%20Portal%20in%20Paragon%20Connect.gif?w=1650&maxW=1510&auto=format&n=867oBBVpxd2C3zc4&q=85&s=d5b255e747bbe0a3ef50f84c1a33a2bd 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Whitelabelling%20the%20Connect%20Portal%20in%20Paragon%20Connect.gif?w=2500&maxW=1510&auto=format&n=867oBBVpxd2C3zc4&q=85&s=a54d280967304ceaa25b50157479fcd2 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Displaying Workflows
Source: https://docs.useparagon.com/connect-portal/displaying-workflows

Control the visibility or customize the description of workflows that appear in the Connect Portal.

Workflows are an easy way for members of your team to build integration logic. Workflows appear in the Connect Portal, in the **Configuration** tab, as a way for your users to opt-in or out of specific features of your integration.

## Customizing the Workflow List

You can customize the Workflow List and their display options by visiting the **Configuration** tab of the Customize Connect Portal screen for any integration.

<Info>
  **Not seeing a workflow in the Connect Portal?** Workflows do *not* appear to your users in the Connect Portal if:

  * The workflow is not deployed
  * The workflow is hidden for all users
  * The workflow uses an Integration Enabled trigger
</Info>

### Reordering Workflows

Drag and drop Workflows to change the order in which they appear to your users in the Connect Portal.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-12-05%20at%2023.28.10.gif?maxW=2726&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=f87d12cb40a8116164e0760f49f398fd" alt="" width="2726" height="1810" data-path="assets/Kapture 2022-12-05 at 23.28.10.gif" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-12-05%20at%2023.28.10.gif?w=280&maxW=2726&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=e4f54e45c181b7817a8a81076994d817 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-12-05%20at%2023.28.10.gif?w=560&maxW=2726&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=63a2f69b2d9628708536a7ccf8b5296b 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-12-05%20at%2023.28.10.gif?w=840&maxW=2726&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=e92408607b7878f1ebd39f7de8bf3ede 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-12-05%20at%2023.28.10.gif?w=1100&maxW=2726&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9dc7e10ecaf93ee6bd081a00167d2563 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-12-05%20at%2023.28.10.gif?w=1650&maxW=2726&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7773dbcf6359d758f683dba673a5849c 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-12-05%20at%2023.28.10.gif?w=2500&maxW=2726&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=5f69b3708d1e26384f83558509b09ad3 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Workflow Display Options

By clicking on a workflow row, you can edit the display options for that specific workflow:

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(9).png?maxW=2732&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=61522d90f4d0ca53796f69cbcb476929" alt="" width="2732" height="1658" data-path="assets/image (9).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(9).png?w=280&maxW=2732&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=94132e63d2001c538e8c2e4f80002779 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(9).png?w=560&maxW=2732&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=af4cedc9593f8246769ea1af8c9cc123 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(9).png?w=840&maxW=2732&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=dad917058f81d0693d8eda22ca946b5f 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(9).png?w=1100&maxW=2732&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=d9d545c45cfe1d0a1a0d5faf501eade6 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(9).png?w=1650&maxW=2732&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=af7637968643efcd446c31a96a720218 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(9).png?w=2500&maxW=2732&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=94338d59439bed581e4de15ccf1a9ad5 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### Name and Description

This is the user-facing name and description of the workflows as it appears in your Connect Portal. You should give your workflow a descriptive name and explain the functionality that it provides in the description to make it easy for your users to decide which workflows they want to activate.

#### Settings

Workflow-level User Settings can be added to allow customization that is specific to a particular workflow (as opposed to User Settings that apply to multiple workflows across the integration).

Your user's selection for workflow-level User Settings will only be available to the workflow they are created for, as values available in the Variable Menu.

Learn more about adding and configuring User Settings below:

<Card title="User Settings" href="/connect-portal/workflow-user-settings" horizontal />

#### Default to enabled

If turned on, the workflow will appear as enabled by default once a user connects their account to the integration.

*This setting is unavailable for workflows that have required workflow-level User Settings.*

Turning on this option will *not* affect the workflow's status for existing users. For example, if the workflow is disabled for an *existing user* prior to turning on this option, it will remain disabled after turning on this option.

#### Hide workflow from Portal for all users

If turned on, the workflow will be hidden from all users from the Connect Portal.

The workflow can still be enabled by default (using the "Default to enabled" option described above) or enabled with a request to the [users.md](/apis/users).

**Workflow Permissions**

You can restrict the visibility of workflows to specific users (or groups of users) with Workflow Permissions.

Learn more about adding and configuring Workflow Permissions below:

<Card
  title="Displaying Workflows"
  href="/connect-portal/displaying-workflows
"
  horizontal
/>


# Field Mapping
Source: https://docs.useparagon.com/connect-portal/field-mapping

Use a Field Mapping User Setting to allow your users to define a mapping between objects in your application and their integration.

## Overview

A **Field Mapping** is a type of User Setting that allows your users to define a mapping between an object in your application (an "Application Object") and an object in their connected integration account (an "Integration Object").

For example: let's say your integration needs to sync your user's Task records from your application to their Tasks in a Salesforce account.

To do that, you'll need to build up a **Mapping** between fields in your application's Tasks and fields for a Task in a connected Salesforce account, as illustrated below:

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%20993%20(1).png?maxW=2309&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=df5a0d6dd0cfede39a8d44b35974f2d4" alt="" width="2309" height="979" data-path="assets/Frame 993 (1).png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%20993%20(1).png?w=280&maxW=2309&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=04d4b0132c83344a306c11eab62046c8 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%20993%20(1).png?w=560&maxW=2309&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=0cbe0feaefd3409c9257f667197dad65 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%20993%20(1).png?w=840&maxW=2309&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=c0b34f5254f0e706fcd68a8c498750d1 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%20993%20(1).png?w=1100&maxW=2309&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b51016d04b170809936146264aeeda10 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%20993%20(1).png?w=1650&maxW=2309&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=542f8c41d445b429dd956f42faabc37d 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%20993%20(1).png?w=2500&maxW=2309&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=3a7960ab3d7cf4d979a5ded6d977258d 2500w" data-optimize="true" data-opv="2" />
</Frame>

To enable your user to provide this Mapping, you can use the Connect Portal to provide a User Setting that displays each field of a Task (Title, Description, Completed) and prompts them to select a matching field of a Salesforce Task.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=24e2be05ee15df6d52bad90a781c379e" alt="" width="2352" height="1382" data-path="assets/image (54).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?w=280&maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=122bf433f4a8b793ac4ec18061fcd220 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?w=560&maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=e6d560fba530b0b04a72dd9d46afcaff 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?w=840&maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=c14fc1534f562e0e8b89a9e50cd5ec5f 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?w=1100&maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=bcb3e249b81553bfb94c7515173bb59e 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?w=1650&maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=1a4d987b7f9127c102c7fc8e7b1b6b97 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?w=2500&maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=91e9df84c903da66f531aa56e0403d1f 2500w" data-optimize="true" data-opv="2" />
</Frame>

Once this Mapping is completed, you're able to use the Mapping like any other [User Setting](/connect-portal/workflow-user-settings/workflow-user-settings#user-settings) in the [Workflow Editor](/connect-portal/field-mapping#usage-in-workflows) to transform objects in either direction (from Application Object to Integration Object **or** from Integration Object to Application Object).

## Adding Field Mapping to the Connect Portal

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-access.gif?maxW=800&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=5e857700551a8a84ba1448d3af2b79d8" alt="" width="800" height="559" data-path="assets/field-mapping-access.gif" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-access.gif?w=280&maxW=800&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=eb3c1501445a850873e6e2f835e0dd70 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-access.gif?w=560&maxW=800&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=c24dd77f20c33d6b1a6e21920d4924d3 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-access.gif?w=840&maxW=800&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=cb26af52c686d2c35f16e4c9b0a96af1 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-access.gif?w=1100&maxW=800&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=a455fb49baa7a161b414138e01c72c89 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-access.gif?w=1650&maxW=800&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=74d8b4b8cb7d054632491503260804de 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-access.gif?w=2500&maxW=800&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=9ca884e85305d35fa7fbe9da1005ca7d 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Steps>
  <Step title="Navigate to Customize Connect Portal">
    In an integration in your project, click on **Customize** from the Connect Portal section in the dashboard.
  </Step>

  <Step title="Select the Field Mapping Input Type">
    Select **Configuration**, add a **Setting**, and then select **Field Mapping** as the type of User Setting.
  </Step>

  <Step title="Configure the Setting">
    Give this setting a descriptive name that explains what this Mapping represents for your integration. For example, if Contacts is your intended Application Object to be mapped to a Salesforce Object, you might title this input "*Map Contacts to this object*".
  </Step>

  <Step title="Add Field Labels">
    Add a label for each property that should be mapped from your Application Object to a Salesforce Object. You might add labels for "First Name", "Last Name", and "Email", if the schema for Contacts in your app includes these properties.
  </Step>
</Steps>

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=24e2be05ee15df6d52bad90a781c379e" alt="" width="2352" height="1382" data-path="assets/image (54).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?w=280&maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=122bf433f4a8b793ac4ec18061fcd220 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?w=560&maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=e6d560fba530b0b04a72dd9d46afcaff 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?w=840&maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=c14fc1534f562e0e8b89a9e50cd5ec5f 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?w=1100&maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=bcb3e249b81553bfb94c7515173bb59e 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?w=1650&maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=1a4d987b7f9127c102c7fc8e7b1b6b97 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(54).png?w=2500&maxW=2352&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=91e9df84c903da66f531aa56e0403d1f 2500w" data-optimize="true" data-opv="2" />
</Frame>

In your [Connect Portal](/getting-started/displaying-the-connect-portal), your users will be prompted to select an object from their Salesforce instance when enabling this workflow. For each of the Application Object properties you labeled, your users will be prompted to select which Integration Object field that property should be mapped to.

By this stage, you have configured a static Field Mapping in the dashboard and can call `paragon.connect` to render the Field Mapping in the Connect Portal in your frontend application.

## Configuring Field Mapping

Many implementations of Field Mapping will warrant additional configuration options. Start by using the Paragon Dashboard to enable additional configuration options for your Field Mapping like [Dynamic Application Fields](#dynamic-application-fields). Then, learn how to [pass dynamic fields through the Paragon SDK](#passing-dynamic-fields-through-the-sdk) in your frontend to render dynamic Field Mapping elements in the Connect Portal.

### Configuring your Field Mapping setting in the Dashboard

#### Dynamic Application Fields

If your Application Fields may vary between your users for a particular Mapping, you are able to provide those options from your frontend application, through the SDK, using **Dynamic Application Fields**.

<Info>
  **Dynamic Application Fields is available for Paragon Enterprise customers and as an add-on for Paragon Pro customers.**
  To learn more, contact your Customer Success Manager or [sales@useparagon.com](mailto:sales@useparagon.com).
</Info>

Enable and configure Dynamic Application Fields by adding a Field Mapping input to your Connect Portal as described above. Configuration for Dynamic Application Fields will have a different interface depending on the integration.

<Frame caption="Left: Pre-configured Field Mapping Input. Right: Field Mapping Input">
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-1.png?maxW=1441&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=370f5cbf5d6ada1e94e7d60f70c18b91" alt="" width="1441" height="1496" data-path="assets/Field-mapping-config-1.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-1.png?w=280&maxW=1441&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=7293f84e228d7123be45af451a0d6d33 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-1.png?w=560&maxW=1441&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=d35aeb8ea5046a87fa417e47d57f8163 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-1.png?w=840&maxW=1441&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=f54988a40c487863e4a117a4ed2aeb6d 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-1.png?w=1100&maxW=1441&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=bf15a30d9bdec8d5f3c1fcc6a049ba07 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-1.png?w=1650&maxW=1441&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=082332ea5493e096523b55f489122634 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-1.png?w=2500&maxW=1441&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=67bce1f462a47331dd56415267204451 2500w" data-optimize="true" data-opv="2" />

  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=e7cbd39ee636157c11e83f504cc3610c" alt="" width="1305" height="1472" data-path="assets/Field-mapping-config-2.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?w=280&maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=81435cc793cac33054e434a54c1ef30a 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?w=560&maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b226494c8d3ec207debbb4fd1fdb29cb 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?w=840&maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=3cd8e55994c052c9f13897faf1b080b7 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?w=1100&maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=137c411cd88c5e6808ea117ec0bcfd21 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?w=1650&maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=1b4497cb1e2147abb1c85fca53a9be8b 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?w=2500&maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=92f724e3ac73e184d4f750d9fd51d230 2500w" data-optimize="true" data-opv="2" />
</Frame>

Complete the dashboard configuration for Dynamic Application Fields using the following steps, depending on the interface you see:

<Tabs>
  <Tab title="Pre-Configured Field Mapping Input">
    Pre-configured Field Mappings simplify the `paragon.connect` call by rendering pre-built dropdowns for the most common object types and fields for you.

    <Steps>
      <Step title="Toggle Dynamic Fields">
        Toggle on the "**Use dynamic fields**" slider option in your Field Mapping setting configuration.
      </Step>

      <Step title="Provide Object Name">
        Provide an Object Name that represents the name of your Application Object. This name will be used as an identifier to provide dynamic application fields through the SDK, as demonstrated in the code example to `paragon.connect` in the [Passing Dynamic Fields through the SDK](#passing-dynamic-fields-through-the-sdk) section.
      </Step>

      <Step title="Edit Example Fields for Testing in the Workflow Editor (Optional)">
        Edit the example fields included in the code snippet to represent realistic values that will be passed from your application. These values will be used for testing in the Workflow Editor, and will not affect the live configuration for your users.
        Learn more about testing your Field Mapping in the [Testing Field Mapping in the Workflow Editor](#testing-field-mapping-in-the-workflow-editor) section.
      </Step>

      <Step title="Save Changes">
        Click **Save** to apply your changes.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Field Mapping Input">
    By default, the Field Mapping Input will have Dynamic Field Mapping enabled.

    <Steps>
      <Step title="Provide Object Name">
        Provide an Object Name that represents the name of your Application Object. This name will be used as an identifier to provide dynamic fields through the SDK, as demonstrated in the code example to `paragon.connect`.
      </Step>

      <Step title="Edit Example Values for Testing in the Workflow Editor (Optional)">
        Edit the example `objectTypes` and `integrationFields` included in the code snippet to represent realistic values that will be passed from your application. This will not affect the live configuration for your users, since values must be passed from your frontend application through the SDK, but use this to test example field values while building workflows.
        Learn more about testing your Field Mapping in the [Testing Field Mapping in the Workflow Editor](#testing-field-mapping-in-the-workflow-editor) section.
      </Step>

      <Step title="Save Changes">
        Click **Save** to apply your changes.
      </Step>
    </Steps>
  </Tab>
</Tabs>

### Passing Dynamic Fields Through the SDK

For all Field Mapping inputs configured in the Dashboard to use Dynamic Application Fields, use the `paragon.connect` method in your frontend to fully configure the **Integration Objects**, **Integration Fields**, and **Application Fields** that are rendered dynamically in the Connect Portal.

[Pre-configured Field Mappings](#pre-configured-field-mapping-support) simplify the SDK call by pre-building dropdowns for the most common object types and fields for you and minimally require you to specify your *Application Fields* in the SDK. You can think of this as the *right-hand-side* of the Field Mapping input.

For all other integrations, you must define the Integration Objects, their Integration Fields (the *left-hand-side* of the Field Mapping input), and your Application Fields.

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-fields-example.png?maxW=768&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=bbcd1b5b1c5621e7ab75888e09920f3d" alt="" width="768" height="588" data-path="assets/field-mapping-fields-example.png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-fields-example.png?w=280&maxW=768&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=d7201c4faceb469a59417edbfcaca7ad 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-fields-example.png?w=560&maxW=768&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=3e21389d8fc875d03b89d3cfe9f9bf93 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-fields-example.png?w=840&maxW=768&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=fbcf079bb6cafea065d7275616b36a91 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-fields-example.png?w=1100&maxW=768&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=a3b061809b7935009845d4cae81a546b 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-fields-example.png?w=1650&maxW=768&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=9d26fe2dcdbaf5df5578a5563e54fe26 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/field-mapping-fields-example.png?w=2500&maxW=768&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=81f23dfd6403b7ee90319c1e78129fcf 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### Passing Application Fields for a Pre-configured Field Mapping

Pass your Application Fields by specifying the `mapObjectFields` option, with an object keyed by the name you specified in the "Object Name" field when configuring your setting:

```js Open a pre-configured Field Mapping with Dynamic Application Fields
paragon.connect("salesforce", {
  mapObjectFields: {
    "Task": {
      fields: [
        { label: "Title", value: "title" },
        { label: "Description", value: "description" },
        { label: "Completed?", value: "isCompleted" }
      ]
    }
  }
});
```

For each field passed, two values are specified:

* `label`: The human-readable description for the field. This will be shown to the user in the Field Mapping input.
* `value`: The field key used by the object as it exists in your application. *This key does not yet support nested properties.*

Calling the above would result in the Connect Portal appearing like below:

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(17).png?maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=a6cbfb7dc6e610e5bc570c957dc2bd76" alt="" width="1600" height="766" data-path="assets/Frame 1 (17).png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(17).png?w=280&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=8cfb06dbf16a73ff272ec1360339f52d 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(17).png?w=560&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=7a8b43f70201775cb93f4ff0546220f9 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(17).png?w=840&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=d3819f0c66d12eb1b09ae26215c1c57c 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(17).png?w=1100&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=075422e47929077838cbf93474d96041 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(17).png?w=1650&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=59fddfba60fdd517198f221be0163b2e 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(17).png?w=2500&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=947438d7238b4cdd7c43c4e810e11987 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### Passing Your Own Integration Objects and Fields

For all integrations, you can fetch and render any object type and its fields that are available in the user's connected integration.

Define the `objectTypes` and `integrationFields` properties and their `get` methods to render either a static list of objects and their fields, or a paginated list of objects and their fields via an API request.

* `objectTypes` — defines the list of record types available in the user’s integration (e.g. “Contact”, “Deal”, “Opportunity”).
* `integrationFields` — defines the fields available for the selected record type.

The both properties require a `get` method that must return either:

* A Promise that resolves to an array of dropdown options, where each is a `{ label, value }` pair as defined above in [Passing Application Fields for a Pre-configured Field Mapping](#passing-application-fields-for-a-pre-configured-field-mapping) example, or
* An object containing both the dropdown options and a pagination cursor

<CodeGroup>
  ```ts objectTypes: Array of Dropdown Options
  // objectTypes
  {
    get: async (cursor, search) => {
      return [
        { label: "Contact", value: "contact" },
        { label: "Deal", value: "deal" },
        { label: "Opportunity", value: "opportunity" }
      ]
    }
  }
  ```

  ```ts objectTypes: Paginated Dropdown
  // objectTypes
  {
    get: async (cursor, search) => {
      return {
        options: [
          { label: "Contact", value: "contact" },
          { label: "Deal", value: "deal" },
          { label: "Opportunity", value: "opportunity" }
        ],
        nextPageCursor: "123"
      }
    }
  }
  ```
</CodeGroup>

**applicationFields**

When passing your own object types and fields, you must alter your `paragon.connect` call to explicitly define the `applicationFields` property.
`applicationFields` defines the list of fields from your application. It should contain a `fields` array containing `{ label, value }` pairs identical to the `fields` array in the [Passing Application Fields for a Pre-configured Field Mapping](#passing-application-fields-for-a-pre-configured-field-mapping) example.

The following are examples of how to fully configure `objectTypes`, `integrationFields`, and `applicationFields` when passing your own object types and fields:

<Tabs>
  <Tab title="Sample Mapping without Paginated Dropdowns">
    ```ts
    paragon.connect("salesforce", {
      mapObjectFields: {
        // Replace "CustomObjectMapping" with your Application Object Name as specified in
        // Field Mapping input options
        CustomObjectMapping: {
          objectTypes: {
            get: async (cursor, search) => {
              const res = await paragon.request("salesforce", "/v1/objects", { method: "GET" });
              return res.data.map((obj) => ({
                label: obj.name,
                value: obj.id
              }));
            }
          },
          // Integration fields from the selected objectTypes (Contacts' schema / field types)    
          // @returns Promise resolving to Integration Fields to display.
          // Each item: { label: string, value: string }
          integrationFields: {
            get: async ({ objectType }) => {
              const res = await paragon.request("salesforce", 
                `v1/objects/${objectType}/fields`, 
                { method: "GET" });
                
              return res.fields.map((field) => ({
                label: field.label,
                value: field.id
              }));  
            }
          },
          // Fields from your application that will be displayed in the Connect Portal
          applicationFields: {
            fields: [
              { label: "Title", value: "title" },
              { label: "Email", value: "email" }
            ],
            defaultFields: [],
            userCanRemoveMappings: true
          }
        }
      }
    });
    ```
  </Tab>

  <Tab title="Sample Mapping with Paginated Dropdowns">
    ```ts
    paragon.connect("slack", {
      mapObjectFields: {
        // Replace "SlackObjectMapping" with your Application Object Name as specified in
        // Field Mapping input options
        SlackObjectMapping: {
          objectTypes: {
            get: async (cursor, search) => {
              const url = `/conversations.list${cursor ? `?cursor=${encodeURIComponent(cursor)}` : ''}`;
              const res = await paragon.request("slack", url, { method: "GET" });
              // Optional search filter (case-insensitive)
              const filteredChannels = (res.channels || []).filter(ch =>
                !search || ch.name.toLowerCase().includes(search.toLowerCase())
              );
              const channels = filteredChannels.map(ch => ({
                label: ch.name,
                value: ch.id,
              }));
              return {
                options: channels,
                nextPageCursor: res.response_metadata?.next_cursor || null,
              };
            },
          },
          // Integration fields from the selected objectTypes (Conversations' schema / field types)    
          // @returns Promise resolving to Integration Fields to display.
          // Each item: { label: string, value: string }
          integrationFields: {
            get: async () => {
              const res = await paragon.request("slack", "/conversations.list", { method: "GET" });
              const options = (res.channels || []).map(ch => ({
                label: ch.name,
                value: ch.id,
              }));
              return { options };
            },
          },
          applicationFields: {
            fields: [
              { label: "Channel Name", value: "name" },
              { label: "Channel ID", value: "id" },
            ],
          },
        },
      },
    });
    ```
  </Tab>
</Tabs>

#### User-Configurable Mappings

If your use case requires it, you can allow users to control the *number* of Field Mappings that are set by adding the `userCanRemoveMappings` option alongside the `fields` array in your `paragon.connect` call.

```js
paragon.connect("salesforce", {
  mapObjectFields: {
    // Replace "Task" with your Application Object Name as specified in
    // Field Mapping input options
    "Task": {
      fields: [
        { label: "Title", value: "title" },
        { label: "Description", value: "description" },
        { label: "Completed?", value: "isCompleted" }
      ],
      userCanRemoveMappings: true
    }
  }
});
```

Setting this option will result in the Connect Portal appearing like below:

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(19).png?maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=d6f957ddda65fb260b0f7ee13a9201d6" alt="" width="1600" height="834" data-path="assets/Frame 1 (19).png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(19).png?w=280&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=6f31e06e038f6f37fdd56edbd2113bda 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(19).png?w=560&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=4c143a8daa798675b804ee72a70af9f4 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(19).png?w=840&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=67e16707b2c6660bbc7ddaaf51e0db3a 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(19).png?w=1100&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=1d5c84bdb114ba483259be052425bd54 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(19).png?w=1650&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=087e0f9c3b3e9b872ef5f3cef5dd3b6b 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(19).png?w=2500&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=be91b842184f458c20f53a721c5bf523 2500w" data-optimize="true" data-opv="2" />
</Frame>

With this option, your users will be able to remove, re-add, and change any of the Mappings that are passed through `fields`. This option can be combined with the `defaultFields` option to achieve different display configurations:

<Frame caption="{ userCanRemoveMappings: true, defaultFields: [] }">
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(64).png?maxW=1298&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=abd07f61360c6dcbca22d708737be6ad" alt="" width="1298" height="794" data-path="assets/image (64).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(64).png?w=280&maxW=1298&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=bff5839190150633e94fb05ed4050624 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(64).png?w=560&maxW=1298&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=c92acebf6656633e9d60edf2bf9f7f47 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(64).png?w=840&maxW=1298&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=0a4486910743f395d7a8d8fa3f880fa5 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(64).png?w=1100&maxW=1298&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=902b083dd427bf375f78b349a0411a7a 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(64).png?w=1650&maxW=1298&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=92052fc627e0f36381be4e2d11e2f49b 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(64).png?w=2500&maxW=1298&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=1cfdd8c5d4f2921aa749b73f318fb749 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Frame caption="{ userCanRemoveMappings: true, defaultFields: ['title'] }">
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(13).png?maxW=1296&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=db3c7c79ccecd01f8f21b6f147089e6a" alt="" width="1296" height="866" data-path="assets/image (13).png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(13).png?w=280&maxW=1296&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=00e374c319b04d792215672fe6d77690 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(13).png?w=560&maxW=1296&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=a12738ce1951ae391f58b5e7da632782 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(13).png?w=840&maxW=1296&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=8b4fe3e16b6b622142502b392ad02d55 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(13).png?w=1100&maxW=1296&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=e800756e5af48f438870a516e7becc8d 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(13).png?w=1650&maxW=1296&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ae45e7103acfdd6b85c23e6e0c3a8e22 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(13).png?w=2500&maxW=1296&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=5c09f64aecdb9137601beaba92ff0315 2500w" data-optimize="true" data-opv="2" />
</Frame>

`defaultFields` is an array of strings matching the `value` property of your `fields`. Any fields with matching `value` keys will be included in the initial list of Field Mappings that your user sees, when viewing the Connect Portal for the first time.

If `defaultFields` is unspecified, *all* fields specified in the `fields` property will appear in the initial list of Field Mappings.

#### User-Creatable Fields

If your Application Object supports freeform fields or a flexible schema, you can allow users to create their own fields in the Field Mapping input.

```js
paragon.connect("salesforce", {
  mapObjectFields: {
    // Replace "Task" with your Application Object Name as specified in
    // Field Mapping input options
    "Task": {
      fields: [
        { label: "Title", value: "title" },
        { label: "Description", value: "description" },
        { label: "Completed?", value: "isCompleted" }
      ],
      defaultFields: [],
      userCanCreateFields: true
    }
  }
});
```

If this option is specified, the Connect Portal will appear with an option for users to create their own fields, if the field is not available in the list populated by `fields`:

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(18).png?maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=cfce693b07027d3ea6876a3027c5fd50" alt="" width="1600" height="652" data-path="assets/Frame 1 (18).png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(18).png?w=280&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=f21e1488b12624c8c24e1ccefcffecff 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(18).png?w=560&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=c82a98122f742a2fd9387ab31207df81 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(18).png?w=840&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b6c747576e6fe653b60f96bcac980503 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(18).png?w=1100&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b85527dbe33d0c0c073142fe8dbdbfc5 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(18).png?w=1650&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=c04c3431ab2612628e31e122692abd8c 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(18).png?w=2500&maxW=1600&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=315970e18728b24581c786b54df41c86 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Testing Field Mapping in the Workflow Editor

When building workflows that use Field Mapping, you can test how your mappings work directly in the Workflow Editor. The mapping is applied based on what is configured for the Test User.

### Configuring Test User Mappings

To configure the Field Mapping for the Test User:

1. Return to the **Customize Connect Portal** section of your integration in the dashboard.
2. Select the **Field Mapping** Input Type setting.
3. Alter the **Test Mapping** code to change the static Integration Objects, Integration Fields, and Application Fields that are rendered in the preview Connect Portal. (This has no production impact.)
4. Click **Save** to apply your changes.
5. **Preview the Connect Portal** to see the updated mapping configuration and fill-in the inputs to mimic the mapping you want to test.

<Frame caption="Configure the test data for the Field Mapping input">
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=e7cbd39ee636157c11e83f504cc3610c" alt="" width="1305" height="1472" data-path="assets/Field-mapping-config-2.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?w=280&maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=81435cc793cac33054e434a54c1ef30a 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?w=560&maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b226494c8d3ec207debbb4fd1fdb29cb 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?w=840&maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=3cd8e55994c052c9f13897faf1b080b7 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?w=1100&maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=137c411cd88c5e6808ea117ec0bcfd21 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?w=1650&maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=1b4497cb1e2147abb1c85fca53a9be8b 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Field-mapping-config-2.png?w=2500&maxW=1305&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=92f724e3ac73e184d4f750d9fd51d230 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Usage in Workflows

After your user specifies their desired mapping in the Connect Portal, you can use their chosen values within workflow actions.

A Field Mapping contains 2 pieces of information:

* The selected Integration Object type (for example, a Salesforce Task).
* The field-level mappings between your Application Object and the selected Integration Object type (for example, Title ⇄ Salesforce Task Subject, Description ⇄ Salesforce Task Description).

You can use the "**Apply field mapping**" option to transform Application Objects (from App Events or Request triggers) to Integration objects and vice versa.

### Transforming from Application Object -> Integration Object

If you receive an Application Object in an App Event or Request payload, you can transform it into an Integration Object by selecting the **Field Mapping Object Type** in the "**Apply field mapping**" option for your App Event or Request trigger.

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(18).png?maxW=490&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=b9512bc269282f347a6e4c5f9eca63aa" alt="" width="490" height="189" data-path="assets/image (18).png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(18).png?w=280&maxW=490&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=8938fa9e1c8eeb89d704c56467226629 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(18).png?w=560&maxW=490&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=5f395ab7fd4b2787ca663f9583a79e49 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(18).png?w=840&maxW=490&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=d40e45c527a0b3714475eb4338577c74 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(18).png?w=1100&maxW=490&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=570b451fbdf6f9e218dffc8cbd084c40 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(18).png?w=1650&maxW=490&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=09668d89afbcc9fb9199b454b00105e5 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(18).png?w=2500&maxW=490&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=28aeed2c67e0e2a9a0a9e55e95f4ed76 2500w" data-optimize="true" data-opv="2" />
</Frame>

Once set, you will see the trigger output data update to show two objects:

* `originalPayload`: This is the original App Event or Request payload received by the trigger.
* `mappedIntegrationObject`: This is the Integration Object that was mapped based on the Field Mapping configured in the Connect Portal.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(52).png?maxW=486&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=8a7e4a4dbe763f77ddce87a336b3caab" alt="" width="486" height="332" data-path="assets/image (52).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(52).png?w=280&maxW=486&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=fa86d94324ab3e2a2c1b63389cee3b05 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(52).png?w=560&maxW=486&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=80a6e5c95e20d33c1c6dc893f586025d 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(52).png?w=840&maxW=486&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6360243d5c193e04777ab0551f8a847f 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(52).png?w=1100&maxW=486&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=597f34052af334129d409dd9efb34e9c 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(52).png?w=1650&maxW=486&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=7b5b4abba2910db24e4b6d5af8f9a7d8 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(52).png?w=2500&maxW=486&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=f837ec97b40c95cd414548cc587baf9e 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Note>
  **Note:** The mapped Integration Object only applies to the **root** of the original payload. If your field exists within a nested JSON, it will not work as expected.
</Note>

### Transforming from Integration Object -> Application Object

When receiving an Integration Object in an Integration trigger (for example, a Salesforce "New Record" trigger), you can transform it into an Application Object using the Field Mapping specified by your user.

In the trigger settings for your workflow, select the **Field Mapping Object Type** in the "**Apply field mapping**" option.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(36).png?maxW=484&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=e067785fca2eb60e8f45e62a535655fe" alt="" width="484" height="199" data-path="assets/image (36).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(36).png?w=280&maxW=484&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=f77c7e0b56b82b47a14a3ecd5dce607b 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(36).png?w=560&maxW=484&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=0cccc2c29cc941413c513e6de094a655 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(36).png?w=840&maxW=484&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=26fc894b85bdcfe623ad03b2cf10a972 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(36).png?w=1100&maxW=484&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=8035497f4a867073a230dee594a2bc76 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(36).png?w=1650&maxW=484&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=ffa11405e4d974f719123e86e335fc93 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(36).png?w=2500&maxW=484&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=53169fe237bfbc51721b5c79edfa060f 2500w" data-optimize="true" data-opv="2" />
</Frame>

Once set, you will see the trigger output data update to show two objects:

* `originalPayload`: This is the original Integration Object received by the trigger.
* `mappedApplicationObject`: This is the Application Object that was mapped based on the field mapping configured in the Connect Portal.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(49).png?maxW=470&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=b31adb14f1bcb1d92207ccd74c0b3a2d" alt="" width="470" height="285" data-path="assets/image (49).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(49).png?w=280&maxW=470&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=00170400fd42c8cc44e8911cec41637e 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(49).png?w=560&maxW=470&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=26027e2ae608484b22c7e904360fc993 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(49).png?w=840&maxW=470&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6b0357b1d5b90f9116c2ab92fedb0205 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(49).png?w=1100&maxW=470&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=446fd8a228f6a918b6832333e0af24d5 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(49).png?w=1650&maxW=470&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=dd88cc68c8e5b9cbe1fd28be279d525c 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(49).png?w=2500&maxW=470&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=45ffbd3eb4f424830933399c1a748b63 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Pre-configured Field Mapping Support

Paragon provides pre-configured Field Mapping support for most CRM integrations, along with select others. These integrations come with fully maintained dropdowns for common record types and fields — you only provide your application fields.

All pre-configured Field Mapping integrations can be overridden by using the SDK to define custom field mapping dropdowns as explained above. This gives you full control over record types, fields, and how they appear in the Connect Portal. (See [Passing Your Own Integration Objects and Fields](#passing-your-own-integration-objects-and-fields)).

* [Close](/resources/integrations/close)
* [Dynamics 365 Sales](/resources/integrations/microsoft-dynamics-365)
* [Dynamics 365 Business Central](/resources/integrations/dynamicsbusinesscentral)
* [HubSpot](/resources/integrations/hubspot)
* [Jira](/resources/integrations/jira)
* [Marketo](/resources/integrations/marketo)
* [Pipedrive](/resources/integrations/pipedrive)
* [QuickBooks](/resources/integrations/quickbooks)
* [Sage Intacct](/resources/integrations/sage-intacct)
* [Salesforce](/resources/integrations/salesforce)
* [Sharepoint](/resources/integrations/sharepoint)
* [ZohoCRM](/resources/integrations/zohocrm)


# Headless Connect Portal
Source: https://docs.useparagon.com/connect-portal/headless-connect-portal

Bring your existing components or design system into your Paragon integrations experience with the Headless Connect Portal.

If your app already uses a component library or design system, you may opt to use the Headless Connect Portal, which allows you to connect to your users' integration accounts with a custom user interface. The Headless Connect Portal provides a **fully managed authentication** so you don't need to worry about managing, storing, or refreshing your customers' credentials.

## Overview

The SDK includes 4 main functions that allow you to use the Headless Connect Portal:

* [`paragon.getIntegrationMetadata`](/apis/api-reference#.getintegrationmetadata): Returns display and branding information for integrations in your project, including a display name and icon.
* [`paragon.installIntegration`](/apis/api-reference#installintegration): Prompts the user for third-party authorization details to connect their account. This function should be used when a user expresses intent to install your integration, for example: from a "Connect" button in your integrations catalog.
* [`paragon.uninstallIntegration`](/apis/api-reference#.workflow): Disconnects the user's account.
* [`paragon.getUser`](/apis/api-reference#.getuser-paragonuser): Returns the current state of the user, with their integrations and account statuses.

## Demo

<Frame caption="A demo implementation of the Headless Connect Portal, using Material UI components and the Paragon SDK">
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=4c80a53566805573254fda2ae38d2690" alt="" width="1684" height="1472" data-path="assets/Kapture 2022-11-16 at 13.06.56.gif" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?w=280&maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=da33248b28cba023bc22a644eaedc830 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?w=560&maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=6e24060ce1b025b08e10bcc753e91ce3 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?w=840&maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=4d3eef336020ad79379f629e07cb90e8 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?w=1100&maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0e91f10de6407b7acaefd576cfb2aa7d 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?w=1650&maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=fd21086b5cb9cd6276413ce6b32ced12 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?w=2500&maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=210094aeda222e7e1c0a0c0e387268fc 2500w" data-optimize="true" data-opv="2" />
</Frame>

This demo is created based on our tutorial to [build an in-app Integrations Catalog](/tutorials/building-an-in-app-integrations-catalog), adapted to use the Headless Connect Portal to show a custom UI to connect your users' integration accounts.

The repository with the completed code is available [here](https://github.com/useparagon/paragon-integrations-catalog-tutorial/tree/headless):

<Card
  title="GitHub - useparagon/paragon-integrations-catalog-tutorial at headless"
  icon="github"
  href="https://github.com/useparagon/paragon-integrations-catalog-tutorial/tree/headless
"
  horizontal
/>

## Usage

Before adding the Headless Connect Portal, you may want to start by following our tutorial to [build an in-app Integrations Catalog.](/tutorials/building-an-in-app-integrations-catalog) This will use some of the functions above to display a list of integrations and their account state.

Once you have a list of integrations displaying in your app, you can use this UI as a starting point for adding the Headless Connect Portal.

### Displaying Integration Metadata

<Frame caption="Displaying integration metadata in a Headless Connect Portal, with Material UI">
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(58).png?maxW=640&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=1f3defd9d8aac87084066d36967ff80f" alt="" width="640" height="180" data-path="assets/image (58).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(58).png?w=280&maxW=640&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=123b9a7ecc6f26ab61997b82a3e4eb4f 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(58).png?w=560&maxW=640&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=f3993d5d1dd9bc26366949918ce14a6d 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(58).png?w=840&maxW=640&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=9a165783bba195f5fd4c00de45131737 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(58).png?w=1100&maxW=640&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=523a8d36dda8e8ea278190ec4c883b25 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(58).png?w=1650&maxW=640&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=0e4d517c498be2d2c0662f30e0aaa87e 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(58).png?w=2500&maxW=640&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=f4a2328f2225d532fb24fc81bdebee42 2500w" data-optimize="true" data-opv="2" />
</Frame>

To display an integration's metadata, use [`.getIntegrationMetadata`](/apis/api-reference#.getintegrationmetadata), passing the `integrationType` as the first argument. This will return an object with the matching integration's display metadata:

```js
{
    type: 'salesforce',
    name: 'Salesforce',
    brandColor: '#057ACF',
    icon: 'https://cdn.useparagon.com/2.35.0/dashboard/public/integrations/salesforce.svg'
}
```

You can use this to display info in your integration detail view component (in this example, a modal written with React and MUI):

```js
import {
  Dialog,
  DialogContent,
  DialogContentText,
  DialogTitle,
} from "@mui/material";
import useParagonGlobal from "../hooks/useParagonGlobal";

function IntegrationDetailView({ integrationType, onClose }) {
  const paragon = useParagonGlobal();
  const integration = paragon && integrationType
    ? paragon.getIntegrationMetadata(integrationType)
    : { name: "", icon: "" };

  return (
    <Dialog open={integrationType !== null} onClose={onClose}>
      <DialogTitle>
        <img src={integration.icon} />
        {integration.name}
      </DialogTitle>
      <DialogContent>
        <DialogContentText>
          This is a description of the {integration.name} integration. You can
          customize this text is in your source code.
        </DialogContentText>
      </DialogContent>
    </Dialog>
  );
}
```

We recommend including:

* The integration icon image, as retrieved from the `.icon` property.
* The integration's name, as retrieved from the `.name` property.
* A short description of what functionality your integration provides. This description should vary for each integration and provide app-specific context.

### Connecting Accounts

<Frame caption="Adding a 'Connect' button to a Headless Connect Portal">
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=d69ceab6c91ce5c675ab74382aec8f47" alt="" width="635" height="179" data-path="assets/image (66).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?w=280&maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=01ee1e5e2c5de2d60ed4e36feebaa074 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?w=560&maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=92d64a15b944d84c8e95546b5d1f3727 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?w=840&maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=33fd982a01e7ecbcaeb39cd720577dc2 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?w=1100&maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=fde0fcf6296328380d981971247e0a74 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?w=1650&maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=1d80e2cc689f07b52b795276eb3fc5d3 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?w=2500&maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=d5a57e854faa13a8ade79f65866dad4c 2500w" data-optimize="true" data-opv="2" />
</Frame>

To add a **Connect** button to the Headless Connect Portal and prompt the user to connect an integration account on click, use the `.installIntegration` function.

`.installIntegration` accepts the same `integrationType` argument, so we can pass this parameter through to this function:

```js
<Button onClick={() => paragon.installIntegration(integrationType)}>
  Connect
</Button>
```

Once this is added, your Integrations Catalog will show the integration authorization when the **Connect** button is clicked.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2011.12.40.gif?maxW=1720&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7982cba42037f8eaa82a2676ebeec93b" alt="" width="1720" height="1412" data-path="assets/Kapture 2022-11-16 at 11.12.40.gif" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2011.12.40.gif?w=280&maxW=1720&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=b17d159b3f67dd2cd77b863cbf6feb37 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2011.12.40.gif?w=560&maxW=1720&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=466031d898d6d1dd55bfcf444002b64d 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2011.12.40.gif?w=840&maxW=1720&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c558b7baf989d562959a052a6b589b66 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2011.12.40.gif?w=1100&maxW=1720&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=d8a7618ea13d1e051e2d61f30a9f372b 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2011.12.40.gif?w=1650&maxW=1720&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=84c2ae68e1e0103300bcc9734b9d1d14 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2011.12.40.gif?w=2500&maxW=1720&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=4cce497152d64c1bb0312f1b555c38ee 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Note>
  **Note**: Integrations that require text-based credentials (i.e. not OAuth) *and* integrations that require some information prior to starting the OAuth flow will briefly show the Connect Portal.
</Note>

### Displaying Account State

<Frame caption="Displaying the Connect/Disconnect button dynamically based on account state">
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(77).png?maxW=1240&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=4cbbfe821f16c3b5acffc689916ebbdd" alt="" width="1240" height="334" data-path="assets/image (77).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(77).png?w=280&maxW=1240&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=2647e2584db67e631d54a75f3e7df3d1 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(77).png?w=560&maxW=1240&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6553752c01dce5a8b11f5aa0dce3266a 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(77).png?w=840&maxW=1240&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=be9d21a32752f8e4b3cc612385953703 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(77).png?w=1100&maxW=1240&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=298d6a9018b88daa79c3b57a3e87a506 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(77).png?w=1650&maxW=1240&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=b3ca7e040471842d5cb22e3d1bf2f815 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(77).png?w=2500&maxW=1240&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=84c9a282a13c467c1d6a1e74eccd1401 2500w" data-optimize="true" data-opv="2" />
</Frame>

To add logic to your Headless Connect Portal to stay in sync with your user's account state, we can use `.getUser` and `.subscribe`.

`.getUser` returns an object with the user's account state:

```json
// Example return result from paragon.getUser()
{
    "authenticated": true,
    "userId": "user-id",
    "integrations": {
        "salesforce": {
            "enabled": false,
            "configuredWorkflows": {}
        },
        "slack": {
            "enabled": true,
            "configuredWorkflows": {},
            "credentialStatus": "VALID",
            "credentialId": "81af6717-9476-458d-8c29-f0aee7ce6d12",
            "providerId": "TM7FL705V",
            "providerData": {}
        },
        "hubspot": {
            "enabled": false,
            "configuredWorkflows": {}
        }
    },
    "meta": {}
}
```

We can use the result of this object to conditionally show a **Connect** or **Disconnect** button, depending on the value of `user.integrations[integrationType].enabled`.

```js
function ConnectButton({ integrationType }) {
  const paragon = useParagonGlobal();
  const { user } = useParagonAuth(paragon);

  if (!user?.authenticated || !integrationType) {
    return null;
  }
  if (!user.integrations[integrationType]?.enabled) {
    // User does not have integration enabled
    return (
      <Button
        variant="contained"
        onClick={() => paragon.installIntegration(integrationType)}
      >
        Connect
      </Button>
    );
  } else {
    // User has integration enabled
    return (
      <Button onClick={() => paragon.uninstallIntegration(integrationType)}>
        Disconnect
      </Button>
    );
  }
}
```

If you are already using the [`useParagonAuth` hook from the tutorial](/tutorials/building-an-in-app-integrations-catalog), the returned `user` object will automatically stay up-to-date by subscribing to `onInstallIntegration` and `onUninstallIntegration` events from the SDK, as shown below:

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=4c80a53566805573254fda2ae38d2690" alt="" width="1684" height="1472" data-path="assets/Kapture 2022-11-16 at 13.06.56.gif" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?w=280&maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=da33248b28cba023bc22a644eaedc830 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?w=560&maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=6e24060ce1b025b08e10bcc753e91ce3 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?w=840&maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=4d3eef336020ad79379f629e07cb90e8 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?w=1100&maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0e91f10de6407b7acaefd576cfb2aa7d 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?w=1650&maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=fd21086b5cb9cd6276413ce6b32ced12 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-16%20at%2013.06.56.gif?w=2500&maxW=1684&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=210094aeda222e7e1c0a0c0e387268fc 2500w" data-optimize="true" data-opv="2" />
</Frame>

If you are not using the `useParagonAuth` hook and are unable to, you can call `paragon.subscribe` on your own to receive updates, as demonstrated below:

```js
// Adapted from useParagonAuth.ts
function MyComponent() {
  const [user, setUser] = useState<AuthenticatedConnectUser | undefined>();

  // Listen for account state changes
  useEffect(() => {
    const listener = () => {
      if (paragon) {
        const authedUser = paragon.getUser();
        if (authedUser.authenticated) {
          setUser({ ...authedUser });
        }
      }
    };
    listener();
    paragon?.subscribe("onIntegrationInstall", listener);
    paragon?.subscribe("onIntegrationUninstall", listener);
    return () => {
      paragon?.unsubscribe("onIntegrationInstall", listener);
      paragon?.unsubscribe("onIntegrationUninstall", listener);
    };
  }, [paragon]);
}
```

### Workflows and User Settings

At this time, the Headless Connect Portal does not include SDK functions for displaying workflows and user settings.

However, it is possible to use the API to:

* Get workflows associated with an integration, including their titles and descriptions
* Get integration-specific options for User Settings (like a user's Salesforce Record Types) directly from the integration provider's API
* Update User Settings and workflow state


# Overview
Source: https://docs.useparagon.com/connect-portal/overview

Focus on building out your integration logic and leave integration authentication to Paragon.

# Paragon's Authentication Layer

Paragon provides a robust, fully-managed authentication layer that makes it easy to connect your users to third-party applications securely and efficiently. It is designed to handle the complexities of OAuth and other authentication flows, so you can focus on building your product.

## Implementation Options

You have the flexibility to bring Paragon's authentication layer into your application in the way that best fits your needs:

### Connect Portal

Use Paragon's out-of-the-box React component to quickly embed a beautiful, secure authentication and integration experience in your app. This option requires minimal setup and provides a streamlined user experience with built-in UI, onboarding, and management tools.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=b73e3e76bfbdb2f71048141ed7766030" alt="Paragon's out-of-the-box Connect Portal" width="1584" height="1366" data-path="assets/image (59).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?w=280&maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6e7562f1cc0d681e52a1d850af96bbab 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?w=560&maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=bf0482ad0226d2b20453eb448a9bda03 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?w=840&maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=4a9fa18f800f2262af648a5c678c7b02 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?w=1100&maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=2efb8831edb9f227ea7963688ca329f7 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?w=1650&maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=942bc40f8368b3e3a3cc727355e05804 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(59).png?w=2500&maxW=1584&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6ff70aad02f5e37862b562857da86a68 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Card title="Explore the Connect Portal" href="/connect-portal/connect-portal-customization" horizontal icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right-icon lucide-arrow-right"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg>}>
  Learn more about Paragon's out-of-the-box authetication portal.
</Card>

### Headless Connect Portal

Prefer to design your own UI? Paragon's Headless option gives you full control over the user interface while still leveraging Paragon's secure authentication and integration logic behind the scenes. Ideal for teams who want a fully custom look and feel while offloading the complexity of authentication.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=d69ceab6c91ce5c675ab74382aec8f47" alt="Paragon's Headless Connect Portal" width="635" height="179" data-path="assets/image (66).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?w=280&maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=01ee1e5e2c5de2d60ed4e36feebaa074 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?w=560&maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=92d64a15b944d84c8e95546b5d1f3727 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?w=840&maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=33fd982a01e7ecbcaeb39cd720577dc2 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?w=1100&maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=fde0fcf6296328380d981971247e0a74 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?w=1650&maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=1d80e2cc689f07b52b795276eb3fc5d3 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(66).png?w=2500&maxW=635&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=d5a57e854faa13a8ade79f65866dad4c 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Card title="Explore the Headless Connect Portal" href="/connect-portal/headless-connect-portal" horizontal icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right-icon lucide-arrow-right"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg>}>
  Learn more about Paragon's headless authentication portal.
</Card>

Both options provide:

* Secure handling of OAuth and other authentication flows
* Management of user settings, field mapping, and workflow visibility
* A scalable, reliable foundation for integrating with third-party integration providers

Explore the pages in this section to learn how to set up, customize, and get the most out of Paragon's authentication layer—whether you choose the Connect Portal or build your own experience with the Headless version.


# Workflow Permissions
Source: https://docs.useparagon.com/connect-portal/workflow-permissions

Restrict the visibility of workflows to specific users or groups with Workflow Permissions.

You can restrict the visibility of workflows to specific users or groups with Workflow Permissions.

Workflow Permissions can be defined for any workflow as a set of conditions that a user's [metadata](../apis/users#associate-connected-user-with-metadata) must match in order for the workflow to appear in their Connect Portal.

For example, you can use Workflow Permissions to:

* Limit the availability of workflows to users on specific pricing plans
* Build a bespoke workflow for a specific user
* Roll out a new workflow to a group of users, under a feature flag

<Info>
  Workflow Permissions is available on our **Enterprise plan** and above. Please [contact us](mailto:sales@useparagon.com) to enable this option in your account.
</Info>

## Using Workflow Permissions

Workflow Permissions are available in the options for any Workflow on the [Customize Connect Portal](./connect-portal-customization) page. Navigate to **Configuration > Workflows**, and choose any workflow to set Workflow Permissions.

To set Workflow Permissions, click **Update** and create conditions for the user's metadata object.

<Frame>
  <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202023-02-22%20at%2003.04.45%20PM.png?maxW=1372&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=ca4f83295c062c24a65ab6c8e6fdced7" alt="" width="1372" height="1054" data-path="assets/[Paragon] 2023-02-22 at 03.04.45 PM.png" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202023-02-22%20at%2003.04.45%20PM.png?w=280&maxW=1372&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=8f2c0bff2d85fa72fa65a0007f404712 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202023-02-22%20at%2003.04.45%20PM.png?w=560&maxW=1372&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=c3c19c08db5d4b7ba4878fd6a4f37961 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202023-02-22%20at%2003.04.45%20PM.png?w=840&maxW=1372&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=50cc3aa22d8d0a1242f3469fa179fc4e 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202023-02-22%20at%2003.04.45%20PM.png?w=1100&maxW=1372&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=2322b5734ad173e69ccf64535d6995c5 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202023-02-22%20at%2003.04.45%20PM.png?w=1650&maxW=1372&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=00b1565c40429ef5c5cadfe3edfaf58e 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202023-02-22%20at%2003.04.45%20PM.png?w=2500&maxW=1372&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=7fbd3b29508533a172cade687512be2d 2500w" data-optimize="true" data-opv="2" />
</Frame>

The fields shown in the field selection menu are based on the [User Metadata](../apis/users#associate-connected-user-with-metadata) for the Test User, which you can update by clicking "Set User Metadata" at the bottom of the menu.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(35).png?maxW=1112&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=398843c0fb9260c1094b02c5ea2bb28b" alt="" width="1112" height="884" data-path="assets/image (35).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(35).png?w=280&maxW=1112&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=5cb6134be8408af806e6935a51408201 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(35).png?w=560&maxW=1112&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6af8af25e77c3dd253852ce56d995a08 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(35).png?w=840&maxW=1112&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=0333115658aacc78ecb7c280b4471e93 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(35).png?w=1100&maxW=1112&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=f05fe02a268600c022c7b76f0d2d2830 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(35).png?w=1650&maxW=1112&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=42e13659c6c801bb6b65d845aa24e1b2 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(35).png?w=2500&maxW=1112&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=1d99ba5c8a48a6e19338c169f01b6e65 2500w" data-optimize="true" data-opv="2" />
</Frame>

Finally, click **Save** to update the permissions for this workflow.

<Note>
  **Note:** If the workflow has already been enabled for existing users prior to this change, it will automatically be disabled if their metadata does not match the saved permissions.
</Note>

## How Workflow Permissions are applied

If a Connected User does not satisfy the Workflow Permissions with the [User Metadata](/apis/users#associate-connected-user-with-metadata) associated with them, the workflow:

* Will not appear in the Connect Portal for this user
* Cannot be enabled for this user using the [Users API](/apis/users), [Connected Users Dashboard](/monitoring/users), or [by default](./displaying-workflows#default-to-enabled)
* Cannot be triggered or executed for this user

Workflow Permissions are re-evaluated whenever the conditions change for the workflow *or* when the metadata for the user has changed.


# Custom Dropdowns
Source: https://docs.useparagon.com/connect-portal/workflow-user-settings/custom-dropdowns

Provide your users with dropdown options from your application.

### Overview

Custom Dropdowns allow you to include custom dropdown inputs in the Connect Portal as a part of the User Settings of your integration.

You can use Custom Dropdowns to allow your users to select:

* Data from your app, like a destination Project to sync Jira tickets into
* A type of User Setting that Paragon does not support natively, like a custom Salesforce enum.

### Usage

To get started with Custom Dropdowns, visit your User Settings and add a new type of **Custom Dropdown:**

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customize%20Connect%20Portal%20-%20User%20config%20-%20Edit%20field.png?maxW=2400&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ab9a5fedf3d6c339050d8c59ff0de53c" width="2400" height="1800" data-path="assets/Customize Connect Portal - User config - Edit field.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customize%20Connect%20Portal%20-%20User%20config%20-%20Edit%20field.png?w=280&maxW=2400&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6756be4f557d603046b3b9c7de01f8a0 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customize%20Connect%20Portal%20-%20User%20config%20-%20Edit%20field.png?w=560&maxW=2400&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=34899e14534f1be87716b52538e047d2 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customize%20Connect%20Portal%20-%20User%20config%20-%20Edit%20field.png?w=840&maxW=2400&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=91a781239418e72a45156f4f5cf3d9f3 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customize%20Connect%20Portal%20-%20User%20config%20-%20Edit%20field.png?w=1100&maxW=2400&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=54c795bdbd16757c2e269833b22d97de 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customize%20Connect%20Portal%20-%20User%20config%20-%20Edit%20field.png?w=1650&maxW=2400&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=8f93b056f6508410ef62012c815b5e65 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customize%20Connect%20Portal%20-%20User%20config%20-%20Edit%20field.png?w=2500&maxW=2400&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=45f78dc35af4eb515b7beb88e39dd1ef 2500w" data-optimize="true" data-opv="2" />
</Frame>

Set a key name to refer to the dropdown when populating its available options.

After setting a key name, an example of the code you need to call from your application to populate the dropdown will appear in the dashboard:

```js
paragon.connect("jira", {
  dropdowns: {
    team: [
      { label: "Team 1", value: "team-1" },
      { label: "Team 2", value: "team-2" },
    ],
  },
});
```

Update your `paragon.connect` call to include the `dropdowns` parameter, which has the key names that you set above. This key can be set to an array of options with two keys:

* `label` — The displayed text shown to the user for the dropdown option.
* `value` — The value that will be saved (e.g. an option ID) when the user selects this dropdown option.
  * This value must be unique across all options in the array. If the value is found to be non-unique, the non-unique option will not be displayed in the list, and a console warning will appear.
  * If either `label` or `value` are missing, the option will not be displayed, and a console warning will appear.

When reading the selection for this User Setting from the SDK or the Workflow Editor, the value will be set to the `value` property of the chosen option (or undefined if unselected).

### Loading a large number of options

If your dropdown data is a large data set, consider defining pagination and search instead of passing a static list.

Here is an example of a `loadOptions` function to paginate over a user's Google Drive folders:

```javascript JavaScript
paragon.connect("googledrive", {
  dropdowns: {
    drivefolder: {
      loadOptions: async (cursor, search) => {
        try {
          const encodedQuery = encodeURIComponent(
            `mimeType='application/vnd.google-apps.folder'${
              search ? ` and name contains '${search}'` : ""
            }`
          );
          const foldersUrl = `https://www.googleapis.com/drive/v3/files?q=${encodedQuery}&fields=nextPageToken,files(id,name)&supportsAllDrives=true&includeItemsFromAllDrives=true&pageSize=50${
            cursor ? `&pageToken=${cursor}` : ""
          }`;

          const foldersResponse = await paragon.request("googledrive", foldersUrl, { method: "GET" });

          const folders = foldersResponse.files.map((folder) => ({
            label: folder.name,
            value: folder.id,
          }));

          return {
            options: folders,
            nextPageCursor: foldersResponse.nextPageToken,
          };
        } catch (err) {
          console.error("Error fetching Drive options", err);
        }
      },
    },
  },
});
```

When you provide an object that includes the `loadOptions` function instead of a static list, the dropdown will paginate through options as the user scrolls and allow for remote search across all available data.

`loadOptions` will be called with 2 arguments:

* `cursor`: The last cursor to be called by the dropdown. If loading for the first time, this value will be undefined.
* `search`: The search term that the user typed into the dropdown. If no search term was provided, this value will be undefined or the empty string (`""`).


# User Settings
Source: https://docs.useparagon.com/connect-portal/workflow-user-settings/workflow-user-settings

Provide settings in the Connect Portal to allow your users to configure their integration and workflows.

**User Settings** provide options for your users to configure settings for their integration in the Connect Portal. This makes it easy for you to create integrations that work with custom objects or fields that may be specific to your users' third-party app accounts.

For example, common use cases include:

* **Slack** - choosing which channel that messages should be sent in
* **Salesforce** - choosing a custom opportunity stage that new opportunities created in
* **Hubspot** - choosing a custom lead status that new leads should be created with
* **Jira** - choosing which Jira user that new issues should be assigned to

User Settings can be defined globally at the integration level or locally at the workflow level.

* If they are included at the integration level, the User Settings can be referenced from any workflow for that integration.
* If they are included at the workflow level, the User Settings will appear when that workflow is enabled by your user and can only be referenced from the workflow it belongs to.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal.png?maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=09df45557b4398f417de4291501847a5" alt="" width="1366" height="1126" data-path="assets/Paragon Connect Portal.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal.png?w=280&maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=af332ad458c6ca7bc370c2e1fc6b47ca 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal.png?w=560&maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=4ffa8b953b0472b58afa12343f545e81 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal.png?w=840&maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=059874c7ba230ec41f1ed12a28174fb1 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal.png?w=1100&maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=74cc15c0bb71322ba77268a377c43fee 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal.png?w=1650&maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=b682545e8c7f0eaf5f4cac92fad3d1c6 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal.png?w=2500&maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=34894cb36057abfdcc5e982e731623c3 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Adding User Settings

To add User Settings at the integration level:

1. Click **Customize Connect Portal** in any integration's Overview page to open the Connect Portal Editor.
2. Click the **Configuration** tab in the sidebar.
3. Under **Settings** in the sidebar, click **+ Add Setting.**
4. Enter options for Name, Field Type, Tooltip, and whether or not the field should be required for your user to enable the integration.

To add User Settings at the workflow level:

1. Click **Customize Connect Portal** in any integration's Overview page to open the Connect Portal Editor.
2. Click the **Configuration** tab in the sidebar.
3. Click on the workflow you'd like to add User Settings to.
4. Under **User Settings** in the sidebar, click **+ Add Setting.**
5. Enter options for Name, Field Type, Tooltip, and whether or not the field should be required for your user to enable the integration.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2011.18.58%20AM.png?maxW=982&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=5353686d726e5d16b3402d5e59a62b95" alt="" width="982" height="1174" data-path="assets/Image 2021-02-16 at 11.18.58 AM.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2011.18.58%20AM.png?w=280&maxW=982&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=d499cd74ebd61ef6774e550e53df8ba7 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2011.18.58%20AM.png?w=560&maxW=982&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=6b5b36919d4d3556f75c4612f3eb8dc0 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2011.18.58%20AM.png?w=840&maxW=982&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=3db4cf44cfa1226a838af16f9b1e0123 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2011.18.58%20AM.png?w=1100&maxW=982&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1a9aa248ad2551acac2d9e7b8759e937 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2011.18.58%20AM.png?w=1650&maxW=982&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=5c745c324ded69217115b7058069b2af 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2011.18.58%20AM.png?w=2500&maxW=982&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=65a4b12c7f05ea711c6091612d18f410 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Referencing User Settings in the Workflow Editor

Actions in Paragon will indicate when they accept User Settings as an input parameter. In these cases, you should first add the respective User Settings in the Connect Portal Editor, then use the **variable menu** to reference that User Setting in the Action sidebar.

<Info>
  Enter two left curly braces `{{` to open the **dynamic** **variable menu.**
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording%202021-02-16%20at%2011.26.38%20AM.gif?maxW=1203&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c76e4c6881b0ad28a3416205765522e5" alt="" width="1203" height="799" data-path="assets/Screen Recording 2021-02-16 at 11.26.38 AM.gif" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording%202021-02-16%20at%2011.26.38%20AM.gif?w=280&maxW=1203&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=5561421ce7ef6eec35ae5f0af443a5c3 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording%202021-02-16%20at%2011.26.38%20AM.gif?w=560&maxW=1203&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=2b52688e942e415ba7872442ada32f76 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording%202021-02-16%20at%2011.26.38%20AM.gif?w=840&maxW=1203&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=9f286fe5fc4d7c4523cb8010b6a3dab3 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording%202021-02-16%20at%2011.26.38%20AM.gif?w=1100&maxW=1203&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a68fcf2f2f533def0e9adc02ab6aad99 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording%202021-02-16%20at%2011.26.38%20AM.gif?w=1650&maxW=1203&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=255cbd065d2c682e33d87b3811a9e20a 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording%202021-02-16%20at%2011.26.38%20AM.gif?w=2500&maxW=1203&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ab19319f37e3bdfdf2f9cedd349b9d2f 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Testing User Settings

To test your Workflow User Settings, open the click the **Preview** button in the top-right of the navigation bar. This launches a live preview where you can test the end-user experience of your Connect Portal.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2012.55.55%20PM%20(1).png?maxW=1916&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=a69e6b71cecbcd15761da19794fbce8b" alt="" width="1916" height="1536" data-path="assets/Image 2021-02-16 at 12.55.55 PM (1).png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2012.55.55%20PM%20(1).png?w=280&maxW=1916&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1f97d628932e3158418db8c02cdc64d2 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2012.55.55%20PM%20(1).png?w=560&maxW=1916&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=d80534f285ad04332f8d35d3edff710d 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2012.55.55%20PM%20(1).png?w=840&maxW=1916&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=5e06bf7c2f91ee371a649817fc5ad7d9 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2012.55.55%20PM%20(1).png?w=1100&maxW=1916&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=09432fdd85d2878756f741e59dfdab08 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2012.55.55%20PM%20(1).png?w=1650&maxW=1916&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=37d779a5fc95edeae1df61950feba155 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Image%202021-02-16%20at%2012.55.55%20PM%20(1).png?w=2500&maxW=1916&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9ce14f01384465dbbe738b9303ec380c 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Connecting a test account

By clicking **Connect** in the Connect Portal Preview, you can connect a test account for that integration and configure any of its Workflow User Settings for that test account.

### Testing workflows with user settings

Once you've enabled an integration in the Connect Portal Preview, you can test its workflows using the **Test Workflow** or **Test Step** button in the Workflow Editor. This will test the workflow on the account that you connected in the Connect Portal Preview, and any User Settings you configured in the Connect Portal Preview will be used as test data.


# Hosted Demo Environment
Source: https://docs.useparagon.com/demo

Start testing your Paragon integrations without embedding our SDK

## Overview

Paragon’s [Demo Environment](https://demo.useparagon.com/demo) is designed to serve as an example implementation of a website with the Paragon SDK embedded in it.

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Paragons%20Hosted%20Demo%20Enviornment%20for%20Paragon%20Connect.png?maxW=2802&auto=format&n=867oBBVpxd2C3zc4&q=85&s=0599210ab3939ff69c58bfcdb7161904" alt="" width="2802" height="1596" data-path="assets/Using Paragons Hosted Demo Enviornment for Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Paragons%20Hosted%20Demo%20Enviornment%20for%20Paragon%20Connect.png?w=280&maxW=2802&auto=format&n=867oBBVpxd2C3zc4&q=85&s=296fd9f08b35288ffb7a82508681d54a 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Paragons%20Hosted%20Demo%20Enviornment%20for%20Paragon%20Connect.png?w=560&maxW=2802&auto=format&n=867oBBVpxd2C3zc4&q=85&s=a938cbb4a121db2bfda6ef00c7e738fe 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Paragons%20Hosted%20Demo%20Enviornment%20for%20Paragon%20Connect.png?w=840&maxW=2802&auto=format&n=867oBBVpxd2C3zc4&q=85&s=b0490e2f5b9ebd65fad4352731042f91 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Paragons%20Hosted%20Demo%20Enviornment%20for%20Paragon%20Connect.png?w=1100&maxW=2802&auto=format&n=867oBBVpxd2C3zc4&q=85&s=85dae0c118404917f02799990bc1aa72 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Paragons%20Hosted%20Demo%20Enviornment%20for%20Paragon%20Connect.png?w=1650&maxW=2802&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9e3d8609beec61d88e681d490ce11ef1 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Paragons%20Hosted%20Demo%20Enviornment%20for%20Paragon%20Connect.png?w=2500&maxW=2802&auto=format&n=867oBBVpxd2C3zc4&q=85&s=57e8b82f76ee510eea03372339129a8a 2500w" data-optimize="true" data-opv="2" />
</Frame>

This allows you to test your workflow logic in a production-like environment without adding more code to your application today.

<Card title="Paragon - Demo Mode" icon="laptop" href="https://demo.useparagon.com/demo" horizontal />

<Accordion title="Testing an On-Premise Instance?">
  Use the Paragon Hosted Demo Environment to test integration logic for on-premise instances by adding the host query parameter with your instance URL:

  `https://demo.useparagon.com/demo?host=``{your_instance_url}`

  Example:

  `https://demo.useparagon.com/demo?host=https://integrations.tasklab.com`
</Accordion>

## Getting Started

To get started:

1. Click “**Open Configuration**”

2. Input your Paragon Project ID. Your Project ID can be found in the URL of your Paragon Dashboard.

3. Input a Signing Key. You can create a Signing Key if you don’t already have one by going to Settings > SDK Setup and select “**Generate a New Signing Key**”.

4. Input a User ID. This is an example id based on a user / company in your application.

Your account will then be connected to the demo and you will be able to view any integrations marked “`Active`” in your Paragon Dashboard.

You can quickly [send data](/workflows/triggers) to Paragon through your browser’s console to test the functionality of sending it from your application. Using [Task History](/monitoring/viewing-task-history), you can verify that your workflows were successfully triggered.

## Testing Workflows

Once you've connected to an integration, you can test any of the workflows for the integration.

### Via SDK

1. In your browser, right-click anywhere on the page and select “**Inspect**” to open the Developer Console.

2. Within the Developer Console, click on the **Console** tab to access the JavaScript console.

3. Copy the SDK call that triggers the desired workflow and paste it into the Console. [View triggers](/workflows/triggers).

4. Press `Enter` to send the SDK call and trigger the workflow.

### Via REST API

1. Navigate to a website or application you can use to test API requests, like Postman.

2. Copy the REST API call that triggers the desired workflow and paste it into the URL input. [View triggers](/workflows/triggers).

3. Use [Paragon's JWT Generator](https://jwt.useparagon.com/) to generate a JWT for the example user / company ID you provided earlier.

4. Under **Authentication**, select **Bearer Token** and paste the created JWT.

5. Press `Send` to send the REST API call and trigger the workflow.

## Validating Executions

After triggering a workflow, you can view your workflow execution in [Task History](/monitoring/viewing-task-history).

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7b8a80c72d6c34a64187ebfd070fc689" alt="" width="3212" height="1128" data-path="assets/Viewing Task History in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=280&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=1df7559bbc63f67a421126484057a7b6 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=560&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=544ece058c61167627944214a787aa64 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=840&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7fb503c79e3d40a800f96ec9393ebe37 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=1100&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=bea92f72acc6685733eec38887b2be0b 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=1650&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=02931ddcb429ad91b3839ea35217785d 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=2500&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=de98f14834fff6de7e9ff595415d0ed4 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Working with Multiple Projects
Source: https://docs.useparagon.com/deploying-integrations/projects

Create unique spaces for different teams to collaborate.

## Overview

Create projects in your Organization. This is great for creating unique spaces for different environments, such as production, staging, and development. Each one has its own workflows and authentication methods so you can test out new changes before going live to your customers.

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Projects%20in%20Paragon%20Connect.png?maxW=2768&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d43d249aef926ba9570fd2aa412560e0" alt="" width="2768" height="1354" data-path="assets/Projects in Paragon Connect.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Projects%20in%20Paragon%20Connect.png?w=280&maxW=2768&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1acc96e2580e8ed125c557567f810bf4 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Projects%20in%20Paragon%20Connect.png?w=560&maxW=2768&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=526407bce0bc1c1024675b2b549eedd6 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Projects%20in%20Paragon%20Connect.png?w=840&maxW=2768&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=23e2349ad60fc2f6f1df945411133769 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Projects%20in%20Paragon%20Connect.png?w=1100&maxW=2768&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3b731c3a2532688d696ed8c4b5b3a8eb 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Projects%20in%20Paragon%20Connect.png?w=1650&maxW=2768&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e5c29e255b07e758915aa2b2c3984e0b 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Projects%20in%20Paragon%20Connect.png?w=2500&maxW=2768&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=64478e72af8be3eee0f16b17ae57f58e 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Info>
  **Looking for **`read-only`** Projects?**

  [Release Environments](/deploying-integrations/release-environments) provides access to `staging` and `production` projects that are `read-only`, allowing you to safely test and deploy changes across your development pipeline.
</Info>

## Creating Projects

To create a new project:

1. Click the Project dropdown in the top-left corner.

2. Click "**+ Create**"

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Projects%20in%20Paragon%20Connect.png?maxW=2088&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=51965f2da67823e3eb74cf109c93f7a2" alt="" width="2088" height="1444" data-path="assets/Creating Projects in Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Projects%20in%20Paragon%20Connect.png?w=280&maxW=2088&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=57d4e1b8134b44f8495fd68ba1e5fc43 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Projects%20in%20Paragon%20Connect.png?w=560&maxW=2088&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=736532fae328515a7cee2566cebe4d64 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Projects%20in%20Paragon%20Connect.png?w=840&maxW=2088&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7cd1475258c31fb7295127d5856bcc09 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Projects%20in%20Paragon%20Connect.png?w=1100&maxW=2088&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=503a0dc290dade1486c4a18af3222aef 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Projects%20in%20Paragon%20Connect.png?w=1650&maxW=2088&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d8972f8619513857787a71d2578f7c4d 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Projects%20in%20Paragon%20Connect.png?w=2500&maxW=2088&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=f640911b08844b074994bed32b2453d8 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Managing Projects

To view and manage projects:

1. Click the Project dropdown in the top-left corner.

2. Click "**Manage projects**".

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20Projects%20in%20Paragon%20Connect.gif?maxW=1695&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=bc2885bedced94426a06c893a92dc5c5" alt="" width="1695" height="772" data-path="assets/Managing Projects in Paragon Connect.gif" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20Projects%20in%20Paragon%20Connect.gif?w=280&maxW=1695&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=2a17fa78b6ffd5042fcc35e7aa605c7f 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20Projects%20in%20Paragon%20Connect.gif?w=560&maxW=1695&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=3ce6135b7340ab7c7a11f7b6a9897d64 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20Projects%20in%20Paragon%20Connect.gif?w=840&maxW=1695&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1f1e4c29ee07597e211c2c9ff5cbfa34 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20Projects%20in%20Paragon%20Connect.gif?w=1100&maxW=1695&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=861f10f14a162c607edba6ec4dec0d52 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20Projects%20in%20Paragon%20Connect.gif?w=1650&maxW=1695&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1e9c6250fb169ebdb973fbce45874ffd 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20Projects%20in%20Paragon%20Connect.gif?w=2500&maxW=1695&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=bfe8dadba42342469d5ef9c89f19d24b 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Deleting Projects

To delete a project:

1. Click the Project dropdown in the top-left corner.

2. Under **Development Projects**, select the triple-dot menu for the Project you want to delete.

3. Click "**Delete project**".

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20Projects%20in%20Paragon%20Connect.png?maxW=2632&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e6db47eb52de7fa4040445befd709676" alt="" width="2632" height="1694" data-path="assets/Deleting Projects in Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20Projects%20in%20Paragon%20Connect.png?w=280&maxW=2632&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=b5d4f843916567cdcac32d44dea9554c 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20Projects%20in%20Paragon%20Connect.png?w=560&maxW=2632&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2ed7a036d089fb9a2f794d9339c8d20a 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20Projects%20in%20Paragon%20Connect.png?w=840&maxW=2632&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=538891f86c1698d1c44069c983982187 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20Projects%20in%20Paragon%20Connect.png?w=1100&maxW=2632&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=1eff10598b895d8aea0ebb5b9e3cbf1f 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20Projects%20in%20Paragon%20Connect.png?w=1650&maxW=2632&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=26653a6de3c04adfc02489c028282996 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20Projects%20in%20Paragon%20Connect.png?w=2500&maxW=2632&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=91f8aa1840ac00c94256206221fa8e10 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Copying Workflows

You can copy workflows between projects by clicking the settings menu inside the Workflow Editor, then selecting **Copy from Project**. When copying from another workflow, your current workflow state will be saved in Version History.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Copying%20workflows%20from%20other%20projects%20in%20Paragon%20Connect.gif?maxW=1325&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=fbd0f997f24dfbf569e83f956d68b4a7" alt="" width="1325" height="800" data-path="assets/Copying workflows from other projects in Paragon Connect.gif" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Copying%20workflows%20from%20other%20projects%20in%20Paragon%20Connect.gif?w=280&maxW=1325&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=eaaba04e8de167dc34eea1315037a69a 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Copying%20workflows%20from%20other%20projects%20in%20Paragon%20Connect.gif?w=560&maxW=1325&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=dc05a442a3a137676bcefd1891cec819 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Copying%20workflows%20from%20other%20projects%20in%20Paragon%20Connect.gif?w=840&maxW=1325&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=9a1c00dfee90fd4c4909e0cc2ce70b7d 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Copying%20workflows%20from%20other%20projects%20in%20Paragon%20Connect.gif?w=1100&maxW=1325&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2e970ad7bc191bda8480e8c1a8a5ee36 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Copying%20workflows%20from%20other%20projects%20in%20Paragon%20Connect.gif?w=1650&maxW=1325&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ade92638114170503c5b892e1500b053 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Copying%20workflows%20from%20other%20projects%20in%20Paragon%20Connect.gif?w=2500&maxW=1325&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=c7f18f0f640879a181af411eb059cd2a 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Release Environments
Source: https://docs.useparagon.com/deploying-integrations/release-environments

Use Release Environments to test and deploy new integrations and integration updates.

**Release Environments** are environments that your team can use to control the development lifecycle of integrations:

* **Development:** Make updates to your integrations and workflows in a development project that can be modified by any member of your team.
* **Staging:** Preview and test integrations in a read-only environment before deploying to Production.
* **Production**: Deploy integrations and updates to live users.

Each Release Environment is a separate project, with separate IDs, [Signing Keys](/getting-started/installing-the-connect-sdk#setup-with-your-own-authentication-backend), [Environment Secrets](/workflows/environment-secrets), and [Connected Users](/monitoring/users).

<Warning>
  **Note:** Release environments share the same underlying resources, such as servers and databases. Resource-intensive actions—like running heavy workflows or load testing—can impact the performance of other environments.
</Warning>

<Accordion title="Have an existing account without Release Environments?">
  If your account does not already have Release Environments enabled, follow the steps below to enable the feature.

  * **Note**: You can only set up one set of Release Environments (Development, Staging, Production) for your account. **Your selection is final and cannot be reversed.**

  1. Start by navigating to your Paragon dashboard. At the end of your Integrations list, you will see a prompt to enable Release Environments. Click **Get started**.
     <Frame>
         <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Environments%20upgrade%20prompt.png?maxW=2504&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c1a07c1542efaf0b53de06fec12c0d61" alt="" width="2504" height="552" data-path="assets/Release Environments upgrade prompt.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Environments%20upgrade%20prompt.png?w=280&maxW=2504&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=93c0e9a3c2ede9715d5d341988bac689 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Environments%20upgrade%20prompt.png?w=560&maxW=2504&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=7fead57c60b5c7526a86279f730c429b 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Environments%20upgrade%20prompt.png?w=840&maxW=2504&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8758c34e3701e62feb7328af1e0ccaa6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Environments%20upgrade%20prompt.png?w=1100&maxW=2504&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=64db683f3bc86238f9cf2387208b13a9 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Environments%20upgrade%20prompt.png?w=1650&maxW=2504&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=9644fc471276ca631cbe570ed7274f10 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Environments%20upgrade%20prompt.png?w=2500&maxW=2504&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=0bb33549e381569a46377d4bec5ea574 2500w" data-optimize="true" data-opv="2" />
     </Frame>
  2. You will be prompted to select the project that represents your Production Environment.

     <Frame>
       <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Onboarding.png?maxW=1290&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3a4004c8a0d2bb7fb717a0e425bcb621" alt="" width="1290" height="1170" data-path="assets/Release Onboarding.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Onboarding.png?w=280&maxW=1290&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3315c9578ae7499cb8cb151826127d7a 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Onboarding.png?w=560&maxW=1290&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8245918636e075ed95d4bdd088c60039 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Onboarding.png?w=840&maxW=1290&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c0e16eeff9afa4fae2f31c0b1c918e0b 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Onboarding.png?w=1100&maxW=1290&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=2f32538b5fcdde2e3d1bd998bf04b7e4 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Onboarding.png?w=1650&maxW=1290&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=827743c6409db9f40ef2aadfcf59a6be 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20Onboarding.png?w=2500&maxW=1290&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a44cb0f416ead060377d57c0847d0b1d 2500w" data-optimize="true" data-opv="2" />
     </Frame>

     **Once you make this selection:**

     1. **The selected project will become read-only** (meaning that Integrations, Workflows, and App Events cannot be modified directly). To update a Production Environment, you will need to create a Versioned Release.

     2. **Development and Staging environments will be automatically created**. If you have existing projects used for Staging or Development, these projects will still be available and unchanged, but they will not participate in the release pipeline.
</Accordion>

## Usage

With Release Environments, your team's integration development will start in the Development environment. Workflows and integrations in the Development environment can be added and modified directly.

Once your team is ready to start testing the changes made in Development, you can create a Release from **Development -> Staging** to validate your changes. Staging can be used for code review and QA, prior to releasing changes to users in your Production environment.

Finally, once your changes have been finalized in the Staging environment, you can create a Release from **Staging -> Production** to deploy your changes to live users.

<Info>
  **Working with a large team?**

  Multiple team members can work together in the Development environment, or they can opt to create an isolated [Development Project](/deploying-integrations/projects) to start working on new changes.

  Development Projects cannot be involved in the Releases pipeline, but you can use our [Copying Workflows](/deploying-integrations/projects#copying-workflows) feature to replicate changes from Development Projects into Development.
</Info>

## Creating a Release

To start a new Release, you can click the Environment Selection menu in the top navigation bar and click **Deploy** on the environment you want to promote.

<Info>
  When hovering over the **Deploy** button, a path will appear between the Release Environments that you are deploying to and from.
</Info>

<Frame>
  <iframe src="https://share.descript.com/embed/IY6Zaq25Y6K" width="640" height="360" frameborder="0" allowfullscreen />
</Frame>

Creating a Release brings you to an undeployed Release Preview. An undeployed Release will show the following banner:

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(87).png?maxW=2835&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=814d5215b14ffb1400447c6b9b8dd55f" alt="" width="2835" height="906" data-path="assets/image (87).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(87).png?w=280&maxW=2835&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=c886d8eafb564cd1f1a0ccf4865fcc4e 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(87).png?w=560&maxW=2835&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=dd2dadbbb506abff85a0896864b652d2 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(87).png?w=840&maxW=2835&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=2566c60617f02e292e7198caca9ff934 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(87).png?w=1100&maxW=2835&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=80c1b63b5cff2a01c830fea14a43fdcf 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(87).png?w=1650&maxW=2835&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=f29b8c601b8a466e1ed4f0a10d001ec5 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(87).png?w=2500&maxW=2835&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=b6429956ca84283419e107129b751598 2500w" data-optimize="true" data-opv="2" />
</Frame>

In a Release Preview, you will see two columns:

* **Change Summary:** A summary of changes made to Integrations, Workflows, and App Events since the last deploy that occurred. Each change will have a type: Add, Modify, or Remove.
* **Messages:** Warning and informational messages about potential issues with or effects of the Release.

  * For example, if there are new [Environment Secrets](/workflows/environment-secrets) being used in the downstream environment (Development) that are not present in the upstream environment (Staging), a prompt will appear to provide a value for the new Environment Secret.
  * Learn more about Messages in [Reviewing Messages](/deploying-integrations/release-environments#reviewing-messages).

Your engineering team can use the Release Preview screen to verify the changes that will be deployed to the next stage of your development pipeline.

If there are unexpected changes present in the Release Preview, you can make changes in the downstream project to prevent unintended updates.

### Reviewing Messages

Messages appear when Paragon detects potential issues or side effects of deploying the set of changes associated with a Release.

Documentation for each type of Message can be found below:

* **indicates an Error Message**. Error Messages appear *after* a Release has been deployed, if any unexpected failures occurred during the deployment.

  <Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Error%20(1).png?maxW=36&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=6e19cd8b1d89250fa8b39f02e9339c76" alt="" width="36" height="39" data-path="assets/Error (1).png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Error%20(1).png?w=280&maxW=36&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=22c7b98f7064565fb4e2a4be256053a8 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Error%20(1).png?w=560&maxW=36&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=141b28453028bd96ce19cd28bb4571b8 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Error%20(1).png?w=840&maxW=36&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=cc59c2f3dd2f76857fa9fb5d2b6af625 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Error%20(1).png?w=1100&maxW=36&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=ca65b285ddfd8e88ef67ba3f358f3fe0 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Error%20(1).png?w=1650&maxW=36&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=6c237da44eb49ec8456bc09228eef503 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Error%20(1).png?w=2500&maxW=36&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=cc989787bdc7d14656e940d4974084a8 2500w" data-optimize="true" data-opv="2" />
  </Frame>

* **indicates a Warning Message**, which requires action to resolve prior to deploying a Release. If Warning Messages are not addressed, integrations may not work as expected.

  <Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Warn.png?maxW=48&auto=format&n=867oBBVpxd2C3zc4&q=85&s=e65d2ee737ea21453185647c17e23179" alt="1" width="48" height="39" data-path="assets/Warn.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Warn.png?w=280&maxW=48&auto=format&n=867oBBVpxd2C3zc4&q=85&s=68d95cb7df11eeeade9148d57b9eb411 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Warn.png?w=560&maxW=48&auto=format&n=867oBBVpxd2C3zc4&q=85&s=f5019ba4590401866a32d98a692bb235 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Warn.png?w=840&maxW=48&auto=format&n=867oBBVpxd2C3zc4&q=85&s=f76e701af113646c80e091c07c1dd1f9 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Warn.png?w=1100&maxW=48&auto=format&n=867oBBVpxd2C3zc4&q=85&s=364a7ece674ef847c2b124152f8136e3 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Warn.png?w=1650&maxW=48&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9630fe0302f11127aa471e88ef09b958 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Warn.png?w=2500&maxW=48&auto=format&n=867oBBVpxd2C3zc4&q=85&s=dbbdd440905744f56637cbaa574426b2 2500w" data-optimize="true" data-opv="2" />
  </Frame>

* **indicates an Informational Message**, which informs you of any changes that have occurred that will affect existing users of your integration.

  <Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Info@3x.png?maxW=36&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c864ddce33a714ba23074cf5a197b832" alt="2" width="36" height="36" data-path="assets/Info@3x.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Info@3x.png?w=280&maxW=36&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1c94cc7d79c95eeac05b3acc56e9a55c 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Info@3x.png?w=560&maxW=36&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=d2caa7a3b06a992fd89ea1ee0833dbf3 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Info@3x.png?w=840&maxW=36&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=3879525ec7d60df63b391eb305934aa2 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Info@3x.png?w=1100&maxW=36&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c49bd928fa6d819a4b82c8e33026e98f 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Info@3x.png?w=1650&maxW=36&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=ba6e426dd3a00d581a6220f3b1c3c958 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Info@3x.png?w=2500&maxW=36&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=3ba827ee05363d3a2c1d7caa3aa7b026 2500w" data-optimize="true" data-opv="2" />
  </Frame>

<AccordionGroup>
  <Accordion title="New Integration Requires Additional App Configuration" icon="exclamation">
    This warning appears when you have added a new integration that uses OAuth to authenticate users.

    You can resolve this warning by providing the App Configuration that is required to deploy this integration to users, such as a **Client ID and Client Secret** (required configuration will vary by integration).
  </Accordion>

  <Accordion title="Environment Secret Missing" icon="exclamation">
    This warning appears when the Release Environment you are deploying to is missing an Environment Secret that is used in the downstream environment.

    You can resolve this warning by providing a value for the Environment Secret as it should be saved in the upstream environment.
  </Accordion>

  <Accordion title="App Event Schema Changed" icon="info">
    This message appears when you have modified the schema of your App Event.

    When modifying the schema of an App Event, you will need to update references to this event in your application source code to use the new event schema.
  </Accordion>

  <Accordion title="App Event Removed" icon="info">
    This message appears when you have removed an App Event.

    You will need to remove references to this event in your application source code. If an invalid App Event name is sent to the API, an error response will be sent back.
  </Accordion>

  <Accordion title="OAuth App Scopes Changed" icon="info">
    *Note: This Release Message is currently in beta.*

    This message appears when the Release includes changes to the scopes requested by the OAuth App for a particular integration.

    If any workflows use logic that requires the new scopes, you will need to prompt current integration users to re-authorize their account (disconnect the integration from the Connect Portal and reconnect an account).

    This message allows you to view and export Affected Users for this change.
  </Accordion>

  <Accordion title="Integration Removed" icon="info">
    This message appears when you have removed an Integration.

    When an Integration is removed, all connected accounts and workflows associated with this integration will be deleted.
  </Accordion>

  <Accordion title="Integration Disabled" icon="info">
    This message appears when you have disabled an Integration in a downstream environment.

    When an Integration is disabled, all connected accounts and workflows associated with this integration will be paused until the integration is re-enabled.
  </Accordion>

  <Accordion title="Required User Setting Added" icon="info">
    This message appears when you have added a [User Setting](/connect-portal/workflow-user-settings) that is marked as required in the Connect Portal options for an integration.

    If any workflows rely on this User Setting, you will need to prompt current integration users to revisit the Connect Portal to set a value for the new required User Setting.

    This message allows you to view and export Affected Users for this change.
  </Accordion>

  <Accordion title="Workflow Enabled by Default" icon="info">
    This message appears when you have added or modified a Workflow to be [enabled by default](/connect-portal/displaying-workflows#default-to-enabled).

    When this Release is deployed, Paragon will attempt to enable the default-enabled workflow for all Connected Users of the associated integration.

    This message allows you to view and export Affected Users for this change.
  </Accordion>

  <Accordion title="Workflow Changed Trigger Type" icon="info">
    This message appears when you have changed the Trigger type for a Workflow.

    When this Release is deployed, Paragon will attempt to create the trigger on behalf of all Connected Users that have enabled this Workflow. For example, if the Trigger has changed from a Request Trigger to a Record Created Trigger, Paragon will need to create a new webhook for your Connected Users to enable the workflow.

    This message allows you to view and export Affected Users for this change.
  </Accordion>
</AccordionGroup>

## Deploying a Release

When you are ready to deploy a Release, click **Deploy** in the Release Preview screen. A prompt will appear to specify:

* **Version Number**: Using semantic versioning, provide a version number to represent this Release. The new version number must be higher than the currently deployed version number.
* **Description**: Describe the Release with a message summarizing changes, for internal reference.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(88).png?maxW=2817&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=73321be295dd8c55ce24eb33a7ba73d5" alt="" width="2817" height="1876" data-path="assets/image (88).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(88).png?w=280&maxW=2817&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=a62200290128d5db57e25df2b5a8c6f7 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(88).png?w=560&maxW=2817&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=4967c9923093c604b9751f8db0fcf559 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(88).png?w=840&maxW=2817&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=601e72ed0ab16d525339a831e7909fee 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(88).png?w=1100&maxW=2817&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=38db6ac47b4229d12d57d95cfa717aa9 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(88).png?w=1650&maxW=2817&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=be4af06fb0e2f40993aa1105f79ee61e 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(88).png?w=2500&maxW=2817&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=f56e7d1b91c6293948b4c144d61ba1f4 2500w" data-optimize="true" data-opv="2" />
</Frame>

Click **Deploy** in the Release confirmation dialog to start the deployment process. The deployment process may take several minutes to complete, depending on the size of the changes.

Once the deployment has completed, the Release screen will update with the **Live** tag, and the version number will update in the Manage Projects screen.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Live%20Release.png?maxW=2730&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=29b14957a9f45def9e2654fae2ecc103" alt="" width="2730" height="436" data-path="assets/Live Release.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Live%20Release.png?w=280&maxW=2730&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9ccfcdceafee9d86b59732de35d21f45 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Live%20Release.png?w=560&maxW=2730&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=a02a146cbd78cd6fb00a38bc3f366a45 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Live%20Release.png?w=840&maxW=2730&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=8b371f560717ea1d5a47cf24b260290e 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Live%20Release.png?w=1100&maxW=2730&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=ce6a022663614c1a0cc1ffb9d28e29f4 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Live%20Release.png?w=1650&maxW=2730&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=779e9d5db6d781a77b4840fc437a4b7c 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Live%20Release.png?w=2500&maxW=2730&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=53ddba62c780de0b7ead08cc90c293d3 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Viewing Release History

You can review past Releases in the Staging and Production environments, by clicking the Releases tab in the left sidebar.

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20History.png?maxW=2736&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=45d055dc71f977ec4e1f6155c69ea801" alt="" width="2736" height="808" data-path="assets/Release History.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20History.png?w=280&maxW=2736&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e185b5fea051eaeaf58cca16f858a19a 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20History.png?w=560&maxW=2736&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=0904a2a1e6cee17776a9ecf891737f40 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20History.png?w=840&maxW=2736&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=afa5246791e3a655834a2d550a729ee5 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20History.png?w=1100&maxW=2736&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f10a74c34a8d3fa1ce06858812974870 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20History.png?w=1650&maxW=2736&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=86ae93ff40aaa3c85e9c7cf73d3a5399 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Release%20History.png?w=2500&maxW=2736&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1bebb796f0806babe7a0e1d43c76bc3b 2500w" data-optimize="true" data-opv="2" />
</Frame>

Click into any row in the Releases table to view the Release Summary screen, which provides the Change Summary and Messages that were associated with that Release.


# Quickstart Sample App
Source: https://docs.useparagon.com/external-link-1





# Workflow Templates
Source: https://docs.useparagon.com/external-link-4





# Paragon MCP Server
Source: https://docs.useparagon.com/external-link-5





# Adding Integrations
Source: https://docs.useparagon.com/getting-started/adding-an-integration



### Choose an Integration

In your Paragon Connect dashboard, click on **Catalog** in the sidebar menu and select the integration provider you want to add.

To add an integration to your dashboard, select the integration and click **"Connect"**.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20an%20Integration%20from%20the%20Integration%20Catalog%20in%20Paragon%20Connect.png?maxW=2432&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=966e0b49ea7de2c2e27501cbc4954f75" alt="" width="2432" height="1468" data-path="assets/Adding an Integration from the Integration Catalog in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20an%20Integration%20from%20the%20Integration%20Catalog%20in%20Paragon%20Connect.png?w=280&maxW=2432&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=61c600c75733639614ff32ca5737f17b 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20an%20Integration%20from%20the%20Integration%20Catalog%20in%20Paragon%20Connect.png?w=560&maxW=2432&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=32809371496a1785674016ce1444cb58 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20an%20Integration%20from%20the%20Integration%20Catalog%20in%20Paragon%20Connect.png?w=840&maxW=2432&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=e51f575509bb54db728be1a5a5502bee 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20an%20Integration%20from%20the%20Integration%20Catalog%20in%20Paragon%20Connect.png?w=1100&maxW=2432&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a6df611e4400c72ae8522c3da696916c 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20an%20Integration%20from%20the%20Integration%20Catalog%20in%20Paragon%20Connect.png?w=1650&maxW=2432&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3c490c9edbad141b4170f2498b42d343 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20an%20Integration%20from%20the%20Integration%20Catalog%20in%20Paragon%20Connect.png?w=2500&maxW=2432&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=5997d6ae27a8cb92f36f49b8bd176519 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Create a developer app

Once you add an integration from our [Integration Catalog](/resources/integrations), you'll need to register a developer app with the integration provider.

When you create your developer app, you'll receive app credentials - usually a Client ID and Secret - that you'll enter in your Paragon dashboard in the next step.

You'll need to specify a redirect URL (sometimes called "callback URL") when configuring your developer app for an integration provider. Here, you should provide Paragon's redirect URL:

```js
https://passport.useparagon.com/oauth
```

<Note>
  You can find provider-specific instructions for setting up a developer app and connecting it to Paragon in the [Integration Providers section](/resources/integrations) of our docs.
</Note>

### Connect your developer app to Paragon

Open your integration from the Paragon dashboard.

Under App Configuration, click **Configure** to add your own OAuth app credentials. *If you don't see this section, this integration may not support OAuth, and you can skip this step.*

Next, enter your OAuth app credentials - usually a Client ID and Secret.

<Note>
  You can add an integration using Paragon's development keys by leaving the app credentials blank. This should only be used for testing, and you should add your own app credentials for use in production.
</Note>

Once you've added your OAuth app credentials, press the "Save Changes" button to save your updates.

<Frame>
  <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2007.58.47%20AM@2x.png?maxW=2828&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=7603731ac4e5bb56725c5b9d7ef32ae4" alt="" width="2828" height="2112" data-path="assets/[Paragon] 2025-02-18 at 07.58.47 AM@2x.png" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2007.58.47%20AM@2x.png?w=280&maxW=2828&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=c1357abb65eb79f259cb49ebbb000743 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2007.58.47%20AM@2x.png?w=560&maxW=2828&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=66bd651dc0d5e8c06862673920350ce2 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2007.58.47%20AM@2x.png?w=840&maxW=2828&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=0ec6552a28da39d7fe8f1616a3f03989 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2007.58.47%20AM@2x.png?w=1100&maxW=2828&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=60b8a39b78fe38ed5a5fb159daf576f9 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2007.58.47%20AM@2x.png?w=1650&maxW=2828&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=2d471be74ba0678499efb5a66f5df60b 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2007.58.47%20AM@2x.png?w=2500&maxW=2828&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=67bf12401c96efbbbadd6f0e008f1084 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Configure Permissions

Once you add integration credentials, you can define which permission scopes will be requested from your users under Integration Settings. You'll usually need to make sure the same scopes are defined when configuring your developer app from the third-party app provider.

<Frame>
  <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.01%20AM@2x.png?maxW=1622&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=ea8fb956785432da717dfc3b50f4c24f" alt="" width="1622" height="1412" data-path="assets/[Paragon] 2025-02-18 at 08.00.01 AM@2x.png" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.01%20AM@2x.png?w=280&maxW=1622&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=53f84b0d78664e709d49f871ec6c4380 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.01%20AM@2x.png?w=560&maxW=1622&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=138767d88f5afa606e03103e1ee6985c 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.01%20AM@2x.png?w=840&maxW=1622&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=0c8c941d3ea78b46fe947137729b57ed 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.01%20AM@2x.png?w=1100&maxW=1622&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=ea871f2d9df071a137dbc12eac011a80 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.01%20AM@2x.png?w=1650&maxW=1622&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=539daff25895e3ef0ee3a01e4307ece8 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.01%20AM@2x.png?w=2500&maxW=1622&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d85a9e7569caff8d9a4bb0b775e70b60 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Displaying the Connect Portal
Source: https://docs.useparagon.com/getting-started/displaying-the-connect-portal

Connect to your users' app accounts with the Connect Portal

Once an integration has been added to the Paragon dashboard, you can now display the Connect Portal for that integration in your application. The **Connect Portal** is a component that your users interact with to connect their third-party app accounts to your application. The Connect Portal provides a **fully managed authentication** so you don't need to worry about managing, storing, or refreshing your customers' credentials.

## Activating the Integration

You'll need to mark your integration as **Active** for it to display to your end users.

To do this, click the "Inactive" button in the top-right corner and press "Activate".

<Frame>
  <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.45%20AM.gif?maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=5d036e5136f46f5ee407fb75c3ff4b1a" alt="" width="800" height="516" data-path="assets/[Paragon] 2025-02-18 at 08.00.45 AM.gif" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.45%20AM.gif?w=280&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=132573f0016c9adedf3d5270045c818d 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.45%20AM.gif?w=560&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=2c4bcc4aaf7e7a3b1e02d5064417c4ce 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.45%20AM.gif?w=840&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=6a94743533bb49640c32381159bef9d7 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.45%20AM.gif?w=1100&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=2b1dbfbaef3519a6948dd24a7f39c443 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.45%20AM.gif?w=1650&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=352f105723d71e972a49f98936adfd0b 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.00.45%20AM.gif?w=2500&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=215bdada68af52629df8eb8d48cf8f20 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Displaying the Connect Portal in your app

[`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string) should be called at the beginning of your application's lifecycle in all cases. This is to make sure that the `userToken` is always as fresh as possible, with respect to your user's existing session on your own site. You may reference [Installing the Connect SDK](/getting-started/installing-the-connect-sdk#setup) for a detailed explanation on how to use [`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string).

**Example:**

```js
await paragon.authenticate(
	// Your Paragon Project ID
	"38b1f170-0c43-4eae-9a04-ab85325d99f7",

	// See Setup for how to encode your user token
	"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.ey..."
);
```

<Accordion title="How do I find my Project ID?">
  You can copy your Project ID by clicking Copy Project ID under the Environment switcher:

  <Frame>
        <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=b37df23ba6e601c8050b64b4b8c9ffd2" alt="" width="800" height="411" data-path="assets/[Paragon] 2025-02-17 at 10.49.44 PM.gif" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=280&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=8c455cda8182ae718b132f91605ab66d 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=560&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d8269a3bcb11802c13916fa80ba8d60d 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=840&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=74048103991e6f31b8bae1ef2492ac17 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=1100&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d8e3b6984edff98a56d57a4b02480cce 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=1650&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=b1c073034427d24165dbbc0fdf3f0859 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=2500&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d33e7e440d11c010292b163e32f49909 2500w" data-optimize="true" data-opv="2" />
  </Frame>
</Accordion>

Once [`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string) has been called and the Promise it returns has resolved, you can call [`.connect`](/apis/api-reference#connect-integrationtype-string) to launch your Connect Portal for a specific integration provider. You can find the `integrationType` identifier you need in the Overview page for the integration.

**Example:**

```js
paragon.connect("salesforce");
```

You *must* have an integration configured of this `integrationType` for the Portal to appear. Otherwise, this function does nothing.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/The%20Connect%20Portal%20in%20Paragon%20Connect.png?maxW=1836&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=40e248fc1c0172e6b6efaa0403d027ba" alt="" width="1836" height="1224" data-path="assets/The Connect Portal in Paragon Connect.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/The%20Connect%20Portal%20in%20Paragon%20Connect.png?w=280&maxW=1836&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=420914795b44e6643e9c1dc31b65d38a 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/The%20Connect%20Portal%20in%20Paragon%20Connect.png?w=560&maxW=1836&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=c82e349edad0c1d823a6f801a14cd040 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/The%20Connect%20Portal%20in%20Paragon%20Connect.png?w=840&maxW=1836&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=1cd6f4faf7349ab5a64981f5130c25e8 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/The%20Connect%20Portal%20in%20Paragon%20Connect.png?w=1100&maxW=1836&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=16e41a08dcefe4aa7969056ac602522d 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/The%20Connect%20Portal%20in%20Paragon%20Connect.png?w=1650&maxW=1836&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=f215267cc1808e226563dd9349d428e1 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/The%20Connect%20Portal%20in%20Paragon%20Connect.png?w=2500&maxW=1836&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=5c0f3d1706804a5f8fce02f5f233c305 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Authenticating an Account

Your users can connect their third-party app account in the Connect Portal by clicking **"Connect"**. Paragon natively supports all sorts of authentication types, like OAuth 2.0 and API Keys.

<Frame caption="An OAuth 2.0 Integration">
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20OAuth%202.0%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?maxW=2128&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=845fe1e14575cbff4185ada671a049f7" alt="" width="2128" height="1426" data-path="assets/Handling OAuth 2.0 in the Connect Portal in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20OAuth%202.0%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?w=280&maxW=2128&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=4122967cb9fd7242b2d9b3dbda130725 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20OAuth%202.0%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?w=560&maxW=2128&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9969cd404d9e49909bee3755bcb551ad 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20OAuth%202.0%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?w=840&maxW=2128&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=8348c250106303a7cc3d732e6e047c09 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20OAuth%202.0%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?w=1100&maxW=2128&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=2d3b7fa7099c145255b6fe64942b5730 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20OAuth%202.0%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?w=1650&maxW=2128&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=b070a8b07fcc2c5c219c5ae5b56d07dd 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20OAuth%202.0%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?w=2500&maxW=2128&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=fd130eb8ae5748bdfd9b03b061d6c4ef 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Frame caption="An API Key Integration">
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20API%20Keys%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?maxW=1814&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c362b18ea69048de5ced303d7fcb0bb5" alt="" width="1814" height="1180" data-path="assets/Handling API Keys in the Connect Portal in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20API%20Keys%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?w=280&maxW=1814&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=e7b1fed7159126a9e89bea0ab3929bd7 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20API%20Keys%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?w=560&maxW=1814&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7dae86384e356b7e2425543b5508442e 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20API%20Keys%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?w=840&maxW=1814&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=db9df7bc25e8ebd1f16c3b135f8051d5 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20API%20Keys%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?w=1100&maxW=1814&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=bc97096c9488953572723450042be37a 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20API%20Keys%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?w=1650&maxW=1814&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7cf3511b51c35b65db9ea73c6805c25d 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20API%20Keys%20in%20the%20Connect%20Portal%20in%20Paragon%20Connect.png?w=2500&maxW=1814&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=f0cc0700d8fbc23bda311f49b3c9c2d5 2500w" data-optimize="true" data-opv="2" />
</Frame>

Once your user connects their third-party app account in the Connect Portal, you can access their app account by creating [Workflows](/workflows/building-workflows) or via the [Proxy API](/apis/proxy). You can always call [`.getUser`](/apis/api-reference#getuser-paragonuser) to retrieve the currently authenticated user and their connected integration state.


# Installing the SDK
Source: https://docs.useparagon.com/getting-started/installing-the-connect-sdk

The Paragon SDK can be imported in your front-end JavaScript to embed the Connect Portal and trigger workflows in your application.

## Installing from npm

You can install the Paragon SDK with npm:

```bash
npm install @useparagon/connect
```

The SDK can be imported in your client-side JavaScript files as a module:

```js
import { paragon } from '@useparagon/connect';
```

**For** [on-premise](https://github.com/useparagon/docs-gitbook/blob/main/getting-started/broken-reference/README.md)**/single-tenant users:**

If you are using an on-prem/single-tenant instance of Paragon, you can call the `.configureGlobal` function to point the SDK to use the base hostname of your Paragon instance.

```js
import { paragon } from '@useparagon/connect';

// If your login URL is https://dashboard.mycompany.paragon.so:
paragon.configureGlobal({
    host: "mycompany.paragon.so"
});
```

<Accordion title="Migrating from the <script> tag?">
  If you are migrating from using the \<script> tag to the npm package, please note that `paragon` is no longer exposed as a global or on the `window` object by default.

  Any references to `paragon` or `window.paragon` must be updated to point to the package import:

  ```js
  + import { paragon } from '@useparagon/connect';

  - window.paragon.authenticate(...);
  + paragon.authenticate(...);
  ```
</Accordion>

## Setup

Before using the Paragon SDK, you'll need to set up your application to verify the identity of your users to the SDK.

Paragon verifies the identity of your users using the authentication system *you're already using,* including managed services like Firebase or Auth0. Some backend code may be required if your application implements its own sign-in and registration.

### Generating tokens with your backend

If your backend server will generate JWTs for Paragon, you'll first need to complete the following steps:

#### 1. Generate a Paragon Signing Key

To generate a Signing Key, go to **Settings > SDK Setup** in your Paragon dashboard. You should store this key in an environment secrets file. For security reasons, we don’t store your Private Key and cannot show it to you again, so we recommend you download the key and store it someplace secure.

A unique Signing Key is generated for each environment. To learn more about the environments supported by Paragon, visit our [Releases](/deploying-integrations/release-environments) documentation.

<Note>
  **Note**: Signing keys never expire. However, generating a new signing key for the same environment will automatically invalidate the previous one.
</Note>

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=b9198527baecec974360d598a5979d53" alt="" width="3238" height="1364" data-path="assets/Choosing an authentication method in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?w=280&maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=85fc05cb65a4543a003685f759fce7e8 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?w=560&maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=b63d56cf073b6b9a507965b6b71dae49 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?w=840&maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=4990b700bb1b7560cd2f0d42c97e40fb 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?w=1100&maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3dd8ac91fceff07d3c13e9d64eb1b5df 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?w=1650&maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=bcd81ac01f24a77d7973be14fe7e21e0 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?w=2500&maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=73409abcc2be560947196aeb23f19799 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### 2. Generate a Paragon User Token

Next, you'll need to generate a Paragon User Token for each of your authenticated users. To do this, you'll need a library in your target language to sign JWTs with RS256. You can find one in your language at [https://jwt.io/](https://jwt.io/).

If your application is a fully client-rendered single-page app, you may have to create and use an additional API endpoint to retrieve a signed JWT (or reuse an existing endpoint that handles authentication or user info).

The signed JWT/Paragon User Token minimally must include the `sub`, `iat`, and `exp` claims:

```js JavaScript
{
	// Uniquely identifying key for a user or their company
	"sub": "the-user/company-id",

	  // Audience claim, must match the project ID in the SDK configuration
  	  "aud": "useparagon.com/{your-project-id}"

	// Issue timestamp, should be the current time
	"iat": 1608600116

	// Expiry timestamp for token, such as 1 hour from time of signature (iat)
	"exp": 1608603716
}
```

<Info>
  **Just for testing: Generating one-off JWTs**

  Use the [Paragon JWT Generator](https://jwt.useparagon.com/) to generate test JWTs for your development purposes. In production, static tokens should never be used.
</Info>

#### 3. Call paragon.authenticate()

You'll call `paragon.authenticate` in your view with a JWT signed by your backend using the library chosen in Step 2. **This JWT is the Paragon User Token.**

<Accordion title="How do I find my Project ID?">
  You can copy your Project ID by clicking Copy Project ID under the Environment switcher:

  <Frame>
        <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=b37df23ba6e601c8050b64b4b8c9ffd2" alt="" width="800" height="411" data-path="assets/[Paragon] 2025-02-17 at 10.49.44 PM.gif" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=280&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=8c455cda8182ae718b132f91605ab66d 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=560&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d8269a3bcb11802c13916fa80ba8d60d 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=840&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=74048103991e6f31b8bae1ef2492ac17 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=1100&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d8e3b6984edff98a56d57a4b02480cce 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=1650&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=b1c073034427d24165dbbc0fdf3f0859 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-17%20at%2010.49.44%20PM.gif?w=2500&maxW=800&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d33e7e440d11c010292b163e32f49909 2500w" data-optimize="true" data-opv="2" />
  </Frame>
</Accordion>

```js
await paragon.authenticate(
	// Your Paragon Project ID
	"38b1f170-0c43-4eae-9a04-ab85325d99f7",

	// See Setup for how to encode your user token
	"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.ey..."
);
```

The `paragon.authenticate` function is Promiseable and resolves when the SDK has successfully authenticated your user. Note that other functions, like `paragon.connect`, may not work as expected until this Promise has resolved.

**Example Implementation:** A Node.js and Express app using Handlebars view templating

1. Adding middleware to sign the JWT and include it in the response context

   ```js
   // server.js - Adding middleware to sign an authenticated user's token
   const jwt = require('jsonwebtoken');

   app.use((req, res, next) => {
     if (!req.user) {
       return next();
     }
     // JWT NumericDates specified in seconds:
     const currentTime = Math.floor(Date.now() / 1000);
     res.locals({
       paragonToken: jwt.sign(
         {
           sub: req.user.id,  // Your user's or their company's ID
           aud: `useparagon.com/{your-project-id}`, // Replace with your actual project ID
           iat: currentTime,
           exp: currentTime + (60 * 60), // 1 hour from now
         },
         process.env.PARAGON_SIGNING_KEY,
         {
           algorithm: "RS256",
         }
       ),
     });
     next();
   });
   ```

2. Use the `paragonJwt` set in context within the view template, with a call to `paragon.authenticate`:

   ```js
   // layout.hbs - Include paragon.authenticate call in the view template
   <body>
   	<script type="text/javascript">
   	  paragon.authenticate("project-id", "{{ paragonToken }}").then(() => {
   		  // paragon.getUser() will now return the authenticated user
   		});
   	</script>
   </body>
   ```

### Using a managed authentication service

If you already use an authentication service like Auth0, Firebase, or a JWKS-compatible authentication server, you can set up your Paragon project to use tokens generated by that service by navigating to **Settings > SDK Setup** and selecting a provider.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=b9198527baecec974360d598a5979d53" alt="" width="3238" height="1364" data-path="assets/Choosing an authentication method in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?w=280&maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=85fc05cb65a4543a003685f759fce7e8 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?w=560&maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=b63d56cf073b6b9a507965b6b71dae49 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?w=840&maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=4990b700bb1b7560cd2f0d42c97e40fb 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?w=1100&maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3dd8ac91fceff07d3c13e9d64eb1b5df 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?w=1650&maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=bcd81ac01f24a77d7973be14fe7e21e0 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20in%20Paragon%20Connect.png?w=2500&maxW=3238&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=73409abcc2be560947196aeb23f19799 2500w" data-optimize="true" data-opv="2" />
</Frame>

Since Paragon uses a JSON Web Token (JWT) to encode and validate user identity, many managed services will already have a token that you can pass directly to Paragon.

<Tabs>
  <Tab title="Auth0">
    You'll need to provide Paragon with your **Auth0 Tenant Domain**, which ends with `.auth0.com`. Example: `https://<YOUR_TENANT>.auth0.com`.

    If you have a domain alias for your tenant domain, use the domain alias instead.

    <Frame>
            <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Auth0%20Authentication%20to%20Paragon%20Connect.png?maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=7ea599ca7325f276ae8e22c72b0349ef" alt="" width="2300" height="954" data-path="assets/Adding Auth0 Authentication to Paragon Connect.png" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Auth0%20Authentication%20to%20Paragon%20Connect.png?w=280&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=597c00a9e7e2b761a80991b95b65ab16 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Auth0%20Authentication%20to%20Paragon%20Connect.png?w=560&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=1216e5476343ccdcfb9889ee4dbeb4d2 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Auth0%20Authentication%20to%20Paragon%20Connect.png?w=840&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=5469c5e84bc9937ad4ab30375a52cb68 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Auth0%20Authentication%20to%20Paragon%20Connect.png?w=1100&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=74061fc8702c3bd68080ab35d4a742b9 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Auth0%20Authentication%20to%20Paragon%20Connect.png?w=1650&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=f0ae04f4aba8e72a6de07f36203e07d2 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Auth0%20Authentication%20to%20Paragon%20Connect.png?w=2500&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=eb67cdda0a289b194799717d5e8776c7 2500w" data-optimize="true" data-opv="2" />
    </Frame>

    The Auth0 ID token can be used directly as the Paragon User Token.

    Auth0 provides [comprehensive docs](https://auth0.com/docs/tokens/id-tokens/get-id-tokens) on retrieving the ID token in various contexts. An example of this, using their [single page app SDK](https://auth0.com/docs/libraries/auth0-single-page-app-sdk#get-id-token-claims):

    ```js
    auth0.getIdTokenClaims().then((claims) => {
      await paragon.authenticate("project-id", claims.__raw);
    });
    ```
  </Tab>

  <Tab title="Firebase">
    You'll need to provide Paragon with your **Firebase Project ID**, which you can find in the Firebase Console.

    <Frame>
            <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Firebase%20Authentication%20to%20Paragon%20Connect.png?maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=e59198ff71d4b3860684ac01e4da5c37" alt="" width="2300" height="954" data-path="assets/Adding Firebase Authentication to Paragon Connect.png" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Firebase%20Authentication%20to%20Paragon%20Connect.png?w=280&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=cadca61fdc63233a5336ab36912250c4 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Firebase%20Authentication%20to%20Paragon%20Connect.png?w=560&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=c03e4b880e28851723b0b9a026831662 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Firebase%20Authentication%20to%20Paragon%20Connect.png?w=840&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=480ee1a2c82fdea51237c8b3364b0f70 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Firebase%20Authentication%20to%20Paragon%20Connect.png?w=1100&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=fac68ab44d1c403bb9306c6545ab741e 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Firebase%20Authentication%20to%20Paragon%20Connect.png?w=1650&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=33d654148f0cc8fb128f9015c02d7043 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Firebase%20Authentication%20to%20Paragon%20Connect.png?w=2500&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=afa8b695a626eb894f083967466e71a2 2500w" data-optimize="true" data-opv="2" />
    </Frame>

    The Firebase ID token can be used directly as the Paragon User Token.

    You can get a Firebase ID token from the [JavaScript client-](https://firebase.google.com/docs/auth/admin/verify-id-tokens#web)side library with:

    ```js
    firebase.auth().currentUser.getIdToken(true).then(async function(idToken) {
      await paragon.authenticate("project-id", idToken);
    })
    ```
  </Tab>

  <Tab title="JWKS Endpoint">
    You'll need to provide Paragon with your **JWKS Endpoint**, which can be found in your identity provider's documentation.

    <Frame>
      <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20JWKS%20Endpoint%20Authentication%20to%20Paragon%20Connect.png?maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=8e8a97b440b4e3c4884d7ae6fd1b5eeb" alt="" width="2300" height="954" data-path="assets/Adding JWKS Endpoint Authentication to Paragon Connect.png" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20JWKS%20Endpoint%20Authentication%20to%20Paragon%20Connect.png?w=280&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=5587cd91d0ba85c3c390f753b99d7598 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20JWKS%20Endpoint%20Authentication%20to%20Paragon%20Connect.png?w=560&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=19faaae2e8b545fd4bcf84c7a856083b 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20JWKS%20Endpoint%20Authentication%20to%20Paragon%20Connect.png?w=840&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=a91f7d9680d704adf2b2fd846ec8a216 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20JWKS%20Endpoint%20Authentication%20to%20Paragon%20Connect.png?w=1100&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=07547b290b449cd4b7058b5171e6a06e 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20JWKS%20Endpoint%20Authentication%20to%20Paragon%20Connect.png?w=1650&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=54debfde5f580e5016a92c4f7850ca91 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20JWKS%20Endpoint%20Authentication%20to%20Paragon%20Connect.png?w=2500&maxW=2300&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=bc0f354510e193653ce5bbe83d9d01d4 2500w" data-optimize="true" data-opv="2" />
    </Frame>

    This endpoint will generally have a URL like:

    ```js
    https://auth-server-example.com/.well-known/jwks.json
    ```

    ### Example: Clerk

    To set up Clerk as an authentication provider:

    1. Create a blank [JWT Template](https://clerk.com/docs/backend-requests/making/jwt-templates) in the Clerk dashboard.

    2. Set the Token Lifetime to at least 1 hour (3600 seconds). You will need to call `paragon.authenticate()` with a valid token at least once per period of your token's lifetime.

    3. Copy the JWKS Endpoint and add it to the Paragon dashboard.

    <Frame>
      <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BDashboard%20%20Clerk.com%5D%202025-03-06%20at%2003.44.10%20PM@2x.png?maxW=1920&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=96e1d705cf2e09ebeb7c790715c6f544" alt="" width="1920" height="998" data-path="assets/[Dashboard  Clerk.com] 2025-03-06 at 03.44.10 PM@2x.png" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BDashboard%20%20Clerk.com%5D%202025-03-06%20at%2003.44.10%20PM@2x.png?w=280&maxW=1920&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=29f0c856610adb54d330512b22644530 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BDashboard%20%20Clerk.com%5D%202025-03-06%20at%2003.44.10%20PM@2x.png?w=560&maxW=1920&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=6ff96d7695a490bf96f0fe377b01e230 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BDashboard%20%20Clerk.com%5D%202025-03-06%20at%2003.44.10%20PM@2x.png?w=840&maxW=1920&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=dabcea72232b79562262aea5896b2652 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BDashboard%20%20Clerk.com%5D%202025-03-06%20at%2003.44.10%20PM@2x.png?w=1100&maxW=1920&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=57778a3b1258c2c7cca7e42b66c25c5c 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BDashboard%20%20Clerk.com%5D%202025-03-06%20at%2003.44.10%20PM@2x.png?w=1650&maxW=1920&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=1dea6a1f37fc309049476350b5abf3c8 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BDashboard%20%20Clerk.com%5D%202025-03-06%20at%2003.44.10%20PM@2x.png?w=2500&maxW=1920&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=a253a6f1380038417d3aa9bd0b1a8cc2 2500w" data-optimize="true" data-opv="2" />
    </Frame>

    4. Call `getToken()` with your template name and pass it to the `paragon.authenticate` method:

    ```js
    const token = await window.Clerk.session.getToken({
        template: "Paragon",
        skipCache: true
    });

    await paragon.authenticate("[Project ID]", token);
    ```
  </Tab>
</Tabs>


# ActionKit
Source: https://docs.useparagon.com/learn/actionkit

One API. Hundreds of integration actions.

<img src="https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ActionKitBanner.png?maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=7b492f7fe6a4fcec2b4109d0c6fa1fbe" alt="Action Kit Banner Pn" width="1056" height="245" data-path="images/ActionKitBanner.png" srcset="https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ActionKitBanner.png?w=280&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=6b48cfbdce5a750702452a42c6216da8 280w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ActionKitBanner.png?w=560&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=d6004c576e15206cb692db9da3dcaab0 560w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ActionKitBanner.png?w=840&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=17f8b145fd07ee9153017023c70709aa 840w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ActionKitBanner.png?w=1100&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=0549af81dfd036c811959a35f458ceeb 1100w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ActionKitBanner.png?w=1650&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=e484f146574de2de0cf8963851fbc598 1650w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ActionKitBanner.png?w=2500&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=ee5fdc0194871a0c17da7ea2868c64b5 2500w" data-optimize="true" data-opv="2" />

**ActionKit** is a single API to add Paragon's library of hundreds of Integration Actions into your product or AI agent

**When to use:** You need to implement real-time, synchronous responses for common integration actions, or supply your AI agent or workflow product with hundreds of integration actions.

### Highlights

* Real-time execution SLAs (extremely low-latency)
* Uniform interface for every integration
* Use-case specific schema formats (for AI agents or workflow products)

### Common use cases:

* Integration tools for AI agents
* Integrations for your workflow product
* Taking action in 3rd-party apps in real-time

<Card title="Learn More" icon="arrow-right" horizontal href="/actionkit/overview">
  Learn more about ActionKit in our comprehensive overview.
</Card>


# Managed Sync
Source: https://docs.useparagon.com/learn/managed-sync

Fully managed and normalized 3rd-party data ingestion pipelines surfaced over an easy to use API.

<img src="https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ManagedSyncBanner.png?maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=e2d50bf16cf96acb8414e16a89196780" alt="Managed Sync Banner Pn" width="1056" height="245" data-path="images/ManagedSyncBanner.png" srcset="https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ManagedSyncBanner.png?w=280&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=fe50096351b96de97dbcb9925d6da25f 280w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ManagedSyncBanner.png?w=560&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=81a0cf79c8ed70f150831a11c224fa12 560w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ManagedSyncBanner.png?w=840&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=42797548a1bbce5ecb539b462ea9327d 840w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ManagedSyncBanner.png?w=1100&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=c4bafe8b313f6112f577d377ccc570cb 1100w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ManagedSyncBanner.png?w=1650&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=c8357596d36fdc64e815f987b36ac2ae 1650w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/ManagedSyncBanner.png?w=2500&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=fba8f100ee01581db121ce1dfcd31fad 2500w" data-optimize="true" data-opv="2" />

**Managed Sync** provides two easy-to-use APIs to pull high volumes of data from your users' integrations into your app, while respecting the data's underlying permissions:

* Sync API: Enable full syncs of your users' 3rd-party data with two API calls
* Permissions API: Enforce access control on ingested 3rd-party data in RAG

### Highlights

* Declarative ingestion jobs for files, CRM records, tickets, accounting data, and more
* Automatic backfill + incremental sync with failure recovery
* Record/document Permissions API for downstream queries
* Scale to hundred of millions of records without managing infrastructure

### Common Use Cases

* Knowledge ingestion for RAG (ie. files, knowledge bases, meeting transcripts, chat)
* Structured data ingestion (ie. CRM, accounting, ticketing)

<Card title="Learn More" icon="arrow-right" horizontal href="/managed-sync/overview">
  Learn more about Managed Sync in our comprehensive overview.
</Card>


# Workflows
Source: https://docs.useparagon.com/learn/workflows

Embedded iPaaS for building event-driven automations

<img src="https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/WorkflowsBanner.png?maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=24c4743838fc4e134805e24bae336743" alt="Workflows Banner Pn" width="1056" height="245" data-path="images/WorkflowsBanner.png" srcset="https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/WorkflowsBanner.png?w=280&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=9cd909ada5e7556b2ae0f0b58bc03c94 280w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/WorkflowsBanner.png?w=560&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=fecb50f82192ff6217b4fd5b68fb45a4 560w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/WorkflowsBanner.png?w=840&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=3f9bff7eea7db6b92184b7e5f8ec89e9 840w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/WorkflowsBanner.png?w=1100&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=58e30df2e2298314ba0e4eef5c84c0c1 1100w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/WorkflowsBanner.png?w=1650&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=3f35d1c4a774d35a64a8708931871125 1650w, https://mintcdn.com/paragon/qEufS2yoY-f7bvVs/images/WorkflowsBanner.png?w=2500&maxW=1056&auto=format&n=qEufS2yoY-f7bvVs&q=85&s=a5ecdb00e833d156027bad44d479304b 2500w" data-optimize="true" data-opv="2" />

Build asynchronous event‑driven automations and orchestrate integration logic at scale.

**When to use:** You need to build durable, asynchronous, event-driven background jobs between your app and your users' 3rd-party apps.

### Highlights

* Build in low-code or Typescript, and version control all workflows in Git
* Highly extenisble - implement any integration logic
* Durable jobs infrastructure (queues, dynamically scaled workers)
* Supports listening to any 3rd-party webhook

### Common Use Cases

* Trigger custom event-driven automations in your users' 3rd-party apps
* Trigger automations in your application from 3rd-party webhooks

<Card title="Learn More" icon="arrow-right" horizontal href="/workflows/overview">
  Learn more about Workflows in our comprehensive overview.
</Card>


# Batch Check Access
Source: https://docs.useparagon.com/managed-sync/api/batch-check-access

post /api/permissions/{syncId}/batch-check
Check access for a list of users and objects



# Check Access
Source: https://docs.useparagon.com/managed-sync/api/check-access

post /api/permissions/{syncId}/check
Check if a user has a specific role for an object



# CRM Company
Source: https://docs.useparagon.com/managed-sync/api/company-schema

A company, organization, or account in a CRM system.

**Pipeline name for Sync configuration**: `companies`


# CRM Contact
Source: https://docs.useparagon.com/managed-sync/api/contact-schema

A contact record in a CRM system.

**Pipeline name for Sync configuration**: `contacts`


# CRM Custom Object
Source: https://docs.useparagon.com/managed-sync/api/custom-object-schema

A custom object record in a CRM system.

**Pipeline name for Sync configuration**: `custom_objects`

When using a Custom Object, you must specify the `customObjectName` in the Sync configuration.

No mapping will be applied to a Custom Object sync, so all properties will be synced as-is and available in the `customFields` object.


# CRM Deal
Source: https://docs.useparagon.com/managed-sync/api/deal-schema

A deal or opportunity record in a CRM system.

**Pipeline name for Sync configuration**: `deals`


# Disable a Sync
Source: https://docs.useparagon.com/managed-sync/api/disable-sync

post /api/syncs/{syncId}/disable
Disable an active Sync for a Connected User

Disabling a Sync will stop it from running or checking for new records. This can be used if your Sync needs to be paused for any reason.

You can re-enable a Sync by calling the [Re-enable Sync](/managed-sync/api/reenable-sync) endpoint, and the Sync will resume from where it left off.


# Download File Content
Source: https://docs.useparagon.com/managed-sync/api/download-content

get /api/syncs/{syncId}/records/{recordId}/content
Download the file associated with a File-type Synced Object



# Enable a Sync
Source: https://docs.useparagon.com/managed-sync/api/enable-a-sync

post /api/syncs
Start a Sync for a Connected User with a specific configuration

Upon sending this request, the sync will immediately start with the account that the user has connected.

After the initial sync has completed, you will receive a `sync_completed` webhook event and records created / updated after the initial sync will send `record_created` or `record_updated` webhook events. [Learn more about the Sync Lifecycle](/managed-sync/sync-api).


# File
Source: https://docs.useparagon.com/managed-sync/api/file-schema

A file stored in a File Storage integration.

**Pipeline name for Sync configuration**: `files`


# Get Sync Status
Source: https://docs.useparagon.com/managed-sync/api/get-sync-status

get /api/syncs/{syncId}
Get the current status of a Sync

Once you have a Sync enabled for a particular Connected User, you can start to poll its status.

You will receive fields for:

* `status` — This tells you the current state of Sync activity.
  * `INITIALIZING`: The Sync has just been created and is pending its first run.
  * `ACTIVE`: The Sync is actively fetching new data.
  * `IDLE`: The Sync has completed and is watching for updates to synced data.
    * Check `summary.lastSyncedAt` to see if the sync has successfully completed.
  * `DISABLED`: The Sync has been paused temporarily by the [Disable a Sync](/managed-sync/api/disable-sync) endpoint.
  * `ERRORED`: The Sync has been suspended due to an error. Check [Webhook Events](/managed-sync/webhooks) for additional error details.
* `summary` — Metrics on the sync progress and last seen record timestamps.


# Get Synced Record
Source: https://docs.useparagon.com/managed-sync/api/get-synced-record

get /api/syncs/{syncId}/records/{recordId}
Get metadata for a specific record in a Sync



# List Objects
Source: https://docs.useparagon.com/managed-sync/api/list-objects

post /api/permissions/{syncId}/list-objects
List objects that a user has access to with an optional role filter



# List Syncs
Source: https://docs.useparagon.com/managed-sync/api/list-syncs

get /api/syncs
List all Syncs for a Connected User



# List Users
Source: https://docs.useparagon.com/managed-sync/api/list-users

post /api/permissions/{syncId}/list-users
List users that have access to an object with an optional role filter



# Pull Synced Records
Source: https://docs.useparagon.com/managed-sync/api/pull-synced-records

get /api/syncs/{syncId}/records
Get records from a Sync

Each page that you consume in pulling syncing records will return a stable cursor representing the last record of the page in `paging.cursor`.

When you receive data as an empty array or `paging.remainingRecords` = 0, your application is caught up to the latest data synced to Paragon.

You can persist the last available `paging.cursor` value to sync available pages when you receive `recordCreated` webhooks in the future.


# Re-enable a Sync
Source: https://docs.useparagon.com/managed-sync/api/reenable-sync

post /api/syncs/{syncId}/reenable
Re-enable an inactive Sync for a Connected User



# Getting Started
Source: https://docs.useparagon.com/managed-sync/getting-started

Try Managed Sync in our Playground environment or using the API.

There are two ways to get started with Managed Sync:

* [**Managed Sync Playground**](https://try.sync.useparagon.com): Try Managed Sync with our Playground environment, where you can connect an account, sync a folder selection, and see synced files and permissions.
* [**Use the API**](#using-the-api): Enable a Sync for a Connected User in your Paragon project by using the API directly.

## Using the Playground

You can explore the basics of Managed Sync by using our Playground environment at [https://try.sync.useparagon.com](https://try.sync.useparagon.com).

To use the Playground, you will need:

* A Paragon Playground account (*this is separate from your Paragon dashboard login*)
* A test account for a supported integration that you can use to sync: Google Drive, SharePoint, Box, Salesforce, or HubSpot

<Info>
  Not all Managed Sync integrations are available to test in the Managed Sync Playground. See the full list of available integrations in the **Integration Reference.**
</Info>

## Using the API

To enable your first Sync in the API, follow these steps:

<Steps>
  <Step title="Connect an integration">
    Use the [Connect Portal](/connect-portal/overview) to connect a user's
    account to an integration that you have added to your Paragon project. You
    will use a Paragon User Token for the same user to send requests to the Sync
    API and Permissions API.
  </Step>

  <Step title="Enable a sync">
    Send a request to [Enable a Sync](/managed-sync/api/enable-a-sync) for the
    integration and the type of content that you want to sync.
  </Step>

  <Step title="Pull synced records">
    Send a request to [Pull Synced Records](/managed-sync/api/pull-synced-records) to
    see records as they are synced.
  </Step>
</Steps>

Next, learn how to implement Sync API and Permissions API in your application for production:

<Card title="Sync API Overview" icon="hammer" horizontal href="/managed-sync/sync-api">
  Learn how to implement Sync API in your application for production.
</Card>


# Amazon S3
Source: https://docs.useparagon.com/managed-sync/integrations/amazons3



## Synced Objects

Amazon S3 supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)

## Files

### Sync Configuration Options

```json Example focus={4-7}
{
    "integration": "amazons3",
    "pipeline": "files",
    "configuration": {
        "bucket": "my-s3-bucket",
        "subfolder": "documents/"
    }
}
```

<ParamField path="bucket" type="string" required>
  The S3 bucket name to sync files from.
</ParamField>

<ParamField path="subfolder" type="string">
  A subfolder path within the bucket to limit the Sync scope to. If not specified, the Sync will ingest all files from the root of the bucket.
</ParamField>


# Box
Source: https://docs.useparagon.com/managed-sync/integrations/box



## Required Scopes

To configure a Sync for Box, you need to request the following scopes from your Box OAuth application:

* `root_readonly`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Box supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)
* [Permissions](/managed-sync/permissions-api)

## Files

### Sync Configuration Options

```json Example
{
    "integration": "box",
    "pipeline": "files",
    "configuration": {}
}
```

Box files sync does not require any additional configuration options. The sync will ingest all available files and folders from the user's Box account.


# Confluence
Source: https://docs.useparagon.com/managed-sync/integrations/confluence



## Required Scopes

To configure a Sync for Confluence, you need to request the following scopes from your Atlassian OAuth application:

* `read:page:confluence`
* `read:space:confluence`
* `read:confluence-content.all`
* `read:content:confluence`
* `read:content-details:confluence`
* `read:confluence-content.summary`
* `read:hierarchical-content:confluence`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Confluence supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)

## Files

### Sync Configuration Options

```json Example focus={4-6}
{
    "integration": "confluence",
    "pipeline": "files",
    "configuration": {
        "spaceId": "123456"
    }
}
```

<ParamField path="spaceId" type="string">
  A Confluence Space ID to limit the Sync scope to pages within a specific space. Either `spaceId` or `pageId` must be provided.
</ParamField>

<ParamField path="pageId" type="string">
  A Confluence Page ID to limit the Sync scope to descendants of a specific page. Either `spaceId` or `pageId` must be provided.
</ParamField>


# Dropbox
Source: https://docs.useparagon.com/managed-sync/integrations/dropbox



## Required Scopes

To configure a Sync for Dropbox, you need to request the following scopes from your Dropbox OAuth application:

* `files.metadata.read`
* `files.content.read`
* `sharing.read`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Dropbox supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)
* [Permissions](/managed-sync/permissions-api)

## Files

### Sync Configuration Options

```json Example focus={4-6}
{
    "integration": "dropbox",
    "pipeline": "files",
    "configuration": {
        "folderId": "/Documents"
    }
}
```

<ParamField path="folderId" type="string">
  A Dropbox folder path or ID to limit the Sync scope to. If not specified, the Sync will ingest all available files from the root directory.
</ParamField>


# Google Drive
Source: https://docs.useparagon.com/managed-sync/integrations/googledrive



## Required Scopes

To configure a Sync for Google Drive, you need to request the following scopes from your Google OAuth application:

* `https://www.googleapis.com/auth/drive.readonly`
* `https://www.googleapis.com/auth/admin.reports.audit.readonly` (optional - for ingesting Permissions Sync link sharing access)

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Google Drive supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)
* [Permissions](/managed-sync/permissions-api)

## Files

### Sync Configuration Options

```json Example focus={4-6}
{
    "integration": "googledrive",
    "pipeline": "files",
    "configuration": {
        "folderId": "1DBmDMhWTzNapG2sSiu7-u7lkSCJnyC34"
    }
}
```

<ParamField path="folderId" type="string">
  A Google Drive Folder ID to limit the Sync scope to. If not specified, the Sync will ingest all available files.
</ParamField>


# HubSpot
Source: https://docs.useparagon.com/managed-sync/integrations/hubspot



## Required Scopes

To configure a Sync for HubSpot, you need to request the following scopes from your HubSpot OAuth application:

**Contacts:**

* `crm.objects.contacts.read`
* `crm.schemas.contacts.read`

**Companies:**

* `crm.objects.companies.read`
* `crm.schemas.companies.read`

**Deals:**

* `crm.objects.deals.read`
* `crm.schemas.deals.read`

**Custom Objects:**

* `crm.objects.custom.read`
* `crm.schemas.custom.read`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

HubSpot supports the following Synced Objects:

* [Contacts](/managed-sync/api/contact-schema)
* [Companies](/managed-sync/api/company-schema)
* [Deals](/managed-sync/api/deal-schema)
* [Custom Objects](/managed-sync/api/custom-object-schema)

## Contacts

### Sync Configuration Options

```json Example
{
    "integration": "hubspot",
    "pipeline": "contacts",
    "configuration": {
        "properties": ["firstname", "lastname", "email", "phone", "company"]
    }
}
```

<ParamField path="properties" type="array">
  An array of HubSpot contact property names to sync. If not specified, the Sync will fetch all available contact properties.
</ParamField>

## Companies

### Sync Configuration Options

```json Example
{
    "integration": "hubspot",
    "pipeline": "companies",
    "configuration": {
        "properties": ["name", "website", "industry"]
    }
}
```

<ParamField path="properties" type="array">
  An array of HubSpot company property names to sync. If not specified, the Sync will fetch all available company properties.
</ParamField>

## Deals

### Sync Configuration Options

```json Example
{
    "integration": "hubspot",
    "pipeline": "deals",
    "configuration": {
        "properties": ["firstname", "lastname", "email", "phone", "company"]
    }
}
```

<ParamField path="properties" type="array">
  An array of HubSpot deal property names to sync. If not specified, the Sync will fetch all available deal properties.
</ParamField>

## Custom Objects

Custom Objects can be used to sync any object type (including custom user-defined object types) from HubSpot directly, without using a mapping to a Synced Object Type.

### Sync Configuration Options

```json Example
{
    "integration": "hubspot",
    "pipeline": "custom_objects",
    "configuration": {
        "customObjectName": "custom_object_name",
        "properties": ["custom_field_name1", "custom_field_name2"]
    }
}
```

<ParamField path="customObjectName" type="string" required>
  The internal name of the object type to sync, e.g. `feedback_submissions`.
</ParamField>

<ParamField path="properties" type="array">
  An array of HubSpot property names to use in the sync. If not specified, the Sync will fetch all available properties for the object type.
</ParamField>


# Intercom
Source: https://docs.useparagon.com/managed-sync/integrations/intercom



## Required Scopes

To configure a Sync for Intercom, you need to request the following scopes from your Intercom OAuth application:

* **Read and List articles**

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Intercom supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)

## Files

### Sync Configuration Options

```json Example focus={4-6}
{
    "integration": "intercom",
    "pipeline": "files",
    "configuration": {
        "help_center_id": "12345"
    }
}
```

<ParamField path="help_center_id" type="string">
  An Intercom Help Center ID to limit the Sync scope to articles within a specific help center. If not specified, the Sync will ingest articles from all available help centers.
</ParamField>


# Microsoft Teams
Source: https://docs.useparagon.com/managed-sync/integrations/microsoft-teams



## Required Scopes

To configure a Sync for Microsoft Teams, you need to request the following scopes from your Microsoft OAuth application:

* `Files.Read.All`
* `Group.Read.All`
* `Sites.Read.All`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Microsoft Teams supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema): Sync files and meeting recordings from Microsoft Teams.

## Files

### Sync Configuration Options

```json Example focus={4-6}
{
    "integration": "microsoft-teams",
    "pipeline": "files",
    "configuration": {
        "teamId": "19:abcd1234567890abcdef1234567890ab@thread.tacv2"
    }
}
```

<ParamField path="teamId" type="string" required>
  The Microsoft Teams Team ID to sync files from. This is required and specifies which team's files should be synced.
</ParamField>


# Dynamics 365 Sales
Source: https://docs.useparagon.com/managed-sync/integrations/microsoftDynamics



## Required Scopes

To configure a Sync for Dynamics 365 Sales, you need to request the following scopes from your Microsoft OAuth application:

* `offline_access`
* `user_impersonation`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Dynamics 365 supports the following Synced Objects:

* [Contacts](/managed-sync/api/contact-schema)
* [Companies](/managed-sync/api/company-schema)
* [Deals](/managed-sync/api/deal-schema)
* [Custom Objects](/managed-sync/api/custom-object-schema)

## Contacts

### Sync Configuration Options

```json Example
{
    "integration": "microsoftDynamics",
    "pipeline": "contacts",
    "configuration": {
        "view": {
            "type": "savedquery",
            "id": "00000000-0000-0000-0000-000000000000"
        }
    }
}
```

<ParamField path="view" type="object">
  A Dynamics 365 view configuration to limit the Sync scope to. If not specified, the Sync will ingest all available contacts from the user's Dynamics 365 account.

  <Expandable title="view properties">
    <ParamField path="type" type="string">
      The type of view: either `savedquery` or `userquery`.
    </ParamField>

    <ParamField path="id" type="string">
      The ID of the saved query or user query.
    </ParamField>
  </Expandable>
</ParamField>

## Companies

### Sync Configuration Options

```json Example
{
    "integration": "microsoftDynamics",
    "pipeline": "companies",
    "configuration": {
        "view": {
            "type": "savedquery",
            "id": "00000000-0000-0000-0000-000000000000"
        }
    }
}
```

<ParamField path="view" type="object">
  A Dynamics 365 view configuration to limit the Sync scope to. If not specified, the Sync will ingest all available companies from the user's Dynamics 365 account.

  <Expandable title="view properties">
    <ParamField path="type" type="string">
      The type of view: either `savedquery` or `userquery`.
    </ParamField>

    <ParamField path="id" type="string">
      The ID of the saved query or user query.
    </ParamField>
  </Expandable>
</ParamField>

## Deals

### Sync Configuration Options

```json Example
{
    "integration": "microsoftDynamics",
    "pipeline": "deals",
    "configuration": {
        "view": {
            "type": "savedquery",
            "id": "00000000-0000-0000-0000-000000000000"
        }
    }
}
```

<ParamField path="view" type="object">
  A Dynamics 365 view configuration to limit the Sync scope to. If not specified, the Sync will ingest all available deals from the user's Dynamics 365 account.

  <Expandable title="view properties">
    <ParamField path="type" type="string">
      The type of view: either `savedquery` or `userquery`.
    </ParamField>

    <ParamField path="id" type="string">
      The ID of the saved query or user query.
    </ParamField>
  </Expandable>
</ParamField>

## Custom Objects

### Sync Configuration Options

```json Example
{
    "integration": "microsoftDynamics",
    "pipeline": "custom_objects",
    "configuration": {
        "customObjectName": "new_customentity",
        "view": {
            "type": "userquery",
            "id": "11111111-2222-3333-4444-555555555555"
        }
    }
}
```

<ParamField path="customObjectName" type="string" required>
  The API name of the Dynamics 365 custom entity to sync, e.g., `new_customentity`.
</ParamField>

<ParamField path="view" type="object">
  A Dynamics 365 view configuration to limit the Sync scope to. If not specified, the Sync will ingest all available records for the custom object from the user's Dynamics 365 account.

  <Expandable title="view properties">
    <ParamField path="type" type="string">
      The type of view: either `savedquery` or `userquery`.
    </ParamField>

    <ParamField path="id" type="string">
      The ID of the saved query or user query.
    </ParamField>
  </Expandable>
</ParamField>


# Notion
Source: https://docs.useparagon.com/managed-sync/integrations/notion



## Synced Objects

Notion supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)

## Files

### Sync Configuration Options

```json Example
{
    "integration": "notion",
    "pipeline": "files",
    "configuration": {}
}
```

Notion files sync does not require any additional configuration options. The sync will ingest all pages and databases that are granted to the integration at time of authentication.


# OneDrive
Source: https://docs.useparagon.com/managed-sync/integrations/onedrive



## Required Scopes

To configure a Sync for OneDrive, you need to request the following scopes from your Microsoft OAuth application:

* `Files.Read.All`
* `Sites.Read.All`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

OneDrive supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)
* [Permissions](/managed-sync/permissions-api)

## Files

### Sync Configuration Options

```json Example focus={4-6}
{
    "integration": "onedrive",
    "pipeline": "files",
    "configuration": {
        "driveId": "b!-RIj2DuyvEyV1T4NlOaMHk8XkS_I8MdFlUCq1BlcjgmhRfAj3-Z8RY2VpuvV_tpd"
    }
}
```

<ParamField path="driveId" type="string">
  A OneDrive Drive ID to limit the Sync scope to a specific drive. If not specified, the Sync will use the user's default drive.
</ParamField>


# Pipedrive
Source: https://docs.useparagon.com/managed-sync/integrations/pipedrive



## Required Scopes

To configure a Sync for Pipedrive, you need to request the following scopes from your Pipedrive OAuth application:

**Contacts and Companies:**

* `contacts:read`

**Deals:**

* `deals:read`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Pipedrive supports the following Synced Objects:

* [Contacts](/managed-sync/api/contact-schema)
* [Companies](/managed-sync/api/company-schema)
* [Deals](/managed-sync/api/deal-schema)

## Contacts

### Sync Configuration Options

```json Example
{
    "integration": "pipedrive",
    "pipeline": "contacts",
    "configuration": {}
}
```

Pipedrive contacts sync does not require any additional configuration options. The sync will ingest all available contacts from the user's Pipedrive account.

## Companies

This Sync will pull Organizations from Pipedrive to map to the standard [Company](/managed-sync/api/company-schema) schema.

### Sync Configuration Options

```json Example
{
    "integration": "pipedrive",
    "pipeline": "companies",
    "configuration": {}
}
```

Pipedrive companies sync does not require any additional configuration options. The sync will ingest all available organizations from the user's Pipedrive account.

## Deals

### Sync Configuration Options

```json Example
{
    "integration": "pipedrive",
    "pipeline": "deals",
    "configuration": {}
}
```

Pipedrive deals sync does not require any additional configuration options. The sync will ingest all available deals from the user's Pipedrive account.


# Salesforce
Source: https://docs.useparagon.com/managed-sync/integrations/salesforce



## Required Scopes

To configure a Sync for Salesforce, you need to request the following scopes from your Salesforce OAuth application:

* `api`
* `refresh_token`
* `offline_access`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Salesforce supports the following Synced Objects:

* [Contacts](/managed-sync/api/contact-schema)
* [Companies](/managed-sync/api/company-schema)
* [Deals](/managed-sync/api/deal-schema)
* [Custom Objects](/managed-sync/api/custom-object-schema)

## Contacts

### Sync Configuration Options

```json Example focus={4-6}
{
    "integration": "salesforce",
    "pipeline": "contacts",
    "configuration": {
        "listViewId": "00B5g00000AWN0qEAH"
    }
}
```

<ParamField path="listViewId" type="string">
  A Salesforce List View ID to limit the Sync scope to. If not specified, the Sync will ingest all available contacts from the user's Salesforce account.
</ParamField>

## Companies

This Sync will pull Accounts from Salesforce to map to the standard [Company](/managed-sync/api/company-schema) schema.

### Sync Configuration Options

```json Example
{
    "integration": "salesforce",
    "pipeline": "companies",
    "configuration": {
        "listViewId": "00B5g00000ABC123EAA"
    }
}
```

<ParamField path="listViewId" type="string">
  A Salesforce List View ID to limit the Sync scope to. If not specified, the Sync will ingest all available companies from the user's Salesforce account.
</ParamField>

## Deals

This Sync will pull Opportunities from Salesforce to map to the standard [Deal](/managed-sync/api/deal-schema) schema.

### Sync Configuration Options

```json Example
{
    "integration": "salesforce",
    "pipeline": "deals",
    "configuration": {
        "listViewId": "00B5g00000ABC123EAA"
    }
}
```

<ParamField path="listViewId" type="string">
  A Salesforce List View ID to limit the Sync scope to. If not specified, the Sync will ingest all available deals from the user's Salesforce account.
</ParamField>

## Custom Objects

### Sync Configuration Options

```json Example
{
    "integration": "salesforce",
    "pipeline": "custom_objects",
    "configuration": {
        "customObjectName": "Product_Catalog__c",
        "listViewId": "00B5g00000XYZ789EAA"
    }
}
```

<ParamField path="customObjectName" type="string" required>
  The API name of the Salesforce custom object to sync, e.g., `Product_Catalog__c`.
</ParamField>

<ParamField path="listViewId" type="string">
  A Salesforce List View ID to limit the Sync scope to. If not specified, the Sync will ingest all available records for the custom object from the user's Salesforce account.
</ParamField>


# ServiceNow
Source: https://docs.useparagon.com/managed-sync/integrations/servicenow



## Synced Objects

ServiceNow supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)

## Files

### Sync Configuration Options

```json Example focus={4-6}
{
    "integration": "servicenow",
    "pipeline": "files",
    "configuration": {
        "kb_id": "kb_knowledge_base_sys_id_here"
    }
}
```

<ParamField path="kb_id" type="string">
  A ServiceNow Knowledge Base ID to limit the Sync scope to articles within a specific knowledge base. If not specified, the Sync will ingest articles from all available knowledge bases.
</ParamField>


# SharePoint
Source: https://docs.useparagon.com/managed-sync/integrations/sharepoint



## Required Scopes

To configure a Sync for SharePoint, you need to request the following scopes from your Microsoft OAuth application:

* `Sites.Read.All`
* `Files.Read.All`
* `User.Read.All`
* `Group.Read.All`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

SharePoint supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)
* [Permissions](/managed-sync/permissions-api)

## Files

### Sync Configuration Options

```json Example focus={4-6}
{
    "integration": "sharepoint",
    "pipeline": "files",
    "configuration": {
        "siteId": "contoso.sharepoint.com,12345678-1234-1234-1234-123456789012,87654321-4321-4321-4321-210987654321"
    }
}
```

<ParamField path="siteId" type="string" required>
  The SharePoint Site ID to sync files from. This is required and specifies which SharePoint site's document libraries should be synced.
</ParamField>


# Zendesk
Source: https://docs.useparagon.com/managed-sync/integrations/zendesk



## Required Scopes

To configure a Sync for Zendesk, you need to request the following scopes from your Zendesk OAuth application:

* `read`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Zendesk supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)

## Files

### Sync Configuration Options

```json Example focus={4-6}
{
    "integration": "zendesk",
    "pipeline": "files",
    "configuration": {
        "locale": "en-us"
    }
}
```

<ParamField path="locale" type="string">
  A locale string to limit the Sync scope to articles in a specific language. If not specified, the Sync will use `en-us` as the default locale.
</ParamField>


# Zoho CRM
Source: https://docs.useparagon.com/managed-sync/integrations/zohocrm



## Required Scopes

To configure a Sync for Zoho CRM, you need to request the following scopes from your Zoho OAuth application:

**All pipelines:**

* `ZohoCRM.modules.READ`
* `ZohoCRM.users.READ`
* `ZohoCRM.bulk.READ`

**Contacts:**

* `ZohoCRM.modules.contacts.READ`

**Companies:**

* `ZohoCRM.modules.accounts.READ`

**Deals:**

* `ZohoCRM.modules.deals.READ`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Zoho CRM supports the following Synced Objects:

* [Contacts](/managed-sync/api/contact-schema)
* [Companies](/managed-sync/api/company-schema)
* [Deals](/managed-sync/api/deal-schema)
* [Custom Objects](/managed-sync/api/custom-object-schema)

## Contacts

### Sync Configuration Options

```json Example
{
    "integration": "zohocrm",
    "pipeline": "contacts",
    "configuration": {}
}
```

Zoho CRM contacts sync does not require any additional configuration options. The sync will ingest all available contacts from the user's Zoho CRM account.

## Companies

### Sync Configuration Options

```json Example
{
    "integration": "zohocrm",
    "pipeline": "companies",
    "configuration": {}
}
```

Zoho CRM companies sync does not require any additional configuration options. The sync will ingest all available companies from the user's Zoho CRM account.

## Deals

### Sync Configuration Options

```json Example
{
    "integration": "zohocrm",
    "pipeline": "deals",
    "configuration": {}
}
```

Zoho CRM deals sync does not require any additional configuration options. The sync will ingest all available deals from the user's Zoho CRM account.

## Custom Objects

### Sync Configuration Options

```json Example
{
    "integration": "zohocrm",
    "pipeline": "custom_objects",
    "configuration": {
        "customObjectName": "Subscriptions"
    }
}
```

<ParamField path="customObjectName" type="string" required>
  The Zoho module API name to sync, e.g., `Subscriptions`.
</ParamField>


# Managed Sync
Source: https://docs.useparagon.com/managed-sync/overview

Managed Sync provides pipelines to sync data from your users' integration sources to your app or RAG pipeline.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managed%20Sync%20Header.png?maxW=4197&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9161384a5cb0af401388dfa91aa77857" alt="Page cover image" width="4197" height="1311" data-path="assets/Managed Sync Header.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managed%20Sync%20Header.png?w=280&maxW=4197&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c8c94192237c919199832d44bd291318 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managed%20Sync%20Header.png?w=560&maxW=4197&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=6f7baf1ee6002de2c24071b9ad67dcf7 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managed%20Sync%20Header.png?w=840&maxW=4197&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=ad1cdfc4c68f60502d756dd1c63d5f26 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managed%20Sync%20Header.png?w=1100&maxW=4197&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=f458cd5abec10fb936e281327cc2dd09 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managed%20Sync%20Header.png?w=1650&maxW=4197&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9c536c3e80ef011e797f3730cdd9177a 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managed%20Sync%20Header.png?w=2500&maxW=4197&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=eb38e8febae36a6df8b86ffdb363f0c2 2500w" data-optimize="true" data-opv="2" />
</Frame>

**Managed Sync** provides a pre-built pipeline for each category of supported integrations that normalizes ingested data, sends webhook updates for changes, and exposes a [Sync API](/managed-sync/sync-api) and [Permissions API](/managed-sync/permissions-api) to pull content and check user access.

**You can use Managed Sync to:**

* Ingest your users' knowledge sources for RAG across a wide range of integrations, bringing critical context to your LLM applications
* Replicate a copy of your users' data to run more powerful analytical queries in your application than supported by integration APIs
* Enforce permissions of all synced data for every user in your application, using our Permissions API

**Paragon will automatically handle:**

* Sync scheduling and error recovery for high-volume syncs
* Normalization of all ingested data into a [Synced Object](/managed-sync/synced-objects) schema for each category of integrations
* Permissioning all ingested data using available APIs with a fine-grained authorization server

<Frame caption="Learn more about Managed Sync in our launch video">
  <iframe width="600" height="300" src="https://www.youtube.com/embed/2KzJnCPJrg8?si=ZqsJLCqIGfbGWOJ-" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen />
</Frame>

## How Managed Sync Works

<Frame><img src="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-overview.png?maxW=1842&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=9d16fc028b0c505849e384da0fc3df45" alt="Sync Setup" width="1842" height="855" data-path="assets/sync-overview.png" srcset="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-overview.png?w=280&maxW=1842&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=616a0a2eccd11d37f45e3bb28f1b1073 280w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-overview.png?w=560&maxW=1842&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=2454971bc0897d02fa8ea060d34adf74 560w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-overview.png?w=840&maxW=1842&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=0a679c37ba15ab36902760bd31e14eda 840w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-overview.png?w=1100&maxW=1842&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=a4b5316e01bdd257032a2b70ef888b4d 1100w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-overview.png?w=1650&maxW=1842&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=79397128d72adc9c27bebc00ae3d491c 1650w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-overview.png?w=2500&maxW=1842&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=650f8d7e75a78af323492d2ecbc09db5 2500w" data-optimize="true" data-opv="2" /></Frame>

Managed Sync includes fully-managed ingestion pipelines for a wide range of integrations in File Storage, Documents, and CRM categories. For example, you can enable a sync pipeline for your user's Google Drive account to pull all workspace content.

#### Normalization without limits

Each Sync in a specific category returns records in a normalized format, which means that you can integrate Managed Sync once for a category and support all integrations in that category.

For integrations like CRMs with custom fields, Sync provides you the full list of available fields by default, so that you always have access to an original copy of the data. [Learn more about available Synced Objects](/managed-sync/synced-objects).

#### Durable, production-ready syncs

Syncs are built to be durable through any issues that may happen with upstream integration providers, including temporary rate limits or API unavailability. Syncs intelligently back off and schedule retries to ensure consistent, durable ingestion for large volumes of data.

Syncs also periodically perform a full refresh of their watched content to validate data accuracy and completeness. [Learn more about the Sync Lifecycle](/managed-sync/sync-api#sync-lifecycle).

#### Permissions indexing

For available integrations, Managed Sync automatically indexes the permissions for each Synced Object and builds a graph database of the relationships between Synced Objects and related users or user groups.

You can use the Permissions API to query this graph in a simple and consistent interface, without implementing the underlying RBAC models of each integration.<br /> [Learn more about the Permissions API](/managed-sync/permissions-api).

## APIs

Managed Sync provides two APIs that allow you to enable Sync pipelines on behalf of your users, pull permissioned content from those pipelines, and receive updates as records change:

* [**Sync API**](/managed-sync/sync-api): Use this API to enable Syncs, check on Sync status, and pull Synced Objects once they are ingested.

  This API can be used as the beginning of your RAG pipeline or to synchronize your database with Paragon's replica of your users' integration data.
* [**Permissions API**](/managed-sync/permissions-api): Use this API to check on the users that are allowed to read or write to a Synced Object.

  This API can be used to filter the search results from your RAG pipeline to only include content that your user has access to, for Syncs that are set up at the organization/admin level.


# Permissions API
Source: https://docs.useparagon.com/managed-sync/permissions-api

Learn how to use and implement Permissions API in your app.

## Usage

The Permissions API uses the same base URL and authorization details as the [Sync API](/managed-sync/sync-api).

## About Permission Syncs

Permission Syncs use available APIs to query all ways that users can access or inherit access to a file.

For example, for the Google Drive integration, Paragon syncs permissions for:

* Direct access assigned to files
* Inherited access from parent folders
* Google Group member access (direct or inherited)
* Google Workspace organization-wide access
  * If not designated as "searchable by organization": access granted from an opened link

Because evaluating permissions can be difficult and error-prone in practice, Permission Syncs store permission data in a fine-grained authorization server that dramatically simplifies the query to check for access.

Instead of searching across role relationships and executing specific rules for each integration, you can query the Permissions API in a standard format:

```json Query to check if a user has access to File ID "123"
{
    "user": "user:youruser@email.com",
    "role": "can_read",
    "object": "[File UUID]"
}
```

This query format works across any File Storage sync that supports Permissions.

Permission Syncs are currently supported on a select number of File Storage integrations and run automatically when files are processed.

## Implementing Permissions API

To implement Permissions API in a production context, your application will need to query the Permissions API to check for access when documents are being requested.

Below is a diagram illustrating how Sync API and Permissions API can be used together in a RAG-based chat application ("Your App") where an organization admin connects their Google Workspace to your app to ingest workspace files on behalf of everyone in that organization.

Permissions API can be used to filter documents that match the user's query from your vector/search database to *only* the files that the user has access to in Google Workspace.

<Frame>
    <img src="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/permissions-api-diagram.png?maxW=2021&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=08522a1fecf3ce1ce878fe1905ba39bc" alt="Permissions API diagram" width="2021" height="1556" data-path="assets/permissions-api-diagram.png" srcset="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/permissions-api-diagram.png?w=280&maxW=2021&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=02c6cc4dce2d03b289554f91f8e477a4 280w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/permissions-api-diagram.png?w=560&maxW=2021&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=f71ea192656bb725f30e033e902009ec 560w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/permissions-api-diagram.png?w=840&maxW=2021&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=8bf3e3229db5ad7d18f81665f9d14e2f 840w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/permissions-api-diagram.png?w=1100&maxW=2021&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=fdb6b74d2056356dac0124e146b2213e 1100w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/permissions-api-diagram.png?w=1650&maxW=2021&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=1e2594c13dd1c76bb73ca1303ee197b0 1650w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/permissions-api-diagram.png?w=2500&maxW=2021&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=b64fbc05cc8fd6796a0fa1aabc3c0c1f 2500w" data-optimize="true" data-opv="2" />
</Frame>

Depending on the architecture of your app or database, you may use one of the following patterns to integrate Permissions API:

* **Search, then filter results**: Use your search database (e.g. Pinecone) for relevant documents, and use [Batch Check Access](/managed-sync/api/batch-check-access) to filter the result set to the documents that the user has access to.
  * Best for RAG apps, where the search result set is bounded to a threshold of semantically relevant documents.
  * This is the pattern illustrated in the above diagram.
* **List all searchable objects, then search**: Use [List Objects](/managed-sync/api/list-objects) to enumerate all searchable documents, and provide this list as a metadata filter on the query to your search database.
  * Ideal for apps where the number of possible documents associated with a given user is low (e.g. \< 1000)


# Sync API
Source: https://docs.useparagon.com/managed-sync/sync-api

Learn how to use and implement Sync API in your app.

## Usage

### Base URL

The Base URL for Sync API and Permissions API is:

```
https://sync.useparagon.com
```

<Accordion title="For on-premise instances">
  On-prem instances will use a different base URL based on the instance hostname.

  ```js
  https://ms-sync.[On-Prem Base URL]
  ```
</Accordion>

### Authorization

The Sync API and Permissions API authorize with a [Paragon User Token](/getting-started/installing-the-connect-sdk#setup). Add this token to the Authorization header of your requests to the Sync API or Permissions API:

```
Authorization: Bearer {user_token}
```

For testing purposes, you can use our [Hosted Demo Environment](/demo) to generate and copy a Paragon User Token in your browser that you can use with Managed Sync.

**Required audience claim in token**

Ensure that your Paragon User Token includes an `aud` claim with your Paragon instance hostname and Project ID. While not required for other Paragon APIs, the `aud` claim is required for Managed Sync.

If you are using your existing Paragon User Token, update your JWT generation code to include the `aud` claim with your Paragon instance hostname and Project ID.

```json JWT Payload highlight={3}
{
    "sub": "your-customer-id",
    "aud": "useparagon.com/{your-project-id}",
    "exp": 1752000000,
    "iat": 1751000000
}
```

<Tip>
  See code examples of encoding your JWT using your project's Signing Key in the [Connect SDK](/getting-started/installing-the-connect-sdk) documentation.
</Tip>

## Sync Lifecycle

After you [Enable a Sync](/managed-sync/api/enable-a-sync) for one of your users, Syncs run through the following lifecycle:

* **Initial sync**: When the sync is first enabled, Paragon will pull all data from the integration (limited by any sync-specific filters) and index the records for later retrieval and change detection.
  * You will receive a `sync_completed` [webhook](/managed-sync/webhooks) when the initial sync is complete.
  * The Sync status will have an `IDLE` status and a `lastSyncedAt` timestamp when the initial sync is complete.
* **Incremental syncs**: After the initial sync, Paragon will check periodically for changes to the data.
  * When records are created or updated, you will receive `record_created` or `record_updated` webhook events with metadata about the affected records.
  * The frequency of incremental syncs is **every minute** by default, but can vary by integration. See integration-specific details in **Integrations Reference**.
* **Periodic full sync**: Every 24 hours, Paragon will perform a full refresh of your users' data to detect any content drift or deletions that are not visible by incremental syncs.
  * After a periodic full sync runs, you may receive a batch of `record_deleted` webhook events for content that is no longer accessible by the Sync (meaning that the record was deleted or unshared from the connecting account).

## Implementing Sync API

To implement Sync API in a production context, your application will need to handle initial and incremental sync phases, as illustrated below:

```mermaid
sequenceDiagram
    participant App as Your Application
    participant Paragon as Paragon
    participant Integration as Integration

    %% Initial Sync
    App->>Paragon: Enable sync for user
    Paragon->>Integration: Pull all data (Initial Sync)
    Integration-->>Paragon: Index and normalize records
    Paragon-->>App: sync_completed webhook
    App->>Paragon: Paginate & pull records

    %% Incremental Syncs
    loop Incremental Sync
        Paragon->>Integration: Check for data changes
        Integration-->>Paragon: Return new/updated records
        Paragon->>Paragon: Detect changes
        Paragon-->>App: record_created / record_updated webhook
        App->>Paragon: Pull new/updated records
    end
```

**Initial sync:**

1. Enable the sync for a user.
2. Poll the Sync API to check on the status of the sync or wait for a `sync_completed` webhook.
3. Paginate through the records in the sync and pull them into your database or RAG pipeline.

**Incremental syncs:**

To handle ongoing updates, you can either:

* Poll the Sync API for new or updated records, using the `cursor` property to get records synced after the last record you pulled.
* Wait for `record_created` and `record_updated` webhooks to trigger when new or updated records are available.


# Synced Objects
Source: https://docs.useparagon.com/managed-sync/synced-objects

Learn about the Synced Objects that are available for each category of integrations.

All records ingested by Managed Sync are normalized into standard Synced Object types supported by each category, so that you can add support for all available integrations in File Storage or CRM while [implementing Sync API](/managed-sync/sync-api) once.

Synced Objects can be retrieved from the Sync API using [Pull Synced Records](/managed-sync/api/pull-synced-records).

## File Storage

Synced Objects for File Storage integrations represent file and folder metadata. Paragon does not store the contents of the files that are synced; files are proxied from the integration directly upon download request.

* [File](/managed-sync/api/file-schema) (`files`): A file or folder in a File Storage integration. Files and folders can be distinguished by `mimeType`.
  * For document integrations like ServiceNow or Confluence, documents will be exported as text or HTML files when [downloading file content](/managed-sync/api/download-content).

## CRM

Synced Objects for CRM come with a normalized schema for each object type, but any unmapped fields are always available in the `customFields` property, giving you complete  over visibility over the underlying contents of each record.

* [Contact](/managed-sync/api/contact-schema) (`contacts`): A person with contact details as represented in a CRM integration.
* [Company](/managed-sync/api/company-schema) (`companies`): A company, organization, or account in a CRM integration.
* [Deal](/managed-sync/api/deal-schema) (`deals`): A deal or opportunity record in a CRM integration.
* [Custom Object](/managed-sync/api/custom-object-schema) (`custom_objects`): Sync any object, including user-defined custom objects, directly from a CRM with a Custom Object sync pipeline.

## Ticketing

<Info>
  Ticketing sync pipelines are coming soon. If you are interested in early access, please [contact us](mailto:support@useparagon.com).
</Info>

## Customizing the Synced Object Model

<Info>
  Synced Object Model customizations and Custom Source Framework are coming soon. If you are interested in early access, please [contact us](mailto:support@useparagon.com).
</Info>

With our Custom Source Framework, you can define your own schema for any Synced Object and add support for integrations outside of our catalog.


# Webhooks
Source: https://docs.useparagon.com/managed-sync/webhooks

Receive webhooks when records are created, updated, or deleted from your Sync.

## Configuring your Webhook URL

You can set up your Webhook URL in the Paragon dashboard to start receiving events about your Syncs.

Navigate to the **Syncs** page in the dashboard to set your Webhook URL for a specific Paragon project:

<Frame>
    <img src="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-set-webhook-url.png?maxW=2190&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=7d1338c36205a4e6676477f8ca46199f" alt="Syncs > Configuration > Set Webhook URL" width="2190" height="464" data-path="assets/sync-set-webhook-url.png" srcset="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-set-webhook-url.png?w=280&maxW=2190&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=2a8287c39b72a484ee07193bdbe841a4 280w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-set-webhook-url.png?w=560&maxW=2190&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=281a8050dd39dc078c725e4a828a2d5d 560w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-set-webhook-url.png?w=840&maxW=2190&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=e084580cdcc5c5ff1412db9db1fc4d25 840w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-set-webhook-url.png?w=1100&maxW=2190&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=980a0a93f82d815253996090d9e54964 1100w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-set-webhook-url.png?w=1650&maxW=2190&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=a500345da3ed43cb8bfc8d6c7e832500 1650w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/sync-set-webhook-url.png?w=2500&maxW=2190&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=7b5c1f9da157eebf7e5476790f7518d4 2500w" data-optimize="true" data-opv="2" />
</Frame>

Your Webhook URL must respond to `POST` requests with a 2xx HTTP status in a timely manner. If your webhook fails to respond repeatedly, we may disable your webhook.

## Receiving Webhook Events

All webhook events will be sent to your configured Webhook URL as a `POST` request.

Each webhook event will include the following standard properties to identify the related Sync and User:

```json
{
	"event": "[event type]",
	"sync": "[integration name]",
	"syncInstanceId": "[ID of Sync]",
	"user": {
		"id": "[ID of Connected User]"
	}
}
```

## Event Types

The full list of possible `event` type values are as follows:

* `sync_complete`
* `sync_errored`
* `record_created`
* `record_updated`
* `record_deleted`
* `record_errored`

### `sync_complete`

This event is sent when an [Initial Sync](/managed-sync/sync-api#sync-lifecycle) has completed successfully.

```json Example payload expandable
{
  "event": "sync_complete",
  "syncInstanceId": "163a345e-2dd4-51ff-bcf5-7667de564bb0",
  "sync": "googledrive",
  "user": {
    "id": "user_01JH448D13EX2BE1SC1GXVT05R"
  },
  "data": {
    "model": "files",
    "syncedAt": "2025-07-07T19:00:00.000Z",
    "numRecords": 1000
  }
}
```

### `sync_errored`

This event is sent when a Sync has failed and cannot continue. After this event is sent, the Sync `status` field will be set to `ERRORED`.

```json Example payload expandable
{
  "event": "sync_errored",
  "syncInstanceId": "f543fd08-5d36-56d7-bd5e-8306e82acb16",
  "sync": "googledrive",
  "user": {
    "id": "user_01JH448D13EX2BE1SC1GXVT05R"
  },
  "error": {
    "message": "Credentials are no longer valid. Please re-authenticate the user's Google Drive account."
  }
}
```

### `record_created`

This event is sent when a Sync has discovered a new record (determined by a permanent ID or path available in the integration provider) during its [Incremental Sync](/managed-sync/sync-api#sync-lifecycle).

Create events do not provide any record data as a part of the event payload, but you can use the [Get Synced Record](/managed-sync/api/get-synced-record) endpoint to get the latest data.

```json Example payload expandable
{
  "event": "record_created",
  "syncInstanceId": "163a345e-2dd4-51ff-bcf5-7667de564bb0",
  "sync": "googledrive",
  "user": {
    "id": "user_01JH448D13EX2BE1SC1GXVT05R"
  },
  "data": {
    "recordId": "3ce16e33-0163-564d-98ce-99b0a25ab375",
    "model": "files"
  }
}
```

### `record_updated`

This event is sent when a Sync has discovered an update to an existing record during its [Incremental Sync](/managed-sync/sync-api#sync-lifecycle).

Update events do not provide any record data as a part of the event payload, but you can use the [Get Synced Record](/managed-sync/api/get-synced-record) endpoint to get the latest data.

```json Example payload expandable
{
  "event": "record_updated",
  "syncInstanceId": "163a345e-2dd4-51ff-bcf5-7667de564bb0",
  "sync": "googledrive",
  "user": {
    "id": "user_01JH448D13EX2BE1SC1GXVT05R"
  },
  "data": {
    "recordId": "3ce16e33-0163-564d-98ce-99b0a25ab375",
    "model": "files"
  }
}
```

### `record_deleted`

This event is sent when a Sync has discovered that a record has been deleted or is otherwise unavailable to the connected account (for example, the record's access has been revoked from your user).

When records are deleted, the contents of their metadata are removed from the Sync, and you can no longer retrieve the synced object or its associated file data. However, the [Pull Synced Records](/managed-sync/api/pull-synced-records) endpoint will provide a sparse entry with the `id` and `external_id` property for visibility on the deletion.

These events are sent after a successful [Periodic Full Sync](/managed-sync/sync-api#sync-lifecycle).

```json Example payload expandable
{
  "event": "record_deleted",
  "syncInstanceId": "0df4921d-0ac4-5c90-b30e-7a9da9c2d02f",
  "sync": "googledrive",
  "user": {
    "id": "user_01JH448D13EX2BE1SC1GXVT05R"
  },
  "data": {
	"model": "files",
	"recordId": "3ce16e33-0163-564d-98ce-99b0a25ab375"
  }
}
```

### `record_errored`

This event is sent when a Sync has encountered an error while processing a record (for example, fetching permission data for this record). This event does not affect the Sync's `status` field, and the Sync will continue processing other records.

```json Example payload expandable
{
  "event": "record_errored",
  "syncInstanceId": "0df4921d-0ac4-5c90-b30e-7a9da9c2d02f",
  "sync": "googledrive",
  "user": {
    "id": "user_01JH448D13EX2BE1SC1GXVT05R"
  },
  "error": {
    "message": "Request failed with status code 404",
    "recordId": "68c3e715-b466-544f-ba2a-165973d85a58",
    "model": "files"
  }
}
```


# Managing Account Settings
Source: https://docs.useparagon.com/managing-account/account-settings

Update your Account Settings, like email, password, and MFA options.

When logged into the dashboard, you can manage your Account Settings by clicking "Settings" in the sidebar.

<Frame><img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/account-settings.png?maxW=2494&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=bbea9e2b61c5942f365eb1b06feafe67" alt="Account Settings" width="2494" height="1898" data-path="assets/account-settings.png" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/account-settings.png?w=280&maxW=2494&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=ae7c85b4a1c384480b017c771b9f258f 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/account-settings.png?w=560&maxW=2494&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=0405170e72133253dcf2beee3261bf99 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/account-settings.png?w=840&maxW=2494&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=e308ea49b239541c01473b357b3a1060 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/account-settings.png?w=1100&maxW=2494&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=168083d67064cf0db48c71b32a680c66 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/account-settings.png?w=1650&maxW=2494&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=8b89ec60d5f13a7422012068841b1ad4 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/account-settings.png?w=2500&maxW=2494&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=ee5b339a5ab50bcee1c2eff919a731c0 2500w" data-optimize="true" data-opv="2" /></Frame>

You can update the following account details:

* **Name**: Your name, as it appears to other members of your team in [Team Members](/managing-account/teams), [Workflow Version History](/workflows/version-history), or [Releases](/deploying-integrations/release-environments).
* **Email**: The email address you use to log in to your account.
* **Two-Step Verification**: [Setup an authenticator app](#adding-two-step-verification) to add an extra layer of security to your account.
* **Organization Name**: The name of your organization, as it appears in the header of your dashboard.
* **Organization Website**: The website of your organization (optional and not used for login).

## Changing your password

To change or reset your password, visit the Paragon dashboard and click "**Forgot password?"** under the login form. If you are already logged in, you must first log out (click your name in the top right corner and click "**Sign out**").

You will be prompted to confirm your email, and a password reset email will be sent to your account's email address.

## Adding two-step verification

In **Settings > Account Details**, you can click **Setup authenticator app** to configure an authenticator app, like Google Authenticator, to add an extra layer of security to your account.

Follow the prompt that appears to complete the setup of your authenticator app.

1. Scan the QR code that appears or click "View setup key" to manually enter the setup code.
2. Enter a code generated by your authenticator app to verify the setup.
3. Click **Finish** to complete the setup process and add Two-Step Verification to your login.

If you need to remove or change your Two-Step Verification settings in the future, you can visit **Settings > Account Details** and click the three-dot menu in the Two-Step Verification section and select **Remove** to setup a new device.

<Warning>
  If you lose access to the device you used to setup your authenticator app, you will need to [contact support](mailto:support@paragon.com) to unlock your account.
</Warning>


# Role Based Access Control
Source: https://docs.useparagon.com/managing-account/role-based-access-control

Assign roles to team members working together on Paragon.

Role-Based Access Control allows you to give team members different levels of visibility to your Paragon projects. For example, you can:

* Assign support team members with **Support** roles for access to the Connected Users and Task History pages *only*
* Designate specific users with **Admin** roles to manage global settings, including team member access and billing information

We recommend giving team members the minimal level of access they need, according to the principle of least privilege.

<Info>
  **Role-Based Access Control is available for Paragon customers on Enterprise plans.** To learn more, contact your Customer Success Manager or [sales@useparagon.com](mailto:sales@useparagon.com).

  \*Admin and Member roles are available for customers on all plans. See \*[Working with Team Members](/managing-account/teams) for more information.
</Info>

## Managing Roles

Roles are managed on an organizational/global level. When a role is assigned, that role will apply across all projects.

Roles can be managed from the dashboard by visiting **Settings** > **Team Members** page for any Project.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Team%20Members%20with%20RBAC%20view.png?maxW=2362&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=0101b6dbca8a9e231bd9bce23cb802ee" alt="" width="2362" height="1110" data-path="assets/Team Members with RBAC view.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Team%20Members%20with%20RBAC%20view.png?w=280&maxW=2362&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=849a392e8f21b534dc51aca595f9c6fe 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Team%20Members%20with%20RBAC%20view.png?w=560&maxW=2362&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=cd7dd4451c91042a2c59ed4f1e1fabb3 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Team%20Members%20with%20RBAC%20view.png?w=840&maxW=2362&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=9dbcbc263172c1671b8d1f622b133730 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Team%20Members%20with%20RBAC%20view.png?w=1100&maxW=2362&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=cba0358768d5e2dfe27987e15e2374ed 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Team%20Members%20with%20RBAC%20view.png?w=1650&maxW=2362&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=88e7f3cb889e196c76e1b82c167606c8 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Team%20Members%20with%20RBAC%20view.png?w=2500&maxW=2362&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=59b114ed694d5cd230ce9a11cd684bae 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can select any existing team member to change their role. New team members can also be invited with a specific role selected.

<Frame>
  <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=1d3eec75e9ba2b18f94955fe37daf559" alt="" width="1668" height="1620" data-path="assets/Adding Team Members to Paragon Connect.png" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?w=280&maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=549e819e904978fb0afea26b61e10936 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?w=560&maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=75965e6e4d1cfdac9ed54f91639b53c2 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?w=840&maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=769ac8f605bfa8acc7088a7ac4dd3d44 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?w=1100&maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=e7c49e52683adb2d592b2c4b1d32b28a 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?w=1650&maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=f839ed5287e2e2ecb245d361508eaf8f 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?w=2500&maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=1e898098c9041c482164f182c85045df 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Role Types

### Admin

**Admins have full read/write access to Paragon projects**. Admins can also exclusively invite new team members and view billing details.

### Members

Members are allowed to modify integrations and deploy workflows, but they cannot create new Event Destinations or modify existing Environment Secrets.

| ✓ Members are allowed to:                                                                                                                                     | ✗ Members are not allowed to:                                                                                                                                                            |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| • Create, delete, activate, or deactivate Integrations <br /> • Create, modify, and deploy Workflows <br /> • Update SDK Setup options, including Signing Key | • View or update Event Destinations <br /> • Update existing Environment Secret values <br /> • Manage API Keys <br /> • Invite new team members <br /> • View or modify billing details |

### Support

Support members are only allowed to view the Connected Users and Task History pages of the dashboard. Using these pages, they can provide support and error information to integration users.

| ✓ Support members are allowed to:                                                                                                                                               | ✗ Support members are not allowed to:                                                                                                                |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| • View and manage Connected Users, their integrations, and their metadata <br /> • View Task History for Workflows <br /> • Replay failed Workflow Executions from Task History | • Create new Projects <br /> • Modify any project details (including Integrations or Workflows) <br /> • View Client IDs or Secrets for Integrations |


# Working with Team Members
Source: https://docs.useparagon.com/managing-account/teams

Invite your team to create integrations on Paragon.

## Inviting a Team Member

Collaborate with your team members to create new integrations or view executions in Task History.

By default, Paragon has [two types of roles](/managing-account/teams#managing-roles-and-permissions) available for projects: **Admin** and **Member**. *Additional roles are available with *[Role-Based Access Control](/managing-account/role-based-access-control)*.*

To add Team Members to your Organization in Paragon:

### 1. Go to "Team Members" in Settings

Click on "Settings" in the sidebar, then click on "Team Members".

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Inviting%20team%20members%20to%20Paragon.gif?maxW=556&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0970515d86d81c9cc2cd9a0daeaf88e5" alt="" width="556" height="418" data-path="assets/Inviting team members to Paragon.gif" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Inviting%20team%20members%20to%20Paragon.gif?w=280&maxW=556&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=a5e8b128c8ad7e81b8896333dbd6bf09 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Inviting%20team%20members%20to%20Paragon.gif?w=560&maxW=556&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7397d222a77581035be2085090de6900 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Inviting%20team%20members%20to%20Paragon.gif?w=840&maxW=556&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=87597fc62f2c504b05188b1b983c078b 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Inviting%20team%20members%20to%20Paragon.gif?w=1100&maxW=556&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=056b70aca4bbaa434cddf693c1a515d1 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Inviting%20team%20members%20to%20Paragon.gif?w=1650&maxW=556&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=fb1f61fcda6f58f0ddc44377543de42b 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Inviting%20team%20members%20to%20Paragon.gif?w=2500&maxW=556&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=ce18ef8f6de2f13953a5b69ad1361122 2500w" data-optimize="true" data-opv="2" />
</Frame>

### 2. Add new team member information

Click the blue "+ New Member" button to the right of the dashboard to invite team members to your Organization in Paragon.

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Add%20new%20member%20button%20in%20Paragon.png?maxW=565&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=33cf652b2cd599f4e5d3f48afc766684" alt="" width="565" height="351" data-path="assets/Add new member button in Paragon.png" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Add%20new%20member%20button%20in%20Paragon.png?w=280&maxW=565&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=2ac61c1c67124719df9700979974c05c 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Add%20new%20member%20button%20in%20Paragon.png?w=560&maxW=565&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=32e81b7d876809a2e7f04946f048ca34 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Add%20new%20member%20button%20in%20Paragon.png?w=840&maxW=565&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=e8c89bc53ac0eef51626c6f61d93fad0 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Add%20new%20member%20button%20in%20Paragon.png?w=1100&maxW=565&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=6312d20e6f523d9d1ce39bdfc77ce219 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Add%20new%20member%20button%20in%20Paragon.png?w=1650&maxW=565&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=305f7bfa4c3a56572df4989aa771767b 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Add%20new%20member%20button%20in%20Paragon.png?w=2500&maxW=565&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=cfa0d77d8a5a662951d686cc567d99ba 2500w" data-optimize="true" data-opv="2" />
</Frame>

Invitees will receive an **email invitation** to join your Organization on Paragon. You’ll receive a confirmation email once your invitations are accepted.

### 3. Select a Role and Send an Invitation

<Frame>
  <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=1d3eec75e9ba2b18f94955fe37daf559" alt="" width="1668" height="1620" data-path="assets/Adding Team Members to Paragon Connect.png" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?w=280&maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=549e819e904978fb0afea26b61e10936 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?w=560&maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=75965e6e4d1cfdac9ed54f91639b53c2 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?w=840&maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=769ac8f605bfa8acc7088a7ac4dd3d44 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?w=1100&maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=e7c49e52683adb2d592b2c4b1d32b28a 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?w=1650&maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=f839ed5287e2e2ecb245d361508eaf8f 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Team%20Members%20to%20Paragon%20Connect.png?w=2500&maxW=1668&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=1e898098c9041c482164f182c85045df 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Managing Roles and Permissions

There are three types of roles Team Members can have in your Organization:

| User Permissions                                             | Support\* | Member | Admin |
| ------------------------------------------------------------ | --------- | ------ | ----- |
| View Task History                                            | ☑️        | ☑️     | ☑️    |
| View Connected Users                                         | ☑️        | ☑️     | ☑️    |
| Create workflows                                             |           | ☑️     | ☑️    |
| Edit workflows                                               |           | ☑️     | ☑️    |
| Delete workflows                                             |           | ☑️     | ☑️    |
| Manage [Environment Secrets](/workflows/environment-secrets) |           |        | ☑️    |
| Manage [Event Destinations](/monitoring/event-destinations)  |           |        | ☑️    |
| Manage API Keys                                              |           |        | ☑️    |
| Edit Billing Details                                         |           |        | ☑️    |
| Update team membership settings                              |           |        | ☑️    |
| Manage Subscription                                          |           |        | ☑️    |

\**This role requires *[*Role-Based Access Control*](/managing-account/role-based-access-control)*.*

## Removing a Team Member

Click on "Remove User" underneath the team member you'd like to remove. After confirming the deletion, the team member will be removed from your Organization.

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Removing%20Team%20Members%20in%20Paragon%20Connect.gif?maxW=1003&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3edb1444f9c79fa4b3cd255b37512b54" alt="" width="1003" height="865" data-path="assets/Removing Team Members in Paragon Connect.gif" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Removing%20Team%20Members%20in%20Paragon%20Connect.gif?w=280&maxW=1003&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f27b650c94637f8c824c768cb9af4dea 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Removing%20Team%20Members%20in%20Paragon%20Connect.gif?w=560&maxW=1003&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=6b1dbc0e2c31f29141cd656a5241e5fd 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Removing%20Team%20Members%20in%20Paragon%20Connect.gif?w=840&maxW=1003&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d4e32ea5a7423cb645a25e15e2505f4f 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Removing%20Team%20Members%20in%20Paragon%20Connect.gif?w=1100&maxW=1003&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=11ea756e8a3a7edfbef835510574c6de 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Removing%20Team%20Members%20in%20Paragon%20Connect.gif?w=1650&maxW=1003&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8d29976c56d2aff41227e0ea488420ed 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Removing%20Team%20Members%20in%20Paragon%20Connect.gif?w=2500&maxW=1003&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=60fe26062ecc509c55369fccff5ee715 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Managing Event Destinations
Source: https://docs.useparagon.com/monitoring/event-destinations

Send notifications from your Paragon project into your logging, analytics, and APM services.

<Note>
  **Note:** This feature is only available to **Admin** users. [Learn more](/managing-account/teams#managing-roles-and-permissions).
</Note>

Event Destinations allow you to configure notifications for events that occur in your Paragon project.

For example, if you'd like to add another email to be notified by email when a workflow fails, you can add an Email Destination. If you prefer notifications via Slack, you can configure a Webhook Destination to a Slack incoming webhook.

You can find your project's Event Destinations by navigating to the global **Settings** tab in the left sidebar and selecting **Monitoring** under your Project Settings.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(8).png?maxW=2838&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=411bcaa9255bbfc6c327beece12b89bc" alt="" width="2838" height="1456" data-path="assets/image (8).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(8).png?w=280&maxW=2838&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=8cece9fa33a69be5a5a6fa4d3b2987ce 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(8).png?w=560&maxW=2838&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=9669155ed399eb76fd369da87fda1391 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(8).png?w=840&maxW=2838&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=c775b3438cdf958ba87937f2f958d03a 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(8).png?w=1100&maxW=2838&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=2f4dc1665f204da55830cbed4edf0aec 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(8).png?w=1650&maxW=2838&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=65ed3066d92713ab400c54d57e1eb2d1 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(8).png?w=2500&maxW=2838&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=dc6ece2351c4bd523d95def0d62bacaf 2500w" data-optimize="true" data-opv="2" />
</Frame>

From this Monitoring page, you can take any of the following actions for any Event Destination:

* Update the configuration of the Event Destination (such as changing the email address or webhook URL)
* Disable the Event Destination, which temporarily pauses notifications sent to this destination
* Delete the Event Destination

## Email Destinations

By default, your project will include an Email Destination for Workflow Failure events, using the email address of the user that created the project.

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(14).png?maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=ea34c16b50ba5c750a70e9b212405f1f" alt="" width="1500" height="964" data-path="assets/Frame 1 (14).png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(14).png?w=280&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=87796280fd8669701f9117ec21661ad4 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(14).png?w=560&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b185b0862d8152ef5789c0c71e3e4cb8 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(14).png?w=840&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b16b959ccab0f0d4a63871723d41e8a9 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(14).png?w=1100&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=f4aff3016aad41da3fbd44997c8082d0 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(14).png?w=1650&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=7d63a3a3cf1aa5af0f0f84d09fd92552 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(14).png?w=2500&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=161e7af48f3c65415931e48fb6b66c58 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can set up additional Email Destinations by following these steps:

1. From the Settings > Monitoring page, click the **Add Destination** button at the top right.

2. In the **Type** field, select **Email.**

3. In the **To** field, enter the desired email to be notified.

4. Optionally, send a test email with the **Test Email** button at the bottom left.

5. Click **Save** to create and enable the new destination.

## Webhook Destinations

<Info>
  **Webhook Destinations are available for Paragon customers on paid plans.** To learn more, contact our team at [sales@useparagon.com](mailto:sales@useparagon.com).
</Info>

Webhook Destinations allow you to receive event notifications from your Paragon project via HTTP requests. Webhook Destinations will receive a POST request when the event occurs, with configurable request headers and body contents.

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(15).png?maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=94112276a7e55fb5e16fdddd6d877f58" alt="" width="1500" height="1470" data-path="assets/Frame 1 (15).png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(15).png?w=280&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=061c31eb417b6169af1b31c1dd500bac 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(15).png?w=560&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=9daf19434e74e419d16d5ab771a2520d 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(15).png?w=840&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=aa36768eaa195edef765f3d350fa5083 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(15).png?w=1100&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=9d3f5d2c41351a041621a2bca758d7ba 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(15).png?w=1650&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=83bd1fa8a8aa43bc23294a5bc1527413 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(15).png?w=2500&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=04a18c6caedbb3229b3012cd28ddad1d 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Setup from template

If you use Slack, Datadog, New Relic, or Sentry, you can configure a Webhook Destination by clicking "Select Template" under **Request Payload** and following the guide to configure below:

<CardGroup cols={2}>
  <Card title="Slack" href="/monitoring/event-destinations/slack">
    Send events as messages in Slack
  </Card>

  <Card title="Datadog" href="/monitoring/event-destinations/datadog">
    Send events as logs in Datadog
  </Card>

  <Card title="New Relic" href="/monitoring/event-destinations/new-relic">
    Send events as logs in New Relic
  </Card>

  <Card title="Sentry" href="/monitoring/event-destinations/sentry">
    Send events as issues in Sentry
  </Card>
</CardGroup>

### Setup manually

You can set up a Webhook Destination by following these steps:

1. From the Settings > Monitoring page, click the **Add Destination** button at the top right.

2. In the **Type** field, select **Webhook (HTTP Request).**

3. In the **URL** field, enter the desired URL to receive the event payload.

4. Optionally, in the **Request Payload** field, you can change the format of the payload. By default, the webhook will receive the full event object (`$.event`). Use `{{` to specify a part of the event data to use in the request payload.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-15%20at%2017.35.15.gif?maxW=990&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=fbeee4f8bc06832bc9daab3b172e2d30" alt="" width="990" height="552" data-path="assets/Kapture 2022-11-15 at 17.35.15.gif" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-15%20at%2017.35.15.gif?w=280&maxW=990&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=802f8f7137a52d858cdca14188e866a3 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-15%20at%2017.35.15.gif?w=560&maxW=990&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=dae89f2fe14d4d53afcf64c4a8fc83e5 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-15%20at%2017.35.15.gif?w=840&maxW=990&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c28122f970bcac7e0e60c7e3375678cd 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-15%20at%2017.35.15.gif?w=1100&maxW=990&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=50296b3a53d8cbacbfa227bf9a3a64cb 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-15%20at%2017.35.15.gif?w=1650&maxW=990&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=68ea743c4edce8c308c6b5386df04483 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Kapture%202022-11-15%20at%2017.35.15.gif?w=2500&maxW=990&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1ed8a7ce01cda7e47d5da21d67d70940 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Optionally, additional request headers can be specified by expanding "Show more request options".

6. Send a test request to your Webhook Destination by clicking **Test Webhook** button at the bottom left.

7. Click **Save** to create and enable the new destination.

<Note>
  **Note:** Your Webhook Destination may be automatically disabled if your webhook responds with too many non-2xx status codes for consecutive events.
</Note>

## Supported Events

The following events can be sent from your Paragon project:

<Accordion title="Workflow Failure">
  An error occurs at any point in a workflow and causes the workflow to reach the Failed status.

  **Example webhook payload:**

  ```json
  {
    "type": "workflow_failure",
    "timestamp": 1729629642607,
    "timestampISO": "2024-10-22T20:40:42.607Z",
    "message": "Workflow “Test Workflow Name“ failed for User <User ID>",
    "user": {
      "id": "<User ID>",
      "metadata": {}
    },
    "project": {
      "id": "613b038f-e9bf-49ec-bc58-ba8d620754c7",
      "name": "Test Project Name"
    },
    "integration": {
      "id": "57a96b31-c69e-421a-bb32-7a25f9c6a893",
      "type": "slack"
    },
    "workflow": {
      "id": "cae72d65-7fc6-4249-9047-48fc640bfd46",
      "name": "Test Workflow Name"
    },
    "data": {
      "type": "workflow_failure",
      "projectId": "613b038f-e9bf-49ec-bc58-ba8d620754c7",
      "workflowId": "cae72d65-7fc6-4249-9047-48fc640bfd46",
      "workflowExecution": {
        "id": "07911c9b-2006-4348-938b-b7ebac94dc1f"
      },
      "stepExecution": {
        "stepId": "3507a59f-d552-45a5-8bca-ed5315111ca0",
        "instanceId": "45ab5c3d-5ad3-46a0-9b79-692b4c06520d",
        "startTime": 1729629642606,
        "endTime": 1729629642606
      },
      "timestamp": 1729629642606,
      "error": "Test error message",
      "executionUrl": "https://dashboard.useparagon.com/connect/projects/613b038f-e9bf-49ec-bc58-ba8d620754c7/history/workflows/cae72d65-7fc6-4249-9047-48fc640bfd46/executions/07911c9b-2006-4348-938b-b7ebac94dc1f"
    }
  }
  ```
</Accordion>

<Accordion title="Credential Failure">
  An error occurs during the OAuth refresh process which cannot be retried. After this error, the user's credential will be [marked as invalid](/apis/users#validating-account-status-with-the-credentialstatus-property).

  Use this event to notify your user to revisit the Connect Portal in your app and re-establish the connection to the affected integration.

  **Example webhook payload:**

  ```json
  {
    "type": "credentials_failure",
    "timestamp": 1729629449422,
    "timestampISO": "2024-10-22T20:37:43.849Z",
    "message": "Connected User “<User ID>“ credential for <Integration> expired and can not be refreshed.",
    "user": {
      "id": "<User ID>",
      "metadata": {}
    },
    "project": {
      "id": "613b038f-e9bf-49ec-bc58-ba8d620754c7",
      "name": "Test Project Name"
    },
    "integration": {
      "id": "57a96b31-c69e-421a-bb32-7a25f9c6a893",
      "type": "slack"
    },
    "data": {
      "userId": "<User ID>",
      "error": "invalid_grant"
    }
  }
  ```
</Accordion>

We are working on adding support for more events. Have a request for other events you'd like to send from your Paragon project? [Let us know](mailto:team@useparagon.com).


# Sending Events to Datadog
Source: https://docs.useparagon.com/monitoring/event-destinations/datadog

Send notifications from your Paragon project into Datadog.

You can configure a Webhook Destination with a preconfigured payload to send messages into Datadog when events, like workflow failures, occur in your Paragon project.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(56).png?maxW=1722&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=3179b2c8017a7289bf529d44b378d20c" alt="" width="1722" height="784" data-path="assets/image (56).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(56).png?w=280&maxW=1722&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=f53f090a0000cdde24fcefb254e00def 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(56).png?w=560&maxW=1722&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=088cd455041eae3bfa40ca540d828963 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(56).png?w=840&maxW=1722&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=7e9c540f53bf4e8376f542afaa3082c8 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(56).png?w=1100&maxW=1722&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=5a10ec6aa71923918772759701e50229 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(56).png?w=1650&maxW=1722&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=8e561725a2b59339d9c316d56282d956 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(56).png?w=2500&maxW=1722&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=544f3291c42fb6ac23ce022fd3a90c44 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Info>
  **Webhook Destinations are available for Paragon customers on Pro and Enterprise plans.** To learn more, contact your Customer Success Manager or [sales@useparagon.com](mailto:sales@useparagon.com).
</Info>

## Configure Datadog

To send notifications to Datadog, you will need to add an API Key to your Datadog organization:

1. In the bottom right menu of your Datadog account, navigate to **Organization Settings**.

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(8).png?maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=a25ae02e07b1622db06c1a84be211253" alt="" width="1500" height="590" data-path="assets/Frame 1 (8).png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(8).png?w=280&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=3166d2c362a90bd78676d2aec3babead 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(8).png?w=560&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=270bac86de0681ec0e03616e061edeaa 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(8).png?w=840&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=2322363d24d8ee62a6eac65b68f3c500 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(8).png?w=1100&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=968e37eec966f110b182596e8885cfc5 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(8).png?w=1650&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=8cf8ea6ddfe46fbe23d58c5716a5e3de 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(8).png?w=2500&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=7644cac5bd8cf49e13a5e4321fb86486 2500w" data-optimize="true" data-opv="2" />
</Frame>

2. Under **Access**, click the **API Keys** settings page.

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(34).png?maxW=2088&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=1722c087aa69343cad69175a299c0f10" alt="" width="2088" height="862" data-path="assets/image (34).png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(34).png?w=280&maxW=2088&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=5255812de5766240a5d3377293bddd87 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(34).png?w=560&maxW=2088&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=b51d69ef29464a73b33b4fe05f38182e 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(34).png?w=840&maxW=2088&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=eabf4279c3789e8c2e6e82341d94ea53 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(34).png?w=1100&maxW=2088&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=d2627f35890df1032a07dd65052bd8fa 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(34).png?w=1650&maxW=2088&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ea90a931a7cf231e24bdf1bfec896142 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(34).png?w=2500&maxW=2088&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=000daf8a12b6cd56d7de53150bb5cb33 2500w" data-optimize="true" data-opv="2" />
</Frame>

3. Click **New Key** and name the key something recognizable, like "Paragon".

4. Once the new API Key value appears, click **Copy Key**. You will need this value to add the Event Destination below.

You will also need to make note of your Datadog Site value, which you can get from your Datalog Login URL or the `DD-SITE` value used in your Datadog agent:

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(10).png?maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=eb3b6373ace683afb17f144db5f6c7d9" alt="" width="1500" height="62" data-path="assets/Frame 1 (10).png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(10).png?w=280&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b964f22402ac7309d2fd884c13a5e483 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(10).png?w=560&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=c14537199a4e9efda225eeba193c43e4 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(10).png?w=840&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=5a704261c5237c1b05cb212e7ae5e54f 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(10).png?w=1100&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=4306a0f0ebbe69697f74537d1f9d1d9f 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(10).png?w=1650&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=f5073f0a1691f1f9275beb759af20bde 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(10).png?w=2500&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=6763aacad88136196832829a7254f042 2500w" data-optimize="true" data-opv="2" />
</Frame>

In the above URL for the Datadog dashboard, **us5.datadoghq.com** is the Datadog Site.

## Create Event Destination

*To create an Event Destination with Datadog, you will need to have followed the above steps to obtain a **Datadog Site and Datadog API Key.***

1. From the Settings > Monitoring page, click the **Add Destination** button at the top right.

2. In the **Type** field, select **Webhook (HTTP Request).**

3. Click "Select Template" next to **Request Payload** and select **Datadog**.

4. In the **URL** field, replace `<DD-SITE>` with your **Datadog Site** value (e.g. `us5.datadoghq.com`).

5. In the **Request Headers** table, replace `<DD-API-KEY>` with your **Datadog API Key**.

6. Click **Test Webhook** to verify that a log can be sent successfully to your Datadog instance.

7. Click **Save** to create and enable the Event Destination.


# Sending Events to New Relic
Source: https://docs.useparagon.com/monitoring/event-destinations/new-relic

Send notifications from your Paragon project into New Relic.

You can configure a Webhook Destination with a preconfigured payload to send messages into New Relic when events, like workflow failures, occur in your Paragon project.

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(17).png?maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=b680ba84439ae63c538abe85305a75a4" alt="" width="1728" height="642" data-path="assets/image (17).png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(17).png?w=280&maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=dcfb8ea605b6186ecc83d59a0bb3a3c7 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(17).png?w=560&maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=d27ca9a57f73449fc05ade1310f0e9c8 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(17).png?w=840&maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=169eed2849a89b22e29fd1cbc569e493 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(17).png?w=1100&maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=3fb105e21c5c0c798684e9a7c7a67d70 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(17).png?w=1650&maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=3ff61fca63ae69c82296249e918b720c 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(17).png?w=2500&maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=df1da8223be891c215c30a58645c6a1a 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Info>
  **Webhook Destinations are available for Paragon customers on Pro and Enterprise plans.** To learn more, contact your Customer Success Manager or [sales@useparagon.com](mailto:sales@useparagon.com).
</Info>

## Configure New Relic

To send notifications to New Relic, you will need to add an API Key to your New Relic project:

1. In the bottom right menu of your New Relic account, navigate to **API Keys.**

   <Frame>
     <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(11).png?maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=01c56c893c43f3a404526b091fde438d" alt="" width="1500" height="844" data-path="assets/Frame 1 (11).png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(11).png?w=280&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=604f18ec3df296e2983b4634bdb60be0 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(11).png?w=560&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=55d334834153036505b2129f70c94e2a 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(11).png?w=840&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=3bfa99527de180b29235f3fc2c6121b0 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(11).png?w=1100&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=4ae3951789dab532a9fceb8ef7db3a3a 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(11).png?w=1650&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=356a4f997ce62dc84f9a38ba6d3ebeb9 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(11).png?w=2500&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=32d8135db3c4cee2befaf743310aa4eb 2500w" data-optimize="true" data-opv="2" />
   </Frame>

2. Click **Create Key** and specify "Ingest - License" for the key type. Name the key something recognizable, like "Paragon".

3. Click the "..." menu next to the new key and click **Copy Key**. You will need this value to add the Event Destination below.

## Create Event Destination

*To create an Event Destination with New Relic, you will need to have followed the above steps to obtain a **New Relic API Key.***

1. From the Settings > Monitoring page, click the **Add Destination** button at the top right.

2. In the **Type** field, select **Webhook (HTTP Request).**

3. Click "Select Template" next to **Request Payload** and select **New Relic**.

4. In the **Request Headers** table, replace `<New Relic API Key>` with your **New Relic API Key**.

5. Click **Test Webhook** to verify that a log can be sent successfully to your New Relic instance.

6. Click **Save** to create and enable the Event Destination.


# Sending Events to Sentry
Source: https://docs.useparagon.com/monitoring/event-destinations/sentry

Send notifications from your Paragon project into Sentry.

You can configure a Webhook Destination with a preconfigured payload to send messages into Sentry when events, like workflow failures, occur in your Paragon project.

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(2)%20(1).png?maxW=1578&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=1e910ef61412d8ac77864ce5123950d9" alt="" width="1578" height="460" data-path="assets/image (2) (1).png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(2)%20(1).png?w=280&maxW=1578&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=11e96f5532b9185191d641f25b03e9f4 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(2)%20(1).png?w=560&maxW=1578&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ebeadebb831a185104231c08312b08d4 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(2)%20(1).png?w=840&maxW=1578&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=abb444712c484edc7715b469765daefa 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(2)%20(1).png?w=1100&maxW=1578&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=79b689177e35293bda34affc0b7e1bd0 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(2)%20(1).png?w=1650&maxW=1578&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ab7357cdcca2c6deb8873992724f1933 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(2)%20(1).png?w=2500&maxW=1578&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=e8daf82c8d56d32dc1ae0ae939960f1b 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Info>
  **Webhook Destinations are available for Paragon customers on Pro and Enterprise plans.** To learn more, contact your Customer Success Manager or [sales@useparagon.com](mailto:sales@useparagon.com).
</Info>

## Configure Sentry

To send notifications to Sentry, you will need to make note of your Sentry Public Key and Sentry Ingest URL.

1. From your Sentry Project, click the Settings gear icon on the top right.

   <Frame>
     <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-15%20at%204.04.06%20PM.png?maxW=3430&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=2df6bb0ab3859361ce1e2c88ad6d4438" alt="" width="3430" height="386" data-path="assets/Screen Shot 2022-11-15 at 4.04.06 PM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-15%20at%204.04.06%20PM.png?w=280&maxW=3430&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=350e118abb463912ce17c9bf9708de11 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-15%20at%204.04.06%20PM.png?w=560&maxW=3430&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=acc176eaf1218c4a93e300443f9c5c55 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-15%20at%204.04.06%20PM.png?w=840&maxW=3430&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=7ac958c83bbced6183255aa622840a46 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-15%20at%204.04.06%20PM.png?w=1100&maxW=3430&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3054fa762ce81a79ab0ec79ccc05798f 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-15%20at%204.04.06%20PM.png?w=1650&maxW=3430&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=cb897be4f9d780b4e9a13da8755576c1 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-15%20at%204.04.06%20PM.png?w=2500&maxW=3430&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d6d3286ed178ffce76d40bc78aecb12a 2500w" data-optimize="true" data-opv="2" />
   </Frame>

2. Under the **SDK Setup** section, click **Client Keys (DSN)**.

3. Copy your DSN. You will need to extract your Sentry Public Key and Sentry Ingest URL from this value:

   <Frame>
     <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(12).png?maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=c21dbfade4935ae9313f4eea49c496a2" alt="" width="1500" height="274" data-path="assets/Frame 1 (12).png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(12).png?w=280&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=9ecd99604255d7d0d2d34ff304442c95 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(12).png?w=560&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=a76787e849675d60b8a9b2f5be1f5591 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(12).png?w=840&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=080face1afcc4fb151b14fdf7aade96e 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(12).png?w=1100&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=db2520aba24622251d0382c0f63631ad 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(12).png?w=1650&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=d9c2c65884ed4ed41ff2743571bb35b0 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201%20(12).png?w=2500&maxW=1500&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=ea39799f710dac3e4158a9bfb614c7a7 2500w" data-optimize="true" data-opv="2" />
   </Frame>

   Once you identify the Sentry Base URL, perform the following steps to get your Sentry Ingest URL:

   1. Prefix the base URL with **"https\://"**

   2. After ".sentry.io/" and before the Project ID path, add **"api/"** to the URL. For example, with the above DSN, this would become: `https://o535635.ingest.sentry.io/api/4504082601017344`

   3. At the end of the URL, add **"/store/"**. The final Sentry Ingest URL should look like: `https://o535635.ingest.sentry.io/api/4504082601017344/store/`

   4. Save this value to use as your Sentry Ingest URL.

## Create Event Destination

*To create an Event Destination with Sentry, you will need to have followed the above steps to obtain a **Sentry Public Key and Sentry Ingest URL.***

1. From the Settings > Monitoring page, click the **Add Destination** button at the top right.

2. In the **Type** field, select **Webhook (HTTP Request).**

3. Click "Select Template" next to **Request Payload** and select **Sentry.**

4. In the **URL** field, paste your **Sentry Ingest URL.**

5. In the **Request Headers** table, replace `<Sentry Key>` with your **Sentry Public Key**.

6. Click **Test Webhook** to verify that an error can be sent successfully to your Sentry project.

7. Click **Save** to create and enable the Event Destination.


# Sending Events to Slack
Source: https://docs.useparagon.com/monitoring/event-destinations/slack

Send notifications from your Paragon project into Slack.

You can configure a Webhook Destination with a preconfigured payload to send messages into Slack when events, like workflow failures, occur in your Paragon project.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(68).png?maxW=1676&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=9a92699c49d1c49e29b5671557fc4ebd" alt="" width="1676" height="240" data-path="assets/image (68).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(68).png?w=280&maxW=1676&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=c18731b990a43d983424cddb180b05da 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(68).png?w=560&maxW=1676&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=d5677fddeb781e97a04b45d59510250b 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(68).png?w=840&maxW=1676&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=742d75347abde71b1115335560c18cf3 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(68).png?w=1100&maxW=1676&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=20e8b8e4eda1d00a9726e76eb9ddfb2f 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(68).png?w=1650&maxW=1676&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=b0a0c87714f7b47ef2072f27f76d1491 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(68).png?w=2500&maxW=1676&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=1f782e07e092c4bd649ba571b9ab1134 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Info>
  **Webhook Destinations are available for Paragon customers on Pro and Enterprise plans.** To learn more, contact your Customer Success Manager or [sales@useparagon.com](mailto:sales@useparagon.com).
</Info>

## Configure Slack

To send notifications to Slack, you will need to create a Slack App and add it to your workspace with an Incoming Webhook:

1. Visit the [Slack API Center](https://api.slack.com/) and **Create an app.**

2. When prompted to create a new app, click "From scratch". Enter a recognizable name like "Paragon" for the App Name and select your Slack Workspace.

3. Under **Features**, navigate to **Incoming Webhooks**. Turn on "Activate Incoming Webhooks".

4. Once Incoming Webhooks is activated, scroll to the bottom and click "Add New Webhook to Workspace".

5. When prompted, select a channel to send your Slack notifications to. We recommend creating a new channel for Paragon notifications. Click **Allow**.

6. Once the webhook is created, click **Copy** in the Webhook URL and save this value to add to Paragon. The value will begin with "`https://hooks.slack.com/...`"

## Create Event Destination

*To create an Event Destination with Slack, you will need to have followed the above steps to obtain a **Slack Webhook URL.***

1. From the Settings > Monitoring page, click the **Add Destination** button at the top right.

2. In the **Type** field, select **Webhook (HTTP Request).**

3. Click "Select Template" next to **Request Payload** and select **Slack**.

4. In the **URL** field, paste the Webhook URL you copied in the previous steps.

5. Click **Test Webhook** to verify that a message gets sent into the Slack channel you selected earlier.

6. Click **Save** to create and enable the Event Destination.


# Event Logs
Source: https://docs.useparagon.com/monitoring/event-logs

Search, view, and trace logs for all Paragon events.

Event Logs allow you to search, view, and trace logs for all events that occur in your Paragon project. Event Logs contain
relevant information that helps you build a complete picture of data moving from your app and your user's integrations into
your Paragon project.

We are launching Event Logs starting with a focus on workflow trigger events such as (custom) webhooks, scheduler triggers, request triggers,and app events.

For example, if you'd like to see how an incoming webhook event from an integration was processed, you can filter by integration and trace the resulting workflow execution.

<Warning>
  Event Logs is currently in a *public beta*. We are currently adding support for [more events](/monitoring/event-logs#unsupported-events).

  Event Log schemas and the log retention policy are subject to change.
</Warning>

You can find you project's Event Logs by navigating to the global **Task History** tab in the left sidebar and selecting the **Logs** tab.

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/event-logs-1.gif?maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=0dcb4f71651e512a3d397680accf9a44" alt="" width="1728" height="1080" data-path="assets/event-logs-1.gif" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/event-logs-1.gif?w=280&maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=b27c94200488477ad060d3d028856f93 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/event-logs-1.gif?w=560&maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=eb1e65a0e6105e6066909f2adcfb4212 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/event-logs-1.gif?w=840&maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=e446e9100779c4cdcf4b2446b8a5c7d2 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/event-logs-1.gif?w=1100&maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=1aa6fece771532910015bbe0c4746f53 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/event-logs-1.gif?w=1650&maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=3ae9529dcac1b3df3cf7d5189fa4a320 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/event-logs-1.gif?w=2500&maxW=1728&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=04fcfc5ae9cdce8d51e01804185edb69 2500w" data-optimize="true" data-opv="2" />
</Frame>

Event Logs contain the following top-level properties:

* **Timestamp**: The date and time the event occurred.
* **Type**: The Paragon feature emitting the event.
* **Message**: The message associated with the event.

## Log Details

By expanding a log, you can view the full event object including the payload, associated Trace IDs, User IDs, and more.

| **Property**                | **Description**                                                                      |
| --------------------------- | ------------------------------------------------------------------------------------ |
| `projectId`                 | Unique identifier for the Paragon project under which the trigger or workflow runs.  |
| `personaId`                 | ID representing the persona (or agent) responsible for executing the trigger.        |
| `type`                      | Indicating the type of trigger or event.                                             |
| `endUserId`                 | Identifier for the end user associated with the event or workflow.                   |
| `connectCredentialId`       | ID of the credential used to connect to an integration.                              |
| `connectCredentialConfigId` | ID for the specific configuration of the credential in use.                          |
| `workflowId`                | Identifier for the workflow that is being triggered or executed.                     |
| `traceId` 🔸                | Identifier used to group logs from the same trigger execution for traceability.      |
| `integrationId` 🔸          | ID of the integration involved, especially for integration or webhook triggers.      |
| `webhookId` 🔸              | Identifier for the webhook associated with a trigger (when applicable).              |
| `eventId` 🔸                | ID for the specific App Event received.                                              |
| `eventName` 🔸              | Name of the App Event being triggered.                                               |
| `error` 🔸                  | Error object included in failure logs to describe the problem.                       |
| `status` 🔸                 | Indicates the result of the operation, such as `EVENT_STATUS.SUCCEEDED` or `FAILED`. |

🔸 Indicates an optional property

## Filtering and Searching

You can filter the Event Logs view using these filter dropdowns:

* **Level**: The severity of the event.
* **Type**: The Paragon feature emitting the event.
* **User ID**: The Paragon user ID who triggered the event.
* **Integration ID**: The integration associated with the triggered event.
* **Trace ID**: The trace ID of the event.
* **Timestamp**: The date and time the event occurred.

Additionally, you can search for specific payload properties by entering a search query in the search bar. For example, if you'd like to search for all logs that contain a particular record ID, you can enter the record ID in the search bar
and the table will filter Log Events where the payload contains that record ID.

## Supported Events

Here are the following event types that can appear in your Event Logs:

<Accordion title="App Events">
  App Events logs are emitted when a workflow is triggered by the Paragon SDK. Learn more about [App Events here](/workflows/triggers/app-events).

  * App Event Trigger Started
  * App Event Trigger No workflows subscribed for trigger
  * App Event Trigger Submitting workflows for execution
  * App Event Trigger Workflows submitted successfully
  * App Event Trigger Workflow submission failures
  * Error preparing workflow for event trigger
  * App Event Trigger No workflow configured with event eventName
</Accordion>

<Accordion title="Request Trigger">
  Request Trigger events are emitted when a workflow is attempted to be triggered by an HTTP request sent to the Paragon Request Trigger.  Learn more about [Request Triggers here](/workflows/triggers/request-trigger).

  * Request Trigger Started
  * Request Trigger workflow submitted for execution
  * Request Trigger execution response timeout occurred
  * Request Trigger Failed
</Accordion>

<Accordion title="Integration Enabled Trigger">
  Integration Enabled Trigger events are emitted when a user initially actives your integration. Learn more about [Integration Enabled Triggers here](/workflows/triggers/integration-enabled-trigger).

  * Integration Enabled Trigger Started
  * Integration Enabled Trigger workflow submitted for execution
  * Integration Enabled Trigger Failed
</Accordion>

<Accordion title="Scheduler Trigger">
  Scheduler Trigger events are emitted when a workflow is triggered according to a Scheduler Trigger's cadence. Learn more about [Scheduler Triggers here](/workflows/triggers/scheduler-trigger).

  * Scheduler Trigger submitting workflow for execution
  * Scheduler Trigger failed to submit execution for workflow
</Accordion>

<Accordion title="Webhook Trigger">
  Webhook Trigger events are emitted when a workflow is triggered by an incoming integration webhook. Learn more about [Webhook Triggers here](/workflows/triggers/integration-trigger).

  * Webhook Trigger request received
  * Webhook Trigger processing record for user
  * Webhook Trigger submitting workflows for processed records
  * Webhook Trigger processing record for app
  * Webhook Trigger submitting workflows for app users
  * Webhook trigger failed to process record
  * Webhook Trigger processing record for resource
  * Webhook Trigger Submitting workflow for resource
  * Webhook trigger failed to process record for resource
  * Webhook Trigger failed to process record
</Accordion>

<Accordion title="[Coming Soon] User Credentials">
  Credential refresh events are emitted when we attempt to refresh a user's access tokens.

  * Credential refresh attempted
  * Credential refresh failed
  * Credential refresh succeeded
</Accordion>

### Unsupported Events

The following events are not currently supported in Event Logs:

* Task executions and their individual outbound API requests
* Workflow execution events
* Requests made to or received by [Resources](/workflows/api-resources).
* Connected User events

Have a request for other events you'd like to send from your Paragon project? Reach out to your account manager or [let us know](mailto:nick@useparagon.com).

## Connecting with Event Destinations

<Info>An integration with [Event Destinations](/monitoring/event-destinations) is coming soon.</Info>

Send Event Logs to your logging, analytics, and APM services by configuring [Event Destinations](/monitoring/event-destinations). All Event Logs can be
forwarded to your observability tools for increased retention and analysis via Event Destinations.


# Managing Connected Users
Source: https://docs.useparagon.com/monitoring/users

Manage connected users and their integrations.

The **Connected Users Dashboard** provides an overview of your users and their connected integrations. For example, you can view which workflows your customers enable or disconnect integrations if they stop paying.

In the Connected Users Dashboard, you can find information about each user:

* **Name/User ID** (e.g. `bowie@useparagon.com` or Paragon)
* **Status** (e.g. Connected or Account Errors)
* **Integrations Enabled** (e.g. Salesforce)
* **Date Created**

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect%20(1).png?maxW=2760&auto=format&n=867oBBVpxd2C3zc4&q=85&s=3302b47580f971a8f25c7c00a717a41f" alt="" width="2760" height="1012" data-path="assets/Viewing Connected Users in the Connected Users Dashboard in Paragon Connect (1).png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect%20(1).png?w=280&maxW=2760&auto=format&n=867oBBVpxd2C3zc4&q=85&s=0a20ba602113631a326abb557cce8191 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect%20(1).png?w=560&maxW=2760&auto=format&n=867oBBVpxd2C3zc4&q=85&s=257d020ace0b4ce7a4a145ffbe09909f 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect%20(1).png?w=840&maxW=2760&auto=format&n=867oBBVpxd2C3zc4&q=85&s=e133ebbf743dfbdee7988dbcfa7731e4 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect%20(1).png?w=1100&maxW=2760&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9ee8be8f4503003235c9255ee3abac02 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect%20(1).png?w=1650&maxW=2760&auto=format&n=867oBBVpxd2C3zc4&q=85&s=90bc619594c4fd9d8c981968e9a7a06c 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Connected%20Users%20in%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect%20(1).png?w=2500&maxW=2760&auto=format&n=867oBBVpxd2C3zc4&q=85&s=775522d365bc79376fbec76f981bc416 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Managing Integrations

The Connected Users Dashboard provides an overview of your user's connected integrations. You can uninstall any integration your user has connected to. This will permanently remove this user's connected account for the integration. They will need to revisit the Connect Portal to reconnect their account.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Uninstalling%20an%20Integration%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.gif?maxW=1366&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=4e9475c6a7716db5337f2bda00e3224c" alt="" width="1366" height="775" data-path="assets/Uninstalling an Integration from the Connected Users Dashboard in Paragon Connect.gif" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Uninstalling%20an%20Integration%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.gif?w=280&maxW=1366&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=0b018e9149ef83405c9f76ab6b322b70 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Uninstalling%20an%20Integration%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.gif?w=560&maxW=1366&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=71c790d8894c300b992fa24b615acb8d 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Uninstalling%20an%20Integration%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.gif?w=840&maxW=1366&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=e835cf5ca103e916fecfcabb47409146 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Uninstalling%20an%20Integration%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.gif?w=1100&maxW=1366&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=c229fa42667001a0a4e745ef33cd1a2a 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Uninstalling%20an%20Integration%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.gif?w=1650&maxW=1366&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=d6a381b8117483e3a4df1ca1833cc877 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Uninstalling%20an%20Integration%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.gif?w=2500&maxW=1366&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=3a25b4adf01fee162c9e2f9c84ef5295 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Note>
  **Note:** Integration-enabled trigger workflows are displayed as **"Not Enabled"** when viewing users' integrations in the Connected Users Dashboard.

  This status does not affect functionality; the workflow will trigger and execute successfully once activated by the Connected User. You can confirm the workflow’s execution via the [Task History](/monitoring/viewing-task-history) page.
</Note>

### Disabling Users

You can disable users to stop their workflows and prevent them from using the Connect Portal. You can re-enable the user later.

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20users%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?maxW=2290&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=c46877f7d7f7d6702f7972da6868474d" alt="" width="2290" height="1024" data-path="assets/Disabling users from the Connected Users Dashboard in Paragon Connect.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20users%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=280&maxW=2290&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=2093b9cf56bd772845250cdaf362dc7e 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20users%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=560&maxW=2290&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=31708177af2aa4e1260f8cefe443c2f7 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20users%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=840&maxW=2290&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=a13855b336eaa242c0c76b42d26bdae7 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20users%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=1100&maxW=2290&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=99d332a158bd2a1d42161155ee8efcf9 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20users%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=1650&maxW=2290&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=d675e0c0158611454023fef7a701e6d0 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20users%20from%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=2500&maxW=2290&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=e9b7d3a9c75640f017921cac88a13be9 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Disabling Workflows for Users

You can also disable workflows for specific users. Any disabled workflow can be re-enabled by the user in the Connect Portal.

To disable a workflow for a user:

1. Select the integration the workflow belongs to.
2. Click the triple-dot menu to the right of the workflow you would like to disable.
3. Select **Disable workflow for user**.

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20Workflows%20for%20Users%20in%20Paragon%20Connect.png?maxW=2288&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=d18517643edcc8a90087e00af6f10a25" alt="" width="2288" height="1404" data-path="assets/Disabling Workflows for Users in Paragon Connect.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20Workflows%20for%20Users%20in%20Paragon%20Connect.png?w=280&maxW=2288&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=c000d52e6a6f4d8b061034da7be99b9b 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20Workflows%20for%20Users%20in%20Paragon%20Connect.png?w=560&maxW=2288&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=f612c734dd34a029c019da4fb57494d3 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20Workflows%20for%20Users%20in%20Paragon%20Connect.png?w=840&maxW=2288&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=12c934d58b902e652cd9e3fad0a5dae8 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20Workflows%20for%20Users%20in%20Paragon%20Connect.png?w=1100&maxW=2288&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=2a13b48613f6559dcfef656eda1dfbe7 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20Workflows%20for%20Users%20in%20Paragon%20Connect.png?w=1650&maxW=2288&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=acb705fa90591d9de5ea24fc8cebb53b 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Disabling%20Workflows%20for%20Users%20in%20Paragon%20Connect.png?w=2500&maxW=2288&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=f7717c403a67ebe3c870d18e80a1e8ec 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Viewing Workflow Executions

You can view workflow executions for a specific user within the Connected Users Dashboard.

To view a Connected User's workflow executions:

1. Select the Connected User you would like to view the workflow executions for.
2. Scroll to the **Task History** section at the bottom of the page.
3. Click the **View Task History** button.

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20within%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?maxW=2252&auto=format&n=867oBBVpxd2C3zc4&q=85&s=12f05b30c0ecd1fa6cf3f8387275eacf" alt="" width="2252" height="1166" data-path="assets/Viewing Task History within the Connected Users Dashboard in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20within%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=280&maxW=2252&auto=format&n=867oBBVpxd2C3zc4&q=85&s=98ed2c710aab97b1c063da7ae9425cc5 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20within%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=560&maxW=2252&auto=format&n=867oBBVpxd2C3zc4&q=85&s=a57c6961ea9c202a33164c78a967b003 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20within%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=840&maxW=2252&auto=format&n=867oBBVpxd2C3zc4&q=85&s=526a7d1ee19b205e3035a9e479705d3d 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20within%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=1100&maxW=2252&auto=format&n=867oBBVpxd2C3zc4&q=85&s=fb335e705bd612632c9bcd6468a547c2 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20within%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=1650&maxW=2252&auto=format&n=867oBBVpxd2C3zc4&q=85&s=0221d1499632354884354fa6179718be 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20within%20the%20Connected%20Users%20Dashboard%20in%20Paragon%20Connect.png?w=2500&maxW=2252&auto=format&n=867oBBVpxd2C3zc4&q=85&s=4928bf67f9112ec943f44e4b1b98c858 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Viewing Task History
Source: https://docs.useparagon.com/monitoring/viewing-task-history

Quickly view a timeline and status of previous workflow executions.

## Overview

Task History keeps track of your workflow executions and lives on the left side of the dashboard. It serves as a timeline and an easy way to navigate through your workflow history, revisit any failed workflows, and get a step-by-step breakdown of the executed tasks in each one.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7b8a80c72d6c34a64187ebfd070fc689" alt="" width="3212" height="1128" data-path="assets/Viewing Task History in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=280&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=1df7559bbc63f67a421126484057a7b6 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=560&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=544ece058c61167627944214a787aa64 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=840&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7fb503c79e3d40a800f96ec9393ebe37 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=1100&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=bea92f72acc6685733eec38887b2be0b 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=1650&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=02931ddcb429ad91b3839ea35217785d 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Task%20History%20in%20Paragon%20Connect.png?w=2500&maxW=3212&auto=format&n=867oBBVpxd2C3zc4&q=85&s=de98f14834fff6de7e9ff595415d0ed4 2500w" data-optimize="true" data-opv="2" />
</Frame>

Under Task History, you can find information about each workflow:

* **Status** (e.g. Success or Errored)
* **Trigger method** (e.g. every 5 minutes or via an App Event)
* **Integration** (e.g. Salesforce)
* **User** who triggered the workflow
* **Time and date** your workflow ran

Clicking anywhere on a workflow provides you with a detailed view of the status of each step related to that workflow. By default, Paragon stores workflow executions for up to 90 days. This number can be configured for users on [on-premise installations](/on-premise/hosting-paragon-on-premise).

<Tip>
  **Want this data in an API?**

  [Task History API](/apis/task-history) is available. To learn more, contact your Customer Success Manager or [sales@useparagon.com](mailto:sales@useparagon.com).
</Tip>

## Detailed task execution

Each workflow in your Task History includes a step-by-step breakdown of the tasks related to the workflow. In this view, the Task History also shows:

* How long it took your workflow to run
* Number of tasks executed
* List of each executed step

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Paragon%20Connect%20workflow%20execution.png?maxW=1948&auto=format&n=867oBBVpxd2C3zc4&q=85&s=2c294135bb68d66834fb12722e8a01d4" alt="" width="1948" height="1068" data-path="assets/Viewing a Paragon Connect workflow execution.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Paragon%20Connect%20workflow%20execution.png?w=280&maxW=1948&auto=format&n=867oBBVpxd2C3zc4&q=85&s=34b99714a9bdef4b521570c51004a8e9 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Paragon%20Connect%20workflow%20execution.png?w=560&maxW=1948&auto=format&n=867oBBVpxd2C3zc4&q=85&s=127f5c56b438bddc8889d56d5a3ef86e 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Paragon%20Connect%20workflow%20execution.png?w=840&maxW=1948&auto=format&n=867oBBVpxd2C3zc4&q=85&s=381cdd4a4c6d6ecf1c309ce335a44231 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Paragon%20Connect%20workflow%20execution.png?w=1100&maxW=1948&auto=format&n=867oBBVpxd2C3zc4&q=85&s=90942deaa970cef71afb67d42599963c 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Paragon%20Connect%20workflow%20execution.png?w=1650&maxW=1948&auto=format&n=867oBBVpxd2C3zc4&q=85&s=26f45239d8a00a0737b21ff3eaa26b2f 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Paragon%20Connect%20workflow%20execution.png?w=2500&maxW=1948&auto=format&n=867oBBVpxd2C3zc4&q=85&s=811e5aca29b680d6e286213dcf7572e8 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Following your workflow

Paragon also allows you to visualize the flow of data throughout each workflow execution, making it easy for teams to track and debug. A **blue path** indicates the path taken by your workflow while running. A **grey path** indicates the path exists in the workflow but was not taken during this execution.

<Frame>
  ![](https://gblobscdn.gitbook.com/assets%2F-MCJwlyhqtCdBfCLUO0d%2F-MCNcV5-7xwbNryBslGB%2F-MCNciZkbDBTPg4EBUXT%2FFollowing%20workflow%20execution.png?alt=media\&token=3d1189a4-7ce2-4153-97d3-dd551fa63d39)
</Frame>

## Editing and replaying

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=fe453805d6bbadce4d3c97cab615d69b" alt="" width="2150" height="770" data-path="assets/Editing and Replaying Tasks in Paragon Connect.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?w=280&maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=a0ed16354fe17749c913da5dc8728d46 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?w=560&maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=674fd63e204410abbca2e8f310b9da4a 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?w=840&maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=e32e0ba38882b47d8c3da5381fac918f 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?w=1100&maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=bf1d743e62bcf896d5dfd9fc38cb9fe8 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?w=1650&maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=d46df5222f97c340539da593b2852b3f 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?w=2500&maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=ffa4f67c6b9d9e6c821854dc27ed6df4 2500w" data-optimize="true" data-opv="2" />
</Frame>

* **Editing the Workflow:** Pressing the "Edit Workflow" button allows you to make changes to your workflow.
* **Replaying the Workflow:** Pressing the "Replay" button re-runs your currently deployed workflow. This is useful if you want to replay a workflow that initially failed.

<Info>
  **Replaying a workflow**

  This replays your workflow in its **execution state** with the original input data. Workflows with an [Integration Enabled trigger](/workflows/triggers/integration-enabled-trigger) cannot be replayed.
</Info>

## Filtering

Filtering your Task History allows you to view the history of specific workflows that meet the criteria you specify while hiding the others.

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Filtering%20workflow%20executions%20in%20Paragon%20Connect.png?maxW=2792&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=4dbfc77fecc4495a7830b37afb321603" alt="" width="2792" height="838" data-path="assets/Filtering workflow executions in Paragon Connect.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Filtering%20workflow%20executions%20in%20Paragon%20Connect.png?w=280&maxW=2792&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=83a19831c5152bb5b1b27aca5c4d7ab1 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Filtering%20workflow%20executions%20in%20Paragon%20Connect.png?w=560&maxW=2792&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=154a4226150c23f7e1d974fb0b4874fe 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Filtering%20workflow%20executions%20in%20Paragon%20Connect.png?w=840&maxW=2792&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=32e4307a96ddad30592b5458eace5af9 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Filtering%20workflow%20executions%20in%20Paragon%20Connect.png?w=1100&maxW=2792&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=123defb47a5801df706fcb16872a5f5e 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Filtering%20workflow%20executions%20in%20Paragon%20Connect.png?w=1650&maxW=2792&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=1f178c95cab2ff5617552a46dd03f256 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Filtering%20workflow%20executions%20in%20Paragon%20Connect.png?w=2500&maxW=2792&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=85e34ac98f8524cd2c50d06f149087f9 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can filter your Task History by:

* **User ID**
* **Status**
  * Queued
  * Running
  * Waiting
  * Success
  * Errored
  * Paused
  * Cancelled
* **Workflow name**
* **Integration name**
* **Date range**

## Debugging

Paragon provides a detailed breakdown of the data input and output of each step. Click on any step to view its status and data. You can make changes to a step by clicking the "Edit Step" button. Doing so will open the workflow editor and display the related step, where you can update it as needed.

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Debugging%20a%20Salesforce%20Workflow%20in%20Paragon%20Connect.png?maxW=2650&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=a94f1c3b4247280b16473232a3c4cf6d" alt="" width="2650" height="1582" data-path="assets/Debugging a Salesforce Workflow in Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Debugging%20a%20Salesforce%20Workflow%20in%20Paragon%20Connect.png?w=280&maxW=2650&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=20b893018bffdca6fda4d41bd03faa2f 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Debugging%20a%20Salesforce%20Workflow%20in%20Paragon%20Connect.png?w=560&maxW=2650&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ebf0bf3fd53b0fdb670adcdc342bb126 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Debugging%20a%20Salesforce%20Workflow%20in%20Paragon%20Connect.png?w=840&maxW=2650&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=91f72360c305722cc9d2b2736687596c 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Debugging%20a%20Salesforce%20Workflow%20in%20Paragon%20Connect.png?w=1100&maxW=2650&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=41c02d049cbbb6bdbe769c9bb80a3d29 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Debugging%20a%20Salesforce%20Workflow%20in%20Paragon%20Connect.png?w=1650&maxW=2650&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e56e29154224ad1f907896f87c9a549f 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Debugging%20a%20Salesforce%20Workflow%20in%20Paragon%20Connect.png?w=2500&maxW=2650&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=faf154812de65c35ee451c0fdf5bd2b1 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Application Architecture
Source: https://docs.useparagon.com/on-premise/application-architecture



## Overview

Paragon is composed of multiple microservices running within Kubernetes or Docker. While there are over 30 packages and microservices, the microservices can generally be grouped into two groups:

* Configuration
* Execution

The read-and-write patterns and volumes for each often differ significantly, so the services and their dependencies are decoupled so they can run independently.

### Configuration

When you log into Paragon, you can add team members, create workflows, configure steps, add and edit secrets, and more. All of these actions and their data fall under the **Configuration** category and are persisted in real-time to Postgres. Postgres acts as the source of truth, and when you are editing your configurations, they’re generally immediately persisted into Postgres.

### Execution

When workflows or connect proxy requests are triggered, they use cached versions of the configurations (e.g. workflows and steps, credentials, etc). Request volumes can be in the tens or hundreds of millions which require reads and writes in the microsecond-millisecond range. Generally, executions rely on cached data in Redis built from configurations stored in Postgres. Logs/results are flushed to Postgres periodically in batches to reduce the load on servers.

## Datastores

A diagram of where data is stored can be found below.

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Data%20Flow%20Diagram.png?maxW=1724&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=0d287570f2a4ad5702f6c5229493dd7e" alt="" width="1724" height="1390" data-path="assets/Paragon Data Flow Diagram.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Data%20Flow%20Diagram.png?w=280&maxW=1724&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=021e32f3a8b372d5f39c0f9c71d68365 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Data%20Flow%20Diagram.png?w=560&maxW=1724&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f4b37f6d0655512ed571d6cef849bffa 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Data%20Flow%20Diagram.png?w=840&maxW=1724&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=eba9af391bbe29e3f0971dd019ca6605 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Data%20Flow%20Diagram.png?w=1100&maxW=1724&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=cfef455f441488a92a4faff3b90618cc 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Data%20Flow%20Diagram.png?w=1650&maxW=1724&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=6b55b9e246b90246e3bca577e4bbff3b 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Data%20Flow%20Diagram.png?w=2500&maxW=1724&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=7e4eb380750cd4ece2b0096379d84c2a 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Microservice Communication

Microservices communicate with each other in one of two methods:

* [Event-based (Redis)](/on-premise/application-architecture#event-based-communication-redis)
* [HTTP](/on-premise/application-architecture#http-based-communication)

###

Requests that fall in the **Execution** category (e.g. executing live workflows, Connect proxy requests, etc) and may happen in large volumes are queued in Redis as jobs. This allows the services to dynamically scale to meet the volume without losing data, retry failed jobs, and provide metrics on throughput, failure rates, and job metadata.

### HTTP-based Communication

Requests that fall in the **Configuration** category (e.g. editing workflows, adding team members, etc) that usually occur in low volumes are typically handled via HTTP calls over the private network. Custom tooling is used to add retry logic based on response codes, provided distributed tracing, validate payloads, and more.

## Queuing Retry Logic

Requests that fall in the **Execution** category (e.g. executing live workflows, Connect proxy requests, etc) have sophisticated logic around retries, some configurable and some automatic.

### Configurable step retries

Auto-retries can be enabled in the sidebar next to your steps. This will retry steps with jitter and exponential backoff upon failure. This is useful for when rate limits may be hit or other faulty APIs.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Retries%20in%20a%20Paragon%20Workflow.png?maxW=471&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=429663bf144b30c7882fa03b3d72f0ba" alt="" width="471" height="127" data-path="assets/Step Retries in a Paragon Workflow.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Retries%20in%20a%20Paragon%20Workflow.png?w=280&maxW=471&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=b1b99f2d39adc0a6b49a85fb8f8aebd5 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Retries%20in%20a%20Paragon%20Workflow.png?w=560&maxW=471&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=56917edd024f329b414d9773eb8dc106 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Retries%20in%20a%20Paragon%20Workflow.png?w=840&maxW=471&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=ec93136e9e29daa76d5ed51f30567b47 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Retries%20in%20a%20Paragon%20Workflow.png?w=1100&maxW=471&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=d9a9735ef0c83917c3461afc9b6c9d9e 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Retries%20in%20a%20Paragon%20Workflow.png?w=1650&maxW=471&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=d66270307a0ca52aff5ed1089bf81917 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Retries%20in%20a%20Paragon%20Workflow.png?w=2500&maxW=471&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=285570901efb411ee25bae242abbd8ca 2500w" data-optimize="true" data-opv="2" />
</Frame>

### System retries

When system errors are detected, like internal network errors or memory issues, the jobs will automatically retry.

### Automatic failures

In some cases, Paragon won’t attempt a request and automatically fail it if it knows the request won’t succeed. An example of this would include expired credentials - if Paragon isn’t able to refresh a credential, then other requests with the authenticated credential will fail.

## Back pressure and autoscaling

Requests that fall in the **Execution** category (e.g. executing live workflows, Connect proxy requests, etc) are queued in Redis to prevent data loss in case of large volumes of requests. This allows Paragon to autoscale to handle large volumes.

### Dedicated Queues

When a customer has a large volume of requests, a dedicated queue is created to process their jobs, and workers are autoscaled immediately to process the new queue. This prevents one customer from flooding primary queues and preventing requests from other customers from being processed.

### Autoscaling workers

The workers use a distributed leader election mechanism to determine the distribution of workers to queues. As soon as new queues are registered, a worker is provisioned in milliseconds to process that queue. Workers report health checks with the queue they’re working on. If a worker stops reporting that it’s working on a queue and a queue still has jobs to process, another worker will pick up the work within seconds.

Additionally, workers self-monitor and shut themselves down if there are no jobs to process in their queue.

The combination of distributed leader election, queue → worker provisioning, health checks, and self-monitoring allow Paragon to handle work across thousands of queues.

## Encryption of credentials

For all credentials and secrets, we use a custom distributed encrypted vault where each value has a unique key generated for encrypting it. The encrypted values and their keys are stored in a separate database and accessed by independent microservices, are decrypted only at execution time, and are only referenced by UUID or other non-sensitive values when represented in workflows. Additionally, the databases are all encrypted at rest, all in-memory caches also encrypt their values using separate rotating expiring keys, and data is encrypted in transit.


# Choosing a Hosting Solution
Source: https://docs.useparagon.com/on-premise/choosing-a-hosting-solution



Paragon offers several hosting solutions including:

* [Cloud](/on-premise/choosing-a-hosting-solution#cloud)
* [Single Tenant](/on-premise/choosing-a-hosting-solution#single-tenant)
* [Managed On-Premise](/on-premise/choosing-a-hosting-solution#managed-on-premise)
* [Unmanaged On-Premise](/on-premise/choosing-a-hosting-solution#unmanaged-on-premise)

## Cloud

Paragon’s cloud hosting is completely managed by Paragon and offered as a standard SaaS solution. It has the most up-to-date features and bug fixes and usually has updates several times a week. We take full responsibility for releases, patch management, security, incident response, and other standard development procedures.

This product is hosted on AWS in servers located in the United States and Europe. It is SOC2 Type 2 certified. For more information on SOC2 Type 2 certification, please visit our [Trust Center](https://security.useparagon.com/overview/eb093a6a-24dd-4fda-ad2b-6ea89cc01a75/soc-2).

You can get started in minutes by visiting the web application [here](https://dashboard.useparagon.com/signup).

#### What are the benefits?

* Get started in minutes
* Frequent releases (usually several each week)
* Fast support times

#### Who is this for?

This solution is the best for most companies. You should use it if you:

* Don’t have any legal obligations to host your data in a certain location
* Don’t have requirements to host your data alongside other customers
* Have expected volumes in the low - moderate usage of up to 10 million requests / month
* Don’t want to manage your own infrastructure

#### Who is this not for?

You should not use this solution if you:

* Need to host your data or servers in a certain country or region outside of the United States or Europe
* Expect more than 10 million requests/month
* Expect individual requests to take longer than 1 minute
* Expect to send and work with data in requests larger than 100 MB

## Single-Tenant

The single-tenant hosting solution is very similar to Paragon’s cloud hosting option except that it runs with completely dedicated resources (VPC, networks, databases, servers, etc).

This product is also hosted on AWS though in any country or region of your choosing. Releases, patch management, and infrastructure is completely managed by Paragon. This hosting solution is also [SOC2 Type 2 certified](https://www.useparagon.com/blog/soc-2-type-2).

#### What are the benefits?

* Choose a country and region to host servers and data
* Data is completely segregated from all customers
* More fault tolerant than the cloud offering
* Branded domains
* Service completely managed

#### Who is this for?

You should use this if you:

* Need your data or servers in a certain country or region
* Need your data segregated from all other customers
* Expect large volumes of traffic (over 10 million requests/month)
* Don’t want to manage your own infrastructure

#### Who is this not for?

You should not use this solution if you:

* Want to run on Azure or GCP instead of AWS

## Managed On-Premise

Managed on-premise is a hybrid offering used by almost all of our enterprise on-premise customers. It provides the security, isolation, and performance of on-premise with the ease of a cloud product.

In this offering, you will provide AWS, Azure, or GCP credentials with restricted access, and Paragon will deploy and manage the account for you. The data lives entirely in your own infrastructure and tooling.

To learn more about the access provided to the generated credentials, navigate to the docs for your cloud provider.

<Card title="Configuring Managed AWS" href="/on-premise/configure/aws" horizontal />

<Card title="Configuring Managed Azure" href="/on-premise/configure/azure" horizontal />

<Card title="Configuring Managed GCP" href="/on-premise/configure/gcp" horizontal />

#### What are the benefits?

* Choose a country and region to host servers and data
* Data is completely segregated from all customers
* Service completely managed
* Branded domains
* Unrestricted volume access

#### Who is this for?

You should use this if you:

* Need your data or servers in a certain country or region
* Need your data segregated from all other customers
* Expect large volumes of traffic (over 10 million requests / month)
* Have a dedicated devops team to configure and manage your infrastructure

## Unmanaged On-Premise

Unmanaged on-premise is a do-it-yourself version which means you deploy, configure, update and manage your Paragon installation on your cloud. In this offering, you can deploy Paragon to your own AWS, Azure or GCP cloud. It provides the highest amount of security but the largest lift in terms of engineering time required to deploy and manage.

#### What are the benefits?

* Choose a country and region to host servers and data
* Data is completely segregated from all customers
* Reuse existing infrastructure (e.g. kubernetes cluster, Postgres server, etc)

#### Who is this for?

You should use this if you:

* Have strict compliance requirements
* Have a dedicated devops team to configure, deploy and manage your installation

#### Who is this not for?

You should not use this solution if you:

* Don’t want to dedicate engineering resources to managing your infrastructure
* Need fast turnaround times for infrastructure-level issues
* Don’t have experience managing Kubernetes, Postgres, or Redis

We have an example repo for deploying Paragon to your own Azure, GCP, or AWS account. You can find it [here](https://github.com/useparagon/enterprise).


# Configuring a Managed Instance
Source: https://docs.useparagon.com/on-premise/configure



## Overview

[Paragon](https://www.useparagon.com/) allows customers the option of self-hosting Paragon on your own infrastructure. All the resources live in your AWS, Azure, or GCP, and data never leaves your cloud.

We additionally offer a Managed On-Premise solution that almost 100% of our on-prem customers use at no additional cost. In this model, our enterprise team will take care of deploying, configuring, and managing your installation to offload 100% of developer time while providing the security and transparency of owning the resources and confidence that other resources in your Azure account are inaccessible.

<Card title="Configuring Managed AWS" href="/on-premise/configure/aws" horizontal />

<Card title="Configuring Managed Azure" href="/on-premise/configure/azure" horizontal />

<Card title="Configuring Managed GCP" href="/on-premise/configure/gcp" horizontal />


# Configuring Managed AWS
Source: https://docs.useparagon.com/on-premise/configure/aws

Configure your managed Paragon instance on AWS.

## Overview

To run Paragon's software on your AWS account, you'll need to use [AWS Organizations](https://aws.amazon.com/organizations/). AWS Organizations allows you to create new AWS accounts with sandboxed resources, policies and billing completely separate from your own.

We additionally offer a Managed On-Premise solution that is used by most of our on-premise customers. In this model, our enterprise team is responsible for deploying, configuring, and managing your installation to offload 100% of developer time while providing the security and transparency of owning the resources and confidence that other resources in your AWS account are inaccessible.

### Security

We use the principle of least privileged access to grant the Paragon installer the access it needs to create and manage resources in your account. When creating an AWS Account, all resources are completely sandboxed within that account and the installer can’t access anything outside of it. Any VPCs, databases, servers, etc on your primary AWS account can’t be accessed from this account.

## Setup

## AWS Organization

**Time required**: 5 minutes

1. Visit the [AWS Organizations](https://console.aws.amazon.com/organizations/home?#/accounts) dashboard and login with an admin account.

2. Click **Add account**.

3. Click **Create account**.

4. Fill in the details

   a. **Account name:** Paragon

   b. **Email address:** [enterprise+YOUR\_ORGANIZATION@useparagon.com](mailto:enterprise+YOUR_ORGANIZATION@useparagon.com) e.g. [*enterprise+google@useparagon.com*](mailto:enterprise+google@useparagon.com)

5. That's it. We'll set it up from there


# Configuring Managed Azure
Source: https://docs.useparagon.com/on-premise/configure/azure

Configure your managed Paragon instance on Azure.

## Overview

[Paragon](https://www.useparagon.com/) allows customers the option of self-hosting Paragon on your own infrastructure. All the resources live in your AWS, Azure, or GCP, and data never leaves your cloud.

We additionally offer a Managed On-Premise solution that almost 100% of our on-prem customers use at no additional cost. In this model, our enterprise team will take care of deploying, configuring, and managing your installation to offload 100% of developer time while providing the security and transparency of owning the resources and confidence that other resources in your Azure account are inaccessible.

### Security

We use the principle of least privileged access to grant the Paragon installer the access it needs to create and manage resources in your account. For Azure customers, we recommend a combination of Azure Tenants, Azure Subscriptions, and RBAC (role-based access control). With this method:

* a new tenant is created on your Azure account with resources created belonging to that tenant and separate from all other resources
* a new subscription is created to associate all Paragon resources created within that tenant
* a role is created to manage resources in the subscription for that tenant and provided to the installer

Using this method, extra redundancies are put in place that ensures Paragon can only interact with the intended resources while providing a means for you to transparently view all resources created, separate billing to manage the resources while being connected to a parent account, and have super user access for all resources created.

## Setup

We’ll need 4 values to install Paragon.

* Tenant Id
* Subscription Id
* Client Id
* Client Secret

### Directions

1. Login to your Azure portal as an admin.

2. Create a tenant.

   a. Search `Azure Active Directory` in the search bar, navigate to your **Azure Active Directory**, and click the **Manage tenants** tab.

   b. Click **+ Create.**

   c. Select **Azure Active Directory** as the tenant type in the **Basics** tab.

   d. Click the **Configuration** tab.

   e. Enter `Paragon` as the Organization name.

   f. Enter a domain name with `paragon` and your organization’s name, i.e. `paragongoogle`. The domain must be alphanumeric.

   g. Click the **Review + create** tab.

   h. Click the **Create** button to create the tenant.

   i. Search `Azure Active Directory` in the search bar, navigate to your **Azure Active Directory**.

   j. ⭐️ Copy the text in the *Overview* section next to *Tenant ID*. This is the **Tenant Id.** ⭐️

3. Create a subscription under the tenant.

   a. Switch to your default Azure directory. You can do this by clicking your account in the top right corner and clicking **Switch directory.**

   b. Search `Subscriptions` in the search bar, and navigate to your **Subscriptions**.

   c. Click **+Add**

   d. In the **Basics** tab, enter `Paragon` for the Subscription name.

   e. Click the **Advanced** tab and select the new tenant you created for the Subscription directory.

   f. Click the **Review + create** tab.

   g. Confirm the name of the subscription is correct in the *Basics* section and the correct tenant is selected in the *Advanced* section.

   h. Click **Create**.

   i. ⭐️ Copy the id of the subscription. This is the **Subscription Id.** ⭐️

4. Create credentials for the Paragon installer.

   a. Switch to the new Paragon directory. You can do this by clicking your account in the top right corner and clicking **Switch directory.**

   b. Search `Azure Active Directory` in the search bar, navigate to your **Azure Active Directory**, and click the **App registrations** tab.

   c. Click **+ New registration.**

   d. Enter `Paragon Installer` for the name of the application.

   e. Select `Accounts in this organizational directory only` for the access type.

   f. Leave the *Redirect URI (optional)* field empty.

   g. Click **Create** to create the application.

   h. ⭐️ Save the text next to *Application (client) ID*. This is the **Client Id**. ⭐️

   i. Click **Add a certificate or secret** next to *Client credentials*.

   j. Click **+ New client secret** to create a new secret.

   k. Enter `Paragon Installer` for the description.

   l. Select `24 months` for *Expires.*

   m. Click **Add** to create the secret.

   n. ⭐️ Save the text under the *Value* column. This is the **Client Secret**. ⭐️

5. Give the new *Paragon Installer* application access to manage the newly created subscription.

   a. Search `Subscriptions` in the search bar, and navigate to your **Subscriptions**.

   b. Click the newly created *Paragon* subscription.

   c. Click **Access control (IAM)** in the left sidebar.

   d. Click **+ Add** and select **Add role assignment**.

   e. Search `Contributor` and click **View** on the right side.

   f. Click **Select role** at the bottom of the sidebar that opened.

   g. Click the **Members** tab and click **+ Select members**.

   h. Search `Paragon Installer` and select the application.

   i. Click the **Select** button at the bottom of the sidebar.

   j. Click **Review + assign** to assign the role.

## Next Steps

Once all of this is done, provide us with these four values, and we’ll set up your installation!

If you have any questions, email [enterprise@useparagon.com](mailto:enterprise@useparagon.com) for help.


# Configuring Managed GCP
Source: https://docs.useparagon.com/on-premise/configure/gcp

Configure your managed Paragon instance on GCP.

## Overview

[Paragon](https://www.useparagon.com/) allows customers the option of self-hosting Paragon on your own infrastructure. All the resources live in your AWS, Azure or GCP account GCP, and data never leaves your cloud.

We provide a managed on-prem solution at no additional cost. In this model, our enterprise team will take care of deploying, configuring, and managing your installation to offload almost 100% of developer time while providing the security and transparency of owning the resources and confidence that other resources in your Azure account are inaccessible.

### Security

We use the principle of least privileged access to grant the Paragon installer the access it needs to create and manage resources in your account. For GCP customers, we recommend a combination of GCP projects and service accounts for RBAC (role based access control). With this method:

* a new project is created on your GCP account with resources created belonging to that porject
* a new service account is created on your GCP account to manage resources in the project to be used by the Paragon installer

## Setup

The only thing that we need provide is the JSON config for the service account used by the installer.

### Directions

1. Login to your GCP console as an admin.

2. Create a project.

   a. In the top left corner (near the **Google Cloud Platform** logo), click the dropdown for your currently active project.

   b. In the modal that appears, click **New Project.**

   c. Name the project **Paragon**.

3. Make sure the newly created project is the currently active one.

4. Create a service account.

   a. Click **IAM & Admin** in the left sidebar.

   b. Click **Service Accounts**.

   c. Click **Create Service Account**.

   d. Make the service account an **Owner** of the project.

   e. Name the account **Paragon Installer**.

5. Retrieve the auth configuration.

   a. Click the newly created service account.

   b. Navigate to **Keys**.

   c. Click **Add Key**.

   d. Generate a JSON file.

   e. Download the file.

## Next Steps

Once all of this is done, provide us the newly created service account file, and we’ll setup your installation!

If you have any questions, email [enterprise@useparagon.com](mailto:enterprise@useparagon.com) for help.


# On Premise Costs
Source: https://docs.useparagon.com/on-premise/costs



<Info>
  **Summary:** Generally, you should expect to pay up to \$2,000 / month in infrastructure costs for volumes of up to 20 million requests/month.

  This could increase or decrease depending on the cloud provider, request volumes (increases server and ingress/egress costs), redundancy and resiliency requirements (increases database costs), and size of data flowing through the system (increases blob storage, cache, and ingress/egress costs).

  For low volumes (under 10 million requests/month) running on single region deployments with spot instances, costs can be as low as \$900/month.
</Info>

## Overview

To run Paragon’s software on your own cloud, you’ll need at a minimum:

* Kubernetes cluster
* PostgreSQL database
* Redis instance
* SendGrid account

While we are constantly optimizing resources and finding ways to cut costs for cloud and on-premise, **costs equal to or below \$1,000/month are our current benchmark when adding or refactoring services for installations with request volumes of 0 - 100 million requests/month.**

Costs can be affected by several factors including cloud provider, request volumes (increases server and ingress/egress costs), redundancy and resiliency requirements (increases database costs), and size of data flowing through the system (increases blob storage, cache, and ingress/egress costs).

We’ve been able to reduce several Managed On-Premise instances to under \$500/month and provide cost optimization for our managed customers at no additional cost. If cloud spend is a concern, consider using our [Managed On-Premise option](/on-premise/choosing-a-hosting-solution#managed-on-premise).

## Resources

### Kubernetes

The Kubernetes cluster runs the microservices. Depending on the number of requests flowing through the system, more servers may need to be instantiated to meet the demand. Services typically autoscale based on horizontal pod autoscalers listening to CPU and memory.

Prices on compute instances can be found below:

<CardGroup cols={3}>
  <Card title="AWS" href="https://aws.amazon.com/eks/" horizontal />

  <Card title="Azure" href="https://learn.microsoft.com/en-us/azure/aks/" horizontal />

  <Card title="GCP" href="https://cloud.google.com/kubernetes-engine" horizontal />
</CardGroup>

Additionally, some of the clouds charge a base price per month for Kubernetes (e.g. AWS EKS charges \$72 / mo).

#### Spot Instances

Kubernetes pricing can be optimized by using spot instances, which can cut costs by as much as 90%. AWS, Azure, and GCP all offer spot instances, which you can learn more about [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html).

Installations can be configured to use a certain percentage of spot instances (0 - 100%).

#### Reserved Pricing

You can save on compute costs by reserving server instances and paying for so many months or years up front. AWS, Azure and GCP all offer this.

#### Pricing Chart

Here are our recommended settings for request volumes of up to 100 million requests/month.

| Cloud     | Instance  | Instances | \$ / Hour | \$ / Hour (Spot) | \$ / Month | \$ / Month (Spot) |
| --------- | --------- | --------- | --------- | ---------------- | ---------- | ----------------- |
| **AWS**   | t3a.small | 16        | 0.0188    | 0.0056           | \$216.58   | \$64.51           |
| **Azure** | B1s       | 32        | 0.0104    | -                | \$239.62   | \$0.00            |
| **Azure** | D2as v5   | 8         | 0.086     | 0.0086           | \$495.36   | \$49.54           |
| **GCP**   | e2-small  | 16        | 0.016751  | 0.016751         | \$192.97   | \$57.89           |

<Info>
  For AWS, add \$72 / mo to run the EKS cluster.
</Info>

### Postgres

Postgres is the primary datastore used for saving data in Paragon. A single server is needed, and several databases are provisioned within it. The costs are generally determined by CPU and memory.

| Instance         | Cloud | vCPU | Memory (GB) | \$ / Hour | \$ / Month | \$ / Month (Multi-AZ) |
| ---------------- | ----- | ---- | ----------- | --------- | ---------- | --------------------- |
| db.t3.micro      | AWS   | 2    | 1           | 0.018     | \$12.96    | \$25.92               |
| db.t3.medium     | AWS   | 2    | 4           | 0.072     | \$51.84    | \$103.68              |
| GP\_Gen5\_2      | Azure | 2    | 10          | 0.176     | \$126.72   | \$253.44              |
| db-f1-micro      | GCP   | null | 0.6         | 0.0105    | \$7.56     | \$15.12               |
| db-n1-standard-2 | GCP   | 2    | -           | 0.0826    | \$59.47    | \$118.94              |

<Info>
  GCP also charges for storage and networking. Learn more [here](https://cloud.google.com/sql/docs/postgres/pricing).
</Info>

#### Reserved Pricing

You can save on Postgres costs by paying for 1 - 3 years upfront. AWS, Azure, and GCP all offer this.

### Redis

Redis is used as a cache and worker queue. A single Redis instance is needed. Pricing is typically determined based on cost and memory.

| Instance         | Cloud | vCPU | Memory (GB) | \$ / Hour | \$ / Month | \$ / Month (Multi-AZ) |
| ---------------- | ----- | ---- | ----------- | --------- | ---------- | --------------------- |
| cache.m6g.xlarge | AWS   | 4    | 12.93       | 0.297     | \$213.84   | \$427.68              |
| cache.r4.xlarge  | AWS   | 4    | 25.05       | 0.455     | \$327.60   | \$655.20              |
| P1               | Azure | 0    | 6           | 0.554     | \$398.88   | \$797.76              |
| P3               | Azure | null | 26          | 2.218     | \$1,596.96 | \$3,193.92            |
| Standard         | GCP   | 0    | 10          | 0.54      | \$388.80   | \$777.60              |
| Standard         | GCP   | null | 25          | 1.15      | \$828.00   | \$1,656.00            |

You can find more about Redis pricing below.

<CardGroup cols={3}>
  <Card title="AWS" href="https://aws.amazon.com/eks/" horizontal />

  <Card title="Azure" href="https://learn.microsoft.com/en-us/azure/aks/" horizontal />

  <Card title="GCP" href="https://cloud.google.com/kubernetes-engine" horizontal />
</CardGroup>

### SendGrid

SendGrid is used to send emails including:

* invite team member
* reset password
* failed workflow notifications

Assuming you’re sending less than 100 emails a day, you can get by on the free tier. On the **Essentials** tier, you can send as much as 1,500 / day and pay \$19.95 / mo.

<Card title="Pricing and Plans" href="https://sendgrid.com/pricing/" horizontal />


# Data Access & Controls
Source: https://docs.useparagon.com/on-premise/data-access-and-controls



## Frequently Asked Questions

### Who has access to your data on the Paragon side?

For unmanaged installations, your data never leaves your installation and no one in Paragon has access to any of your data besides the billing contact information associated with the subscription.

For managed installations, your data never leaves your installation, and a Paragon support engineer can get limited access to perform maintenance or support tasks such as viewing application logs or debugging a workflow. Temporary access is granted upon request, logged and approved internally, and an audit trail of commands executed is automatically tracked. Sensitive data, like credentials, are never accessible.

### What type of access is required for managed installations?

The Paragon installer needs credentials to provision application resources via Terraform. Because the credentials are sandboxed to the tenant / organization / subscription, the installer cannot access any other resources on the AWS / Azure / GCP account. These credentials aren’t shared with any Paragon engineers.

Paragon support engineers are granted temporary access to application logs via ElasticSearch or limited database access via [Teleport](https://goteleport.com/) to perform routine support duties requested by customers.

### How is access limited to support engineers?

Each managed installation is only accessible from a list of whitelisted IP addresses modified on demand and additionally protected by SSH keys.

### Is there an audit trail for access?

Access requests are logged and approved internally. SSH access is automatically logged to an S3 bucket with all commands executed.


# Hosting Paragon On Premise
Source: https://docs.useparagon.com/on-premise/hosting-paragon-on-premise

Learn about deploying Paragon on your own infrastructure.

## Overview

<Info>
  Paragon On-Premise is only available on our [Enterprise plan](https://www.useparagon.com/pricing). If you're evaluating Paragon for a large production use case or have any questions about our Enterprise plan, please [book a call](https://useparagon.com/book-demo).
</Info>

Paragon offers an on-premise solution that allows you to run Paragon on your own infrastructure. AWS, Azure, and GCP have first-class support.

Paragon On-Premise is often used by companies that need to:

* Store or work with personally identifiable information (PII)
* Have stricter policies, procedures, or contracts with enterprise customers
* Require Single Sign-On (SSO) support for authentication

Paragon is SOC2 Type 2 certified, and both our cloud and managed on-premise solutions adhere to the policies and procedures required in the certification. Read more [here](https://www.useparagon.com/blog/soc-2-type-2).

We offer several solutions including:

* Cloud
* Single Tenant
* Managed On-Premise
* Unmanaged On-Premise

To decide which one is best for you, head over to the next section.


# Incident Response
Source: https://docs.useparagon.com/on-premise/incident-response



## Overview

For managed installations, we have hundreds of metrics being constantly collected with alarms configured to alert Paragon’s support team upon deviations or when dangerous values are detected. You can learn more [here](/on-premise/system-metrics-and-alarms).

<Card title="System Metrics and Alarms" href="/on-premise/system-metrics-and-alarms" horizontal />

We proactively respond to deviations and often remediate misconfigurations, and errors, and optimize costs before customers or their users are made aware.

If you detect issues with your environment, please contact our team, and we’ll prioritize fixing and patching your environment as soon as possible.

### Underutilization of resources

When resources are consistently underutilized, we’ll handle the downsizing of resources (e.g. Postgres, Redis, etc) to save you money on your monthly bill.

### More resources needed

When not enough resources are available (e.g. servers, database memory or CPU, etc), there are several courses of action that we take. In almost every case, we’re notified within seconds of a lack of resources within a managed installation. In most of those cases, we have autoscaling enabled within predefined limits to meet the demand. If we need to resize a service that would materially affect monthly costs, we’ll notify your team and request approval to update the configuration for your installer to update your system.

### High error rates

When high error rates are detected, we’ll immediately investigate the source of error rates and take the appropriate action. In many cases, it’s a new workflow that’s being tested or misconfigured, and no action is needed.

Generally, releases are tested in our cloud environment and confirmed to be stable before deploying to enterprise environments, so rollbacks due to high error rates in on-premise environments rarely happen.

### Hacks / Exploited Systems

If an exploit has been detected by our team, your team will be notified immediately and a Paragon response team will be formed. If you become aware of an exploit, please notify us immediately, and we’ll take care of patching and updating your system immediately.

### System downtime

Every microservice is configured with horizontal pod scalers, services, and health checks to enforce uptime. If services are regularly going offline due to high load or a lack of resources, please report it to the support team, and we’ll make sure to investigate and optimize your installation.

### General bugs

If you find a bug or regression within your installation, please report it to the support team, and we’ll prioritize patching and updating your system as soon as possible.


# Infrastructure Architecture
Source: https://docs.useparagon.com/on-premise/infrastructure-architecture



## Overview

The system can be divided into multiple components:

* Network
* Kubernetes cluster
* Datastores
* Application microservices
* System monitors
* Bastion (optional)

Below you can find a diagram of the infrastructure with detailed information.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/On%20Premise%20Data%20Flow.png?maxW=4824&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=3ac1ffc756028cb48d086e23e06ac6a6" alt="" width="4824" height="3696" data-path="assets/On Premise Data Flow.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/On%20Premise%20Data%20Flow.png?w=280&maxW=4824&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=afa54b74741d6833767ae0600fc720b6 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/On%20Premise%20Data%20Flow.png?w=560&maxW=4824&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=6ce0441a1fcd01206fc12aa14386d4f4 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/On%20Premise%20Data%20Flow.png?w=840&maxW=4824&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=d6aeb299731da7cdbe7495cd522c5bd3 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/On%20Premise%20Data%20Flow.png?w=1100&maxW=4824&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=226dbaa35f18167fce50015db36e3a9a 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/On%20Premise%20Data%20Flow.png?w=1650&maxW=4824&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=bdb14e59c4dd6866a9fb887e5d00a576 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/On%20Premise%20Data%20Flow.png?w=2500&maxW=4824&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=a55dd05aee0690f0ac5909edb70bac52 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Network

The network consists of:

* **Virtual Private Cloud:** a private network that hosts all of the resources
* **Public and Private Subnets:** segmented pieces of the network used to limit ingress and egress to resources
* **Nat Gateway:** network address translation service for connecting services in private network to the public internet
* **Internet Gateway:** VPC component that allows communication between the VPC and the public internet
* **Route Tables:** rules and routes that determine network traffic to and from subnets and gateways
* **Elastic IP Addresses:** IP addresses attached to gateways and bastions
* **Load Balancer:** resource for distributing incoming network traffic to backend services and exposing them to the public internet

Some of this terminology is specific to AWS components, but the general architecture is the same for GCP and Azure customers.

### Kubernetes Cluster

Paragon microservices run within a [Kubernetes](https://kubernetes.io/) cluster, an open-source system for automating deployment, scaling, and management of containerized applications.

AWS, Azure, and GCP all provide managed Kubernetes services that offload the majority of system administration work and are the recommended method for deploying Paragon. You can learn more about each one below:

<CardGroup cols={3}>
  <Card title="AWS" href="https://aws.amazon.com/eks/" horizontal />

  <Card title="Azure" href="https://learn.microsoft.com/en-us/azure/aks/" horizontal />

  <Card title="GCP" href="https://cloud.google.com/kubernetes-engine" horizontal />
</CardGroup>

### Datastores

Paragon uses three separate datastores for storing data: Postgres, Redis, and an S3-compliant blob storage.

### Postgres

Postgres is used as the primary datastore. For multi-tenant cloud installations, three separate Postgres servers are provisioned for security and performance. On-premise installations use a single Postgres server for cost savings.

Some of the data stored in Postgres includes:

* Users, teams and organizations
* Workflow and step configurations
* Metadata on Task History
* Encrypted credentials

### Redis

Redis is used as a cache and a worker queue. For multi-tenant cloud installations, a standalone Redis server and a clustered Redis server is provisioned. On-premise installations use a single Redis standalone Redis server for cost savings.

Some of the data cached in Redis includes:

* System metrics
* Shared system locks to coordinate distributed leader election between microservices
* Expensive Postgres read operations that don’t need real-time stats (e.g. task usage)
* Deployed workflows

### S3-Compliant Blob Storage

Files are persisted in an S3-compliant blob storage provider. A custom [Minio](https://min.io/) image has been built that can connect to AWS S3, Azure Blob Storage, or GCP Cloud Storage.

Some of the files stored in the blob storage provider include:

* Workflow execution data
* User image uploads
* Cached data too large for Redis

### Application Microservices

Paragon is built using microservice architecture. The applications are deployed to the Kubernetes cluster using a [Helm chart](https://helm.sh/), which is a package manager for Kubernetes.

The applications never export or sync data outside of the installation. At most there are only 3 types of requests that hit Paragon’s cloud infrastructure:

1. **License verification.** On system bootup and on a periodic cron, the microservices will contact Paragon’s cloud instance to verify that a license is valid and an installation can run.
2. **Billing information.** When viewing your billing pages to get information on number of integrations, monthly / annual costs, etc, the microservices will contact Paragon’s cloud instance to retrieve billing information.
3. **Anonymous usage analytics.** Anonymized usage analytics are sent to Paragon’s cloud instance. This contains metrics like execution count, number of users, integrations used, etc but doesn’t contain any information identifying users or any of the data within the installation. This can be disabled.

### System Monitors

Grafana, Prometheus, and several exporters run in each environment that feeds system metrics into Prometheus. These track hundreds of metrics in the load balancers, databases, worker queues, and microservices and have fine-tuned alerts to notify us of deviations or dangerous values. These metrics are only fed into the real-time dashboards running within the installation and never leave the installation.

You can read more about these in [System Metrics and Alarms](/on-premise/system-metrics-and-alarms).

<Card title="System Metrics and Alarms" href="/on-premise/system-metrics-and-alarms" horizontal />

<Info>
  Only managed installations (e.g. cloud, single tenant, and managed on-premise) have system monitors. If you’re running an unmanaged on-premise installation, you’ll need to create your own tooling and processes for monitoring CPU and memory, error rates, etc.
</Info>

### Bastion (optional)

The services running in Paragon are primarily in the private subnets, meaning they aren’t exposed to the public internet. To connect to administrative tools like Grafana or Kibana or interact with the Kubernetes cluster via `kubectl`, a bastion server can optionally be deployed to the installation.

In managed on-premise versions, a bastion is deployed and pre-configured with `kubectl`, `helm`, and other useful CLI tools to interact with the installation.


# System Metrics and Alarms
Source: https://docs.useparagon.com/on-premise/system-metrics-and-alarms



For managed environments (cloud, single-tenant and managed on-premise), Grafana, Prometheus, and several exporters are deployed to the environment to aggregate system metrics, render them in custom dashboards and send alerts when deviations or dangerous values are detected.

Some of the systems that are monitored include:

* Load balancer
* Redis
* Postgres
* Postgres worker queue
* Redis worker queue
* Workflow executions
* Connect Proxy Requests
* Microservices

### Load balancer

Metrics and alarms include:

* Request count / response time
* HTTP response codes
* Connection count
* Bytes processed
* TLS errors

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Load%20Balancer%20Metrics%20Dashboard.png?maxW=768&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=8f5fd7d6b1604d79b06ddd087e979db5" alt="" width="768" height="757" data-path="assets/Load Balancer Metrics Dashboard.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Load%20Balancer%20Metrics%20Dashboard.png?w=280&maxW=768&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=ee35eba28c51cdc5b737f434a377fff2 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Load%20Balancer%20Metrics%20Dashboard.png?w=560&maxW=768&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c75b344f990f46062ca98c30d3752a79 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Load%20Balancer%20Metrics%20Dashboard.png?w=840&maxW=768&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=88a9a8899747765c1959dd97d6ae82b1 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Load%20Balancer%20Metrics%20Dashboard.png?w=1100&maxW=768&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=50d0b9f0e52c57a5409d9f50920136ce 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Load%20Balancer%20Metrics%20Dashboard.png?w=1650&maxW=768&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=e6b43726297bec80327de99c21eb3526 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Load%20Balancer%20Metrics%20Dashboard.png?w=2500&maxW=768&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=cac12225b87f533558f21bbfb82f48dc 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Redis

Metrics and alarms include:

* Uptime
* Clients
* Memory usage
* Commands executed/second
* Hits/misses per second
* Total items per database
* Network I/O
* Expiring vs non-expiring keys
* Expired/evicted
* Command calls/second

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Metrics%20Dashboard.png?maxW=1560&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=bafe2db8b20ba96bc61d55234b9e2359" alt="" width="1560" height="540" data-path="assets/Redis Metrics Dashboard.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Metrics%20Dashboard.png?w=280&maxW=1560&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=2c8eddf618f7177f6dbf69a3efc12a35 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Metrics%20Dashboard.png?w=560&maxW=1560&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=94122ed54fdb93d91b4d1b719cf68ff2 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Metrics%20Dashboard.png?w=840&maxW=1560&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f0eeac1c4e02ae8b60186711f2759c25 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Metrics%20Dashboard.png?w=1100&maxW=1560&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d4df9a5a1d1094b8fb64e0fc61633d44 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Metrics%20Dashboard.png?w=1650&maxW=1560&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=27d8a0f6fa8138132c7e05cfd31459ff 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Metrics%20Dashboard.png?w=2500&maxW=1560&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=20dc128daad0ece440299b56861f80ae 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Postgres

Metrics and alarms include:

* CPU usage
* Memory usage
* Transactions
* Locks
* Conflicts/deadlocks
* Cache hit rate

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Postgres%20Metrics%20Dashboard.png?maxW=1562&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f478c375b8291f877376878db2b56680" alt="" width="1562" height="635" data-path="assets/Postgres Metrics Dashboard.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Postgres%20Metrics%20Dashboard.png?w=280&maxW=1562&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d45e233399e9f708fb5d2e8d0b58b7f2 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Postgres%20Metrics%20Dashboard.png?w=560&maxW=1562&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c70ff8600d6358407667e639bc966993 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Postgres%20Metrics%20Dashboard.png?w=840&maxW=1562&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=0c439339d7ee40fae36662757bcdab1c 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Postgres%20Metrics%20Dashboard.png?w=1100&maxW=1562&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c0cd722083aa2435d37032d952f603b5 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Postgres%20Metrics%20Dashboard.png?w=1650&maxW=1562&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=bfd0ca1896c0897e18e3fdb9acb96f53 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Postgres%20Metrics%20Dashboard.png?w=2500&maxW=1562&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=b20fff04ebe5140d82922098c20e43ed 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Postgres Worker Queue

Metrics and alarms include:

* Workers
* Throughput
* Average wait
* Job statuses
* Job duration
* Error rate
* Average wait per queue
* Workers per queue

### Redis Worker Queue

Metrics and alarms include:

* Queue length
* Queue states
* Failures by queue
* Job duration

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Worker%20Queue%20Metrics%20Dashboard.png?maxW=1513&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=6badccf34c47dbb0e86cc89c0ec19497" alt="" width="1513" height="539" data-path="assets/Redis Worker Queue Metrics Dashboard.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Worker%20Queue%20Metrics%20Dashboard.png?w=280&maxW=1513&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=96b21796abeef9b23e143cdb7b4b6062 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Worker%20Queue%20Metrics%20Dashboard.png?w=560&maxW=1513&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=7cbc4f40232faa30e6d156b35ab66078 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Worker%20Queue%20Metrics%20Dashboard.png?w=840&maxW=1513&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a48fea80ac28d3df821edd9cfb1f8add 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Worker%20Queue%20Metrics%20Dashboard.png?w=1100&maxW=1513&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=4004d0a76cd5e3b9612a3e8e27f1ae88 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Worker%20Queue%20Metrics%20Dashboard.png?w=1650&maxW=1513&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e7c3884fe6a512d7fffaa236a5a1c80a 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Redis%20Worker%20Queue%20Metrics%20Dashboard.png?w=2500&maxW=1513&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=af4c7147ecc4e5f37657d6f70d815775 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Workflow Executions

Metrics and alarms include:

* Workflow executions
* Step executions
* Workflow completion rate

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Executions%20Metrics%20Dashboard.png?maxW=1565&auto=format&n=867oBBVpxd2C3zc4&q=85&s=8666d851e24182a121fbacbd27f8a9d9" alt="" width="1565" height="678" data-path="assets/Workflow Executions Metrics Dashboard.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Executions%20Metrics%20Dashboard.png?w=280&maxW=1565&auto=format&n=867oBBVpxd2C3zc4&q=85&s=1f23dc38af652fec82172c97d84bbb26 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Executions%20Metrics%20Dashboard.png?w=560&maxW=1565&auto=format&n=867oBBVpxd2C3zc4&q=85&s=8acbaff36321e4dc676e6d08ae562f20 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Executions%20Metrics%20Dashboard.png?w=840&maxW=1565&auto=format&n=867oBBVpxd2C3zc4&q=85&s=6ba68926b1394a08da8714163f38a3ee 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Executions%20Metrics%20Dashboard.png?w=1100&maxW=1565&auto=format&n=867oBBVpxd2C3zc4&q=85&s=0f3834cb8a781194da7a2b2efa94263e 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Executions%20Metrics%20Dashboard.png?w=1650&maxW=1565&auto=format&n=867oBBVpxd2C3zc4&q=85&s=cd14f30ea48c08f1c6c9448d74df055f 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Executions%20Metrics%20Dashboard.png?w=2500&maxW=1565&auto=format&n=867oBBVpxd2C3zc4&q=85&s=497fcad2f5c71fe6cfce968cb711f5fb 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Connect Proxy Requests

Metrics and alarms include:

* Total request count
* Latency
* Open requests
* Status code
* Status code by integration
* Status code by credential

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Proxy%20Requests%20Metrics%20Dashboard.png?maxW=1560&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=fbd901adfaa59249cdc815b1b3481e9c" alt="" width="1560" height="642" data-path="assets/Connect Proxy Requests Metrics Dashboard.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Proxy%20Requests%20Metrics%20Dashboard.png?w=280&maxW=1560&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=aa242c655733f88d342b907e75722dd7 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Proxy%20Requests%20Metrics%20Dashboard.png?w=560&maxW=1560&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=04b2c9ccd1aa87aea88ee5ec0495a9a2 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Proxy%20Requests%20Metrics%20Dashboard.png?w=840&maxW=1560&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=dd21637e8f07fe9f587ed9b7331fba0d 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Proxy%20Requests%20Metrics%20Dashboard.png?w=1100&maxW=1560&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=1f94ab97e7537d0b3c1693e6affbed22 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Proxy%20Requests%20Metrics%20Dashboard.png?w=1650&maxW=1560&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=7b40fb69bb45fc7f7bb5e20773ae3073 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Proxy%20Requests%20Metrics%20Dashboard.png?w=2500&maxW=1560&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=aa7fdaeedce680f5c5350f0938fca924 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Microservices

Metrics and alarms include:

* Requests
* Apdex score
* Error rate
* Event loop lag
* CPU
* Heap
* Request duration


# System Requirements
Source: https://docs.useparagon.com/on-premise/system-requirements



## Getting Started

To run Paragon on-premise, you’ll need:

* A Paragon license
* A major cloud provider account (e.g. AWS, Azure, or GCP)
* A Terraform account
* A SendGrid account
* A domain name

### Paragon License

Paragon authenticates its license to our cloud at boot and periodically to ensure the license is valid and the system can run.

If you don't already have a license, please contact [sales@useparagon.com](mailto:sales@useparagon.com), and we’ll get you connected.

### Major cloud provider account

Paragon comes bundled with a set of docker images, meaning you can run it on AWS, GCP, Azure, or any other server or cloud that supports Docker and has internet connectivity. It’s most resilient when running in Kubernetes. We have first class support for AWS, Azure and GCP.

For [Managed On-Premise installations](/on-premise/choosing-a-hosting-solution), you’ll need to provide credentials to provision your account. Here are links to instructions for the AWS, Azure, and GCP:

<Card title="Configuring Managed AWS" href="/on-premise/configure/aws" horizontal />

<Card title="Configuring Managed Azure" href="/on-premise/configure/azure" horizontal />

<Card title="Configuring Managed GCP" href="/on-premise/configure/gcp" horizontal />

### Terraform Account

The infrastructure state is managed within [Terraform](https://terraform.io/), a tool for managing infrastructure as code. For single-tenant or managed on-premise, we’ll use our own Terraform account.

### SendGrid Account

[SendGrid](https://sendgrid.com/) is used for sending emails from your Paragon instance. This includes:

* Failed workflow emails
* Inviting team members
* Resetting passwords

You’ll need an API key and an email that has been approved from the SendGrid dashboard to send emails.

### Domain name

A domain name is used to create a zone and CNAMEs for the microservices. You can purchase a domain name on [Namecheap](https://namecheap.com/) or provide a subdomain for an existing domain and we’ll create CNAMEs under that subdomain.

## Infrastructure Components

You will need some additional infrastructure components including:

* Kubernetes cluster
* Postgres database
* Redis database
* S3-compliant object store

You can learn more about these on the [Infrastructure Architecture](/on-premise/infrastructure-architecture) page. To see how to configure these components for AWS, Azure, or GCP using Terraform, reference the on-premise repo [here](https://github.com/useparagon/enterprise).


# Welcome to Paragon
Source: https://docs.useparagon.com/overview

Embedded integration infrastructure for B2B SaaS & AI products

Paragon is an all-in-one embedded platform for building native product integrations that connect your product with your customers’ 3rd-party SaaS apps, without the plumbing.

The core platform provides you the building blocks for every integration ([130+ native connectors](/resources/integrations) as well as a [custom integration builder](/resources/custom-integrations)), including:

* An embedded SDK to build seamless in-app integration experiences, with a white-labeled [Connect Portal](/connect-portal/) (or build your own UI with a [headless](/connect-portal/headless-connect-portal) implementation)
* Multi-tenant architecture that keeps every one of your customer’s data and integration configuration isolated
* Fully managed integration [authentication](/getting-started/displaying-the-connect-portal) (OAuth 2.0/API Keys) for every integration
* Detailed event logs for enterprise‑ready [monitoring and observability](/monitoring/viewing-task-history)
* Flexible [deployment](/on-premise/choosing-a-hosting-solution) options: cloud, on-premise, or forward-deployed

<Card title="Platform Overview" href="/platform" horizontal arrow>
  Learn more about the building blocks of the Paragon platform.
</Card>

When building the integration logic, you can pick from Paragon’s suite of **three** purpose‑built products:

<CardGroup cols={3}>
  <Card title="Managed Sync" icon="share-nodes" href="/managed-sync/overview" cta="Learn more">
    * Fully managed and normalized data ingestion pipelines and 3rd-party permissions graph.
  </Card>

  <Card title="ActionKit" icon="sparkles" href="/actionkit/overview" cta="Learn more">
    * Universal API & MCP to access hundreds of synchronous CRUD actions in real time.
  </Card>

  <Card title="Workflows" icon="diagram-nested" href="/workflows/overview" cta="Learn more">
    * An event‑driven runtime for orchestrating complex, asynchronous integration logic.
  </Card>
</CardGroup>

To help you determine which product to use, you can explore by use case or by product below.

## Browse by Use Case

Popular use cases built on Paragon, with guidance on which product to use

<AccordionGroup>
  <Accordion title="Ingestion for RAG">
    <h3 style={{ marginTop: 0 }}>Ingestion for RAG</h3>

    Ingest users' external knowledge sources for RAG, and enforce access control on that data at query-time.

    <Card title="Product: Managed Sync" icon="share-nodes" href="/managed-sync/overview" horizontal arrow>
      Fully managed and normalized data ingestion pipelines and 3rd-party permissions graph, built for RAG.
    </Card>

    <Card title="Guide: Ingesting your users' file data for RAG" icon="book" href="https://www.useparagon.com/use-case/article/file-ingestion" horizontal arrow>
      Read our guide to implement RAG file ingestion with integrations end-to-end.
    </Card>
  </Accordion>

  <Accordion title="AI Agent Tools">
    <h3 style={{ marginTop: 0 }}>AI Agent Tool Calling</h3>

    Equip your agentic product to read & write data in third‑party tools via agent-optimized integration tools.

    <Card title="Product: ActionKit" icon="sparkles" href="/actionkit/overview" horizontal arrow>
      Universal API & MCP to give your AI agent access to hundreds of Integration Actions.
    </Card>

    <Card title="Guide: Ingesting your users' file data for RAG" icon="book" href="https://www.useparagon.com/use-case/article/file-ingestion" horizontal arrow>
      Read our guide to implement RAG file ingestion with integrations end-to-end.
    </Card>
  </Accordion>

  <Accordion title="Bidirectional Sync">
    <h3 style={{ marginTop: 0 }}>Bidirectional Sync</h3>

    Keep objects in your app and your customers’ 3rd-party systems perfectly synchronized, reflecting changes made in either application.

    <Card title="Product: Managed Sync (Pull)" icon="share-nodes" href="/managed-sync/overview" horizontal arrow>
      Fully managed and normalized data ingestion pipelines for pulling data from your customers' 3rd-party systems.
    </Card>

    <Card title="Product: Workflows (Push)" icon="diagram-nested" href="/workflows/overview" horizontal arrow>
      Build event‑driven automations for writing data back to your customers' 3rd-party systems.
    </Card>

    <Card title="Guide: Building a bidirectional CRM sync" icon="book" href="https://www.useparagon.com/use-case/article/real-time-bidirectional-crm-sync" horizontal arrow>
      Read our guide to implement a bidirectional CRM sync end-to-end.
    </Card>
  </Accordion>

  <Accordion title="Integrations for your Workflow Product">
    <h3 style={{ marginTop: 0 }}>Workflow Product Integrations</h3>

    Support hundreds of integration nodes/steps in your own workflow product.

    <Card title="Product: ActionKit" icon="sparkles" href="/actionkit/overview" horizontal arrow>
      Universal API & MCP to give your workflow product access to hundreds of Integration Actions.
    </Card>

    <Card title="Guide: Adding integrations to your workflow product" icon="book" href="https://www.useparagon.com/use-case/article/workflow-builder-actions" horizontal arrow>
      Read our guide to add integrations to your workflow product.
    </Card>
  </Accordion>

  <Accordion title="Structured Ingestion">
    <h3 style={{ marginTop: 0 }}>Structured Data Ingestion</h3>

    Enable normalized ingestion pipelines from your users' structured data sources (ie. CRM, ticketing, etc.).

    <Card title="Product: Managed Sync" icon="share-nodes" href="/managed-sync/overview" horizontal arrow>
      Fully managed and normalized data ingestion pipelines for pulling data from your customers' 3rd-party systems.
    </Card>
  </Accordion>
</AccordionGroup>

## Browse by Product

Purpose-built products to implement your desired integration use case.

<Tabs>
  <Tab title="Managed Sync">
    ### Managed Sync

    **Managed Sync** provides two easy-to-use APIs to pull high volumes of data from your users' integrations into your app, while respecting the data's underlying permissions:

    * Sync API: Enable full syncs of your users' 3rd-party data with two API calls
    * Permissions API: Enforce access control on ingested 3rd-party data in RAG

    ### Highlights

    * Declarative ingestion jobs for files, CRM records, tickets, accounting data, and more
    * Automatic backfill + incremental sync with failure recovery
    * Record/document Permissions API for downstream queries
    * Scale to hundred of millions of records without managing infrastructure

    ### Common Use Cases

    * Knowledge ingestion for RAG (ie. files, knowledge bases, meeting transcripts, chat)
    * Structured data ingestion (ie. CRM, accounting, ticketing)

    <Card title="Learn More" icon="arrow-right" horizontal href="/managed-sync/overview">
      Learn more about Managed Sync in our comprehensive overview.
    </Card>
  </Tab>

  <Tab title="ActionKit">
    ### ActionKit

    **ActionKit** is a single API to add Paragon's library of hundreds of Integration Actions into your product or AI agent

    **When to use:** You need to implement real-time, synchronous responses for common integration actions, or supply your AI agent or workflow product with hundreds of integration actions.

    ### Highlights

    * Real-time execution SLAs (extremely low-latency)
    * Uniform interface for every integration
    * Use-case specific schema formats (for AI agents or workflow products)

    ### Common use cases:

    * Integration tools for AI agents
    * Integrations for your workflow product
    * Taking action in 3rd-party apps in real-time

    <Card title="Learn More" icon="arrow-right" horizontal href="/actionkit/overview">
      Learn more about ActionKit in our comprehensive overview.
    </Card>
  </Tab>

  <Tab title="Workflows">
    ### Workflows

    Build asynchronous event‑driven automations and orchestrate integration logic at scale.

    **When to use:** You need to build durable, asynchronous, event-driven background jobs between your app and your users' 3rd-party apps.

    ### Highlights

    * Build in low-code or Typescript, and version control all workflows in Git
    * Highly extenisble - implement any integration logic
    * Durable jobs infrastructure (queues, dynamically scaled workers)
    * Supports listening to any 3rd-party webhook

    ### Common Use Cases

    * Trigger custom event-driven automations in your users' 3rd-party apps
    * Trigger automations in your application from 3rd-party webhooks

    <Card title="Learn More" icon="arrow-right" horizontal href="/workflows/overview">
      Learn more about Workflows in our comprehensive overview.
    </Card>
  </Tab>
</Tabs>


# Build and Push
Source: https://docs.useparagon.com/paragraph/build-and-push



## Building your project locally

After defining a workflow, you can use the `para` CLI to validate and build the workflow to prepare to upload it to the Paragon dashboard. Building workflows creates a subfolder in your project called `out/` with auto-generated files.

You can build all workflows in your project with the `build` command:

```bash
para build
```

If your build is successful, you will see:

```bash
✓ Typescript project successfully built.
✓ Created build in out/build.json file.
```

Otherwise, see [Diagnosing build errors](/paragraph/build-and-push#diagnosing-build-errors) below to address build errors.

## Pushing your project to Paragon

<Info>
  Try [Git Sync](/paragraph/setting-up-git-sync) to configure an integration between your Paragraph files stored in a Git repository and your Paragon project.

  Git Sync keeps your Paragon project and Paragraph repository automatically in-sync.
</Info>

To upload on a one-off basis to your Paragon project, use the `push` command in the CLI.

```bash
para push
```

* If your workflow has previously been pushed to your Paragon project, this command will *overwrite* any changes that have been made to this workflow with the current contents of the Paragraph file that you are pushing.
* Workflows cannot be pushed to Staging or Production Release Environments. [Create a Release](/deploying-integrations/release-environments#creating-a-release) to move integration updates from Development -> Staging -> Production.

**Note: Paragraph projects are linked to the original project they were initialized from and cannot be changed.**

* Currently, you cannot use the `push` command to push or "copy" a project to a different Project ID. If your team requires this functionality, please reach out to discuss your needs and to get early access to a related feature we are working on: [support@useparagon.com](mailto:support@useparagon.com).

  * You can [create a Release](/deploying-integrations/release-environments#creating-a-release) to move integration updates from Development -> Staging -> Production.

* Do not attempt to modify `project.json` or `build.json` to do this, as you may inadvertently cause workflows to be moved across projects.

## Pulling changes from Paragon

To pull changes from the dashboard on a one-off basis to your Paragon project, **first commit all pending changes in your local repository**, and then use the `pull` command in the CLI.

```bash
para pull
```

* Any uncommitted changes may be overwritten by the `pull` command.
* As with the `push` command, any integrations or workflows that are absent from the source (your Paragon dashboard in the `pull` case) will be removed from the destination (the local repository). The best way to reconcile these types of removals is with [Git Sync](/paragraph/setting-up-git-sync), which will use your commits to sequence these changes.

## Diagnosing build errors

The build command operates in 2 phases:

1. A TypeScript compilation runs to check types for all of your workflows and integration configurations.

2. The compilation result is evaluated to produce a build artifact to upload to Paragon, in `out/build.json`.

If you are encountering TypeScript compilation errors, they will appear as follows:

```bash
src/integrations/hubspot/workflows/newWorkflow.ts:31:25 - error TS2554: Expected 1 arguments, but got 0.

31     const triggerStep = new EventStep();
                           ~~~~~~~~~~~~~~~
Found 1 error(s).
```

These errors are also visible in your editor, if you have a TypeScript language server running. TypeScript errors can be indicative of one of the following issues:

| Problem                                                                                                                            | Resolution                                                                                                                                                                                                                                                                                                                                                                                    |
| ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Missing or invalid parameters** <br /> Steps have incomplete configurations, which does not produce a valid workflow.            | Visit the workflows with incomplete steps and correct their configuration. <br /><br /> If some workflow steps are intentionally incomplete (*e.g.* the workflow is a draft), you can prefix the filename with `~` to exclude it from the build.                                                                                                                                              |
| **Incorrect step output path referenced** <br /> A step requires output from other steps, but the path it references is not valid. | Visit the workflows with invalid step output paths and correct references to `.output`. <br /><br /> Use the TypeScript-powered autocomplete to help identify available properties.                                                                                                                                                                                                           |
| **Function step code is using unknown properties**                                                                                 | Because Function step code in the dashboard does not use TypeScript, errors can appear in your exported Function steps about unsafely accessing properties in untyped values. <br /><br /> These errors can help refactor your Function step code to be type-safe, but you can ignore them by using `// @ts-ignore` above lines that are causing errors.                                      |
| **Missing types from `@useparagon/integrations`**                                                                                  | Integration-specific dependencies may be missing from your project. Run `para install` with the CLI to pull in missing dependencies.                                                                                                                                                                                                                                                          |
| **Error: `persona.meta.js` is not found in project**                                                                               | This error may indicate that you have incorrectly imported modules in a workflow. <br /><br /> Check your import statements in workflows to verify that you are using relative paths instead of absolute paths: <br /> ✅ `"../../../events/newTask"` <br /> ❌ `"src/events/newTask"` <br /><br /> If your imports look correct, try following the steps below to clear stale build artifacts. |

If you are encountering many TypeScript compilation errors that should be ignored, you can attempt a build that suppresses these types of errors with the `--skip-type-errors` flag:

```bash
para build --skip-type-errors
```

If you are encountering errors *after* the TypeScript build succeeds, verify that your error is not caused by stale build artifacts:

* Delete the `dist/` folder.
* Delete the `tsconfig.tsbuildinfo` file.

These stale build artifacts may cause evaluation errors after deleting workflows or integrations.


# Defining App Events
Source: https://docs.useparagon.com/paragraph/defining-app-events

Learn how to define App Event schemas in Paragraph projects.

[App Events](/workflows/triggers#app-events) are JSON payloads that can be used to trigger workflows from your application, using the SDK or API. In Paragraph, you can define an App Event with a file that declares its name and schema.

### Creating a new App Event

App Events reside in the `src/events` folder of your Paragraph project. You can create a new file, like `src/events/newTask.ts`, to define a new type of App Event.

```ts
import { IEventInit } from '@useparagon/core/event';

export type EventSchema = {
  title: 'Example Title';
  description: 'Example Description';
  storyPointEstimate: 0;
};

const event: IEventInit<EventSchema> = {
  /**
   *  name of event
   */
  name: 'New Task',

  /**
   * schema of event payload
   */
  schema: {
    title: 'Example Title',
    description: 'Example Description',
    storyPointEstimate: 0,
  },
};

export default event;
```

The file must export a default object that includes the name of the event (which will be used in the SDK and the API when App Events are sent) and an example payload.

### Using an App Event in a Workflow

To use the App Event in a workflow file, import the event into the Workflow:

```ts
import newTaskEvent from "../../../events/newTask";
```

<Warning>
  Currently, relative imports are required to be used from Workflow files. Avoid using absolute imports, e.g. `src/events/newTask`.
</Warning>

Then, you can pass the event into an `EventStep` trigger as the first step in the Workflow:

```ts
const triggerStep = new EventStep(newTaskEvent);
```


# Defining Integrations
Source: https://docs.useparagon.com/paragraph/defining-integrations

Learn how to define and configure workflows as code within a Paragraph project.

## Project Structure

The folder structure of your Paragraph project defines what integrations are available.

The **src/integrations/** folder from your project root (the location of your paragon.json file) defines what integrations are available:

<Frame>
  <img src="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/paragraph-fs.png?maxW=732&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=fffe9923dd3cb21038e07ff8772448e1" alt="" width="732" height="642" data-path="assets/paragraph-fs.png" srcset="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/paragraph-fs.png?w=280&maxW=732&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=9ab59d0d090d3080bd73a56e7f7a41ce 280w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/paragraph-fs.png?w=560&maxW=732&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=961a9b3cba2744df7b88f2c18d79052b 560w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/paragraph-fs.png?w=840&maxW=732&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=314d571d085eacd9bb149f28088aec84 840w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/paragraph-fs.png?w=1100&maxW=732&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=db6efa1c08c356d4b0729beb59620068 1100w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/paragraph-fs.png?w=1650&maxW=732&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=da741b8cb142bea9a0ba5e99fe826e05 1650w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/paragraph-fs.png?w=2500&maxW=732&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=184859415d55d4c4a4d9970016637730 2500w" data-optimize="true" data-opv="2" />
</Frame>

Each subfolder in the **src/integrations/** folder contains:

* `workflows/` subfolder for each workflow for the integration.
* `config.ts` configures the display settings for the [Connect Portal](/connect-portal/connect-portal-customization) used for this integration, including the description and overview text. See more below in [Configuring an Integration](/paragraph/defining-integrations#configuring-an-integration).
* `inputs.ts` configures integration-level [User Settings](/connect-portal/workflow-user-settings) exposed to your customers in the Connect Portal. For example, if you need to prompt your users to select a Field Mapping for Salesforce or a Destination Folder for Google Drive, you can define a User Setting. See more below in [Configuring User Settings](/paragraph/defining-integrations#configuring-user-settings).

## Adding an Integration

To add an integration, you can use the CLI wizard:

```bash
para new integration
```

The CLI will prompt you to search the integration you want to use and install the necessary dependencies.

## Configuring an Integration

The **config.ts** file in any integration folder describes the Connect Portal configuration.

**Example:**

```ts
import { IIntegrationConfig } from '@useparagon/core/integrations';

export const config: IIntegrationConfig = {
	description: "Sync records from Microsoft Dynamics",
	overviewText: `Connect your Microsoft Dynamics 365 account and sync your Dynamics 365 accounts, contacts, leads, or opportunities. Enable your sales team to close more deals by keeping your Dynamics 365 CRM records up to date - without manual data entry.
  
Our Dynamics 365 integration enables you to:  
  
- Automatically create or update records in Dynamics 365
- Sync records from Dynamics 365
- Receive updates when a record in Dynamics 365 is created or updated`,
}
```

The configuration includes the following fields:

* Short description of the integration
* An overview of the integration, as a string of Markdown-formatted text

## Configuring User Settings

The **inputs.ts** file in any integration folder defines integration-level [User Settings](/connect-portal/workflow-user-settings) exposed to your customers in the Connect Portal.

For example, if you need to prompt your users to select a Field Mapping for Salesforce or a Destination Folder for Google Drive, you can expose these options in the Connect Portal.

**Example:**

```ts
import { createInputs } from '@useparagon/integrations/salesforce';

const integrationInputs = createInputs({
    "fieldMapping": {
        id: "fieldMapping",
        type: 'field_mapping',
        title: "Map a custom Salesforce Object to an object in TaskLab",
        required: true,
    }
});

export default integrationInputs;
```

Define inputs as entries in the object passed to the `createInputs` function.

* The key (`"fieldMapping"`) is how you will reference this input in other Paragraph workflows.

* The `id` property of the object is how you will reference the value of this User Setting in the [SDK or API](/apis/users) and must be a stable identifier. Changing this property will result in existing selections for this setting losing their values in your customers' Connect Portal.

* The `type` property of the object refers to the type of User Setting that is shown. Standard options include `"text"`, `"boolean"`, `"number"`, and `"password"`.

  * Integration-specific options like `"field_mapping"` are defined in the integration-specific types and can be found with your editor autocomplete (e.g. Ctrl-space in VS Code).

* The `title` property of the object is what will be displayed in the Connect Portal for your customers, to explain usage for this User Setting.

* Optionally, include:

  * `required`: Specify if this User Setting will be required for input by your customers.

  * `tooltip`: Specify a tooltip that will explain usage of this input for your customers.

*Workflow-level* User Settings (settings specific to a particular workflow) can be defined within Workflows with the same format, in the `inputs` property of the workflow file.

## Custom Integrations

To define a [Custom Integration](/resources/custom-integrations) in your project, create a subfolder with the name `custom.[integrationName]`, where `integrationName` is the lowercased, alphanumeric name of the integration (for example: "GitHub Enterprise" -> `custom.githubenterprise`).

<Info>
  Any changes to the `name` property of your Custom Integration will affect the subfolder name and string used in `paragon.connect()`.
</Info>

In this folder, add the following `config.ts` file to configure the Custom Integration and its authentication and display settings:

```ts
import {
  ICustomIntegrationConfig,
  createConfigInputs,
} from '@useparagon/core/integration';

export const inputs = createConfigInputs({});

const config: ICustomIntegrationConfig = {
  name: '',
  description: '',
  accentColor: '#000000',
  authenticationType: '', // oauth | basic | oauth_client_credential
  
  // For OAuth
  authorizationUrl: ``,
  accessTokenUrl: ``,
  scopes: '',
  includeClientIdAndSecrets: false,
  usePKCEInCodeExchange: true,
  
  apiBaseUrl: ``,
  testEndpointPath: ``,
  authorization: {
    type: 'bearer',
    token: `{{settings.oauthAccessToken}}`,
  },
};

export default config;
```

You'll also need to add an `inputs.ts` file to add any User Settings for this integration:

```ts
import { createInputs } from '@useparagon/core/inputs';

const integrationInputs = createInputs({});

export default integrationInputs;
```

When defining workflows for Custom Integrations, you can import `ICustomIntegration` from the core library to get started:

```ts
import {
  // ...
  ICustomIntegration,
  // ...
} from '@useparagon/core';

export default class extends Workflow<
  ICustomIntegration,
  IPersona<typeof personaMeta>,
  DefaultInputToResultMap
> {
  define(
    integration: ICustomIntegration,
    context: IContext<DefaultInputToResultMap>,
    connectUser: IConnectUser<IPersona<typeof personaMeta>>,
  ) {
  }
}
```


# Defining Workflows
Source: https://docs.useparagon.com/paragraph/defining-workflows

Learn how to define workflows as code within a Paragraph project.

Paragraph workflows are TypeScript or JavaScript files that define a workflow, including its step configuration and control flow.

Workflows authored in Paragraph are fully compatible with the Paragon dashboard, for viewing in Task History and the Workflow Editor.

## Creating a workflow

You can create a new workflow by running the following CLI command:

```bash
para new workflow --integration [integration name, e.g. salesforce]
```

The CLI will prompt you to title your workflow. Once you have completed this prompt, the CLI will create a new TypeScript file in the `workflows/` folder of your selected integration:

<Frame>
  <img src="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/syncContactsFromSalesforcets-tasklab-integrations.png?maxW=724&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=50a44790090454f902c4fe128ee69cb0" alt="" width="724" height="578" data-path="assets/syncContactsFromSalesforcets-tasklab-integrations.png" srcset="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/syncContactsFromSalesforcets-tasklab-integrations.png?w=280&maxW=724&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=acaa21e4ab1c3324dd521585a616cd9f 280w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/syncContactsFromSalesforcets-tasklab-integrations.png?w=560&maxW=724&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=44603b7844271a82cda051495b7955af 560w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/syncContactsFromSalesforcets-tasklab-integrations.png?w=840&maxW=724&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=dcb303a40763ca853d3cf1fe93d8f91b 840w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/syncContactsFromSalesforcets-tasklab-integrations.png?w=1100&maxW=724&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=96fd0cc9cf9c498c7513b1be5bb3eba2 1100w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/syncContactsFromSalesforcets-tasklab-integrations.png?w=1650&maxW=724&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=1c7a5b93f22c840cd7bc25ca15d09f57 1650w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/syncContactsFromSalesforcets-tasklab-integrations.png?w=2500&maxW=724&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=40898faa4f9b10471efd2bf63b574390 2500w" data-optimize="true" data-opv="2" />
</Frame>

An example of a simple workflow to sync contacts from Salesforce is below:

```ts
/**
 * Sync contacts from Salesforce workflow implementation
 */
export default class extends Workflow {
  define(
    integration: ISalesforceIntegration,
    context: IContext<InputResultMap>,
    connectUser: IConnectUser<IPersona<typeof personaMeta>>,
  ) {
    // Define steps used in workflow
    const triggerStep = integration.triggers.recordCreated({
      recordType: 'Contact',
    });

    const searchByEmailStep = new RequestStep({
      url: `https://api.myapp.io/api/contacts?email=${triggerStep.output.contact.email}`,
      method: 'GET',
    });

    const contactExistsCondition = new ConditionalStep({
      if: Operators.ArrayIsNotEmpty(searchByEmailStep.output.response.body.data),
    });

    const createContactStep = new RequestStep({
      url: `https://api.myapp.io/api/contacts`,
      method: 'POST',
      body: { user_id: connectUser.userId, contact: triggerStep.output.result },
      bodyType: 'json',
    });

    const updateContactStep = new RequestStep({
      url: `https://api.myapp.io/api/contacts`,
      method: 'PATCH',
      body: { user_id: connectUser.userId, contact: `${triggerStep.output.result}`, contact_id: `${searchByEmailStep.output.response.body[0].id}` },
      bodyType: 'json',
    });

    // Orchestrate steps
    triggerStep
      .nextStep(searchByEmailStep)
      .nextStep(
        contactExistsCondition
          .whenTrue(updateContactStep)
          .whenFalse(createContactStep),
      );

    return this.register({ triggerStep, searchByEmailStep, contactExistsCondition, createContactStep, updateContactStep });
  }
}
```

This is equivalent to the following workflow structure in the workflow dashboard:

<Frame>
  <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-03-24%20at%2010.47.18%20PM@2x.png?maxW=1450&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=9927a494522aaf0c7519508e1f02e96f" alt="" width="1450" height="1250" data-path="assets/[Paragon] 2024-03-24 at 10.47.18 PM@2x.png" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-03-24%20at%2010.47.18%20PM@2x.png?w=280&maxW=1450&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=81dd04dc3140d27ce272933c924d3639 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-03-24%20at%2010.47.18%20PM@2x.png?w=560&maxW=1450&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=0a83135a83e6902c60d792a1a4b3ced2 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-03-24%20at%2010.47.18%20PM@2x.png?w=840&maxW=1450&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=9c30d96ac4b7e40bbcd8f9f6d47aa1e0 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-03-24%20at%2010.47.18%20PM@2x.png?w=1100&maxW=1450&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=b5f58e2cbfc92761b805321cd95f9d0b 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-03-24%20at%2010.47.18%20PM@2x.png?w=1650&maxW=1450&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=cc78149dfad08d562f9238515212121f 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-03-24%20at%2010.47.18%20PM@2x.png?w=2500&maxW=1450&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=824017615d8cf552baf658628da97bd9 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Defining steps

In the `define` function of a workflow, steps can be created and configured. A step can be created in one of the following ways:

```ts
// Constructing a new standard Step
const request = new RequestStep({
    ...
});

// Calling an Integration Action or Integration Trigger
const getRecords = integration.actions.searchRecords({
    ...
}, {})
```

* **Standard steps and triggers** (App Event Trigger, Request Trigger, Cron Trigger, Function, Request, Response, Conditional, Fan Out, and Integration Request) must be imported from the `@useparagon/core` library and configured to include the parameters that are required to run the step.
* **Integration-specific Actions or Triggers** are available in the `integration` parameter passed to the `define` function.

All steps can use the following options in the constructor (or the second parameter for Integration Actions):

```ts
{
    // If true, this step will use Auto-Retry on failures
    autoRetry: true,

    // If true, this step will allow the workflow to continue if it fails,
    // emitting the error as output
    continueWorkflowOnError: true,

    // The step title, as displayed in the Workflow Editor
    description: "Step Title for Workflow Editor"
}
```

For a full reference of steps, see our API documentation for the `@useparagon/core` package: [@useparagon/core Glossary](/paragraph/reference/useparagon-core).

#### Referencing step outputs

Steps can be declared and configured in the `define()` function in any order. You will define an explicit flow/ordering for the steps using orchestration functions: see [Orchestrating steps](/paragraph/defining-workflows#orchestrating-steps).

To reference step output in another step, simply access the `.output` property of a step or trigger:

```ts
const triggerStep = integration.triggers.recordCreated({
  recordType: 'Contact',
});

const searchByEmailStep = new RequestStep({
  url: `https://api.myapp.io/api/contacts?email=${triggerStep.output.contact.email}`,
  method: 'GET',
  params: {},
  headers: {},
  description: 'Search By Email',
});
```

For convenience, you can interpolate step outputs into strings with the template string format as in the example above. This mirrors the `{{1.output.contact.email}}` syntax of the Workflow Editor. For more advanced transformations on outputs, use a Function step.

#### Referencing User Settings and Environment Secrets

To reference User Settings or Environment Secrets as inputs, use the `context` parameter of the `define()` function.

The `.getEnvironmentSecret` function will use the [Environment Secret](/workflows/environment-secrets) value stored at a specified key.

```ts
const requestStep = new RequestStep({
  url: `https://api.myapp.io/api/contacts`,
  method: 'GET',
  headers: {
    Authorization: `Bearer ${context.getEnvironmentSecret("API_KEY")}`
  },
});
```

The `.getInput` function will get the value of a User Setting. You can reference integration-level User Settings by importing from the integration's `inputs.ts` file or workflow-level User Settings with `this.inputs`.

```ts
// Import integration-level User Settings
import inputs from '../inputs';
//...

const searchRecordsStep = integration.actions.searchRecords({
    // Reference integration-level User Settings
    recordType: context.getInput(inputs.fieldMapping).objectName,
    filterFormula: Operators.StringContains(
        "OpportunityStage",
        // Reference workflow-level User Settings
        context.getInput(this.inputs.opportunityStage)
    )
}, {});
```

#### Referencing User Metadata or IDs

To reference [User Metadata](/apis/users#using-metadata-in-workflows) or your Connected User ID, use the `connectUser` parameter of the `define()` function.

```ts
const updateContactStep = new RequestStep({
  url: `https://api.myapp.io/api/contacts`,
  method: 'PATCH',
  params: {},
  headers: {},
  body: {
    user_id: connectUser.userId,
    user_email: connectUser.meta.Email,
    contact: `${triggerStep.output.result}`,
    contact_id: `${searchByEmailStep.output.response.body[0].id}`,
  },
  bodyType: 'json',
});
```

The type for User Metadata comes from the `persona.meta.ts` file at the root of your Paragraph `src/` folder. You can export an example metadata object from that file to expose available fields.

#### Conditional logic

Some steps will require you to define `ConditionInput` parameters, such as the Conditional Step or Stop Condition for Request Step Pagination.

When you need to define a condition, start by importing the `Operators` from `@useparagon/core`:

```bash
import * as Operators from '@useparagon/core/operator';
```

Operators contain conditions (like "string equals" or "number greater than") that can be chained together with AND or OR conditions. Paragon requires conditions to be in "disjunctive normal form" when chained, meaning that all conditions are "ORs of ANDs."

For example:

```ts
const shouldUpdateCondition = new ConditionalStep({
  if: Operators.Or(
    Operators.And(
      Operators.ArrayIsNotEmpty(requestStep.output.response.body.data),
    ),
  ),
  description: 'Update or Create',
});
```

## Orchestrating steps

After defining or importing steps, the workflow requires an *orchestration* that describes how the steps are connected in the control flow.

The basic way to orchestrate step is to use the `.next()` function, available for every step. For example:

```ts
// Request -> Function -> Response
requestStep
    .next(functionStep)
    .next(responseStep);
```

### Conditional branches

Conditional steps have additional functions, `.whenTrue()` and `.whenFalse()` for creating execution branches when a condition is True or False.

```ts
ifContactExistsStep
    .whenTrue(updateRecord)
    .whenFalse(createRecord)
.next(responseStep)
```

Conditional steps do not need to specify `.whenTrue` or `.whenFalse` functions. If unspecified, the respective True/False branch will be empty.

### Fan out branches

Fan Out steps have an additional function, `.branch`, for creating a branch of execution that runs in parallel over an array of data.

Note that the branch function is *not* chainable.

```ts
fanOut
    .branch(
        transformRecord
            .next(pickProperties)
            .next(updateRecord)
    ).next(responseStep)
```

## Reusing steps

You can reuse steps or configuration by creating a shared top-level directory in your project `src/` folder (the name can be anything *except* `integrations`).

For example, you can create a `common/` folder within `src/`:

```plain
src/
+ ├─ common/
+ │  ├─ apiRequest.ts
  ├─ integrations/
  │  ├─ salesforce/
  │  │  ├─ workflows/
  │  │  ├─ config.ts
```

You can export step definitions from common files as in the example below. To access `execution` data, you can import the static `Execution` class from the `@useparagon/workflow` library:

```ts
// src/common/apiRequest.ts
import { Execution, RequestStep } from '@useparagon/core';

export const apiRequest = (path) => new RequestStep({
    url: `https://myapi.example.com${path}`,
    authorization: {
        type: "BEARER",
        token: Execution.getEnvironmentSecret("API_PRIVATE_KEY")
    }
});
```

Workflow files are able to import and reuse steps from top-level folders locally.

```ts
// src/integrations/salesforce/workflows/syncNewRecords.ts
import { Step, Trigger } from '@useparagon/workflow';
import { SalesforceWorkflow } from '@useparagon/integrations/salesforce';
import { apiRequest } from '../../../common/apiRequest';

export default class ExampleWorkflow extends SalesforceWorkflow {
    define: (salesforce, execution, user) => {
       	// ...
       	const apiRequestWhenTrue = apiRequest('/success');
       	const apiRequestWhenFalse = apiRequest('/failure');

	const stateMachine = event
		.next(stringContainsParagonDomain)
		.whenTrue(apiRequestWhenTrue)
		.whenFalse(apiRequestWhenFalse);
	
	this.register(stateMachine, { event, functionStep, apiRequestWhenTrue, apiRequestWhenFalse });
    }
}
```


# Getting Started with Paragraph
Source: https://docs.useparagon.com/paragraph/getting-started

Paragraph allows you to author and maintain Paragon integrations as code, which can be synced with a Git repository to track revisions over time.

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201000002911%20(2).png?maxW=1619&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=8b0b2957e80696b9681006436a445578" alt="Page cover image" width="1619" height="438" data-path="assets/Frame 1000002911 (2).png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201000002911%20(2).png?w=280&maxW=1619&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=dd5131483e8fa28cf73538e5b593f12f 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201000002911%20(2).png?w=560&maxW=1619&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b0a5316e6a161e5ba827634589731e89 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201000002911%20(2).png?w=840&maxW=1619&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b11c4c22a69ee742a5157b20c330edfd 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201000002911%20(2).png?w=1100&maxW=1619&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=60263af83a34fbd05036dd5df04128aa 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201000002911%20(2).png?w=1650&maxW=1619&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=a80d81632f65f71dbcb17daa11f849c9 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Frame%201000002911%20(2).png?w=2500&maxW=1619&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=c9040e39c662a2f9e079a8dee81b3339 2500w" data-optimize="true" data-opv="2" />
</Frame>

With Paragraph, your engineering team can:

* Define all your integrations powered by Paragon as code, while still being able to view, edit, and debug from the dashboard
* Version control all changes to your integrations in a Git repository, which can be used to bring code review, unit testing, and CI/CD to your development process
* Use more advanced abstractions in Workflows, including reusable steps or modularizing workflow logic across integrations

<Frame>
  <iframe width="560" height="315" src="https://www.youtube.com/embed/eD2a7LlCjQM?si=yZFNML9EjvuzK5Dq" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen />
</Frame>

## Overview

Paragraph is a TypeScript-based framework for building your Paragon integrations in code. In a Paragraph project, you'll define:

* Integrations that are available to your users
* [Connect Portal configuration](/connect-portal/connect-portal-customization), including [User Settings](/connect-portal/workflow-user-settings) and [Field Mappings](/connect-portal/field-mapping)
* [Workflows](/workflows/building-workflows), including [Triggers](/workflows/triggers) and Steps

Paragraph projects can be packaged and sent to Paragon for deployment using the Paragon CLI or [from your CI/CD](/paragraph/setting-up-git-sync).

You can also continue to use the Paragon dashboard to edit your projects. By [setting up Git Sync](/paragraph/setting-up-git-sync), you can sync back changes made in the Paragon dashboard to your Paragraph project, stored in a Git repository.

<Accordion title="What Isn't Defined in a Paragraph Project?">
  Paragraph represents your integration business logic and doesn't include some types of configuration values that are specified in the dashboard.

  The following configuration values must be maintained using the dashboard and will have no representation in your Paragraph project:

  * [Environment Secrets](/workflows/environment-secrets): Sensitive values that are used in Workflows are defined and managed in the dashboard, in Project Settings.

  * [Signing Keys](/getting-started/installing-the-connect-sdk#setup-with-your-own-authentication-backend): The private key used to sign Paragon User Tokens is generated and managed in the dashboard, in Project Settings.

  * [Client ID and Secret](/getting-started/adding-an-integration#connect-your-developer-app-to-paragon): Any sensitive credentials representing your OAuth app with an integration are managed in the Settings tab of any integration.

  * Scopes: Scopes requested by your OAuth app are also managed in the Settings tab of any integration.

    * For Custom Integrations, scopes are included in the Paragraph config file.

  * [Team Members](/managing-account/teams): Users and roles that have access to your Paragon organization are managed in the dashboard, in Organization Settings.
</Accordion>

## Installing the CLI

### Installing the CLI and Authorizing Your Account

To begin setting up Paragraph project, you'll need to install the Paragon CLI. You can install the CLI globally with npm:

```bash
npm install -g @useparagon/cli
```

Once installed, the CLI will be available as the alias `para`. See for the full reference for available CLI commands.

You can link your Paragon account to the CLI by running:

```bash
para auth login
```

<Accordion title="Using an On-Prem Environment?">
  You can authenticate to the CLI from your on-premises environment with the `--host` flag:

  ```bash
  para auth login --host https://dashboard.yourhost.paragon.so
  ```
</Accordion>

Follow the CLI prompt to login to Paragon and authorize the CLI. When you successfully log in, you should see:

```bash
Logged in as [Your Name] (yourname@email.com)
```

Authenticating with the CLI generates a CLI Key which is stored locally in `~/.paragon/credentials.json`. You can view and revoke CLI Keys in the dashboard in; **Settings > CLI Keys**.

## Starting a Paragraph Project

### Exporting from Paragon

You can export a Paragraph project from your Paragon dashboard by using the CLI:

```bash
para init --create-from-existing
```

A project selector will appear to choose a project to export as a Paragraph project.

### Initializing an Empty Project

Alternatively, you can initialize a new Paragon project with the CLI:

```bash
para init new-project-name
```

### Cloning an Existing Project

If you are cloning an existing Paragraph repository that a teammate started, make sure to install dependencies in the project:

```bash
git clone git@github.com:useparagon/integrations.git
para install
```

## Creating a New Integration

Create a new integration in Paragraph with the CLI:

```bash
para new integration
```

A prompt will appear to select the integration you'd like to add. Once selected, a new folder for the integration will appear in your `src/` folder.

*Learn more about how to configure an integration in *[*Defining Integrations*](/paragraph/defining-integrations)*.*

## Creating a New Workflow

Start building a new workflow in an existing integration with the CLI:

```bash
para new workflow --integration salesforce
```

Specify the name of the integration folder, e.g. `salesforce` in the `--integration` flag. A prompt will appear to title the workflow. A new TypeScript file will appear in the `src/integrations/[integration]` subfolder.

*Learn more about workflows and how to define and orchestrate steps in *[*Defining Workflows*](/paragraph/defining-workflows)*.*

## Building and Pushing

Once you are ready to push your changes back to the Paragon dashboard, you can use the CLI to validate your project and push to Paragon:

```bash
para build
```

*Learn more about handling build errors in *[*Build and Push*](/paragraph/build-and-push)*.*

Once you see a message confirming that a build has been created, use the CLI to upload to the Paragon platform:

```bash
para push
```

<Info>
  Try [Git Sync](/paragraph/setting-up-git-sync) to configure an integration between your Paragraph files stored in a Git repository and your Paragon project.

  Git Sync keeps your Paragon project and Paragraph repository automatically in-sync.
</Info>


# Update Guide
Source: https://docs.useparagon.com/paragraph/reference/update-guide



## Updating Paragraph

To update the Paragraph to the latest version, simply run the following command in your terminal:

```bash
npm install -g @useparagon/cli
para install --sync-versions
```


# @Useparagon/Core Glossary
Source: https://docs.useparagon.com/paragraph/reference/useparagon-core

Learn about the different types Paragon supports

## Triggers

### CronStep

Use `CronStep` to start the workflow on a periodic schedule. [Scheduler](/workflows/triggers#scheduler)

**Inputs**

| Parameter  | Type     | Description                                                                                                                                                     |
| ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cron`     | string\* | The cron expression of the schedule for this trigger, from seconds to weeks. <br /> **Example**: `0 0 9 * * *` (every day at 9:00 AM)                           |
| `timezone` | string   | The timezone to use for the cron expression, expressed as an IANA timezone string. Defaults to `America/Los_Angeles`. <br /> **Example**: `Etc/Universal` (UTC) |

**Example**

```js
/**
 * Example: Scheduler Trigger configured to run a workflow every day at 9am PST.
 */
const triggerStep = new CronStep({
  cron: '0 0 9 */1 * *',
  timeZone: 'America/Los_Angeles',
});
```

**Outputs**

The CronStep does not produce any usable output.

### EndpointStep

Use `EndpointStep` to trigger this workflow via an HTTP request. [Request](/workflows/triggers#request)

**Inputs**

| Parameter               | Type                | Description                                                                                                                                                                                                                                                  |
| ----------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `allowArbitraryPayload` | boolean\*           | If true, this Request trigger will accept any type of request. If false, this Request trigger will require `headerValidations`, `bodyValidations`, and `paramValidations` to be defined.                                                                     |
| `headerValidations`     | HeaderValidation\[] | An array of validations to use on the headers for requests to this Request trigger. This can be used to validate the presence of required headers to inbound requests. <br /> **Example**: `[{ key: "X-Tasklab-Id", required: true }]`                       |
| `bodyValidations`       | BodyValidation\[]   | An array of validations to use on body fields for requests to this Request trigger. This can be used to validate the presence or type of data in the body of inbound requests. <br /> **Example**: `[{ key: "userId", dataType: "STRING", required: true }]` |
| `paramValidations`      | ParamValidation\[]  | An array of validations to use on the URL parameters for requests to this Request trigger. This can be used to validate the presence of required parameters to inbound requests. <br /> **Example**: `[{ key: "query", required: true }]`                    |

**Example**

```js
/**
 * Example: Request Trigger configured with parameter, header, and body validations.
 */
const triggerStep = new EndpointStep({
  allowArbitraryPayload: false,
  paramValidations: [
    {
      key: 'key',
      required: true,
    },
  ] as const,
  headerValidations: [
    {
      key: 'Content-Type',
      value: 'application-json',
    },
  ] as const,
  bodyValidations: [
    {
      key: 'email',
      dataType: 'STRING',
      required: true,
    },
    {
      key: 'first_name',
      dataType: 'STRING',
      required: true,
    },
    {
      key: 'last_name',
      dataType: 'STRING',
      required: true,
    },
  ] as const,
});
```

**Outputs**

Access the output of a Request trigger with `requestTrigger.output.request`. The below fields are fields of the `.request` property.

| Field     | Type                  | Description                                                                                                                                                                                                                                                                          |
| --------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `headers` | object                | An object of the HTTP headers received in the request. Access these properties in lowercased format, e.g. `requestTrigger.output.request.headers['content-type']`.                                                                                                                   |
| `body`    | any                   | An object or string of the HTTP body received in the request. The `body` will be an object when the Content-Type is `application/json`, `multipart/form-data`, or `application/x-www-form-urlencoded`. Otherwise, it will be attempted to be parsed as a string or File (see below). |
| `params`  | object                | An object of the URL parameters received in the request.                                                                                                                                                                                                                             |
| `file`    | FileValue / undefined | If the HTTP body refers to a file, the file contents will be available as a `FileValue` object. Otherwise, this property will resolve to `undefined`.                                                                                                                                |

### EventStep

Use `EventStep` to trigger this workflow with an [App Event](/workflows/triggers#app-events).

**Inputs**

To construct an App Event Trigger, first import your App Event into the Workflow:

```js
import taskCreated from '../../../events/newTask';
```

Then, pass this import to the constructor of `EventStep`:

```js
const trigger = new EventStep(taskCreated);
```

Because App Events can be shared across different workflows and integrations, they are required to be defined in the `src/events` folder of your Paragraph project.

**Example**

```js
/**
 * Example: App Event Trigger configured with an event and object mapping.
 */
const triggerStep = new EventStep(event, {
  objectMapping: ``,
});
```

**Outputs**

Access the output of an App Event trigger with `appEventTrigger.output`. The output will match the schema of the App Event that this trigger uses.

### IntegrationEnabledStep

Use `IntegrationEnabledStep` to trigger this workflow when a user enables the integration.

**Inputs**

This trigger does not use any parameters.

**Example**

```js
/**
 * Example: Integration Enabled Trigger with default configuration.
 */
const triggerStep = new IntegrationEnabledStep();
```

**Outputs**

The IntegrationEnabledStep does not produce any usable output.

## Steps

### ConditionalStep

A Conditional branching step to allow for control flow in Workflows.

**Inputs**

| Parameter | Type               | Description                                                                                                                                                                                                                                       |
| --------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `if`      | ConditionalInput\* | The condition to evaluate for determining whether or not to proceed into the "true" or "false" branch beneath this step. <br /> Learn more about defining ConditionalInputs: [Conditional logic](/paragraph/defining-workflows#conditional-logic) |

**Example**

```js
/**
 * Example: Conditional Step to check if an item is in a list using operators.
 */
const itemInListStep = new ConditionalStep({
  if: Operators.Or(
    Operators.And(Operators.StringContains('["a","b","c"]', 'a')),
    Operators.And(
      Operators.StringContains('["a","b","c"]', 'c'),
      Operators.StringDoesNotContain('["a","b","c"]', 'd'),
    ),
  ),
  description: 'Item in List?',
});
```

**Outputs**

| Parameter        | Type           | Description                                                         |
| ---------------- | -------------- | ------------------------------------------------------------------- |
| `selectedChoice` | `"Yes" / "No"` | The branch that was chosen when this ConditionalStep was evaluated. |

### DelayStep

A step to pause the workflow for a fixed amount of time.

**Inputs**

| Parameter | Type                                       | Description                                                                  |
| --------- | ------------------------------------------ | ---------------------------------------------------------------------------- |
| `value`   | number\*                                   | How long to pause the workflow for, measured by the `unit` parameter.        |
| `unit`    | `"SECONDS" / "MINUTES" / "HOURS" / "DAYS"` | The unit of time to use when delaying the workflow. Defaults to `"MINUTES"`. |

**Example**

```js
/**
 * Example: Delay Step delaying a workflow execution for 5 minutes
 */
const delayStep = new DelayStep({
  unit: 'MINUTES',
  value: 5,
  description: 'Delay workflow for 5 minutes',
 });
```

**Outputs**

The DelayStep does not produce any usable output.

### FanOutStep

A step to map over a set (array) of data in parallel, for e.g. data transformation or batch uploads.

**Inputs**

| Parameter  | Type   | Description                                   |
| ---------- | ------ | --------------------------------------------- |
| `iterator` | any\[] | A set of data to iterate over in the Fan Out. |

```js
/**
 * Example: Fan Out step iterating through each item in an array from a previous step.
 */
const eachItemStep = new FanOutStep({
  description: 'Each Item',
  iterator: functionStep.output.result,
});
```

**Outputs**

Access one instance of a Fan Out step with `fanOutStep.output.instance`. This can only be used by steps that are in this Fan Out's branch (see: [Fan out branches](/paragraph/defining-workflows#fan-out-branches)).

| Field      | Type | Description                                                                |
| ---------- | ---- | -------------------------------------------------------------------------- |
| `instance` | any  | An item of the `iterator` property that is being processed in this branch. |

### FunctionStep

A JavaScript function step.

**Inputs**

| Parameter    | Type       | Description                                                                                                                                                                                                                                                                                                                                                                                |
| ------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `code`       | Function\* | The function to run. This function must have the signature `function(parameters, libraries)` and must be *self-contained*, meaning that it cannot reference JavaScript values outside of the function body. To pass execution data through this step, use the `parameters` object. <br /> The list of `libraries` can be found in: [JavaScript Libraries](/resources/javascript-libraries) |
| `parameters` | object\*   | Parameters from other step outputs to inject into the function.                                                                                                                                                                                                                                                                                                                            |

**Example**

```js
/**
 * Example: Function Step using IFunctionStepParameters.
 * Here the function code is provided as a string, which will be dynamically executed.
 */
const functionStepParams: IFunctionStepParameters = {
  id: 'funcStep',
  name: 'String Code Function',
  code: `
    function execute(params, libraries) {
      // Example: Reverse a given string.
      return params.input.split('').reverse().join('');
    }
    module.exports = execute;
  `,
  parameters: [{ key: 'input', value: 'reverse me' }],
  autoRetry: false,
  continueWorkflowOnError: false
};
```

**Outputs**

Access the result of an Function step with `functionStep.output.result`.

| Field    | Type | Description                                                                                                                                                                                              |
| -------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result` | any  | The return result of `code` after evaluation with `parameters`. <br /> **Note:** If `code` returns a `Promise`, the Function step will automatically await this Promise and return the unwrapped result. |

### IntegrationRequestStep

A step to send a custom request to the integration's API, without needing to provide auth details.

**Inputs**

| Parameter    | Type                                                             | Description                                                                                                                                                                                                                               |
| ------------ | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `method`     | `"GET" / "POST" / "PATCH" / "PUT" / "DELETE"`\*                  | The HTTP method to use for this API request. If you select `POST`, `PUT`, or `PATCH` methods, the `body` and `bodyType` parameters will be required.                                                                                      |
| `url`        | string\*                                                         | The relative path of the API request, with respect to the base URL provided by the integration. Specifying a full URL is also supported.                                                                                                  |
| `bodyType`   | `"json" / "form-data" / "x-www-form-urlencoded" / "xml" / "raw"` | Select the type of request body that should be sent. Paragon will automatically encode the payload and set the correct `Content-Type` headers.                                                                                            |
| `body`       | object / string / `(pageToken: string) => object / string)`      | An object or string representing the request body to be sent. If using [Request Step Pagination](/workflows/requests/request-pagination), you can specify a function that returns the body of the request with respect to the Page Token. |
| `headers`    | object / `(pageToken: string) => object`                         | An object of the HTTP headers sent in the request. Integration Request Steps will automatically include the user's authentication details for the request.                                                                                |
| `params`     | object / `(pageToken: string) => object`                         | An object of the URL parameters sent in the request. Parameters can be specified either here or in the `url` property.                                                                                                                    |
| `pagination` | `(step) => PaginationOptions`                                    | If using [Request Step Pagination](/workflows/requests/request-pagination), you can define the options used in this function. Use the `step` parameter of the `pagination` function to access the output. <br /><br />                    |

`pagination` Example:

```javascript
new IntegrationRequestStep({
  method: "GET",
  url: "/opportunities",
  params: (pageToken) => ({
    pageToken
  }),
  pagination: (step) => {
    return {
      outputPath: step.output.response.body.data,
      pageToken: step.output.response.body.nextPageToken,
      stopCondition: Operators.Or(
        Operators.And(
          Operators.DoesNotExist(step.output.response.body.nextPageToken)
        )
      )
    }
  },
});
```

**Example**

```js
/**
 * Example: Integration Request step configured to pull contacts.
 */
const integrationRequestStep = new IntegrationRequestStep({
  autoRetry: false,
  continueWorkflowOnError: false,
  description: 'Get Contacts through API',
  method: 'GET',
  url: `/contacts?email=sean@useparagon.com`,
  params: { email: 'sean@useparagon.com' },
  headers: {},
});
```

**Outputs**

Access the output of an Integration Request step with `requestStep.output.response`.

| Field        | Type   | Description                                                    |
| ------------ | ------ | -------------------------------------------------------------- |
| `headers`    | object | An object of the HTTP headers received in the response.        |
| `body`       | any    | An object or string of the HTTP body received in the response. |
| `statusCode` | number | The HTTP status code of the response.                          |

### RequestStep

A step to send an HTTP request from a workflow.

**Inputs**

| Parameter       | Type                                                             | Description                                                                                                                                                     |
| --------------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `method`        | `"GET" / "POST" / "PATCH" / "PUT" / "DELETE"`\*                  | The HTTP method to use for this API request. If you select `POST`, `PUT`, or `PATCH` methods, the `body` and `bodyType` parameters will be required.            |
| `url`           | string\*                                                         | The full URL of the HTTP request to send.                                                                                                                       |
| `bodyType`      | `"json" / "form-data" / "x-www-form-urlencoded" / "xml" / "raw"` | Select the type of request body that should be sent. Paragon will automatically encode the payload and set the correct `Content-Type` headers.                  |
| `body`          | object / string                                                  | An object or string representing the request body to be sent.                                                                                                   |
| `headers`       | object                                                           | An object of the HTTP headers sent in the request.                                                                                                              |
| `params`        | object                                                           | An object of the URL parameters sent in the request. Parameters can be specified either here or in the `url` property.                                          |
| `authorization` | AuthorizationConfig                                              | Choose between Basic authentication, Bearer token authentication, and OAuth 2.0 Client Credentials for handling the authorization of this request. <br /><br /> |

`authorization` Example:

```javascript
new RequestStep({
  method: 'GET',
  url: 'https://myapp.io/api',
  authorization: {
    type: 'basic',
    username: 'paragon-user',
    password: context.getEnvironmentSecret("API_SECRET"),
  },
});
```

**Outputs**

Access the output of a Request step with `requestStep.output.response`.

| Field        | Type   | Description                                                    |
| ------------ | ------ | -------------------------------------------------------------- |
| `headers`    | object | An object of the HTTP headers received in the response.        |
| `body`       | any    | An object or string of the HTTP body received in the response. |
| `statusCode` | number | The HTTP status code of the response.                          |

**Example**

```js
/**
 * Example: POST Request with JSON body
 */
const postRequestStepInit: IRequestStepInit = {
  id: 'step2',
  name: 'POST Request Example (JSON)',
  url: 'https://api.example.com/items',
  method: 'POST',
  bodyType: 'json',
  body: {
    item: 'newItem',
    quantity: 10,
  },
  params: { verbose: 'true' },
  headers: { 'Content-Type': 'application/json' },
  authorization: {
    type: 'bearer',
    token: 'abcdef123456',
  },
  ignoreFailure: false,
  autoRetry: false,
  continueWorkflowOnError: false
};
```

### ResponseStep

A step (*for use in Request-triggered workflows only*) to send an HTTP response from a workflow.

**Inputs**

| Parameter      | Type                   | Description                                                                                                                                               |
| -------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `responseType` | `"JSON" / "FILE"`\*    | The type of Response to send to the HTTP Request that triggered the workflow. Choose between a JSON-encoded response or a raw File type.                  |
| `body`         | `object / FileValue`\* | If using a JSON `responseType`, provide an object to send in the response. If using a File `responseType`, provide a `FileValue` to send in the response. |
| `statusCode`   | `number`\*             | The status code to send in the Response to the HTTP Request that triggered the workflow.                                                                  |

**Example**

```js
/**
 * Example: Response step returning a 201 status code with a message.
 */
const send201Step = new ResponseStep({
  description: 'Send 201',
  statusCode: 201,
  responseType: 'JSON',
  body: { message: 'Contact Created!' },
});
```


# Setting up Git Sync
Source: https://docs.useparagon.com/paragraph/setting-up-git-sync

Connect your Git repository to sync changes made in Paragon to a version control system.

You can sync your Paragon project with GitHub using Git Sync, allowing you to easily incorporate Paragon into your version control and code review processes.

When Git Sync is enabled, any changes made to your integrations or workflows in the Paragon dashboard will automatically sync to your connected Git repository as [Paragraph](/paragraph/getting-started) files.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(85).png?maxW=3414&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=f2bce44af303b1741ba52d32d158bb7d" alt="" width="3414" height="1906" data-path="assets/image (85).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(85).png?w=280&maxW=3414&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=41a4dc7caeffb3bb87e829982bd0ea7e 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(85).png?w=560&maxW=3414&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=359175fea3870415d4d7aec109441684 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(85).png?w=840&maxW=3414&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=c29f1e191645182c93cd4b90c530d4db 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(85).png?w=1100&maxW=3414&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=274b0764d29596adb6e695ad1b1007c9 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(85).png?w=1650&maxW=3414&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=f80b4fd8508abd671e38caf51aa619ca 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(85).png?w=2500&maxW=3414&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=46e74f7f1a5de47c7d7b8313ba4b501a 2500w" data-optimize="true" data-opv="2" />
</Frame>

## How Syncing Works

Git Sync works by automating CLI commands with GitHub Actions, in response to change events in Paragon or in your Git repository. You can opt into a bidirectional sync or a one-way sync, depending on what works best for your team:

* **Bidirectional Sync**: Both engineering and non-engineering team members will be working on integrations development, editing in both code and the workflow editor.
* **One-Way Sync from Git -> Paragon**: Paragraph code will be the source of truth, and updates to integrations will strictly be made in code. Works best when only engineering team members will be working on integrations development, or where advanced patterns like higher-order steps or modular workflow fragments are required.
* **One-Way Sync from Paragon -> Git**: Paragon dashboard will be the source of truth, and updates will sync back to Git as a more fine-grained form of version control.

<Warning>
  **Limitations**

  * If you are using advanced patterns in Paragraph, such as reusable steps, higher-order steps, or modular workflow fragments, Git Sync currently cannot recover the use of these abstractions in code.
  * When making updates in a dashboard to a workflow that is using advanced patterns in Paragraph, the advanced pattern will be a replaced with an inline representation of the resulting steps.
  * If these limitations affect you, you can opt in to a one-way Git Sync from Git -> Paragon.
</Warning>

## Setup

### Repository Setup

First, we'll need to set up a GitHub repository to sync your integrations with.

1. If you don't already have one, create a new GitHub repository. This repository can be public or private.

2. Push the contents of your initialized Paragraph project to your repository: [Exporting from Paragon](/paragraph/getting-started#exporting-from-paragon).

3. Add and commit new files called `.github/workflows/paragraph-push.yml` and `.github/workflows/paragraph_pull_runner.yml` at the root of your repository with the contents of the **GitHub Actions Workflow Files** below.

4. Navigate to your GitHub repository and select Settings. Navigate to **Secrets and Variables > Actions**.

5. Create a repository secret for `PARAGON_CLI_KEY`. You can find this value on your machine in the file `~/.paragon/credentials.json`. It will be the value within `token` in this file.

<Accordion title="GitHub Actions Workflow Files">
  Any commits that you write to your Git repository will trigger a CI workflow that builds and pushes the contents back to the Paragon dashboard.

  ```yaml
  name: Push to Paragon

  on:
      push:
          # Set this to your selected branch in Paragon
          branches: [ "main" ]

      # Allows you to run this workflow manually from the Actions tab
      workflow_dispatch: 

  jobs:
    push_to_paragon:
      name: Push to Paragon
      runs-on: ubuntu-latest
        
      steps:
        - uses: actions/checkout@v4
        - id: push
          uses: useparagon/paragraph-push@v1
          with:
            paragonKey: ${{ secrets.PARAGON_CLI_KEY }}
            paragonZeusUrl: https://zeus.useparagon.com
            paragonDashboardUrl: https://dashboard.useparagon.com
  ```

  Any changes that you make from the dashboard will trigger a CI workflow. This workflow will re-export the contents of your Paragon project into Paragraph, committing the resulting diff.

  ```yaml
  name: Pull from Paragon

  on: 
    workflow_dispatch:
      inputs:
        projectId:
          type: string
          required: true
          description: 'Paragon project id'

        commitId:
          type: string
          required: true
          description: 'Paragon project commit id'

  jobs:
    pull_from_paragon:
      name: Pull from Paragon
      runs-on: ubuntu-latest

      permissions:
        contents: write
        
      steps:
        - uses: actions/checkout@v4
        - id: pull
          uses: useparagon/paragraph-pull@v1
          with:
            projectId: ${{ inputs.projectId }}
            commitId: ${{ inputs.commitId }}
            paragonKey: ${{ secrets.PARAGON_CLI_KEY }}
            paragonZeusUrl: https://zeus.useparagon.com
            paragonDashboardUrl: https://dashboard.useparagon.com
  ```
</Accordion>

### Token Setup

Next, you'll need to generate a GitHub Personal Access Token (PAT) to use in the Paragon dashboard.

1. In GitHub [Developer Settings](https://github.com/settings/tokens), click the Fine-grained Tokens section in the Personal Access Tokens sidebar.

2. Generate a new token. Specify a descriptive name like "Paragon Git Sync" and desired expiration.

3. Select the repository owner/organization as the Resource Owner of the token. If your organization is not appearing in the list of available Resource Owners, you may need to ask your GitHub organization admin to allow PATs in your organization (see [GitHub docs](https://docs.github.com/en/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization#restricting-access-by-fine-grained-personal-access-tokens)).

4. Select your intended integrations repository in Repository Access.

5. Select the following Permissions:

   **Actions:** Read and write

   **Contents**: Read only

   **Metadata:** Read only

   **Members**: Read only

   The Overview of the Permissions should look like:

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(86).png?maxW=1650&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=74f5ed60e27d624435273622fb4dd127" alt="" width="1650" height="852" data-path="assets/image (86).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(86).png?w=280&maxW=1650&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=84fb30ea8afde44743793fef99a11c3e 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(86).png?w=560&maxW=1650&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=a11848836bdd725c48d3dfc5684e5bfe 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(86).png?w=840&maxW=1650&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=a3c0cf02c1e9a44c31cfeec43f715cbf 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(86).png?w=1100&maxW=1650&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=da5f691fadf68774a896b1bb798acbc9 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(86).png?w=1650&maxW=1650&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=41fba6abea18cf294dc2d3c7eef830db 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(86).png?w=2500&maxW=1650&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=40fd2c3be58a701f93fb377284ebbc10 2500w" data-optimize="true" data-opv="2" />
</Frame>

6. Generate the token.

7. In the Paragon dashboard, click "Sync Git Branch" in the top navigation bar.

8. Paste your PAT and press Connect.

9. Select a repository to sync Paragon with.

10. Select which branch of your Git repository your Paragon project should sync with. Each Paragon project can be associated with a different branch in your Git repository.

<Warning>
  **Note**: If your fine-grained PAT requires admin approval, you will immediately receive a generated token value, but the permissions will not be granted until the admin approves the token. Please verify that your token has been approved before proceeding.
</Warning>

Git Sync works with both classic and fine-grained PATs, but we recommend using a fine-grained PAT to generate a token with least-access privileges. See below for classic token instructions.

<Accordion title="Setup Instructions for Classic Personal Access Tokens">
  Generate a classic Personal Access Token with the following scopes:

  * `repo`
  * `workflow`
  * `read:org`
  * `admin:repo_hook`
  * `read:user`

  Paste this value into the Paragon dashboard, under "Sync Git Branch".
</Accordion>

## Syncing Changes

As you make changes to your integrations in the Paragon dashboard, your changes will be synced as commits to your connected Git repository.

Workflow changes can be synced immediately by clicking **Options > Save Version** in the Workflow Editor.

You can view the sync history for your Paragon project by clicking the Sync Status icon in the navigation bar of the Paragon dashboard.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/App%20Event%20Page.png?maxW=2400&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=921e8c214501600e05540cd331d3fcd3" alt="" width="2400" height="1922" data-path="assets/App Event Page.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/App%20Event%20Page.png?w=280&maxW=2400&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=cf42492d35019f53fd2e23701d4c3833 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/App%20Event%20Page.png?w=560&maxW=2400&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3f289040d254c722ecf078c5c108a588 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/App%20Event%20Page.png?w=840&maxW=2400&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=b4f86df379f781eebf430e58a9276a03 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/App%20Event%20Page.png?w=1100&maxW=2400&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=61691ea1b5962681dd2010cda37732ca 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/App%20Event%20Page.png?w=1650&maxW=2400&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=d727eafaf128951f2e9ccbcac3eb6c1d 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/App%20Event%20Page.png?w=2500&maxW=2400&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=6b3c439e4523bbf704e58a1ebf1a475f 2500w" data-optimize="true" data-opv="2" />
</Frame>

If you are not seeing changes appear in the dashboard or in your Git repository, verify your token permissions in [Token Setup](/paragraph/setting-up-git-sync#token-setup).

## Resetting the Repository

If you need to reset the original repository you chose for syncing with Paragon, please contact our support team. You can reach us at [support@useparagon.com](mailto:support@useparagon.com).


# Platform
Source: https://docs.useparagon.com/platform



Paragon's core platform provides you the building blocks for every integration ([130+ native connectors](/resources/integrations) as well as [custom integrations](/resources/custom-integrations)).

## Embedded Connect Portal

Paragon provides an SDK that you can embed in your app to build seamless in-app integration experiences. You can use our out-of-the-box Connect Portal or use your own components using our Headless Connect Portal.

<CardGroup cols={2}>
  <Card title="Connect Portal" href="/connect-portal/connect-portal-customization" img="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Portal%20Example.png?maxW=1280&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=28bbaf4dedd705b09e06e2db117251ad" width="1280" height="887" data-path="assets/Connect Portal Example.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Portal%20Example.png?w=280&maxW=1280&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b5480b2360a8883c623dc2e2cb86e7c0 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Portal%20Example.png?w=560&maxW=1280&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8fb596e8f4e85a806782f048491ecaa0 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Portal%20Example.png?w=840&maxW=1280&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f21c8050aebc2dd6164de5b9ebbaa91c 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Portal%20Example.png?w=1100&maxW=1280&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f5295c830fc09f288d6a77e50206a19e 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Portal%20Example.png?w=1650&maxW=1280&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=9e61195485a24cf6fdf0e963c429b16c 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20Portal%20Example.png?w=2500&maxW=1280&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c76eb485fbb61794a379da7e21e44628 2500w" data-optimize="true" data-opv="2">
    Quickly enable your users to connect their apps with a pre-built, customizable portal—no code required.
  </Card>

  <Card title="Headless Connect Portal" href="/connect-portal/headless-connect-portal" img="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Headless%20Connect%20Portal%20Example.png?maxW=2292&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1a81f347ac497ef7331446fa69acd83a" width="2292" height="1584" data-path="assets/Headless Connect Portal Example.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Headless%20Connect%20Portal%20Example.png?w=280&maxW=2292&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=2e861f80e5eab8fd07b8d975c2cdcd02 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Headless%20Connect%20Portal%20Example.png?w=560&maxW=2292&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=11c31314bb383604cbc5d76c54313beb 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Headless%20Connect%20Portal%20Example.png?w=840&maxW=2292&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=5cdec07148891376eb3e620b8710212d 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Headless%20Connect%20Portal%20Example.png?w=1100&maxW=2292&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=d7283ec2283a283405bb05e29ad36e11 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Headless%20Connect%20Portal%20Example.png?w=1650&maxW=2292&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=320719d603ec3e21e6040dc170470bbf 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Headless%20Connect%20Portal%20Example.png?w=2500&maxW=2292&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=db5c06b86741667c26575492b1fe043e 2500w" data-optimize="true" data-opv="2">
    Leverage your own UI to create a fully custom integration experience tailored to your product.
  </Card>
</CardGroup>

## Multi-Tenant Architecture

Paragon is designed with a multi-tenant architecture that keeps every one of your customer’s data and integration configuration isolated.

When [installing the SDK](/getting-started/installing-the-connect-sdk), your app provides a token to the SDK to authenticate your customer before connecting their integrations.

## Fully-Managed Authentication

Paragon handles integration authentication in the background for all of your integrations seamlessly. When sending any integration request from Paragon on behalf of your customers, authorization details are automatically included and refreshed when expired.

Credentials are stored securely within Paragon and are encrypted at rest and in-transit.

## Observability & Monitoring

Paragon provides detailed logs and error handling for enterprise‑ready observability and monitoring for all your customers' integration activity.

<CardGroup cols={2}>
  <Card title="Task History" href="/monitoring/viewing-task-history" img="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=fe453805d6bbadce4d3c97cab615d69b" width="2150" height="770" data-path="assets/Editing and Replaying Tasks in Paragon Connect.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?w=280&maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=a0ed16354fe17749c913da5dc8728d46 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?w=560&maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=674fd63e204410abbca2e8f310b9da4a 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?w=840&maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=e32e0ba38882b47d8c3da5381fac918f 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?w=1100&maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=bf1d743e62bcf896d5dfd9fc38cb9fe8 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?w=1650&maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=d46df5222f97c340539da593b2852b3f 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20and%20Replaying%20Tasks%20in%20Paragon%20Connect.png?w=2500&maxW=2150&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=ffa4f67c6b9d9e6c821854dc27ed6df4 2500w" data-optimize="true" data-opv="2">
    View detailed logs for every step in your bi-directional sync pipeline for all of your customers with Task History.
  </Card>

  <Card title="Event Destinations" href="/monitoring/event-destinations" img="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Event%20Destinations%20in%20Paragon%20Connect.png?maxW=1818&auto=format&n=867oBBVpxd2C3zc4&q=85&s=1fc8b8f1e512d1be93ee7c384455f27a" width="1818" height="612" data-path="assets/Viewing Event Destinations in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Event%20Destinations%20in%20Paragon%20Connect.png?w=280&maxW=1818&auto=format&n=867oBBVpxd2C3zc4&q=85&s=2c6799eb320f72daf5b252d1dc695f0b 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Event%20Destinations%20in%20Paragon%20Connect.png?w=560&maxW=1818&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9ce857105a8d0585816944cf8dcf1800 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Event%20Destinations%20in%20Paragon%20Connect.png?w=840&maxW=1818&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7537a9637772bcc6e3f8d1818d5c39c1 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Event%20Destinations%20in%20Paragon%20Connect.png?w=1100&maxW=1818&auto=format&n=867oBBVpxd2C3zc4&q=85&s=5dd655045bd2199b76313068b011cae6 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Event%20Destinations%20in%20Paragon%20Connect.png?w=1650&maxW=1818&auto=format&n=867oBBVpxd2C3zc4&q=85&s=de77ef2e49947c43bc81085a1c927f83 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20Event%20Destinations%20in%20Paragon%20Connect.png?w=2500&maxW=1818&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9f8fd29f60a1840c60657c9c58d04659 2500w" data-optimize="true" data-opv="2">
    Send error logs to any of the services your team uses internally for monitoring your own application with Event Destinations.
  </Card>
</CardGroup>

## Flexible Deployment Options

You can use Paragon in a variety of deployment options, including our hosted cloud US and EU environments, single-tenant on-premise deployments, or other forward-deployed options.

<Card title="Choose your deployment option for Paragon" icon="arrow-right" horizontal href="/on-premise/choosing-a-hosting-solution">
  Learn more about the different deployment options for Paragon.
</Card>


# Custom Integrations
Source: https://docs.useparagon.com/resources/custom-integrations

Create your own custom integration with any app provider on Paragon.

## Overview

<Tip>
  Custom Integrations are included in all **paid plans**. [Contact us](https://calendly.com/useparagon/paragon-demo) to schedule a demo of Custom Integrations or upgrade your account.
</Tip>

Custom Integrations allow you to build your own custom integration with any app provider on Paragon, even if it's not natively supported by our integration catalog.

Similar to natively supported integration on Paragon, Custom Integrations provide the following features:

* **Embedded Connect Portal** for your customers to activate and configure the integration in your app.
* **Fully managed authentication** with OAuth 2.0 or API Keys.
* **Visual workflow editor** for creating custom integration logic.
* **Access to any API methods** provided by the application's API.

## Building a Custom Integration

The general prerequisites for building a Custom Integration with any app provider on Paragon are:

* The app provider must have a public API.
* Have access to the app provider's API documentation.
* If the app provider uses OAuth authentication, create a developer account and developer application from the app provider.

To start building a Custom Integration, click the **build your own custom integration** button at the top of your integration catalog in Paragon.

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Builder%20in%20the%20Paragon%20Connect%20Catalog.png?maxW=2792&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=dbc243142a5000834ba0f9398a9cf388" alt="" width="2792" height="1348" data-path="assets/Custom Integration Builder in the Paragon Connect Catalog.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Builder%20in%20the%20Paragon%20Connect%20Catalog.png?w=280&maxW=2792&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=3d4170a9e54ab8a1525e897e16fd683b 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Builder%20in%20the%20Paragon%20Connect%20Catalog.png?w=560&maxW=2792&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=4228432de1d22df0af2b820a959b10c0 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Builder%20in%20the%20Paragon%20Connect%20Catalog.png?w=840&maxW=2792&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=513a8c80be388a9ed9f0343d47a4e258 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Builder%20in%20the%20Paragon%20Connect%20Catalog.png?w=1100&maxW=2792&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=382e80de31de927298e5e05ad2955f1c 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Builder%20in%20the%20Paragon%20Connect%20Catalog.png?w=1650&maxW=2792&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e965d817674071ef5adef91c330242d0 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Builder%20in%20the%20Paragon%20Connect%20Catalog.png?w=2500&maxW=2792&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=c0439ae6b45006c803f755bd92d57916 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Step 1. Basic Info

You'll first need to provide some basic information about the app provider that will appear in the Connect Portal for the integration.

* **Name** - A short name for the app provider.
* **Description** - A short description for what the app provider does.
* **App Icon** - Only SVG formats accepted.
* **Accent Color** - The brand color that will be used in the accents of the Connect Portal for this integration.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Basic%20info%20for%20Custom%20Integrations%20in%20Paragon%20Connect.png?maxW=3060&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=592bcf3cf91682e2989115151b0fe962" alt="" width="3060" height="1516" data-path="assets/Basic info for Custom Integrations in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Basic%20info%20for%20Custom%20Integrations%20in%20Paragon%20Connect.png?w=280&maxW=3060&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=891b945a9123508324fca31797a947fc 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Basic%20info%20for%20Custom%20Integrations%20in%20Paragon%20Connect.png?w=560&maxW=3060&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=4ec455c964af94ffa4f50d04fe6e1839 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Basic%20info%20for%20Custom%20Integrations%20in%20Paragon%20Connect.png?w=840&maxW=3060&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=06e96abbeeb03e2f256640939752c72d 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Basic%20info%20for%20Custom%20Integrations%20in%20Paragon%20Connect.png?w=1100&maxW=3060&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f487d6fd7869af101fd2deaed42ac3db 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Basic%20info%20for%20Custom%20Integrations%20in%20Paragon%20Connect.png?w=1650&maxW=3060&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f64ba0d78cf5fcdd2ce53b63122783b0 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Basic%20info%20for%20Custom%20Integrations%20in%20Paragon%20Connect.png?w=2500&maxW=3060&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=2ae105375f94016a5a181ff4699e1d63 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Step 2. Authentication Method

Select a method of authentication for your app provider. You can usually find this in your app provider's API documentation.

**OAuth 2.0** is typically used when a user needs to authenticate access to their account. For example, a user signing into Salesforce so that your application can make changes on their behalf.

Some app providers use **API keys** for authorization. An API key is a token that a client provides when making API calls. API keys are typically found within the app provider's account settings.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20for%20a%20custom%20integration%20on%20Paragon.png?maxW=3128&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=118869730ff5706783d05142cf391053" alt="" width="3128" height="1482" data-path="assets/Choosing an authentication method for a custom integration on Paragon.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20for%20a%20custom%20integration%20on%20Paragon.png?w=280&maxW=3128&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3f6c943a8caecfb69dbc8e7b3150e2d4 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20for%20a%20custom%20integration%20on%20Paragon.png?w=560&maxW=3128&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=8e752d05b31fd5d2ad1a1e7ae8a14af3 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20for%20a%20custom%20integration%20on%20Paragon.png?w=840&maxW=3128&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=71163281eb05a6e28bb1a56fdc0605ea 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20for%20a%20custom%20integration%20on%20Paragon.png?w=1100&maxW=3128&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3771127411745e79069901c73da0138a 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20for%20a%20custom%20integration%20on%20Paragon.png?w=1650&maxW=3128&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=9dc620901b7512eb136566be03e85388 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20an%20authentication%20method%20for%20a%20custom%20integration%20on%20Paragon.png?w=2500&maxW=3128&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=e2a8be52b2f751283f98193251aac827 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Step 3. Authentication Setup

#### OAuth 2.0

Specify the sign-in URL, also known as the **Authorization URL**, that this integration uses to begin the OAuth 2.0 authentication flow. If the URL includes a value that must be supplied by your end-user, use the **Advanced Options** to add input fields.

You can usually find the OAuth credentials for your selected provider in their API Documentation. You'll need access to the following credentials:

* Auth URL
* Access Token URL
* Client ID
* Client Secret
* Scopes Requested

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20OAuth%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect-1.png?maxW=3108&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=a35ceeeee1318525b505b1ba3d408edb" alt="" width="3108" height="1548" data-path="assets/Setting up the OAuth flow for a custom integration in Paragon Connect-1.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20OAuth%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect-1.png?w=280&maxW=3108&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=fd53c1bc96d1288902cd7af9ba19beac 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20OAuth%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect-1.png?w=560&maxW=3108&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=4a09ee9345dfbfac1f20f4d55d79d9ca 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20OAuth%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect-1.png?w=840&maxW=3108&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=09a8d0a55d37a9b1de5a0030f1da0fa5 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20OAuth%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect-1.png?w=1100&maxW=3108&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=41f6107ae9559a5077d0e644108ba6c4 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20OAuth%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect-1.png?w=1650&maxW=3108&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=729dcbe2e9403a5bf9e5c50e923baa89 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20OAuth%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect-1.png?w=2500&maxW=3108&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=4694c0acb9872c9ef48d99f7835d3352 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### API Keys

You can add **Input Fields** for API keys or user details that are required to authenticate with your selected app provider.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20API%20Key%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect.png?maxW=3128&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=5787bd825146379888e9acdaf9cf59ab" alt="" width="3128" height="1482" data-path="assets/Setting up the API Key flow for a custom integration in Paragon Connect.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20API%20Key%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect.png?w=280&maxW=3128&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=3fd56ec647ec96a8f9e0d27f950f39bb 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20API%20Key%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect.png?w=560&maxW=3128&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=a706c20e0ac7ed0ff0e5fa6df4ac05f7 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20API%20Key%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect.png?w=840&maxW=3128&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=70c71ec399b6e179dc4e1bedb546680b 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20API%20Key%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect.png?w=1100&maxW=3128&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=7876c42c3d37b3ec1b6888d605fda4a8 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20API%20Key%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect.png?w=1650&maxW=3128&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=03bfd37b1b8e8e889bbafa75f54b234f 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20the%20API%20Key%20flow%20for%20a%20custom%20integration%20in%20Paragon%20Connect.png?w=2500&maxW=3128&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=f5c062dfeb889af8797df1b6d2bdcf73 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### OAuth Client Credentials

Specify the URL that this integration uses to exchange an authorization code for access tokens, also known as the **Access Token URL**. The Paragon Connect Portal prompts your user for their Client ID and Client Secret needed to validate the authentication.

<Frame>
    <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Client%20OAuth%20Credentials%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?maxW=3060&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=77a5a56fff33b084db3733b078fd983f" alt="" width="3060" height="1516" data-path="assets/Using Client OAuth Credentials when creating custom integrations in Paragon Connect.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Client%20OAuth%20Credentials%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?w=280&maxW=3060&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=95787861c893f73ed3aab30d56ef605b 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Client%20OAuth%20Credentials%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?w=560&maxW=3060&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=66b67f1c76136adc187f746e49d08226 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Client%20OAuth%20Credentials%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?w=840&maxW=3060&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=82ed36b3f03b98d1d2a83d3b85461996 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Client%20OAuth%20Credentials%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?w=1100&maxW=3060&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=cc8c517e3b859c319537ed4711738024 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Client%20OAuth%20Credentials%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?w=1650&maxW=3060&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=5c8c892018f2d3224342bd34268a517a 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Client%20OAuth%20Credentials%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?w=2500&maxW=3060&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=14a34694c35ddd46b3c441f8a30bd392 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### OAuth 2.0 ROPC (Password)

Specify the URL that this integration uses to exchange an authorization code for access tokens, also known as the **Access Token URL**, along with the **Client ID**, **Client Secret**, and any requested scopes for your app provider.

The Paragon Connect Portal prompts your user for their Username, Password, and API Key needed to validate the authentication.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20OAuth%202.0%20ROPC%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?maxW=3192&auto=format&n=867oBBVpxd2C3zc4&q=85&s=15ba161e13acb73b7a669f0b6786de0e" alt="" width="3192" height="1654" data-path="assets/Using OAuth 2.0 ROPC when creating custom integrations in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20OAuth%202.0%20ROPC%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?w=280&maxW=3192&auto=format&n=867oBBVpxd2C3zc4&q=85&s=17dee0e3851487360f8948c2e3d23841 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20OAuth%202.0%20ROPC%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?w=560&maxW=3192&auto=format&n=867oBBVpxd2C3zc4&q=85&s=884a4bfa281cd98a63e96d12da17985a 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20OAuth%202.0%20ROPC%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?w=840&maxW=3192&auto=format&n=867oBBVpxd2C3zc4&q=85&s=197263209f07c56b9cf6b65ef92c286b 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20OAuth%202.0%20ROPC%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?w=1100&maxW=3192&auto=format&n=867oBBVpxd2C3zc4&q=85&s=da6092eb622ea3880291c324cd35a0bb 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20OAuth%202.0%20ROPC%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?w=1650&maxW=3192&auto=format&n=867oBBVpxd2C3zc4&q=85&s=b193e9fcab21b773e56112530ec49cc1 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20OAuth%202.0%20ROPC%20when%20creating%20custom%20integrations%20in%20Paragon%20Connect.png?w=2500&maxW=3192&auto=format&n=867oBBVpxd2C3zc4&q=85&s=3c4babcdb8b032c40dc1f8d239f9aa99 2500w" data-optimize="true" data-opv="2" />
</Frame>

Once you've added your authentication method, press the `Enable` button inside the Connect Portal preview to validate the connection. You must successfully enable your integration before moving to the next step.

### Step 4. API Setup

You can also access your custom provider through the **Workflow Builder** or **Paragon SDK.**

* **API Base URL -** Specify the base URL for API requests made to this integration.
* **API Authorization** - Specify how API requests get authenticated for this integration.
* **Test Endpoint URL** - Specify a request URL that can be used to test that your user's account credentials are valid. This endpoint must be reachable via a `GET` request.

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API%20Setup%20for%20custom%20integrations%20on%20Paragon%20Connect.png?maxW=3060&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=5c9c484c0904ee096e16434d07295dbe" alt="" width="3060" height="1516" data-path="assets/API Setup for custom integrations on Paragon Connect.png" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API%20Setup%20for%20custom%20integrations%20on%20Paragon%20Connect.png?w=280&maxW=3060&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=0bb86032be388c81e5a6430b7d4b0cf5 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API%20Setup%20for%20custom%20integrations%20on%20Paragon%20Connect.png?w=560&maxW=3060&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=1b29a31954facba57ce6836e9d8c4a5d 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API%20Setup%20for%20custom%20integrations%20on%20Paragon%20Connect.png?w=840&maxW=3060&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=bcdcf714a1cd57bdf33b52f1e9efd105 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API%20Setup%20for%20custom%20integrations%20on%20Paragon%20Connect.png?w=1100&maxW=3060&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=04496f3ea80035e7f8f5d23dca353077 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API%20Setup%20for%20custom%20integrations%20on%20Paragon%20Connect.png?w=1650&maxW=3060&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=75cc3e4671389a22e33fc4c4b823e7c1 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API%20Setup%20for%20custom%20integrations%20on%20Paragon%20Connect.png?w=2500&maxW=3060&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=ca93c4293fd54de1fd40eaefa871fbbd 2500w" data-optimize="true" data-opv="2" />
</Frame>

Once you've added the fields above, you can press the `Send test request` button to validate your custom integration configuration. Press the `Finish` button to save your custom integration.

## Using Custom Integrations

Once you've added a custom integration to Paragon, you can access it through the Workflow Builder, Paragon SDK, and Proxy API.

### Workflow Builder

You can make API Requests to your app provider from the Workflow Builder by selecting your app provider from the workflow sidebar. Paragon prefills the request URL with the API Base URL from [Step 4](/resources/custom-integrations#step-4-api-setup). Simply provide the API endpoint to the request that you want to make.

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Workflows%20in%20Paragon%20Connect.png?maxW=3396&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=77a536053d1344de0a1cfe89d588d6ff" alt="" width="3396" height="1628" data-path="assets/Custom Integration Workflows in Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Workflows%20in%20Paragon%20Connect.png?w=280&maxW=3396&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=4c612180b0601ae1a8533ed2f3ca135a 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Workflows%20in%20Paragon%20Connect.png?w=560&maxW=3396&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=fde24828f97dc3af1ad0dbcc349f274c 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Workflows%20in%20Paragon%20Connect.png?w=840&maxW=3396&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=359ce365a10e3342d2504a03681cef78 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Workflows%20in%20Paragon%20Connect.png?w=1100&maxW=3396&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=99e0ed7b007d632624c6c384b1b9b412 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Workflows%20in%20Paragon%20Connect.png?w=1650&maxW=3396&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=a5e4a03e28d8f4f95a55ad4ea038755e 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Integration%20Workflows%20in%20Paragon%20Connect.png?w=2500&maxW=3396&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=da37956cc657bea2d6453edc15bf4219 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Info>
  Paragon automatically provides the `Authorization` information provided in [Step 4](/resources/custom-integrations#step-4-api-setup) in the request.
</Info>

<Card title="Discover Workflows" href="/workflows/building-workflows" horizontal icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right-icon lucide-arrow-right"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg>}>
  Learn more about building workflows in our comprehensive overview.
</Card>

### Paragon SDK

Once your users have connected their accounts, you can use the Paragon SDK to access any of your app provider's endpoints on behalf of connected users. You'll need to prefix the app provider's name with `custom.` when making requests. For example, a custom GitHub integration would be referenced as `custom.github`.

<Note>
  **Note:** When using custom app providers in the Paragon SDK, prefix the app provider name with `custom.`.
</Note>

```js JavaScript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Data 
await paragon.request("custom.<app_provider_name>", "<api_endpoint>", {
  method: "GET",
})
```

**Example:**

```js JavaScript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>)

// Create new Issue
await paragon.request("custom.onesignal", "/notifications", {
    method: "POST",
    body: { 
    "title": "This notification was created from your app"
    }
})
```

<Card title="Explore the Paragon SDK" href="/apis/api-reference" horizontal icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right-icon lucide-arrow-right"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg>}>
  Learn more about triggering integration logic from the frontend with the Paragon SDK.
</Card>

### Proxy API

If you'd like to issue a request from your server to your custom integration on behalf of an end-user, you can make the request to:

```bash REST API
https://proxy.useparagon.com/projects/<Paragon Project ID>/sdk/proxy
  /custom/<Integration ID>/<API path>

Authorization: Bearer <Paragon User Token>
```

* A Bearer token must also be specified with a Paragon User Token.
* This endpoint accepts any HTTP verb you want to use with the API.
* The Integration ID can be found in the dashboard (`/.../integrations/<Integration ID>`) or with the [Get project's integrations](/apis/api-reference#get-project’s-integrations) API endpoint.

**Example:**

```bash REST API
POST https://proxy.useparagon.com/projects/19d...012/sdk/proxy
    /fb243b75-35e7-46b3-ba6c-967ccebeb449/notifications

Authorization: Bearer eyJ...
Content-Type: application/json

{ 
    "title": "This notification was created from your app"
}
```

<Card title="Explore the Proxy API" href="/apis/proxy" horizontal icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right-icon lucide-arrow-right"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg>}>
  Learn more about triggering integration logic from the backend with the Proxy API.
</Card>


# Custom Webhooks
Source: https://docs.useparagon.com/resources/custom-webhooks

Create your own custom webhook with any integration provider on Paragon.

## Overview

Custom Webhooks allow you to build your own webhook trigger with any integration provider on Paragon.

## Building a Custom Webhook

The prerequisites for building a Custom Webhook with any integration provider on Paragon are:

* The integration provider must have a webhook API.
* You have access to the integration provider's webhook API documentation.
* If the integration provider uses OAuth authentication, create a developer account and developer application from the integration provider.
* You have access to a sandbox within the integration provider's service.
* A Paragon account with a **Pro plan** or above.

To start building a Custom Webhook, click the **Triggers** tab from within an integration in your integration catalog in Paragon. You'll need to complete the following steps:

### Step 1. Basic Info

You'll first need to provide some basic information about the webhook that will appear in the Workflow Editor and dictate the trigger's configuration.

**Trigger Name** - A descriptive short name for the webhook, like *Record Created.*

**How is this webhook created?** You can usually find this in your integration provider's webhook API documentation.

* Select **API Request** if the webhook can be created programmatically using the provider's webhook API.
* Select **Manual** otherwise.

**What type of webhook is this?**

* Select **User-level** if webhooks are created for each user.
* Select **App-level** if webhooks are created once at the client or application level.

<Frame>
  <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API.png?maxW=4800&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=6bbde2cc742ff7befaf956ace6a8927a" alt="" width="4800" height="3600" data-path="assets/API.png" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API.png?w=280&maxW=4800&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=93b8fef8d33b49baf4467a749bf3a012 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API.png?w=560&maxW=4800&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=26a26fcd0e50873a41f3d648da66a649 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API.png?w=840&maxW=4800&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=3acd9c2fa76594cbfc8a03b9d5374353 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API.png?w=1100&maxW=4800&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=99b6f85e3894463c8d6fde0074b604fa 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API.png?w=1650&maxW=4800&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=1282e6132b26b0d2982216018906a907 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/API.png?w=2500&maxW=4800&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=d8eabeb91f3df4dbb9e646ec798d51dd 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Step 2. Webhook Setup

#### Option 1: Programmatic Webhook API Setup

Describe the API request parameters to create the webhook. This information should be found in the provider's webhook API documentation.

* **Webhook Setup Request URL**
* **Target** - Instruct the webhook provider where to send webhook events by referencing a custom URL associated with your Paragon project to subscribe and receive events. `{{settings.webhookURL}}`
* **Authorization** - Defaults to the authentication scheme used for the Paragon integration. If the provider's webhook API authenticates differently, this can be overridden and developer tokens can be referenced from the variable menu.
* **Webhook Response** - Customize these options if the provider's webhook API requires a custom response from the webhook recipient server.

You must connect an integration sandbox account to test the request to create the webhook before continuing through the rest of the wizard.

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Webhook%20-_%20API%20Setup.png?maxW=4800&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=34b9cac98119ba35f5be75b69dcb94c3" alt="" width="4800" height="4360" data-path="assets/Custom Webhook -_ API Setup.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Webhook%20-_%20API%20Setup.png?w=280&maxW=4800&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=8b55e04e1e1cdb2c1938e1616e86a144 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Webhook%20-_%20API%20Setup.png?w=560&maxW=4800&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=058e10c8e456104d2368c842d55bf034 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Webhook%20-_%20API%20Setup.png?w=840&maxW=4800&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=bb5a7b7ac2b7cd5ac997ae74b4c7b6a7 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Webhook%20-_%20API%20Setup.png?w=1100&maxW=4800&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=af84c43664f89a4ce5cb53e323e5411a 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Webhook%20-_%20API%20Setup.png?w=1650&maxW=4800&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=b2363a9c9d27d9cec0a09b032595a1f5 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20Webhook%20-_%20API%20Setup.png?w=2500&maxW=4800&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=3bd069ea78710eeec6d10337eb5cb32f 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### Option 2: Manual Setup

Copy the **Webhook Target URL** which you will need to input when you create the webhook trigger in the integration provider's app sandbox or developer portal. For Paragon projects with pre-existing triggers in a given integration, this target link is the same as the one you have already configured to listen for events.

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-12%20at%2009.25.08.png?maxW=569&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=9f237930858c794c38f54cfc4bd3f7b3" alt="" width="569" height="289" data-path="assets/CleanShot 2024-08-12 at 09.25.08.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-12%20at%2009.25.08.png?w=280&maxW=569&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=aac34e50e797d3541ec8321a77884e87 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-12%20at%2009.25.08.png?w=560&maxW=569&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=a4ed1603cb7e425a9349b32504ec5ffb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-12%20at%2009.25.08.png?w=840&maxW=569&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=4bb2e56a3bb623d93ec1103c02a0ba95 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-12%20at%2009.25.08.png?w=1100&maxW=569&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=468ec4cf3999bce5fc2e304651dc03bd 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-12%20at%2009.25.08.png?w=1650&maxW=569&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=adda9bba487d65303d19cdb687fdb328 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-12%20at%2009.25.08.png?w=2500&maxW=569&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=7f6c17207930e52fc0e354787374b3e3 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Warning>
  **Manual, User-Level Triggers** will require your app to instruct each of your users to instantiate this webhook in their integration's account manually. Each user will have a unique URL generated by appending their associated `credentialId` as an `id `query parameter, replacing the`/test` path placeholder.
</Warning>

Use the `.getUser()` [SDK method](/apis/api-reference#getuser-→-paragonuser) to reference the current users' `credentialId` and append that ID to the copied **Webhook Target URL** in the following form:

```bash
https://hermes.useparagon.com/.../?id={{credentialID}}
```

**Customizing the listener Response Type**

Some integration providers enforce verification – when the webhook is created – requiring the events recipient server to respond in a certain way to prove their authenticity. Use the **Response Type** input to define this behavior.

A **Use custom code** option is made available for fully configuring the response behavior and saving any webhook secrets returned by the provider. This function should return an object describing the response with the following properties: `status`, `headers`, and `body`. A `persist` property is available to save incoming request values for reference later in the webhook wizard.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-08-07%20at%2015.05.56.png?maxW=497&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=1a1a557159b9727627ae0cee1b96480b" alt="" width="497" height="624" data-path="assets/CleanShot 2024-08-07 at 15.05.56.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-08-07%20at%2015.05.56.png?w=280&maxW=497&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=81c09d0a7671804bac36a8cc018b597d 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-08-07%20at%2015.05.56.png?w=560&maxW=497&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f2daa377fdfa1e0d8d0788bd4c837f7b 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-08-07%20at%2015.05.56.png?w=840&maxW=497&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=d71176e64de6ea85e6b3d6810897e441 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-08-07%20at%2015.05.56.png?w=1100&maxW=497&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=5e4d57a158303da43b633a59af58f3d0 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-08-07%20at%2015.05.56.png?w=1650&maxW=497&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=5e689b4512c20071aa7de754623e748e 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-08-07%20at%2015.05.56.png?w=2500&maxW=497&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=9c30b44a741de32ea8934ce0c8a481fc 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Step 3. Event Handling

#### Event Routing

App-level webhooks require you to match the user-identifying property of the incoming event payload with the existing user ID saved by Paragon. This ensures that incoming events are associated to the correct user. Use the variable menu to reference properties and headers of the incoming event to match against the *Provider ID* Paragon uses internally to identify tenants of an integration.

#### Payload Verification

Specify how Paragon should process incoming webhook events and validate their authenticity. You can usually find these details in the webhook security or validation sections of their webhook API Documentation.

The most common methods of payload verification are supported as pre-configured options, and a custom code option is provided to allow you to define your own HMAC digest if necessary.

Once you've configured your payload validation method, press the `Listen for events` button to validate the verification. Receiving an event once configuring your payload validation method confirms that your validation is properly configured. You must successfully receive a payload before moving to the next step.

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2016.21.48@2x.png?maxW=3448&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=fd09a783644b81d9daba5c9189ff3c8b" alt="" width="3448" height="1918" data-path="assets/CleanShot 2024-08-07 at 16.21.48@2x.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2016.21.48@2x.png?w=280&maxW=3448&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=849e7a6c594a0b91a17439ee39c4e594 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2016.21.48@2x.png?w=560&maxW=3448&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=1ee436cfdd0212219db02fbd950c2411 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2016.21.48@2x.png?w=840&maxW=3448&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=fb9d56e301d87eff5ddbb16af6f0bb5f 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2016.21.48@2x.png?w=1100&maxW=3448&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=99af6270dce192445ac45ef26d1e70a4 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2016.21.48@2x.png?w=1650&maxW=3448&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=dcc09a8f32a91b45e46c578a234b0277 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2016.21.48@2x.png?w=2500&maxW=3448&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=818e5c73755a520edf002b7ae4892510 2500w" data-optimize="true" data-opv="2" />
</Frame>

Press the `Finish` button to save your custom trigger.

## Using your Custom Webhooks

Once you've fully configured your custom trigger, you can now access it through the Workflow Builder in the same way as existing integration triggers.

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2015.24.42.png?maxW=496&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=a66d2e09f6ec3b054b833b9c84343f52" alt="" width="496" height="596" data-path="assets/CleanShot 2024-08-07 at 15.24.42.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2015.24.42.png?w=280&maxW=496&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e599a217a5d3a5b4e1db8fcde0392d24 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2015.24.42.png?w=560&maxW=496&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=4b3b498b22fbc149cdcdcf5bc7d54ebc 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2015.24.42.png?w=840&maxW=496&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=ea5e733e93bc359824fbcd2b13a341a7 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2015.24.42.png?w=1100&maxW=496&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c1bf8ee2d88391c4cbaca766b35ecf20 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2015.24.42.png?w=1650&maxW=496&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5511771e2b0c7c402ba3686011b3de96 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-08-07%20at%2015.24.42.png?w=2500&maxW=496&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5a0a8a7661b195d6179a575557c755c5 2500w" data-optimize="true" data-opv="2" />
</Frame>

**Testing Workflows with Custom Webhooks**

When testing your workflows with your Custom Webhooks, you must be able to trigger a test event in your integration sandbox to simulate a production scenario. Clicking *Test Step* on your Custom Trigger will prompt Paragon to listen for a webhook event to be sent to the URL.


# Overview
Source: https://docs.useparagon.com/resources/integrations



You can find the full list of supported Integration providers below. If you don't see the provider that you're looking for, you can [build it yourself using the Custom Integrations Builder](/resources/custom-integrations) or [let us know](mailto:team@useparagon.com) and we can add it for you.

<CardGroup cols={2}>
  <Card title="ActiveCampaign" href="/resources/integrations/activecampaign" horizontal />

  <Card title="Adobe Acrobat Sign" href="/resources/integrations/adobe-acrobat-sign" horizontal />

  <Card title="Adobe Experience Manager" href="/resources/integrations/adobe-experience-manager" horizontal />

  <Card title="ADP Workforce Now" href="/resources/integrations/adp-workforce-now" horizontal />

  <Card title="Airtable" href="/resources/integrations/airtable" horizontal />

  <Card title="Amazon S3" href="/resources/integrations/amazon-s3" horizontal />

  <Card title="Amplitude" href="/resources/integrations/amplitude" horizontal />

  <Card title="Apollo.io" href="/resources/integrations/apollo-io" horizontal />

  <Card title="Asana" href="/resources/integrations/asana" horizontal />

  <Card title="Azure DevOps" href="/resources/integrations/azure-devops" horizontal />

  <Card title="BambooHR" href="/resources/integrations/bamboohr" horizontal />

  <Card title="BigQuery" href="/resources/integrations/bigquery" horizontal />

  <Card title="Box" href="/resources/integrations/box" horizontal />

  <Card title="Calendly" href="/resources/integrations/calendly" horizontal />

  <Card title="ClickUp" href="/resources/integrations/clickup" horizontal />

  <Card title="Close" href="/resources/integrations/close" horizontal />

  <Card title="Coda" href="/resources/integrations/coda" horizontal />

  <Card title="Confluence" href="/resources/integrations/confluence" horizontal />

  <Card title="Copper" href="/resources/integrations/copper" horizontal />

  <Card title="DocuSign" href="/resources/integrations/docusign" horizontal />

  <Card title="Dropbox" href="/resources/integrations/dropbox" horizontal />

  <Card title="Dropbox Sign" href="/resources/integrations/dropboxsign" horizontal />

  <Card title="Dynamics 365 Business Central" href="/resources/integrations/dynamicsbusinesscentral" horizontal />

  <Card title="Dynamics 365 Finance" href="/resources/integrations/dynamics-finance" horizontal />

  <Card title="Emarsys" href="/resources/integrations/emarsys" horizontal />

  <Card title="Facebook Ads" href="/resources/integrations/facebook-ads" horizontal />

  <Card title="Facebook Pages" href="/resources/integrations/facebook-pages" horizontal />

  <Card title="Figma" href="/resources/integrations/figma" horizontal />

  <Card title="Freshdesk" href="/resources/integrations/freshdesk" horizontal />

  <Card title="Freshsales" href="/resources/integrations/freshsales" horizontal />

  <Card title="Front" href="/resources/integrations/front" horizontal />

  <Card title="Gainsight" href="/resources/integrations/gainsight" horizontal />

  <Card title="GitHub" href="/resources/integrations/github" horizontal />

  <Card title="Gmail" href="/resources/integrations/gmail" horizontal />

  <Card title="Gong" href="/resources/integrations/gong" horizontal />

  <Card title="Google Ad Manager" href="/resources/integrations/google-ad-manager" horizontal />

  <Card title="Google Ads" href="/resources/integrations/googleads" horizontal />

  <Card title="Google Analytics" href="/resources/integrations/google-analytics" horizontal />

  <Card title="Google Analytics GA4" href="/resources/integrations/googleanalyticsga4" horizontal />

  <Card title="Google Calendar" href="/resources/integrations/google-calendar" horizontal />

  <Card title="Google Campaign Manager 360" href="/resources/integrations/google-campaign-manager-360" horizontal />

  <Card title="Google Docs" href="/resources/integrations/googledocs" horizontal />

  <Card title="Google Drive" href="/resources/integrations/google-drive" horizontal />

  <Card title="Google Search Console" href="/resources/integrations/google-search-console" horizontal />

  <Card title="Google Sheets" href="/resources/integrations/google-sheets" horizontal />

  <Card title="Greenhouse" href="/resources/integrations/greenhouse" horizontal />

  <Card title="Gusto" href="/resources/integrations/gusto" horizontal />

  <Card title="Heap" href="/resources/integrations/heap" horizontal />

  <Card title="Hive" href="/resources/integrations/hive" horizontal />

  <Card title="HubSpot" href="/resources/integrations/hubspot" horizontal />

  <Card title="iManage" href="/resources/integrations/imanage" horizontal />

  <Card title="Insightly" href="/resources/integrations/insightly" horizontal />

  <Card title="Intellum" href="/resources/integrations/intellum" horizontal />

  <Card title="Intercom" href="/resources/integrations/intercom" horizontal />

  <Card title="Jira" href="/resources/integrations/jira" horizontal />

  <Card title="Keap" href="/resources/integrations/keap" horizontal />

  <Card title="Klaviyo" href="/resources/integrations/klaviyo" horizontal />

  <Card title="Lever" href="/resources/integrations/lever" horizontal />

  <Card title="Linear" href="/resources/integrations/linear" horizontal />

  <Card title="LinkedIn" href="/resources/integrations/linkedin" horizontal />

  <Card title="LinkedIn Marketing" href="/resources/integrations/linkedinmarketing" horizontal />

  <Card title="Magento" href="/resources/integrations/magento" horizontal />

  <Card title="Mailchimp" href="/resources/integrations/mailchimp" horizontal />

  <Card title="Marketo" href="/resources/integrations/marketo" horizontal />

  <Card title="Microsoft Dynamics 365" href="/resources/integrations/microsoft-dynamics-365" horizontal />

  <Card title="Microsoft Excel" href="/resources/integrations/microsoftexcel" horizontal />

  <Card title="Microsoft Outlook" href="/resources/integrations/outlook" horizontal />

  <Card title="Microsoft Teams" href="/resources/integrations/microsoft-teams" horizontal />

  <Card title="Miro" href="/resources/integrations/miro" horizontal />

  <Card title="Mixpanel" href="/resources/integrations/mixpanel" horizontal />

  <Card title="Monday" href="/resources/integrations/monday" horizontal />

  <Card title="Netsuite" href="/resources/integrations/netsuite" horizontal />

  <Card title="Notion" href="/resources/integrations/notion" horizontal />

  <Card title="OneDrive" href="/resources/integrations/onedrive" horizontal />

  <Card title="OneNote" href="/resources/integrations/onenote" horizontal />

  <Card title="OpenAI" href="/resources/integrations/openai" horizontal />

  <Card title="Eloqua" href="/resources/integrations/eloqua" horizontal />

  <Card title="Oracle Financials Cloud" href="/resources/integrations/oracle-financials-cloud" horizontal />

  <Card title="Outreach" href="/resources/integrations/outreach" horizontal />

  <Card title="PagerDuty" href="/resources/integrations/pagerduty" horizontal />

  <Card title="PandaDoc" href="/resources/integrations/pandadoc" horizontal />

  <Card title="Pardot" href="/resources/integrations/pardot" horizontal />

  <Card title="Pipedrive" href="/resources/integrations/pipedrive" horizontal />

  <Card title="PowerBI" href="/resources/integrations/powerbi" horizontal />

  <Card title="Productboard" href="/resources/integrations/productboard" horizontal />

  <Card title="QuickBooks" href="/resources/integrations/quickbooks" horizontal />

  <Card title="Quip" href="/resources/integrations/quip" horizontal />

  <Card title="Ramp" href="/resources/integrations/ramp" horizontal />

  <Card title="Sailthru" href="/resources/integrations/sailthru" horizontal />

  <Card title="Sage Accounting" href="/resources/integrations/sage-accounting" horizontal />

  <Card title="Sage Intacct" href="/resources/integrations/sage-intacct" horizontal />

  <Card title="Salesforce" href="/resources/integrations/salesforce" horizontal />

  <Card title="SalesLoft" href="/resources/integrations/salesloft" horizontal />

  <Card title="SAP S/4HANA" href="/resources/integrations/saps4hana" horizontal />

  <Card title="SAP SuccessFactors" href="/resources/integrations/sapsuccessfactors" horizontal />

  <Card title="Segment" href="/resources/integrations/segment" horizontal />

  <Card title="ServiceNow" href="/resources/integrations/servicenow" horizontal />

  <Card title="SharePoint" href="/resources/integrations/sharepoint" horizontal />

  <Card title="Shopify" href="/resources/integrations/shopify" horizontal />

  <Card title="Shortcut" href="/resources/integrations/shortcut" horizontal />

  <Card title="Slack" href="/resources/integrations/slack" horizontal />

  <Card title="Snowflake" href="/resources/integrations/snowflake" horizontal />

  <Card title="Stack Overflow Teams" href="/resources/integrations/stackoverflowteams" horizontal />

  <Card title="Stripe" href="/resources/integrations/stripe" horizontal />

  <Card title="Tableau" href="/resources/integrations/tableau" horizontal />

  <Card title="TikTok Ads" href="/resources/integrations/tiktokads" horizontal />

  <Card title="Todoist" href="/resources/integrations/todoist" horizontal />

  <Card title="Trello" href="/resources/integrations/trello" horizontal />

  <Card title="Typeform" href="/resources/integrations/typeform" horizontal />

  <Card title="Unleashed" href="/resources/integrations/unleashed" horizontal />

  <Card title="Vanta" href="/resources/integrations/vanta" horizontal />

  <Card title="Vimeo" href="/resources/integrations/vimeo" horizontal />

  <Card title="WhatsApp" href="/resources/integrations/whatsapp" horizontal />

  <Card title="WooCommerce" href="/resources/integrations/woocommerce" horizontal />

  <Card title="WordPress" href="/resources/integrations/wordpress" horizontal />

  <Card title="Workable" href="/resources/integrations/workable" horizontal />

  <Card title="Workday" href="/resources/integrations/workday" horizontal />

  <Card title="Xero" href="/resources/integrations/xero" horizontal />

  <Card title="Zendesk" href="/resources/integrations/zendesk" horizontal />

  <Card title="Zendesk Sell" href="/resources/integrations/zendesksell" horizontal />

  <Card title="Zoho CRM" href="/resources/integrations/zohocrm" horizontal />

  <Card title="Zoho People" href="/resources/integrations/zohopeople" horizontal />

  <Card title="Zoom" href="/resources/integrations/zoom" horizontal />
</CardGroup>


# ActiveCampaign
Source: https://docs.useparagon.com/resources/integrations/activecampaign

Connect to your users' ActiveCampaign accounts.

## Setup Guide

You can find your ActiveCampaign app credentials in your [ActiveCampaign Developer Settings](https://developers.activecampaign.com/reference/authentication).

You'll need the following information to set up your ActiveCampaign App with Paragon Connect:

* API Key
* Domain

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to ActiveCampaign

Once your users have connected their ActiveCampaign account, you can use the Paragon SDK to access the ActiveCampaign API on behalf of connected users.

See the ActiveCampaign [REST API documentation](https://developers.activecampaign.com/reference/overview) for their full API reference.

Any ActiveCampaign API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Contact by ID
await paragon.request("activecampaign", "3/contacts/<id>", {
  method: "GET"
});

// Create a Deal
await paragon.request("activecampaign", "3/deals", {
  method: "POST",
  body: {
    deal: {
      contact: "51",
      account: "45",
      description: "This deal is an important deal",
      currency: "usd",
      group: "1",
      owner: "1",
      percent: null,
      stage: "1",
      status: 0,
      title: "AC Deal",
      value: 45600,
      fields: [
        {
          "customFieldId": 1,
          "fieldValue": "First field value"
        },
      ]
    }
  }
});

// Get all Campaigns
await paragon.request("activecampaign", "3/campaigns", {
  method: "GET"
});
  
```

## Building ActiveCampaign workflows

Once your ActiveCampaign account is connected, you use the [ActiveCampaign Request](/workflows/requests#making-integration-requests) step to access any of ActiveCampaign's API endpoints without the authentication piece.

When creating or updating records in ActiveCampaign, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Adobe Acrobat Sign
Source: https://docs.useparagon.com/resources/integrations/adobe-acrobat-sign

Connect to your users' Adobe Acrobat Sign accounts.

## Setup Guide

You can find your Adobe Acrobat Sign app credentials in your [Adobe Acrobat Sign Developer Account.](https://opensource.adobe.com/acrobat-sign/developer_guide/index.html)

You'll need the following information to set up your Adobe Acrobat Sign App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your Adobe Acrobat Sign app to Paragon

Under **Integrations > Connected Integrations > Adobe Acrobat Sign > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Adobe Acrobat Sign App page.
* **Client Secret:** Found under Client Secret on your Adobe Acrobat Sign App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Leaving the Client ID and Client Secret blank will use Paragon development keys.

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Adobe%20Acrobat%20SIgn%20app%20to%20Paragon%20Connect.png?maxW=2066&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=92af9fed347ef75f0abd8fa2ea58b616" alt="" width="2066" height="1164" data-path="assets/Connecting your Adobe Acrobat SIgn app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Adobe%20Acrobat%20SIgn%20app%20to%20Paragon%20Connect.png?w=280&maxW=2066&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2fd4df9278a325bb2a562f9673849978 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Adobe%20Acrobat%20SIgn%20app%20to%20Paragon%20Connect.png?w=560&maxW=2066&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=0615e723cefcf6e611c104dd442557d6 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Adobe%20Acrobat%20SIgn%20app%20to%20Paragon%20Connect.png?w=840&maxW=2066&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=94631c3b5b2743ca460081e972f2ac59 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Adobe%20Acrobat%20SIgn%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2066&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a5dc346996956e68683f1a24da6d013d 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Adobe%20Acrobat%20SIgn%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2066&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e7a8ec43948d2c0165e99f4b6ac7a8a2 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Adobe%20Acrobat%20SIgn%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2066&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=cde0c2b87c0be10e905cbf9b8804c422 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Adobe Acrobat Sign

Once your users have connected their Adobe Acrobat Sign account, you can use the Paragon SDK to access the Adobe Acrobat Sign API on behalf of connected users.

See the Adobe Acrobat Sign [REST API documentation](https://opensource.adobe.com/acrobat-sign/developer_guide/index.html) for their full API reference.

Any Adobe Acrobat Sign API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Agreements for the Connected User
paragon.request("acrobatsign", "/agreements", {
  method: "GET"
});

// Get the Status of an Agreement
paragon.request("acrobatsign", "/agreements/<AGREEMENT_ID>", {
  method: "GET"
});

// Create an Agreement for signature request
paragon.request("acrobatsign", "/agreements", {
  method: "POST",
  body: {
    "fileInfos": [
      {
        "transientDocumentId": ""
      }
    ],
    "name": "My Document Agreement",
    "participantSetsInfo": [
      {
        "order": 1,
        "role": "",
        "memberInfos": [
          {
            "email": "bowie@useparagon.com"
          }
        ]
      }
    ],
    "signatureType": "",
    "state": ""
  }
});
  
```

## Building Adobe Acrobat Sign workflows

Once your Adobe Acrobat Sign account is connected, you use the [Adobe Acrobat Sign Request](/workflows/requests#making-integration-requests) step to access any of Adobe Acrobat Sign's API endpoints without the authentication piece.

When creating or updating records in Adobe Acrobat Sign, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Adobe Experience Manager
Source: https://docs.useparagon.com/resources/integrations/adobe-experience-manager

Connect to your users' Adobe Experience Manager accounts.

## Setup Guide

You can find your Adobe Experience Manager app credentials in your [Adobe Experience Manager Developer Account.](https://developer.adobe.com/dep/guides/postman/setup-environment/)

You'll need the following information to set up your Adobe Experience Manager App with Paragon Connect:

* Domain
* [Technical Account Details](https://experience.adobe.com/#/cloud-manager/landing.html)

## Connecting to Adobe Experience Manager

Once your users have connected their Adobe Experience Manager account, you can use the Paragon SDK to access the Adobe Experience Manager API on behalf of connected users.

See the Adobe Experience Manager [REST API documentation](https://developer.adobe.com/dep/guides/postman/setup-environment/) for their full API reference.

Any Adobe Experience Manager API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get a Folder
await paragon.request("adobeexperiencemanager", "/myFolder.json", {
    method: "GET"
});

// Create a Folder
await paragon.request("adobeexperiencemanager", "/*", {
    method: 'POST',
    body: {
      "name": "myAssetsFolder",
      "jcr:title": "My Assets Folder"
    }
});
  
```

## Building Adobe Experience Manager workflows

Once your Adobe Experience Manager account is connected, you can add steps to perform the following actions:

* Create Folder
* Delete Folder
* Delete Asset
* Create Asset Rendition
* Update Asset Rendition
* Delete Asset Rendition

You can also use the [Adobe Experience Manager Request](/workflows/requests#making-integration-requests) step to access any of Adobe Experience Manager's API endpoints without the authentication piece.

When creating or updating records in Adobe Experience Manager, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# ADP Workforce Now
Source: https://docs.useparagon.com/resources/integrations/adp-workforce-now

Connect to your users' ADP Workforce Now accounts.

## Setup Guide

You can find your ADP Workforce Now app credentials in your [ADP Workforce Now Developer Account.](https://developers.adp.com/build/api-explorer)

You'll need the following information to set up your ADP Workforce Now App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your ADP Workforce Now app to Paragon

Under **Integrations > Connected Integrations > ADP Workforce Now > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your ADP Workforce Now App page.
* **Client Secret:** Found under Client Secret on your ADP Workforce Now App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20your%20ADP%20Workforce%20Now%20app%20to%20Paragon%20Connect.png?maxW=2056&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=4d088df1bb94763194976dd2090fbb90" alt="" width="2056" height="1190" data-path="assets/Connecting your ADP Workforce Now app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20your%20ADP%20Workforce%20Now%20app%20to%20Paragon%20Connect.png?w=280&maxW=2056&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=822b7609beebf9ecb14471c8faa56213 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20your%20ADP%20Workforce%20Now%20app%20to%20Paragon%20Connect.png?w=560&maxW=2056&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b722a99d92d3814b3bea7e0096a98d22 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20your%20ADP%20Workforce%20Now%20app%20to%20Paragon%20Connect.png?w=840&maxW=2056&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=a416c4087c58c794aeb4cec7e92e7c18 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20your%20ADP%20Workforce%20Now%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2056&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=40ba91cf402f149e60d313dcdf0064fe 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20your%20ADP%20Workforce%20Now%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2056&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=33f2c528a6b5813dfef1698e14c5f095 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20your%20ADP%20Workforce%20Now%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2056&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=4fcb5a05ddcb3417c525c4d3bbeae6b0 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to ADP Workforce Now

Once your users have connected their ADP Workforce Now account, you can use the Paragon SDK to access the ADP Workforce Now API on behalf of connected users.

See the ADP Workforce Now [REST API documentation](https://developers.adp.com/build/api-explorer) for their full API reference.

Any ADP Workforce Now API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Workers
paragon.request("adpworkforcenow", "hr/v2/workers", {
  method: "GET"
});

// Get Worker's Pay Distributions
paragon.request("adpworkforcenow", "/payroll/v2/workers/<aoid>/pay-distributions", {
  method: "GET"
});

// Get a Job Application by ID
paragon.request("adpworkforcenow", "/staffing/v2/job-applications/<job-application-id>", {
  method: "GET"
});
  
```

## Building ADP Workforce Now workflows

Once your ADP Workforce Now account is connected, you use the [ADP Workforce Now Request](/workflows/requests#making-integration-requests) step to access any of ADP Workforce Now's API endpoints without the authentication piece.

When creating or updating records in ADP Workforce Now, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Airtable
Source: https://docs.useparagon.com/resources/integrations/airtable

Connect to your users' Airtable accounts.

## Setup Guide

You can find your Airtable app credentials in your [Airtable Developer Account](https://airtable.com/developers).

You'll need the following information to set up your Airtable App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Add your Airtable app to Paragon

Under **Integrations > Connected Integrations > Airtable > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Airtable App page.
* **Client Secret:** Found under Client Secret on your Airtable App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Airtable%20app%20to%20Paragon%20Connect.png?maxW=2012&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=bbe7377949617dcb9ab52c203c02f368" alt="" width="2012" height="1208" data-path="assets/Connecting your Airtable app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Airtable%20app%20to%20Paragon%20Connect.png?w=280&maxW=2012&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e168b46d5ecab19a5430026544848490 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Airtable%20app%20to%20Paragon%20Connect.png?w=560&maxW=2012&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2069bde57b56edbafef27b86b934b1a8 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Airtable%20app%20to%20Paragon%20Connect.png?w=840&maxW=2012&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=789bbb7304da4383ecaaffd324ce6d41 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Airtable%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2012&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e407d77006e185b83c750409c4d12050 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Airtable%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2012&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c3e667b745976a91a98dc1faca1b3c6d 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Airtable%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2012&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=63685ec067635a9903d4d1ed1ad8f40b 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Airtable

Once your users have connected their Airtable account, you can use the Paragon SDK to access the Airtable API on behalf of connected users.

See the Airtable [REST API documentation](https://airtable.com/api) for their full API reference.

Any Airtable API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// List records
paragon.request("airtable", "/<BASE ID>/<TABLE NAME>?maxRecords=3&view=Grid%20view", {
  method: "GET"
});

// Create a record
paragon.request("airtable", "/<BASE ID>/<TABLE NAME>", {
  method: "POST",
  body: {
  "records": [
      "fields": {
        "<AIRTABLE COLUMN NAME>": <VALUE>
      }
    ]
  }
});
  
```

## Building Airtable workflows

Once your Airtable account is connected, you use the [Airtable Request](/workflows/requests#making-integration-requests) step to access any of Airtable's API endpoints without the authentication piece.

When creating or updating records in Airtable, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Amazon S3
Source: https://docs.useparagon.com/resources/integrations/amazon-s3

Connect to your users' Amazon S3 accounts.

## Setup Guide

You can find your Amazon S3 app credentials in your [Amazon S3 Developer Account.](https://docs.aws.amazon.com/AmazonS3/latest/API/Type_API_Reference.html)

You'll need the following information to set up your Amazon S3 App with Paragon Connect:

* API Key

## Connecting to Amazon S3

Once your users have connected their Amazon S3 account, you can use the Paragon SDK to access the Amazon S3 API on behalf of connected users.

See the Amazon S3 [REST API documentation](https://docs.aws.amazon.com/AmazonS3/latest/API/Type_API_Reference.html) for their full API reference.

Any Amazon S3 API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get an Object
await paragon.request("amazons3", "/<Bucket>/<Key>", {
  method: "GET"
});

// Create a Bucket
await paragon.request("amazons3", "/<Bucket>", {
  method: "PUT",
  body: `<?xml version="1.0" encoding="UTF-8"?>
<CreateBucketConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
   <LocationConstraint>us-east-2</LocationConstraint>
</CreateBucketConfiguration>`
});
  
```

## Building Amazon S3 workflows

Once your Amazon S3 account is connected, you can add steps to perform the following actions:

* Create Folder
* Delete Folder
* Upload File
* Download File
* List Files

You can also use the [Amazon S3 Request](/workflows/requests#making-integration-requests) step to access any of Amazon S3's API endpoints without the authentication piece.

When creating or updating records in Amazon S3, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Amplitude
Source: https://docs.useparagon.com/resources/integrations/amplitude

Connect to your users' Amplitude accounts.

## Setup Guide

You can find your Amplitude app credentials on your [Amplitude Settings page](https://www.docs.developers.amplitude.com/analytics/find-api-credentials/).

You'll need the following information to set up your Amplitude App with Paragon Connect:

* Amplitude API Key

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to Amplitude

Once your users have connected their Amplitude account, you can use the Paragon SDK to access the Amplitude API on behalf of connected users.

See the Amplitude [REST API documentation](https://www.docs.developers.amplitude.com/analytics/api-reference-overview/) for their full API reference.

Any Amplitude API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get cohorts data from Amplitude
paragon.request("amplitude", "/3/cohorts", {
  method: "GET",
});

// Get data from a dashboard chart
paragon.request("amplitude", "/api/3/chart/<chart_id>/query", {
  method: "GET"
});
  
```

## Building Amplitude workflows

Once your Amplitude account is connected, you use the [Amplitude Request](/workflows/requests#making-integration-requests) step to access any of Amplitude's API endpoints without the authentication piece.

When creating or updating records in Amplitude, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Apollo.io
Source: https://docs.useparagon.com/resources/integrations/apollo-io

Connect to your users' Apollo.io accounts.

## Setup Guide

You can find your Apollo.io app credentials in your [Apollo.io Developer Account.](https://apolloio.github.io/apollo-api-docs/?shell#introduction)

You'll need the one of the following pieces of information to set up your Apollo.io App with Paragon Connect:

* Client ID and Client Secret
* API Key

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

<Tabs>
  <Tab title="OAuth 2.0">
    ### Add the Redirect URL to your Apollo.io app

    Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Apollo.io app:

    1. Log in to your **Apollo** account and go to **Settings > Integrations > API > Connect**.
    2. Click **OAuth Registration** to start registering your app.
    3. In the registration form, provide:
       * **App Name** – Your app’s name.
       * **App Logo** – (optional) for display in the authorization prompt.
       * **OAuth Redirect URL** – Paste Paragon Connect’s redirect URL:
         ```
         https://passport.useparagon.com/oauth
         ```
       * **Scopes** – Select only the permissions your app needs. Apollo adds basic scopes (e.g. `read_user_profile`, `app_scopes`) by default.
    4. Click **Submit** (or Save) to register your app.

    Apollo.io provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

    ### Add your Apollo.io app to Paragon

    1. Select **Apollo.io** from the **Integrations Catalog**.

    2. Under **Integrations > Connected Integrations > Apollo.io > App Configuration > Configure**, fill out your credentials from the end of the [previous section](/resources/integrations/apollo-io#add-the-redirect-url-to-your-apollo-io-app) in their respective sections:

    * **Client ID:** Found at the end of the previous section.
    * **Client Secret:** Found at the end of the previous section.
    * **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

    Press the purple "**Save Changes**" button to save your credentials.

    <Info>
      **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
    </Info>

    <Frame>
      <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Apollo.io%20app%20to%20Paragon%20Connect.png?maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=5d40eae6a3c135c29c934cd3400b531d" alt="" width="1570" height="1174" data-path="assets/Connecting your Apollo.io app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Apollo.io%20app%20to%20Paragon%20Connect.png?w=280&maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f7afa90241ccd0cda00bf6630b19b03a 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Apollo.io%20app%20to%20Paragon%20Connect.png?w=560&maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=7bc12deab72ffcf3fa4ed4c25c5a7cb3 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Apollo.io%20app%20to%20Paragon%20Connect.png?w=840&maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=96f50cd354ab739bb75ed445b29b1a8c 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Apollo.io%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=0f565a4c57054fe98f07b6305ec79566 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Apollo.io%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=3cffa7e86ea40295e149bc9a3008652f 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Apollo.io%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2b2f02e6fa790c7a693f83eaf0648a52 2500w" data-optimize="true" data-opv="2" />
    </Frame>
  </Tab>

  <Tab title="API Keys">
    ### Add your Apollo.io app to Paragon

    1. Select **Apollo.io** from the **Integrations Catalog**.
    2. Under **Connect Portal > Test Connect Portal**, click **Connect** to start the connection process.
    3. Insert your API Key and click **Continue**.
  </Tab>
</Tabs>

## Connecting to Apollo.io

Once your users have connected their Apollo.io account, you can use the Paragon SDK to access the Apollo.io API on behalf of connected users.

See the Apollo.io [REST API documentation](https://apolloio.github.io/apollo-api-docs/?shell#introduction) for their full API reference.

Any Apollo.io API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Create a Contact            
await paragon.request('apolloio', '/contacts', {
  method: 'POST',
  body: { 
   "first_name": "Jonny",
   "last_name": "Snow",
   "title": "Lord Commander",
   "organization_name": "Apollo"
  },
});

// Search Users
await paragon.request('apolloio', '/users/search', {
  method: 'GET',
});
  
```

## Building Apollo.io workflows

Once your Apollo.io account is connected, you use the [Apollo.io Request](/workflows/requests#making-integration-requests) step to access any of Apollo.io's API endpoints without the authentication piece.

When creating or updating records in Apollo.io, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Asana
Source: https://docs.useparagon.com/resources/integrations/asana

Connect to your users' Asana accounts.

## Setup Guide

You can find your Asana app credentials by visiting your [Asana Developer App Console](https://app.asana.com/0/developer-console).

You'll need the following information to set up your Asana app with Paragon:

* Client ID
* Client Secret

### Add the Redirect URL to your Asana app

Paragon provides a redirect URL to send information to your Asana app. To add the redirect URL to your Asana app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log into your [Asana Developer App Console](https://app.asana.com/0/developer-console).

3. Select the Asana application you'd like to connect to Paragon.

4. Under **Authorization > Redirect URLs**, paste the Redirect URL provided in Step 1.

<Info>
  **Note:** You'll need to create a new Asana app if you don't already have one
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Asana%20for%20OAuth%20in%20Paragon.gif?maxW=803&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=268aa02d735f62b913a02427a227f79f" alt="" width="803" height="591" data-path="assets/Configuring Asana for OAuth in Paragon.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Asana%20for%20OAuth%20in%20Paragon.gif?w=280&maxW=803&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=715b20c524a3de5076b12a8a80ee0074 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Asana%20for%20OAuth%20in%20Paragon.gif?w=560&maxW=803&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=73e5d6dd284f6dad8aa86221539194e7 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Asana%20for%20OAuth%20in%20Paragon.gif?w=840&maxW=803&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=9f6f1f951a12440e53b27e70161e9e17 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Asana%20for%20OAuth%20in%20Paragon.gif?w=1100&maxW=803&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=a2adaf4703287aafac2ba11adbd33c2e 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Asana%20for%20OAuth%20in%20Paragon.gif?w=1650&maxW=803&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=6d6be1e4258d41606da55da73f8693f2 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Asana%20for%20OAuth%20in%20Paragon.gif?w=2500&maxW=803&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8f506400334c29ad0ea55201131f0e65 2500w" data-optimize="true" data-opv="2" />
</Frame>

Asana provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

5. Under **Test & distribute > Manage distribution** , select **Any workspace** to allow your customers to enable your integration.

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20all%20Workspaces%20in%20Asana%20for%20Paragon%20Connect.png?maxW=2726&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=f0749627ff806aed70829739c87de4a9" alt="" width="2726" height="1066" data-path="assets/Enabling all Workspaces in Asana for Paragon Connect.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20all%20Workspaces%20in%20Asana%20for%20Paragon%20Connect.png?w=280&maxW=2726&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=e933c3ec5631dab2a091cfd51ff36b94 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20all%20Workspaces%20in%20Asana%20for%20Paragon%20Connect.png?w=560&maxW=2726&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=bbf977ac3681201ee77cdca07497bbfd 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20all%20Workspaces%20in%20Asana%20for%20Paragon%20Connect.png?w=840&maxW=2726&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=40d4ca18e081fd86e9cc149ce15f9d38 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20all%20Workspaces%20in%20Asana%20for%20Paragon%20Connect.png?w=1100&maxW=2726&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=6f030bafa0a13660bc56ea39f62b51ca 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20all%20Workspaces%20in%20Asana%20for%20Paragon%20Connect.png?w=1650&maxW=2726&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=76b6a26be3e9179f08929a6e876b7bad 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20all%20Workspaces%20in%20Asana%20for%20Paragon%20Connect.png?w=2500&maxW=2726&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=3d7730ee0ed4d663c94bc9e47a1c68ea 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Asana app to Paragon

1. Select Asana from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Asana > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/asana#add-the-redirect-url-to-your-asana-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

## Connecting to Asana

Once your users have connected their Asana account, you can use the Paragon SDK to access the Asana API on behalf of connected users.

See the Asana [REST API documentation](https://developers.asana.com/docs/) for their full API reference.

Any Asana API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// List files
await paragon.request("asana", "tasks", { 
  method: "POST",
  body: {
    "name": "Water the plants",
    "due_on": "2019-09-15"
  }
});
```

## Building Asana workflows

Once your Asana account is connected, you can add steps to perform the following actions:

* Create Comment
* Create Project
* Get Projects
* Get Project by ID
* Create Task
* Update Task
* Get Tasks
* Get Task by ID
* Get Task by External ID
* Add Task to Selection
* Get Teams
* Get Workspaces

You can also use the [Asana Request](/workflows/requests#making-integration-requests) step to access any of Asana's API endpoints without the authentication piece.

When creating or updating tasks in Asana, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Asana account. For example, you might want to trigger a workflow whenever tasks are updated to sync your users' Asana Tasks to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Asana%20Triggers%20in%20Paragon%20Connect.png?maxW=2210&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=34ec18a2d1ccc2e959b4d7c1a8ac2e42" alt="" width="2210" height="1464" data-path="assets/Asana Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Asana%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=2210&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=87fd16f758aad96d212029f76376620d 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Asana%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=2210&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=854d44c8944f79aec4f77e93822d1d93 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Asana%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=2210&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=8f2c69ae5e5237926c2c79d114835d5b 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Asana%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=2210&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=fadd625dbcecbdacc90c045d8765afb6 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Asana%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=2210&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=d91e1d389f5fc03ab3426ef3600c5dd6 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Asana%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=2210&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=cdf48eb7951659a619bfb904f072aa8c 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Asana below:

* **New Task**
* **Task Updated**
* **Task Completed**
* **Task Deleted**
* **Tag Added**
* **New Project**
* **New Comment**

## Testing Asana workflows

Once you have deployed your workflows and are ready to connect users from other Asana Workspaces to your Asana Application, ensure that you have selected the proper *Distribution method* for the application.

<Warning>
  Seeing an `invalid_request: The required parameter 'client_id' is missing`error?

  Ensure your Asana application is correctly distributed following these instructions.
</Warning>

In the ***Manage distribution*** settings of your Asana Application details found in the [Asana Developer App Console](https://app.asana.com/0/developer-console), select the ***Any Workspace*** distribution method. This will allow Asana users from other Workspaces to connect to your Asana application.

<Frame>
  <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/9a01fdc-Screenshot_2023-03-21_at_10.21.14_AM.png?maxW=2938&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=3020a7fead58e008b335e37f2b8c660b" alt="" width="2938" height="1338" data-path="assets/9a01fdc-Screenshot_2023-03-21_at_10.21.14_AM.png" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/9a01fdc-Screenshot_2023-03-21_at_10.21.14_AM.png?w=280&maxW=2938&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=fff6a0db400f9184691781c2902e1989 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/9a01fdc-Screenshot_2023-03-21_at_10.21.14_AM.png?w=560&maxW=2938&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=d400673b0c3f0b0dfaf25eda8a0746dd 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/9a01fdc-Screenshot_2023-03-21_at_10.21.14_AM.png?w=840&maxW=2938&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=2757f19b45b22cc784eb61ac8baf3e47 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/9a01fdc-Screenshot_2023-03-21_at_10.21.14_AM.png?w=1100&maxW=2938&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=531d72eb4d1fb52bcb4fa8528824d8bd 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/9a01fdc-Screenshot_2023-03-21_at_10.21.14_AM.png?w=1650&maxW=2938&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=10a8cbf63577ee33e9d0b782132b0143 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/9a01fdc-Screenshot_2023-03-21_at_10.21.14_AM.png?w=2500&maxW=2938&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=32983bb05f53b230a3109b87699f0d62 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Azure DevOps
Source: https://docs.useparagon.com/resources/integrations/azure-devops

Connect to your users' Azure DevOps accounts.

## Setup Guide

You can find your Azure DevOps application credentials by visiting your Microsoft Azure Portal.

You'll need the following information to set up your Azure DevOps App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add the Redirect URL to your Azure DevOps app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Azure DevOps app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

3. Navigate to **All Services > App Registrations** and select your application.

4. Select **Authentication** from the sidebar.

5. Under **Platform configurations**, press the **"Add a platform"** button.

6. Select the **Web** platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the **Save** button at the top of the page.

### Generate a Client Secret

Since Azure DevOps does not automatically provide you with a Client Secret for your application, we'll need to make one. To get your Client Secret:

1. Navigate to **Manage > Certificates & secrets** in the sidebar.

2. Under **Client Secrets**, press the **+ New client secret** button.

3. Name your client credentials and select an expiry that works best for your application. Press **Add** to create your credentials.

4. Copy the displayed Client Secret under the **Value** column.

<Info>
  **Note:** You will need to periodically create new and update your Client Secret as they expire for all Microsoft integrations.
</Info>

### Add your Azure DevOps app to Paragon

Under **Integrations > Connected Integrations > Azure DevOps > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/azure-devops#add-the-redirect-url-to-your-azure-devops-app) in their respective sections:

* **Application Type:** Select your OAuth 2.0 provider. If you are configuring the Azure DevOps integration for the first time, select `Microsoft Entra ID App`.
  Learn more at [selecting your OAuth2 provider.](/resources/integrations/azure-devops#selecting-your-azure-devops-oauth2-provider)
* **Client ID:** Found under **Essentials > Application (client) ID** on your Microsoft Azure Portal app page.
* **Client Secret:** Found under **Manage > Certificates & secrets** on your Microsoft Azure Portal app page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Azure%20DevOps%20app%20to%20Paragon%20Connect.png?maxW=1616&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=8ec0696bf1fe8b66816ed60f59532036" alt="" width="1616" height="1214" data-path="assets/Connecting your Azure DevOps app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Azure%20DevOps%20app%20to%20Paragon%20Connect.png?w=280&maxW=1616&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=1c1dda89d41f8b537f10af2c4558f470 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Azure%20DevOps%20app%20to%20Paragon%20Connect.png?w=560&maxW=1616&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=5d1e09199fef63deb5708a9afbde9c2a 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Azure%20DevOps%20app%20to%20Paragon%20Connect.png?w=840&maxW=1616&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c2d1475e299d13f144e0bee1cd5464c3 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Azure%20DevOps%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1616&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c944e4565b7297a467d8ffef93cbeba4 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Azure%20DevOps%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1616&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=7248d93018115cbbb50794ccb27d14ac 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Azure%20DevOps%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1616&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=5756153c965c5bc953c26c2da963c523 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Azure DevOps

Once your users have connected their Azure DevOps account, you can use the Paragon SDK to access the Azure DevOps API on behalf of connected users.

See the Azure DevOps [REST API documentation](https://docs.microsoft.com/en-us/rest/api/azure/devops) for their full API reference.

Any Azure DevOps API endpoints can be accessed with the Paragon SDK as shown in this examples

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
          
// Get Project List
await paragon.request("azuredevops", "/projects?api-version=5.0", {
  method: “GET”,
});
```

## Building Azure DevOps workflows

Once your Azure DevOps account is connected, you can add steps to perform the following actions:

* Search Work Items
* Create Work Item
* Update Work Item
* Delete Work Item

You can also use the [Azure DevOps Request](/workflows/requests#making-integration-requests) step to access any of Azure DevOps's API endpoints without the authentication piece.

When creating or updating work items in Azure DevOps, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Selecting your Azure DevOps OAuth2 Provider

When setting up the Azure DevOps integration for the first time, select `Azure Entra ID App` as the application type. You will obtain the required Client ID and Client Secret directly from the Azure Portal.

The `Azure DevOps OAuth App` option is only available to users who created the application prior to the announcement.

### Migrating from Azure DevOps OAuth provider into Entra ID

Microsoft has [announced](https://devblogs.microsoft.com/devops/no-new-azure-devops-oauth-apps/) that as of April 23, 2025, the Azure DevOps OAuth app platform is no longer accepting new app registrations. And the Azure DevOps Oauth Platform will be retired later in 2026.

1. Follow the steps described in [Step 1](/resources/integrations/azure-devops#add-the-redirect-url-to-your-azure-devops-app).
2. In your Paragon dashboard, reconfigure the integration following the steps described in [Add your Azure DevOps app to Paragon](/resources/integrations/azure-devops#add-your-azure-devops-app-to-paragon). Select `Microsoft Entra ID App` as the Application Type.

<Warning>
  **Warning:** Migrating from one OAuth provider to another is a disruptive process to your connected users requiring them to reconnect.
</Warning>


# BambooHR
Source: https://docs.useparagon.com/resources/integrations/bamboohr

Connect to your users' BambooHR accounts.

## Setup Guide

You can find your BambooHR app credentials in the [BambooHR Partner Program dashboard.](https://partners.bamboohr.com/apps-marketplace-program/)

You'll need the following information to set up your BambooHR App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your BambooHR app to Paragon

Under **Integrations > Connected Integrations > BambooHR > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found in your BambooHR Partner Program dashboard.
* **Client Secret:** Found in your BambooHR Partner Program dashboard.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20BambooHR%20application%20to%20Paragon%20Connect.png?maxW=1986&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=53fba4d8400eb4288fb1e245fdd2861c" alt="" width="1986" height="1144" data-path="assets/Connecting your BambooHR application to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20BambooHR%20application%20to%20Paragon%20Connect.png?w=280&maxW=1986&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b3a0406bc1c552c15122eafc9666686e 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20BambooHR%20application%20to%20Paragon%20Connect.png?w=560&maxW=1986&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=7f34b5d231189ae1f2d0242c45ec7b92 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20BambooHR%20application%20to%20Paragon%20Connect.png?w=840&maxW=1986&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2fad61af3785f22ca78da37b4640d073 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20BambooHR%20application%20to%20Paragon%20Connect.png?w=1100&maxW=1986&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a08acb306d1327daf98b8362d3c87bda 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20BambooHR%20application%20to%20Paragon%20Connect.png?w=1650&maxW=1986&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=33d0b2c94833c08234080b92121e0e06 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20BambooHR%20application%20to%20Paragon%20Connect.png?w=2500&maxW=1986&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=77bc5b12e6962b666a59c5afba45fed8 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to BambooHR

Once your users have connected their BambooHR account, you can use the Paragon SDK to access the BambooHR API on behalf of connected users.

See the BambooHR [REST API documentation](https://documentation.bamboohr.com/reference/) for their full API reference.

Any BambooHR API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Company Directory
paragon.request("bamboohr", "/employees/directory", {
  method: "GET"
});

// Create a time-off request
paragon.request("bamboohr", "/employees/<EMPLOYEE ID>/time_off/request", {
  method: "POST",
  body: {
    "status": "approved",
    "start": "2022-07-01",
    "end": "2022-07-04",
    "timeOffTypeId": 86,
    "amount": 16,
    "notes": [{from: "manager", note: "Get well soon!"}],
    "previousRequest": 0
  }
});

// Get benefit deduction types
paragon.request("bamboohr", "/benefits/settings/deduction_types/all", {
  method: "GET"
});
  
```

## Building BambooHR workflows

Once your BambooHR account is connected, you can add steps to perform the following actions:

* Create Employee
* Update Employee
* Get Employee by ID
* Get Employee Directory
* Create a Time Off Request
* Change a Request Status
* Adjust Time Off Balance for an Employee
* Get Time Off Requests for an Employee
* Get Time Off Types
* Get Field List
* Add List Field Values

You can also use the [BambooHR Request](/workflows/requests#making-integration-requests) step to access any of BambooHR's API endpoints without the authentication piece.

When creating or updating records in BambooHR, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# BigQuery
Source: https://docs.useparagon.com/resources/integrations/bigquery

Connect to your users' BigQuery accounts.

## Setup Guide

You can find your Google app credentials by visiting your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project).

You'll need the following information to set up your Google App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Warning>
  Google Applications using scopes that permit access to certain user data must complete a verification process. [Read more](https://developers.google.com/identity/protocols/oauth2/scopes) about Google's various API scopes and procceses to verify your usage.
</Warning>

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Credentials** in the sidebar.

3. Press "**+ Create Credentials**", then select **OAuth client ID.**

4. Select "**Web application**" from the Application type drop-down menu.

<Info>
  **Note:** You'll need to configure Google's [consent screen](https://console.developers.google.com/apis/credentials) for access to **Client ID** and **Client Secret** if you haven't already.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1b9e06d58c0af9526d0717455bc7dfc2" alt="" width="1100" height="460" data-path="assets/Selecting Web Application in Google OAuth.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=280&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d51c0e8d2d42614976e477a9b406d05b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=560&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c586cfd9cb3101d95570703e4b9b4391 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=840&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ebd57b6af69773d922a982aba16b46d6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1100&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e79d58d62443ff5f84ff36188eef2431 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1650&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=25f8bcba040605492dc96066d8d7585d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=2500&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91bc9b710bd18e32c729785db0e68123 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Under **Authorized redirect URIs**, press the "**+ Add URI**" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "**Create**" button.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b920a76168a769c9a052eca8d97cb24" alt="" width="548" height="257" data-path="assets/Connect - Adding Google redirect URI for OAuth.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=280&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=080738ea9c75f4c982bc6fb64d217666 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=560&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5b09543fbb14db3fab8d0b8abeddadfb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=840&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f7c189919cdc9d0718954f1f154d992e 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1100&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3067bf209ba4185136976ab859009c09 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1650&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=52a3cd30df1425f5c2fa866c9df03643 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=2500&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e8e336914fc3971c7ea2c13710efe849 2500w" data-optimize="true" data-opv="2" />
</Frame>

Google provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Enable BigQuery in Google Cloud Console Dashboard

1. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Library** in the sidebar.

2. Search for "BigQuery API" from the API Library.

3. Select the "BigQuery API".

4. Press the blue "**Enable**" button to enable the API for your application.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BigQuery%20in%20Google%20Cloud%20Platform.png?maxW=1398&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3901c6dcae1bea120a4d9826a3093ed7" alt="" width="1398" height="498" data-path="assets/BigQuery in Google Cloud Platform.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BigQuery%20in%20Google%20Cloud%20Platform.png?w=280&maxW=1398&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=122862475d8e248c6ff6cf0eb8726105 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BigQuery%20in%20Google%20Cloud%20Platform.png?w=560&maxW=1398&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=783af13cbca56967e4542000f9beb8c4 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BigQuery%20in%20Google%20Cloud%20Platform.png?w=840&maxW=1398&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=9df66f837c5882ddef1a2e7af40fcb65 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BigQuery%20in%20Google%20Cloud%20Platform.png?w=1100&maxW=1398&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ec4a6f835fb32efc0c194247e2b86058 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BigQuery%20in%20Google%20Cloud%20Platform.png?w=1650&maxW=1398&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=955007a69989a8d2b30c62e12f862247 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BigQuery%20in%20Google%20Cloud%20Platform.png?w=2500&maxW=1398&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=bd8284e5f487439ad4bfc5be09dad2ad 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Google app to Paragon

1. Select **BigQuery** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > BigQuery > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/bigquery#add-the-redirect-url-to-your-google-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.

* **Client Secret:** Found at the end of Step 1.

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5790675cf1c75ebfbcaf8425e83a022e" alt="" width="1764" height="1106" data-path="assets/Connecting a new Google app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=280&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b24271f5a6c15048b6892d2200aa1b42 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=560&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f78acb99ac7869f09bcbc0a073386745 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=840&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c14a7c6c75c8b0bd7e926629fc40e7c1 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=57d4d7a0218c8007f67a99684730d216 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8707dc94bd895f01269e9fd9656b4054 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e53cae7f5a05ff7a7dd2ce512ccc5287 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to BigQuery

Once your users have connected their BigQuery account, you can use the Paragon SDK to access the BigQuery API on behalf of connected users.

See the BigQuery [REST API documentation](https://cloud.google.com/bigquery/docs/reference/rest) for their full API reference.

Any BigQuery endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// List tables in a given dataset
paragon.request("bigquery", "/projects/<PROJECT ID>/datasets/<DATASET ID>/tables", {
  method: "GET"
});

// List projects
paragon.request("bigquery", "/projects", {
  method: "GET"
});

// Create a job
paragon.request("bigquery", "/projects/<PROJECT ID>/jobs", {
  method: "POST",
  body: {
    "kind": string,
    "etag": string,
    "id": string,
    "selfLink": string,
    "user_email": string,
    "configuration": {
      object (JobConfiguration)
    },
    "jobReference": {
      object (JobReference)
    },
    "statistics": {
      object (JobStatistics)
    },
    "status": {
      object (JobStatus)
    },
    "principal_subject": string
  }
});
  
```

## Building BigQuery workflows

Once your BigQuery account is connected, you use the [BigQuery Request](/workflows/requests#making-integration-requests) step to access any of BigQuery's API endpoints without the authentication piece.

When creating or updating records in BigQuery, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Publishing your BigQuery application

### Setting up a Redirect Page in your app

Your BigQuery integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

* Receives a `GET` request with a number of query parameters.
* Redirect to `https://passport.useparagon.com/oauth` with the same query parameters.

```
paragon.connect("bigquery", {
  overrideRedirectUrl: "https://your-app.url/bigquery-redirect"
});
```

### Updating the allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your BigQuery Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and select your application.

2. Navigate to **APIs & Services > Credentials** and select the credentials you use with Paragon.

3. Under **Authorized redirect URIs**, provide the URL of your Redirect Page.


# Box
Source: https://docs.useparagon.com/resources/integrations/box

Connect to your users Box accounts

## Setup Guide

You can find your Box app credentials in your [Box Developer Account.](https://developer.box.com/reference/)

You'll need the following information to set up your Box App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your Box app to Paragon

Under **Integrations > Connected Integrations > Box > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Box App page.
* **Client Secret:** Found under Client Secret on your Box App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development
  keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Box%20app%20to%20Paragon%20Connect.png?maxW=2176&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=69474a5ae52a56392b0b25e02aad1c69" alt="" width="2176" height="1162" data-path="assets/Connecting your Box app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Box%20app%20to%20Paragon%20Connect.png?w=280&maxW=2176&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a1b4418792991c410b470e6f35c6551a 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Box%20app%20to%20Paragon%20Connect.png?w=560&maxW=2176&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ffc705a0eac4c21ced8a96cdf4d52b8e 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Box%20app%20to%20Paragon%20Connect.png?w=840&maxW=2176&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=05c885ee2d5b6aeedc510ef5ec399e83 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Box%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2176&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=eb0c2d0b5a6492aa66866c938a1a4c09 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Box%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2176&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ff8b01d34cf1d183dc48df2f294ef834 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Box%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2176&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2a2d6adcb6a2cbc684e4472f30a58bb2 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Box

Once your users have connected their Box account, you can use the Paragon SDK to access the Box API on behalf of connected users.

See the Box [REST API documentation](https://developer.box.com/reference/) for their full API reference.

Any Box API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Get File Information
await paragon.request("box", "/files/:file_id", {
  method: "GET"
});

// Copy a file
await paragon.request("box", "/files/:file_id/copy", {
  method: "POST",
  body: {
    "parent":{
      "id": "123"
    }
  }
});

// List all collections
await paragon.request("box", "/collections", {
  method: "GET"
});

```

## Building Box workflows

Once your Box account is connected, you can add steps to perform the following actions:

* Upload File from URL
* Upload File
* Get File by ID
* List Files
* Download File
* Create Folder
* Move Folder
* Get Folder by ID
* Search Folders
* Delete Folder

<Note>
  For actions that accept `folderId` as a value, you can pass `0` for the root
  or parent folder
</Note>

You can also use the [Box Request](/workflows/requests#making-integration-requests) step to access any of Box's API endpoints without the authentication piece.

When creating or updating records in Box, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using the Box File Picker

You can allow your user to select files from their Box account in your app with the Paragon SDK.

#### Showing the File Picker

Use the Paragon SDK in your frontend application to show the File Picker in your app.

The SDK provides an `ExternalFilePicker` class to load Box's JavaScript into your page and authenticate with your user's connected Box account.

```javascript
let picker = new paragon.ExternalFilePicker("box", {
    onFileSelect: (files) => {
        // Handle file selection
    }
});

// Loads external dependencies and user's access token, and sets the folderId to the root folder
await picker.init({ folderId: "0" });

// Open the File Picker
picker.open();
```

You can configure the File Picker to listen for additional callbacks or to restrict allowed file types. Learn more about configuring File Picker options in the [SDK Reference](/apis/api-reference#externalfilepicker).

#### Downloading the Selected File

The Box File Picker callback will return a `Response` object describing the user's file picker interaction including an array of any files selected. Using this array of file objects, you can use the [Proxy API](/apis/proxy) to perform an authenticated proxy requests to download the files.

<CodeGroup>
  ```javascript JavaScript
  await paragon.request('box', '/files/1917222621209/content', {
  	method: 'GET'
  });
  ```

  ```plain REST API
  POST https://proxy.useparagon.com/projects/19d...012/sdk/proxy/box/files/<fileID>/content

  Authorization: Bearer eyJ...
  Content-Type: application/json
  ```
</CodeGroup>


# Calendly
Source: https://docs.useparagon.com/resources/integrations/calendly

Connect to your users' Calendly accounts.

## Setup Guide

<Info>
  **Note:** You'll need to create a new Calendly app if you don't already have one.
</Info>

You can find your Calendly app credentials in your [Calendly Developer Account.](https://developer.calendly.com/api-docs/4b402d5ab3edd-calendly-developer)

You'll need the following information to set up your Calendly App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add the Redirect URL to your Calendly app

Paragon provides a redirect URL to send information to your Calendly app. To add the redirect URL to your Calendly app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log into your [Calendly Developer Portal](https://developer.calendly.com/).

3. Select your app from the list of apps.

4. Under **Redirect URLs**, paste-in the redirect URL from Paragon. The redirect URL can be found in Step 1.

5. Press the `Save` button to confirm your changes.

### Add your Calendly app to Paragon

Under **Integrations > Connected Integrations > Calendly > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Calendly App page.
* **Client Secret:** Found under Client Secret on your Calendly App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Calendly%20app%20to%20Paragon%20Connect.png?maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e6af456e813f174305009304120982a3" alt="" width="2044" height="928" data-path="assets/Connecting your Calendly app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Calendly%20app%20to%20Paragon%20Connect.png?w=280&maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e4f73314b70fd10b381060d35edbb54b 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Calendly%20app%20to%20Paragon%20Connect.png?w=560&maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=45da697e9301f1df0455cdb5e93039dd 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Calendly%20app%20to%20Paragon%20Connect.png?w=840&maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=5681f8ffdea08ee1e556349464ea1755 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Calendly%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=7171ee5607ae08c1adc786d0ced45e59 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Calendly%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=54d517a73e25d10357bfca6a2a895f10 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Calendly%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=68d201d489dbde6a2fd9711815cfb59c 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Calendly

Once your users have connected their Calendly account, you can use the Paragon SDK to access the Calendly API on behalf of connected users.

See the Calendly [REST API documentation](https://developer.calendly.com/api-docs/4b402d5ab3edd-calendly-developer) for their full API reference.

Any Calendly API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Fetch an organization's events
paragon.request("calendly", "/scheduled_events", {
  method: "GET"
});

// List an organization's or user's event types
paragon.request("calendly", "event_types?organization=<Organization>", {
  method: "GET"
});
  
```

## Building Calendly workflows

Once your Calendly account is connected, you can add steps to perform the following actions:

* Get Event Type Details
* Get Available Times for Event Type
* Search Events
* Get Event by ID
* Get Event Invitees
* Cancel Event

You can also use the [Calendly Request](/workflows/requests#making-integration-requests) step to access any of Calendly's API endpoints without the authentication piece.

When creating or updating records in Calendly, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Calendly account. For example, you might want to trigger a workflow whenever new invitees are created in Calendly to sync your users' Calendly events to your application in real-time.

You can find the full list of Webhook Triggers for Calendly below:

* **Invitee Created**
* **Invitee Canceled**


# ClickUp
Source: https://docs.useparagon.com/resources/integrations/clickup

Connect to your users' ClickUp accounts.

## Setup Guide

<Info>
  **Note:** You'll need to create a new ClickUp app if you don't already have one.
</Info>

You can find your ClickUp app credentials by visiting your ClickUp Integrations Portal.

You'll need the following information to set up your ClickUp App with Paragon Connect:

* Client ID
* Client Secret

### Add the Redirect URL to your ClickUp app

Paragon provides a redirect URL to send information to your ClickUp app. To add the redirect URL to your ClickUp app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [ClickUp account](https://clickup.com/), click your Workspace avatar in the lower-left corner

3. Select **Integrations**.

4. Click **ClickUp API**.

5. Select your application.

6. Under **Redirect URL(s)**, paste-in Paragon Connect's redirect URL found in Step 1. Click the **Save** button to save your changes.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Redirect%20URL%20to%20Clickup%20for%20Paragon%20Connect.png?maxW=2304&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a3fcf8f53cdc3a8cde0c7bebed0571d7" alt="" width="2304" height="1078" data-path="assets/Adding the Paragon Redirect URL to Clickup for Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Redirect%20URL%20to%20Clickup%20for%20Paragon%20Connect.png?w=280&maxW=2304&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=9635ab9f8f36d82d4040f5d3ddb53afd 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Redirect%20URL%20to%20Clickup%20for%20Paragon%20Connect.png?w=560&maxW=2304&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3912d091161b167b8c38e1e0bf6c8a98 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Redirect%20URL%20to%20Clickup%20for%20Paragon%20Connect.png?w=840&maxW=2304&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=6ebf0332e350d63f7681858daa5327ae 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Redirect%20URL%20to%20Clickup%20for%20Paragon%20Connect.png?w=1100&maxW=2304&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=7dd7ec0961a2e3a9c5b0418d013fd51f 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Redirect%20URL%20to%20Clickup%20for%20Paragon%20Connect.png?w=1650&maxW=2304&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=038e9170b75f9e580bf401d65419abe0 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Redirect%20URL%20to%20Clickup%20for%20Paragon%20Connect.png?w=2500&maxW=2304&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=c1711201bfb912bf9e169f38cc72a64c 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your ClickUp app to Paragon

1. Select ClickUp from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > ClickUp > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/clickup#add-the-redirect-url-to-your-clickup-app) in their respective sections:

* **Client ID:**

  * Log in to your ClickUp dashboard.

  * Select "**Settings"** from the sidebar.

  * Under **Integrations > ClickUp API**, select your application.

  * Copy the **Client ID** from "**Client ID**".

* **Client Secret:**

  * Log in to your ClickUp dashboard.

  * Select "**Settings"** from the sidebar.

  * Under **Integrations > ClickUp API**, select your application.

  * Copy the **Client Secret** from "**Client Secret**".

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20ClickUp%20application%20to%20Paragon%20Connect%20(1).png?maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=cd99429c19380d89bdce184d0ef73b84" alt="" width="1860" height="862" data-path="assets/Connecting your ClickUp application to Paragon Connect (1).png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20ClickUp%20application%20to%20Paragon%20Connect%20(1).png?w=280&maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=6a96e3f4836a4eab6cfdba15d6e998d2 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20ClickUp%20application%20to%20Paragon%20Connect%20(1).png?w=560&maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=9b6e38a78652ca15dcab85d14f118e07 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20ClickUp%20application%20to%20Paragon%20Connect%20(1).png?w=840&maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a11a15b064ebe3138aba0a2b541bccbd 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20ClickUp%20application%20to%20Paragon%20Connect%20(1).png?w=1100&maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ad39122392f941d59050bcd9f9b4d92e 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20ClickUp%20application%20to%20Paragon%20Connect%20(1).png?w=1650&maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=7085bec6efff7de8b7706d7a01c52f9e 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20ClickUp%20application%20to%20Paragon%20Connect%20(1).png?w=2500&maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2f1ea83ecf8d7a3e12c1e3b0b25c0aeb 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to ClickUp

Once your users have connected their ClickUp account, you can use the Paragon SDK to access the ClickUp API on behalf of connected users.

See the ClickUp [REST API documentation](https://clickup.com/api) for their full API reference.

Any ClickUp API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get current team information
await paragon.request("clickup", "/team", {
  method: "GET"
});

// Get lists outside of folders
await paragon.request("clickup", "/space/<Space ID>/list?archived=false", {
  method: "GET"
});

// Create task in list
await paragon.request("clickup", "/list/<List ID>/task", {
  method: "POST",
  body: {
    name: "New Task Name",
    description: "New Task Description",
    status: "Open"
  }
});
  
```

## Building ClickUp workflows

Once your ClickUp account is connected, you can add steps to perform the following actions:

* Create Task
* Update Task
* Search Tasks
* Get Tasks in List
* Delete Task

You can also use the [ClickUp Request](/workflows/requests#making-integration-requests) step to access any of ClickUp's API endpoints without the authentication piece.

When creating or updating Tasks in ClickUp, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' ClickUp account. For example, you might want to trigger a workflow whenever new tasks are created in ClickUp to sync your users' ClickUp tasks to your application in real-time.

You can find the full list of Webhook Triggers for ClickUp below:

* **New Folder Created**
* **Folder Updated**
* **New List Created**
* **List Updated**
* **New Space Created**
* **Space Updated**
* **New Task Created**
* **Task Updated**
* **New Comment on Task**


# Close
Source: https://docs.useparagon.com/resources/integrations/close

Connect to your users' Close accounts.

## Setup Guide

You can find your Close app credentials in your [Close Developer Account](https://developer.close.com/).

You'll need the following information to set up your Close App with Paragon Connect:

* Close API Key

## Connecting to Close

Once your users have connected their Close account, you can use the Paragon SDK to access the Close API on behalf of connected users.

See the Close [REST API documentation](https://developer.close.com/) for their full API reference.

Any Close API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create a contact
paragon.request("close", "/contact", {
  method: "POST",
  body: {
    "lead_id":"lead_QyNaWw4fdSwxl5Mc5daMFf3Y27PpIcH0awPbC9l7uyo",
    "name":"John Appleseed",
    "title":"CEO",
    "phones":[
        {"phone":"9045551234","type":"mobile"}
    ],
    "emails":[
        {"email":"john@example.com","type":"office"}
    ],
    "urls":[
        {"url":"http://twitter.com/google/","type":"url"}
    ],
  }
});

// Create a lead
paragon.request("close", "[relative URL]", {
  method: "POST",
  body {
    "name": "Example Company",
    "url": "http://company.domain.com/",
    "description": "A company",
    "status_id": "stat_1ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
    "contacts": [
        {
            "name": "Gob",
            "title": "Sr. Vice President",
            "emails": [
                {
                    "type": "office",
                    "email": "gob@example.com"
                }
            ],
            "phones": [
                {
                    "type": "office",
                    "phone": "8004445555"
                }
            ]
        }
    ]
  }
});

// Get all opportunities
paragon.request("close", "/opportunity", {
  method: "GET"
});
  
```

## Building Close workflows

Once your Close account is connected, you can add steps to perform the following actions:

* Create Record
* Update Record
* Get Record by ID
* Search Record
* Delete Record
* Search Records by JSON Filter

You can also use the [Close Request](/workflows/requests#making-integration-requests) step to access any of Close's API endpoints without the authentication piece.

When creating or updating records in Close, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Close account. For example, you might want to trigger a workflow whenever new leads are created in Close to sync your users' Close leads to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Close%20Webhook%20Triggers%20in%20Paragon%20Connect.png?maxW=2094&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=203da7aaec31f0d7a88926d635495602" alt="" width="2094" height="1480" data-path="assets/Close Webhook Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Close%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=2094&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=67ebf3880c22cb4bc3e38380618b2072 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Close%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=2094&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=2cd2d710593c8d337f90428658b322da 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Close%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=2094&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=82759cdd20a6be5b35be613415c9fe57 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Close%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=2094&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f9ba706a5457ce382ed329ef718ea587 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Close%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=2094&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=169bc9a3084fff9d845671afeae7f38a 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Close%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=2094&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c9378a0d184339103b80be711735f44e 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Close below:

* **Record Created**
* **Record Updated**
* **Record Deleted**


# Coda
Source: https://docs.useparagon.com/resources/integrations/coda

Connect to your users' Coda accounts.

## Setup Guide

You can find your Coda API Token in your [Coda account settings](https://coda.io/account).

You'll need the following information to set up your Coda account with Paragon Connect:

* Coda API Token

## Connecting to Coda

Once your users have connected their Coda account, you can use the Paragon SDK to access the Coda API on behalf of connected users.

See the Coda [REST API documentation](https://coda.io/developers/apis/v1) for their full API reference.

Any Coda API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create a Document
paragon.request("coda", "/docs", {
  method: "POST",
  body: {
    "title": "Project Tracker",
    "sourceDoc": "iJKlm_noPq",
    "timezone": "America/Los_Angeles",
    "folderId": "fl-ABcdEFgHJi"
  }
});

// Get Documents
paragon.request("coda", "/docs", {
  method: "GET"
});
  
```

## Building Coda workflows

Once your Coda account is connected, you can add steps to perform the following actions:

* Create Document
* Search Documents
* Get Document by ID
* Delete Document
* Search Tables
* Get Table by ID

You can also use the [Coda Request](/workflows/requests#making-integration-requests) step to access any of Coda's API endpoints without the authentication piece.

When creating or updating records in Coda, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Confluence
Source: https://docs.useparagon.com/resources/integrations/confluence

Connect to your users' Confluence accounts.

## Setup Guide

You can find your Confluence app credentials in your [Confluence Developer Account.](https://developer.atlassian.com/cloud/confluence/rest/v1/intro)

You'll need the following information to set up your Confluence App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your Confluence app to Paragon

Under **Integrations > Connected Integrations > Confluence > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Confluence App page.
* **Client Secret:** Found under Client Secret on your Confluence App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Confluence%20app%20to%20Paragon%20Connect.png?maxW=988&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=1ada31b52d9963f810af55739a92589d" alt="" width="988" height="633" data-path="assets/Connecting your Confluence app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Confluence%20app%20to%20Paragon%20Connect.png?w=280&maxW=988&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=237dce1760e35e54dcc9ad014f1eb1f7 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Confluence%20app%20to%20Paragon%20Connect.png?w=560&maxW=988&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=afd2bb0314123b07607b0f08b9301ecc 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Confluence%20app%20to%20Paragon%20Connect.png?w=840&maxW=988&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f03a3a3c1fd5070776bcea7abc518c36 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Confluence%20app%20to%20Paragon%20Connect.png?w=1100&maxW=988&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=664fd9798634f5efa59be19282e68ef6 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Confluence%20app%20to%20Paragon%20Connect.png?w=1650&maxW=988&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=7b58fe5a6f021c9ba4e928da8fbe4e6a 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Confluence%20app%20to%20Paragon%20Connect.png?w=2500&maxW=988&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=bccd8c2e21f3e6b151b850ba9823aefc 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Confluence

Once your users have connected their Confluence account, you can use the Paragon SDK to access the Confluence API on behalf of connected users.

See the Confluence [REST API documentation](https://developer.atlassian.com/cloud/confluence/rest/v1/intro) for their full API reference.

Any Confluence API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Retrieve Pages
paragon.request("confluence", "/wiki/api/v2/pages", {
  method: "GET"
});

// Create a Page
paragon.request("confluence", "/wiki/api/v2/pages", {
  method: "POST",
  body: {
    "spaceId": 15,
    "status": "current",
    "title": "<string>",
    "body": {
      "representation": "storage",
      "value": "<string>"
    }
  }
});
  
```

## Building Confluence workflows

Once your Confluence account is connected, you can add steps to perform the following actions:

* Create Page
* Update Page
* Get Page by ID
* Get Pages in Space
* Get Pages by Label
* Search Pages
* Delete Page
* Get Space by ID
* Search Spaces
* Get Blog Posts

You can also use the [Confluence Request](/workflows/requests#making-integration-requests) step to access any of Confluence's API endpoints without the authentication piece.

When creating or updating records in Confluence, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Copper
Source: https://docs.useparagon.com/resources/integrations/copper

Connect to your users' Copper accounts.

## Setup Guide

You can find your Copper CRM credentials in your Copper settings.

You'll need the following information to set up your Copper account with Paragon Connect:

* Email Address of the Token Owner
* API Key

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to Copper

Once your users have connected their Copper account, you can use the Paragon SDK to access the Copper API on behalf of connected users.

See the Copper [REST API documentation](https://developer.copper.com/) for their full API reference.

Any Copper API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create a Person
paragon.request("copper", "/v1/people", {
  method: "POST",
  body: {
    "name":"Foo Westwood",
    "emails": [
      {
      "email":"foo@westwood.com",
      "category":"work"
      }
    ],
    "address": {
      "street": "123 Main Street",
      "city": "Savannah",
      "state": "Georgia",
      "postal_code": "31410",
      "country": "United States"
    },
    "phone_numbers": [
      {
      "number":"415-123-45678",
      "category":"mobile"
      }
    ]
  }
});

// Create a Lead
paragon.request("copper", "/v1/leads", {
  method: "POST",
  body: {
    "name":"Foo Westwood",
    "email": {
      "email":"foo@westwood.com",
      "category":"work"
    },
    "phone_numbers": [
      {
        "number":"415-123-45678",
        "category":"mobile"
      }
    ],
    "address": {
      "street": "123 Main Street",
      "city": "Savannah",
      "state": "Georgia",
      "postal_code": "31410",
      "country": "United States"
    },
    "custom_fields": [
      {
        "custom_field_definition_id": 100764,
        "value": "Text fields are 255 chars or less!"
      },
      {
        "custom_field_definition_id": 103481,
        "value": "Text area fields can have long text content"
      }
    ],
    "customer_source_id":331242
  }
});

// Search Opportunities
paragon.request("copper", "/v1/opportunities/search", {
  method: "POST",
  body: {
    "page_size": 5,
    "sort_by": "name"
  }
});
  
```

## Building Copper workflows

Once your Copper account is connected, you use the [Copper Request](/workflows/requests#making-integration-requests) step to access any of Copper's API endpoints without the authentication piece.

When creating or updating records in Copper, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# DocuSign
Source: https://docs.useparagon.com/resources/integrations/docusign

Connect to your users' DocuSign accounts.

## Setup Guide

You can find your DocuSign app credentials in your [DocuSign Developer Account.](https://developers.docusign.com/docs/esign-rest-api/reference/)

You'll need the following information to set up your DocuSign App with Paragon Connect:

* Integration Key
* Secret Key
* Scopes Requested

### Add your DocuSign app to Paragon

Under **Integrations > Connected Integrations > DocuSign > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Integration Key:** Found under Apps and Keys section on your DocuSign App page.
* **Secret Key:** Found under Apps and Keys section on your DocuSign App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Integration Key and Secret Key blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20DocuSign%20app%20to%20Paragon%20Connect.png?maxW=1796&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=414dbd989919496b84767dadf46f9057" alt="" width="1796" height="1578" data-path="assets/Connecting your DocuSign app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20DocuSign%20app%20to%20Paragon%20Connect.png?w=280&maxW=1796&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=6043c5c0ced88da1178d7159add1bd26 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20DocuSign%20app%20to%20Paragon%20Connect.png?w=560&maxW=1796&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=fc066279eac53308b2f0038909aa2e33 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20DocuSign%20app%20to%20Paragon%20Connect.png?w=840&maxW=1796&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=eadf5d369161f0c0fae62c038547602e 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20DocuSign%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1796&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=9a555038ae8175068a1ab95e9da974bf 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20DocuSign%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1796&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=918b6c2c2a4c0616abc4990b11ec57bd 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20DocuSign%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1796&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=9423e50702bbbb04fd404aa13cf01c09 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to DocuSign

Once your users have connected their DocuSign account, you can use the Paragon SDK to access the DocuSign API on behalf of connected users.

See the DocuSign [REST API documentation](https://developers.docusign.com/docs/esign-rest-api/reference/) for their full API reference.

Any DocuSign API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get recipient signature information for a signer
await paragon.request("docusign", "/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature", {
  method: "GET"
});

// List documents associated with a DocuSign envelope object
  method: "GET"
});

// Get a list of invoices for the account
await paragon.request("docusign", "/billing_invoices", {
  method: "GET"
});
  
```

## Building DocuSign workflows

Once your DocuSign account is connected, you can add steps to perform the following actions:

* Create an Envelope
* Get Envelope by ID
* Update Envelope
* Send an Envelope
* Search Envelopes
* Envelope Custom Fields (CRUD)

You can also use the [DocuSign Request](/workflows/requests#making-integration-requests) step to access any of DocuSign's API endpoints without the authentication piece.

When creating or updating records in DocuSign, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' DocuSign account. For example, you might want to trigger a workflow whenever new envelopes are signed in DocuSign to sync your users' DocuSign envelopes to your application in real-time.

You can find the full list of Webhook Triggers for DocuSign below:

* **Envelope Sent**
* **Envelope Delivered**
* **Envelope Signed/Completed**
* **Envelope Declined**
* **Recipient Sent**
* **Recipient Signed/Completed**
* **Recipient Declined**


# Dropbox
Source: https://docs.useparagon.com/resources/integrations/dropbox

Connect to your users' Dropbox accounts.

## Setup Guide

You can find your Dropbox app credentials in your [Dropbox Developer Account.](https://www.dropbox.com/developers/documentation/http/documentation)

You'll need the following information to set up your Dropbox App with Paragon Connect:

* App Key
* App Secret
* Scopes Requested

### Add the Redirect URL to your Dropbox app

Paragon provides a redirect URL to send information to your Dropbox app. To add the redirect URL to your Dropbox app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log into your [Dropbox Developer Portal](https://www.dropbox.com/developers/).

3. Select your app from the list of apps.

4. Under **Redirect URIs**, paste-in the redirect URL from Paragon. The redirect URL can be found in Step 1.

5. Press the `Save` button to confirm your changes.

### Add your Dropbox app to Paragon

Under **Integrations > Connected Integrations > Dropbox > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **App Key:** Found under **Settings > App key** on your Dropbox App page.
* **App Secret** Found under **Settings > App secret** on your Dropbox App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dropbox%20app%20to%20Paragon%20Connect.png?maxW=2022&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=35036809a842ec63ee2e749052404253" alt="" width="2022" height="944" data-path="assets/Connecting your Dropbox app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dropbox%20app%20to%20Paragon%20Connect.png?w=280&maxW=2022&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=4bf46ce39f3e4b11bc871e7d9cfb77b3 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dropbox%20app%20to%20Paragon%20Connect.png?w=560&maxW=2022&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e346abf17df7dca77f7c468519ff4599 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dropbox%20app%20to%20Paragon%20Connect.png?w=840&maxW=2022&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=eac1f7729ce179a075c87d51851c52b9 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dropbox%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2022&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=60fff12365e7a1f955ff12a7439e5eb7 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dropbox%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2022&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f8410a6b8c2af4527441c2e26d138334 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dropbox%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2022&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=900ba98ef85cd879aa59289dd4ce6655 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Dropbox

Once your users have connected their Dropbox account, you can use the Paragon SDK to access the Dropbox API on behalf of connected users.

See the Dropbox [REST API documentation](https://www.dropbox.com/developers/documentation/http/documentation) for their full API reference.

Any Dropbox API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Query files in Dropbox's root directory
paragon.request("dropbox", "/2/files/list_folder", {
  method: "POST",
  body: {
  {
    "include_deleted": false,
    "include_has_explicit_shared_members": false,
    "include_media_info": false,
    "include_mounted_folders": true,
    "include_non_downloadable_files": true,
    "path": "",
    "recursive": false
  }
});

// Move a file or folder to a different location.
paragon.request("dropbox", "/2/files/move_v2", {
  method: "POST",
  body: {
    "allow_ownership_transfer": false,
    "allow_shared_folder": false,
    "autorename": false,
    "from_path": "/Homework/math",
    "to_path": "/Homework/algebra"
  }
});

  
```

## Building Dropbox workflows

Once your Dropbox account is connected, you can add steps to perform the following actions:

* Upload File
* Get File by Name
* List Files
* Create Folder
* Move Folder
* Get Folder by ID
* Search Folders
* Delete Folder

You can also use the [Dropbox Request](/workflows/requests#making-integration-requests) step to access any of Dropbox's API endpoints without the authentication piece.

When creating or updating records in Dropbox, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Dropbox account. For example, you might want to trigger a workflow whenever new files are created in Dropbox to sync your users' Dropbox files to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Dropbox%20Webhook%20Triggers%20in%20Paragon%20Connect.png?maxW=905&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=1578acc6b95a990f55abea1e37310dc4" alt="" width="905" height="697" data-path="assets/Dropbox Webhook Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Dropbox%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=905&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=5d5b4d955f7fa3fb45227f83e272fed3 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Dropbox%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=905&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b32d79165366b8039c537cccc911442d 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Dropbox%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=905&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=212f5f11dfa130b46f2fe1fc870dcc97 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Dropbox%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=905&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=534a323e9971d500c37d8f92ea31b1f7 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Dropbox%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=905&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=c2f5beab1e21cace27046e076a83f27b 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Dropbox%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=905&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=ee7e7d30ecec8abdc9d75c3cc273e866 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Dropbox below:

* **File Created**
* **File Deleted**
* **File Updated**


# Dropbox Sign
Source: https://docs.useparagon.com/resources/integrations/dropboxsign

Connect to your users' Dropbox Sign accounts.

## Setup Guide

You can find your Dropbox Sign API Key in your [Dropbox Sign API Settings](https://app.hellosign.com/home/myAccount?current_tab=integrations#api)[.](https://developers.hellosign.com/api/reference/welcome/)

You'll need the following information to set up your Dropbox Sign App with Paragon Connect:

* API Key

## Connecting to Dropbox Sign

Once your users have connected their Dropbox Sign account, you can use the Paragon SDK to access the Dropbox Sign API on behalf of connected users.

See the Dropbox Sign [REST API documentation](https://developers.hellosign.com/api/reference/welcome/) for their full API reference.

Any Dropbox Sign API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create Embedded Signature Request
await paragon.request('dropboxsign', 'signature_request/create_embedded', {
  method: 'POST'
  body: {
    "title": "NDA with Acme Co.",
    "subject": "The NDA we talked about",
    "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
    "signers": [
      {
        "email_address": "jack@example.com",
        "name": "Jack",
        "order": 0
      },
    ],
    "cc_email_addresses": [
      "lawyer@dropboxsign.com",
      "lawyer@dropboxsign.com"
    ],
    "file_urls": [
      "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1"
    ],
    "metadata": {
      "custom_id": 1234,
      "custom_text": "NDA #9"
    },
    "signing_options": {
      "draw": true,
      "type": true,
      "upload": true,
      "phone": false,
      "default_type": "draw"
    },
    "field_options": {
      "date_format": "DD - MM - YYYY"
    },
    "test_mode": true
  }
});

// Get the status of a Signature Request
await paragon.request("dropboxsign", "signature_request/<signature_request_id>", {
  method: "GET",
});  
```

## Building Dropbox Sign workflows

Once your Dropbox Sign account is connected, you can add steps to perform the following actions:

* Create and Send Signature Request
* Update Signature Request
* Get Signature Request by ID
* Search Signature Requests
* Cancel Incomplete Signature Request
* Download Files

You can also use the [Dropbox Sign Request](/workflows/requests#making-integration-requests) step to access any of Dropbox Sign's API endpoints without the authentication piece.

When creating or updating records in Dropbox Sign, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Dynamics 365 Finance
Source: https://docs.useparagon.com/resources/integrations/dynamics-finance

Connect to your users' Dynamics 365 Finance accounts.

## Setup Guide

You can find your Dynamics 365 Finance app credentials in your [Dynamics 365 Finance Developer Account.](https://docs.microsoft.com/en-us/dynamics365/fin-ops-core/dev-itpro/data-entities/odata)

You'll need the following information to set up your Dynamics 365 Finance App with Paragon Connect:

* Client Key
* Client Secret
* Scopes Requested

### Add the Redirect URL to your Dynamics 365 Finance app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Dynamics 365 Finance app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

3. Navigate to **All Services > App Registrations** and select your application.

4. Select **Authentication** from the sidebar.

5. Under **Platform configurations**, press the **"Add a platform"** button.

6. Select the **Web** platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the **Save** button at the top of the page.

### Generate a Client Secret

Since Dynamics 365 Finance does not automatically provide you with a Client Secret for your application, we'll need to make one. To get your Client Secret:

1. Navigate to **Manage > Certificates & secrets** in the sidebar.

2. Under **Client Secrets**, press the **+ New client secret** button.

3. Name your client credentials and select an expiry that works best for your application. Press **Add** to create your credentials.

4. Copy the displayed Client Secret under the **Value** column.

### Add your Dynamics 365 Finance app to Paragon

1. Select **Dynamics 365 Finance** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Dynamics 365 > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/dynamics-finance#add-the-redirect-url-to-your-dynamics-365-finance-app) in their respective sections:

* **Client ID:** Found under **Essentials > Application (client) ID** on your Microsoft Azure Portal app page.

* **Client Secret:** Found under **Manage > Certificates & secrets** on your Microsoft Azure Portal app page.

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Finance%20app%20to%20Paragon%20Connect.png?maxW=1814&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=d1bb4173e127d676a7920413107cd34a" alt="" width="1814" height="1156" data-path="assets/Connecting your Dynamics 365 Finance app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Finance%20app%20to%20Paragon%20Connect.png?w=280&maxW=1814&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=d50225b219ca515809a5bce0aea5b8fb 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Finance%20app%20to%20Paragon%20Connect.png?w=560&maxW=1814&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=d3950c97e50153dad2ac776f5eabf155 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Finance%20app%20to%20Paragon%20Connect.png?w=840&maxW=1814&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=3841ab45aa6559014b0101dbbc6ccee8 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Finance%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1814&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=eee24adc1199841f9ba2f2d9cfbacf28 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Finance%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1814&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=1df2fc47f351c374bad4733346ad2f85 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Finance%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1814&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2daf16b5f0e92a6898a1d3f13af50109 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Dynamics 365 Finance

Once your users have connected their Dynamics 365 Finance account, you can use the Paragon SDK to access the Dynamics 365 Finance API on behalf of connected users.

See the Dynamics 365 Finance [REST API documentation](https://docs.microsoft.com/en-us/dynamics365/fin-ops-core/dev-itpro/data-entities/odata) for their full API reference.

Any Dynamics 365 Finance API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get a list of customers
paragon.request("dynamicsfinance", "/Customers", {
  method: "GET"
});

// Get a list of vendors
paragon.request("dynamicsfinance", "/Vendors", {
  method: "GET"
});

// Get a list of "Inventory profiles"
paragon.request("dynamicsfinance", "/InventoryProfiles", {
  method: "GET"
});  
  
```

## Building Dynamics 365 Finance workflows

Once your Dynamics 365 Finance account is connected, you can add steps to perform the following actions:

* Get Accounts
* Create Vendor
* Update Vendor
* Get Vendor by ID
* Search for Vendor
* Create Bill
* Update Bill
* Get Bill by ID
* Search for Bill
* Delete Bill
* Create Bill Line Item
* Update Bill Line Item
* Get Bill Line Item by ID
* Search for Bill Line Item
* Delete Bill Line Item
* Create Customer
* Update Customer
* Get Customer by ID
* Search for Customer
* Delete Customer
* Create Invoice
* Update Invoice
* Get Invoice by ID
* Search for Invoice
* Delete Invoice
* Create Invoice Line Item
* Update Invoice Line Item
* Get Invoice Line Item by ID
* Search for Invoice Line Item
* Delete Invoice Line Item
* Create Payment Journal
* Update Payment Journal
* Get Payment Journal by ID
* Search for Payment Journal
* Delete Payment Journal
* Create Payment Journal Line Item
* Update Payment Journal Line Item
* Get Payment Journal Line Item by ID
* Search for Payment Journal Line Item
* Delete Payment Journal Line Item

You can also use the [Dynamics 365 Finance Request](/workflows/requests#making-integration-requests) step to access any of Dynamics 365 Finance's API endpoints without the authentication piece.

When creating or updating records in Dynamics 365 Finance, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Dynamics 365 Business Central
Source: https://docs.useparagon.com/resources/integrations/dynamicsbusinesscentral

Connect to your users' Dynamics 365 Business Central accounts.

## Setup Guide

You can find your Dynamics 365 Business Central app credentials in your [Dynamics 365 Business Central Developer Account.](https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/)

You'll need the following information to set up your Dynamics 365 Business Central App with Paragon Connect:

* Consumer Key
* Consumer Secret
* Scopes Requested

### Add the Redirect URL to your Dynamics 365 Finance app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Dynamics 365 Business Central app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

3. Navigate to **All Services > App Registrations** and select your application.

4. Select **Authentication** from the sidebar.

5. Under **Platform configurations**, press the **"Add a platform"** button.

6. Select the **Web** platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the **Save** button at the top of the page.

### Generate a Client Secret

Since Dynamics 365 Business Central does not automatically provide you with a Client Secret for your application, we'll need to make one. To get your Client Secret:

1. Navigate to **Manage > Certificates & secrets** in the sidebar.

2. Under **Client Secrets**, press the **+ New client secret** button.

3. Name your client credentials and select an expiry that works best for your application. Press **Add** to create your credentials.

4. Copy the displayed Client Secret under the **Value** column.

### Add your Dynamics 365 Business Central app to Paragon

1. Select **Dynamics 365 Business Central** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Dynamics 365 Business Central > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/dynamicsbusinesscentral#add-the-redirect-url-to-your-dynamics-365-finance-app) in their respective sections:

* **Client ID:** Found under **Essentials > Application (client) ID** on your Microsoft Azure Portal app page.

* **Client Secret:** Found under **Manage > Certificates & secrets** on your Microsoft Azure Portal app page.

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Business%20Central%20app%20to%20Paragon%20Connect.png?maxW=1976&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=6e8e657246998f10880ee5f864f09211" alt="" width="1976" height="1156" data-path="assets/Connecting your Dynamics 365 Business Central app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Business%20Central%20app%20to%20Paragon%20Connect.png?w=280&maxW=1976&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=6a6a0eae677e2e0003d965ca7c570f98 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Business%20Central%20app%20to%20Paragon%20Connect.png?w=560&maxW=1976&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=dc4a5d483f4fbc15e27ec255bcb143c7 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Business%20Central%20app%20to%20Paragon%20Connect.png?w=840&maxW=1976&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=36a85a24dcd5cd0dbc63c7f930426eed 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Business%20Central%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1976&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=8d3354a9082db561fa5475942482a77a 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Business%20Central%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1976&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=7025cfdb1a7ee9d7a1c21bc8225a4e9c 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Dynamics%20365%20Business%20Central%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1976&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b975982a73d4e82c24ff5dac4c558a0c 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Dynamics 365 Business Central

Once your users have connected their Dynamics 365 Business Central account, you can use the Paragon SDK to access the Dynamics 365 Business Central API on behalf of connected users.

See the Dynamics 365 Business Central [REST API documentation](https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/) for their full API reference.

Any Dynamics 365 Business Central API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create purchase invoice
paragon.request("dynamicsbusinesscentral", "/purchaseInvoices", {
  method: "POST",
  body: {
    number: "108001",
    invoiceDate: "2019-01-01",
    dueDate: "2019-01-01",
    currencyCode: "USD",
    pricesIncludeTax: false,
    totalAmountExcludingTax: 3122.8,
    totalTaxAmount: 187.37,
    totalAmountIncludingTax: 3310.17,
    status: "Paid",
  }
});

// Get the balance sheet
paragon.request("dynamicsbusinesscentral", "/balanceSheet?$orderby=lineNumber&$filter=dateFilter eq 2020-12-30", {
  method: "GET"
});

//Update a vendor by ID
paragon.request("dynamicsbusinesscentral", "/vendors([Vendor ID])", {
  method: "PATCH",
  body: {
    displayName: "Wide World Importers Inc.",
    blocked: "Payment"
  }
});
  
```

## Building Dynamics 365 Business Central workflows

Once your Dynamics 365 Business Central account is connected, you can add steps to perform the following actions:

* Create Vendor
* Update Vendor
* Get Vendor by ID
* Search for Vendor
* Delete Vendor
* Create Purchase Invoice
* Update Purchase Invoice
* Post a Purchase Invoice
* Get Purchase Invoice by ID
* Search for Purchase Invoice
* Delete Purchase Invoice
* Create Purchase Invoice Line Item
* Update Purchase Invoice Line Item
* Get Purchase Invoice Lines
* Get Purchase Invoice Line Item by ID
* Search for Purchase Invoice Line Item
* Delete Purchase Invoice Line Item
* Get Accounts
* Get Account by ID
* Create Tax Group
* Update Tax Group
* Get Tax Group by ID
* Search for Tax Group
* Delete Tax Group
* Create Payment Term
* Update Payment Term
* Get Payment Term by ID
* Search for Payment Term
* Delete Payment Term

You can also use the [Dynamics 365 Business Central Request](/workflows/requests#making-integration-requests) step to access any of Dynamics 365 Business Central's API endpoints without the authentication piece.

When creating or updating records in Dynamics 365 Business Central, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Dynamics 365 Business Central account. For example, you might want to trigger a workflow whenever new records are created in Dynamics 365 Business Central to sync your users' Dynamics 365 Business Central records to your application in real-time.

You can find the full list of Webhook Triggers for Dynamics 365 Business Central below:

* **Record Created**
* **Record Updated**
* **Record Deleted**


# Oracle Eloqua
Source: https://docs.useparagon.com/resources/integrations/eloqua

Connect to your users' Oracle Eloqua accounts.

## Setup Guide

You can find your Oracle Eloqua app credentials by visiting your Oracle Eloqua App dashboard.

**Note:** You'll need to create a new Oracle Eloqua app if you don't already have one.

You'll need the following information to set up your Oracle Eloqua App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your Oracle Eloqua app to Paragon

Under **Integrations > Connected Integrations > Oracle Eloqua > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Oracle Eloqua App page.
* **Client Secret:** Found under Client Secret on your Oracle Eloqua App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

**Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20an%20Oracle%20Eloqua%20application%20to%20Paragon%20Connect.png?maxW=1840&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c4d3d3d972724797b643657ac11cf11f" alt="" width="1840" height="1176" data-path="assets/Connecting an Oracle Eloqua application to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20an%20Oracle%20Eloqua%20application%20to%20Paragon%20Connect.png?w=280&maxW=1840&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=eff70f6349cf57b20d9754a747364476 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20an%20Oracle%20Eloqua%20application%20to%20Paragon%20Connect.png?w=560&maxW=1840&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=fb4a2f410fe6cea19fec7782a1702fe9 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20an%20Oracle%20Eloqua%20application%20to%20Paragon%20Connect.png?w=840&maxW=1840&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=abeb50c4b37504abb2d2afb03f4cfda5 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20an%20Oracle%20Eloqua%20application%20to%20Paragon%20Connect.png?w=1100&maxW=1840&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=39dd178a436dbec5049fa05af992e6cc 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20an%20Oracle%20Eloqua%20application%20to%20Paragon%20Connect.png?w=1650&maxW=1840&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=9575c873d141e95d8780ab2d62da3b3b 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20an%20Oracle%20Eloqua%20application%20to%20Paragon%20Connect.png?w=2500&maxW=1840&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b76bb46aeedd7a7cfda94ad4b64db604 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Oracle Eloqua

Once your users have connected their Oracle Eloqua account, you can use the Paragon SDK to access the Oracle Eloqua API on behalf of connected users.

See the Oracle Eloqua [REST API documentation](https://docs.oracle.com/en/cloud/saas/marketing/eloqua-rest-api/rest-endpoints.html) for their full API reference.

Any Oracle Eloqua API endpoints can be accessed with the Paragon SDK as shown in this example.

```
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get a list of all campaigns
await paragon.request("eloqua", "/api/rest/2.0/assets/campaigns", {
  method: "GET"
});

// Create a campaign
await paragon.request("eloqua", "/api/rest/2.0/assets/campaign", {
  method: "POST",
  body: {
    name: "New campaign",
    elements: []
  }
});

// Activate a campagin
await paragon.request("eloqua", "/api/rest/2.0/assets/campaign/active/<Campaign ID>", {
method: "POST",
body: {
  activateNow: true
}
});
```

## Building Oracle Eloqua workflows

Once your Oracle Eloqua account is connected, you can add steps to perform the following actions:

* Create Campaign
* Update Campaign
* Activate Campaign
* Search Campaigns
* Get Campaign by ID
* Create Email
* Update Email
* Search Emails
* Send Email Deployment
* Create Contact
* Update Contact
* Search Contacts

You can also use the [Oracle Eloqua Request](/workflows/requests#making-integration-requests) step to access any of Oracle Eloqua's API endpoints without the authentication piece.

When creating or updating campaigns or contacts in Oracle Eloqua, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Oracle%20Eloqua%20workflow%20in%20Paragon%20Connect.png?maxW=2270&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=093f69ec498c81e00ec95bb94c59567c" alt="" width="2270" height="1398" data-path="assets/Creating a Oracle Eloqua workflow in Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Oracle%20Eloqua%20workflow%20in%20Paragon%20Connect.png?w=280&maxW=2270&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=24890ccba56cf261d30789ba75879f8f 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Oracle%20Eloqua%20workflow%20in%20Paragon%20Connect.png?w=560&maxW=2270&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=1f34cebbd16cc4654d3d43d850fdb656 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Oracle%20Eloqua%20workflow%20in%20Paragon%20Connect.png?w=840&maxW=2270&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=73fa1f8bedcdcbce6eb6e0b8a4671d51 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Oracle%20Eloqua%20workflow%20in%20Paragon%20Connect.png?w=1100&maxW=2270&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=eccd2eadb3315d8856e8581557d032de 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Oracle%20Eloqua%20workflow%20in%20Paragon%20Connect.png?w=1650&maxW=2270&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=5e7f303f8a173609e062abbc4e3d529f 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Oracle%20Eloqua%20workflow%20in%20Paragon%20Connect.png?w=2500&maxW=2270&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=83e33004ffc01c3d9c8c11c28f0d2643 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Emarsys
Source: https://docs.useparagon.com/resources/integrations/emarsys

Connect to your users' Emarsys accounts.

## Setup Guide

You can find your Emarsys app credentials in your [Emarsys account.](https://dev.emarsys.com/docs/core-api-reference/64bjdnkvt328t-overview-of-endpoint-batches)

You'll need the following information to set up your Emarsys account with Paragon Connect:

* API Username
* API Secret

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to Emarsys

Once your users have connected their Emarsys account, you can use the Paragon SDK to access the Emarsys API on behalf of connected users.

See the Emarsys [REST API documentation](https://dev.emarsys.com/docs/core-api-reference/64bjdnkvt328t-overview-of-endpoint-batches) for their full API reference.

Any Emarsys API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// List Contacts
await paragon.request("emarsys", "v2/contact/query/?return=<field identifier ID>", {
  method: "GET"
});

// Update a Contact
await paragon.request("emarsys", "v2/contact", {
  method: "PUT",
  body: {
  "key_id": "3",
  "contacts": [
    {
      "1": "sample text",
      "2": "sample text",
      "3": "xyz@example.com"
    }
  ]
}
});

// Get Segments
paragon.request("emarsys", "v2/filter/<Segment ID>", {
  method: "GET"
});

// Get Campaigns
paragon.request("emarsys", "v2/email", {
  method: "GET"
});
  
```

## Building Emarsys workflows

Once your Emarsys account is connected, you use the [Emarsys Request](/workflows/requests#making-integration-requests) step to access any of Emarsys's API endpoints without the authentication piece.

When creating or updating records in Emarsys, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Facebook Ads
Source: https://docs.useparagon.com/resources/integrations/facebook-ads

Connect to your users' Facebook Ads accounts.

## Setup Guide

You can find your Facebook Ads app credentials by visiting your [Facebook Developer App Settings.](https://developers.facebook.com/apps/)

<Info>
  **Note:** You'll need to create a new Facebook Ads app if you don't already have one.
</Info>

You'll need the following information to set up your Facebook Ads App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add the Redirect URL to your Facebook Ads app

Paragon provides a redirect URL to send information to your Facebook Ads app. To add the redirect URL to your Facebook Ads app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log into your [Facebook Developer Portal](https://developers.facebook.com/apps/).

3. Select your app from the list of apps.

4. Under **Add a product**, select **Facebook Login**.

5. Under **Valid OAuth Redirect URIs**, paste-in the redirect URL from Paragon. The redirect URL can be found in Step 1.

6. Press the blue `Save changes` button to confirm your changes.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=6bb69ea708ba4a321019497a17e26d20" alt="" width="2234" height="1144" data-path="assets/Adding the Facebook Ads redirect URL for Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?w=280&maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=1c2e2943f472ab53a2ace993b47d1ec1 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?w=560&maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=c05de142de836e8f1ce212fcff94f150 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?w=840&maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=d1d8fa7f543a225bfa5ad0d06546433c 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?w=1100&maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=aacce09e389aee4a0b3dc076e37c8bb3 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?w=1650&maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=c13873ea9a35586e30f9c1c1bf5e655e 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?w=2500&maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=024465eef99e994f631cdaedee45b86a 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Facebook Ads app to Paragon

1. Select **Facebook Ads** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Facebook Ads > App Configuration > Configure**, fill out your credentials in their respective sections:

* **Client ID:**

  1. Log in to your Facebook Ads [dashboard](https://developers.facebook.com/apps/).

  2. Select your application.

  3. Select **Settings > Basic** from the sidebar.

  4. Copy the **App ID** to use in Paragon Connect.

* **Client Secret:**

  1. Log in to your Facebook Ads [dashboard](https://developers.facebook.com/apps/).

  2. Select your application.

  3. Select **Settings > Basic** from the sidebar.

  4. Copy your **App Secret** to use in Paragon Connect.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Ads%20account%20to%20Paragon.png?maxW=1178&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=45dcd4d6bba6d6bb75a1965c8ebfbd93" alt="" width="1178" height="571" data-path="assets/Connecting your Facebook Ads account to Paragon.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Ads%20account%20to%20Paragon.png?w=280&maxW=1178&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c224799315845c69f2439832b25c74e7 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Ads%20account%20to%20Paragon.png?w=560&maxW=1178&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e3d04f9d66d38a7a9f579ac4fa7a8584 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Ads%20account%20to%20Paragon.png?w=840&maxW=1178&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=554151d3e731de413f1cfe18b363dfa0 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Ads%20account%20to%20Paragon.png?w=1100&maxW=1178&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=1adfb147af10d47595f518ed1f6c91a9 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Ads%20account%20to%20Paragon.png?w=1650&maxW=1178&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=bd0817dbf2baea8ff724da14c1d8e030 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Ads%20account%20to%20Paragon.png?w=2500&maxW=1178&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a0c28faab72dd221e22ed86b0bcbb4a6 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Facebook Ads

Once your users have connected their Facebook Ads account, you can use the Paragon SDK to access Facebook Ads on behalf of connected users.

See the Facebook Ads [REST API documentation](https://developers.facebook.com/docs/marketing-apis/overview) for their full API reference.

Any Facebook Ads API endpoints can be accessed with the Paragon SDK as shown in this example.

```js JavaScript
// You can find your project ID in the Overview tab of any Integration.

// Authenticate the user
paragon.authenticate(<ProjectID>, <Paragon User Token>);

// Get Campaigns
await paragon.request(‘facebookAds’, 'act_<AD_ACCOUNT_ID>/campaigns', {
  method: 'GET'
})

// Create a Campaign
await paragon.request('facebookAds', 'act_<AD_ACCOUNT_ID>/campaigns' , {
  method: 'POST',
  body: {
    name: "My First Campaign",
    objective: "POST_ENGAGEMENT",
    status: "PAUSED",
    special_ad_categories: []
  }
})
```

## Building Facebook Ads workflows

Once your Facebook Ads account is connected, you can add steps to perform the following actions:

* Create Campaign
* Update Campaign
* Get Campaigns
* Get Campaign by ID
* Create Ad Set
* Update Ad Set
* Get Ad Sets
* Get Ad Set by ID
* Create Ad
* Update Ad
* Get Ad by ID
* Build Ad Creative Object
* Create Ad Creative
* Create Lead Gen Form
* Send Purchase Event
* Send Lead Event
* Send Funnel Event

You can also use the [Facebook Ads Request](/workflows/requests#making-integration-requests) step to access any of Facebook Ads's API endpoints without the authentication piece.

When using Facebook Ads, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Facebook%20Ads%20Workflow.svg?maxW=631&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=96335be86270045e03406de712406f1d" alt="" width="631" height="504" data-path="assets/Facebook Ads Workflow.svg" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Facebook%20Ads%20Workflow.svg?w=280&maxW=631&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=ead1e53ead1d9595c1c719cb916039b8 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Facebook%20Ads%20Workflow.svg?w=560&maxW=631&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=60b8f1dc6ee3e069256803fc233c2c4e 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Facebook%20Ads%20Workflow.svg?w=840&maxW=631&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=4082d4ec5aa3e079be63c9c369e2ad88 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Facebook%20Ads%20Workflow.svg?w=1100&maxW=631&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=0b50d101aeb74c505aa205a3f186ff54 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Facebook%20Ads%20Workflow.svg?w=1650&maxW=631&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=e02930d85bea9f62092b8f91c0c31ce5 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Facebook%20Ads%20Workflow.svg?w=2500&maxW=631&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=df61b54b902ebfe39a074abc6f3d199f 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Facebook Pages
Source: https://docs.useparagon.com/resources/integrations/facebook-pages

Connect to your users' Facebook Pages accounts.

## Setup Guide

You can find your Facebook Ads app credentials by visiting your [Facebook Developer App Settings.](https://developers.facebook.com/apps/)

<Info>
  **Note:** You'll need to create a new Facebook Pages app if you don't already have one.
</Info>

You'll need the following information to set up your Facebook Pages App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add the Redirect URL to your Facebook Pages app

Paragon provides a redirect URL to send information to your Facebook Pages app. To add the redirect URL to your Facebook Pages app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log into your [Facebook Developer Portal](https://developers.facebook.com/apps/).

3. Select your app from the list of apps.

4. Under **Add a product**, select **Facebook Login**.

5. Under **Valid OAuth Redirect URIs**, paste-in the redirect URL from Paragon. The redirect URL can be found in Step 1.

6. Press the blue `Save changes` button to confirm your changes.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=6bb69ea708ba4a321019497a17e26d20" alt="" width="2234" height="1144" data-path="assets/Adding the Facebook Ads redirect URL for Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?w=280&maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=1c2e2943f472ab53a2ace993b47d1ec1 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?w=560&maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=c05de142de836e8f1ce212fcff94f150 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?w=840&maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=d1d8fa7f543a225bfa5ad0d06546433c 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?w=1100&maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=aacce09e389aee4a0b3dc076e37c8bb3 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?w=1650&maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=c13873ea9a35586e30f9c1c1bf5e655e 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Facebook%20Ads%20redirect%20URL%20for%20Paragon%20Connect.png?w=2500&maxW=2234&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=024465eef99e994f631cdaedee45b86a 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Facebook Pages app to Paragon

1. Select **Facebook** Pages from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Facebook Pages > App Configuration > Configure**, fill out your credentials in their respective sections:

* **Client ID:**

  1. Log in to your Facebook Pages [dashboard](https://developers.facebook.com/apps/).

  2. Select your application.

  3. Select **App Settings > Basic** from the sidebar.

  4. Copy the **App ID** to use in Paragon Connect.

* **Client Secret:**

  1. Log in to your Facebook Pages [dashboard](https://developers.facebook.com/apps/).

  2. Select your application.

  3. Select **App Settings > Basic** from the sidebar.

  4. Copy your **App Secret** to use in Paragon Connect.

Press the purple "**Save Changes**" button to save your credentials.

* **Permissions:**

  1. Log in to your Facebook Pages [dashboard](https://developers.facebook.com/apps/).

  2. Select your application.

  3. Select **App Review > Permissions and Features** from the sidebar.

  4. Copy your scopes to use in Paragon Connect.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Pages%20app%20to%20Paragon%20Connect.png?maxW=1197&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e159acf927a677e0d25677ff36252e60" alt="" width="1197" height="606" data-path="assets/Connecting your Facebook Pages app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Pages%20app%20to%20Paragon%20Connect.png?w=280&maxW=1197&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=14a84cb6cd9309b252352ba1728d6369 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Pages%20app%20to%20Paragon%20Connect.png?w=560&maxW=1197&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ce01317bf30461a2d8f23fe3c28376a7 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Pages%20app%20to%20Paragon%20Connect.png?w=840&maxW=1197&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=720a8b96e7de418d3f925ef41f20be81 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Pages%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1197&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=096ed11682a1988b9c4ead084c9cb50f 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Pages%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1197&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=84fc46604151d196951d7f776d9436f3 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Facebook%20Pages%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1197&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a63a42ee94089fc9b8bfda9259479b53 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Facebook Pages

Once your users have connected their Facebook Pages account, you can use the Paragon SDK to access Facebook Pages on behalf of connected users.

See the Facebook Pages [REST API documentation](https://developers.facebook.com/docs/pages) for their full API reference.

Any Facebook Pages endpoints can be accessed with the Paragon SDK as shown in this example.

```js JavaScript
// You can find your project ID in the Overview tab of any Integration.

// Authenticate the user
paragon.authenticate(<ProjectID>, <Paragon User Token>);

// Post content to a Facebook Page
await paragon.request('facebookpages', '/feed', {
  method: 'POST',
  body: {
  'message': 'Hello Fans!'
  }
});

// Get Page Info
await paragon.request('facebookpages', '?fields=about,name,category,description,contact_address,emails,app_id,posts,username,verification_status,link,personal_info,phone', {
  method: 'GET'
});

// Get a single Metric
await paragon.request('facebookpages', '/insights/<metric-name>', {
  method: 'GET'
});
```

## Building Facebook Pages workflows

Once your Facebook Pages account is connected, you use the [Facebook Pages Request](/workflows/requests#making-integration-requests) step to access any of Facebook Pages' API endpoints without the authentication piece.

When creating or updating records in Facebook Pages, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Figma
Source: https://docs.useparagon.com/resources/integrations/figma

Connect to your users' Figma accounts.

## Setup Guide

You can find your Figma app credentials in your [Figma Developer Account.](https://www.figma.com/plugin-docs/apis/api-reference/)

You'll need the following information to set up your Figma App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your Figma app to Paragon

Under **Integrations > Connected Integrations > Figma > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Figma App page.
* **Client Secret:** Found under Client Secret on your Figma App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Figma%20app%20to%20Paragon%20Connect.png?maxW=1010&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=058b84ec30530300e3f75b57b5eb8a3a" alt="" width="1010" height="589" data-path="assets/Connecting your Figma app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Figma%20app%20to%20Paragon%20Connect.png?w=280&maxW=1010&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=7c5fb9a6e4182b0d9d31832474ebba00 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Figma%20app%20to%20Paragon%20Connect.png?w=560&maxW=1010&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=3540bc6774c1005a058469233afb108e 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Figma%20app%20to%20Paragon%20Connect.png?w=840&maxW=1010&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=0126e9ae7b6a96a7446151448eda31a4 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Figma%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1010&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a2b8ff6e928c95f5304fc43a92555f69 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Figma%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1010&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=97ec13503cd7c150cf4e2b77d7dcbcf1 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Figma%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1010&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=4514599f5a22cae7b805b9b3e4574ca0 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Figma

Once your users have connected their Figma account, you can use the Paragon SDK to access the Figma API on behalf of connected users.

See the Figma [REST API documentation](https://www.figma.com/plugin-docs/apis/api-reference/) for their full API reference.

Any Figma API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get a File
paragon.request("figma", "/v1/files/:key", {
  method: "GET"
});

// Get a Project's Files
paragon.request("figma", "/v1/projects/:project_id/files", {
  method: "GET"
});
  
```

## Building Figma workflows

Once your Figma account is connected, you can add steps to perform the following actions:

* Get Files by ID
* Get File Node
* Get Rendered Image from File
* Get Users' Projects
* Get Project Files
* Create Comment
* Get Comments by File
* Delete Comment
* Create Comment Reaction
* Get Comment Reactions by File
* Delete Comment Reaction

You can also use the [Figma Request](/workflows/requests#making-integration-requests) step to access any of Figma's API endpoints without the authentication piece.

When creating or updating records in Figma, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Freshdesk
Source: https://docs.useparagon.com/resources/integrations/freshdesk

Connect to your users' Freshdesk accounts.

## Setup Guide

You can find your Freshdesk credentials in your [Freshdesk account.](https://developers.freshdesk.com/api/)

You'll need the following information to set up your Freshdesk account with Paragon Connect:

* Freshdesk Domain
* API Key

## Connecting to Freshdesk

Once your users have connected their Freshdesk account, you can use the Paragon SDK to access the Freshdesk API on behalf of connected users.

See the Freshdesk [REST API documentation](https://developers.freshdesk.com/api/) for their full API reference.

Any Freshdesk API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get all tickets
paragon.request("freshdesk", "/tickets", {
  method: "GET"
});

// Create a ticket
paragon.request("freshdesk", "/tickets", {
  method: "POST",
  body: { 
     description: "Details about the issue...",
     subject: "Support Needed...",
     email: "tom@outerspace.com",
     priority: 1,
     status: 2,
     cc_emails: ["ram@freshdesk.com","diana@freshdesk.com"]
    }
});

// Get all contacts
paragon.request("freshdesk", "/contacts", {
  method: "GET"
});
  
```

## Building Freshdesk workflows

Once your Freshdesk account is connected, you can add steps to perform the following actions:

* Create Ticket
* Update Ticket
* Get Ticket by ID
* Delete Ticket

You can also use the [Freshdesk Request](/workflows/requests#making-integration-requests) step to access any of Freshdesk's API endpoints without the authentication piece.

When creating or updating records in Freshdesk, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Freshsales
Source: https://docs.useparagon.com/resources/integrations/freshsales

Connect to your users' Freshsales accounts.

## Setup Guide

You'll need the following information to set up your Freshsales App with Paragon Connect:

* Domain
* API Key

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your Freshsales app to Paragon

Under **Integrations > Connected Integrations > Freshsales > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Domain:** Found under https\://\[domain].myfreshworks.com/
* **API Key:** Found under Profile Settings > API Settings > Your API Key on your Freshsales settings page.

## Connecting to Freshsales

Once your users have connected their Freshsales account, you can use the Paragon SDK to access the Freshsales API on behalf of connected users.

See the Freshsales [REST API documentation](https://developer.freshsales.io/api/) for their full API reference.

Any Freshsales API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create a Contact
await paragon.request("freshsales", "/contacts", {
  method: "POST",
  body: {
    "contact": {
        "first_name": "James",
        "last_name": "Westwood",
        "mobile_number":"1-926-555-9503"
    }
  }
});

// Create a Lead
await paragon.request("freshsales", "/leads", {
  method: "POST",
  body: {
  "lead": {
         "first_name": "Foo",
         "last_name": "Westwood",
         "mobile_number":"1-926-652-9503",
         "company": { 
            "name": "Widgetz.io"
        } 
    }
  }
});

// Get all Deals
await paragon.request("freshsales", "/deals/view/<view_id>", {
  method: "GET"
});
  
```

## Building Freshsales workflows

Once your Freshsales account is connected, you use the [Freshsales Request](/workflows/requests#making-integration-requests) step to access any of Freshsales's API endpoints without the authentication piece.

When creating or updating records in Freshsales, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Front
Source: https://docs.useparagon.com/resources/integrations/front

Connect to your users' Front accounts.

## Setup Guide

You can find your Front app credentials in your [Front Developer Account.](https://dev.frontapp.com/reference/introduction)

You'll need the following information to set up your Front App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your Front app to Paragon

Under **Integrations > Connected Integrations > Front > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Front App page.
* **Client Secret:** Found under Client Secret on your Front App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Front%20app%20to%20Paragon%20Connect.png?maxW=981&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=7976feab83321de08fc342ae5a54485a" alt="" width="981" height="451" data-path="assets/Connecting your Front app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Front%20app%20to%20Paragon%20Connect.png?w=280&maxW=981&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c843d0e723d06d80380bd3ab68675efc 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Front%20app%20to%20Paragon%20Connect.png?w=560&maxW=981&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=af60720ad99dd0a58a00e5b8c30f08b4 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Front%20app%20to%20Paragon%20Connect.png?w=840&maxW=981&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f3d5afeae63f768e6720142191bce004 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Front%20app%20to%20Paragon%20Connect.png?w=1100&maxW=981&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ea804caa41ca450641532d428982a01a 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Front%20app%20to%20Paragon%20Connect.png?w=1650&maxW=981&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b6b02732afc5c546b7ba702c6c3d2c92 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Front%20app%20to%20Paragon%20Connect.png?w=2500&maxW=981&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=0fcb485b7cf88efdfb5428f31eac75b0 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Front

Once your users have connected their Front account, you can use the Paragon SDK to access the Front API on behalf of connected users.

See the Front [REST API documentation](https://dev.frontapp.com/reference/introduction) for their full API reference.

Any Front API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create a Conversation
await paragon.request('front', '/conversations', {
  method: "POST",
  body: {
    "type": "discussion",
    "inbox_id": "abc123",
    "subject": "Paragon",
    "comment": {
      "body": "Test Comment"
    }
  }
});

// List Contacts
await paragon.request("front", "/contacts", {
  method: "GET"
});

// Create a Contact
await paragon.request('front', '/contacts', {
  method: "POST",
  body: {
    "name": "Foo Westwood",
    "is_spammer": false,
    "handles": [
      {
        "handle": "@foo",
        "source": "twitter"
      }
    ]
  }
});
  
```

## Building Front workflows

Once your Front account is connected, you can add steps to perform the following actions:

* Create Account
* Update Account
* Get Account by ID
* Search Accounts
* Delete Account
* Create Contact
* Update Contact
* Get Contact by ID
* Search Contacts
* Delete Contact

You can also use the [Front Request](/workflows/requests#making-integration-requests) step to access any of Front's API endpoints without the authentication piece.

When creating or updating records in Front, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Gainsight
Source: https://docs.useparagon.com/resources/integrations/gainsight

Connect to your users' Gainsight accounts.

## Setup Guide

You can find your Gainsight API credentials in your [Gainsight account](https://support.gainsight.com/Gainsight_NXT/Connectors/Connectors/API_Integrations/Generate_API_Access_Key).

You'll need the following information to set up your Gainsight account with Paragon Connect:

* Access Key
* Instance URL

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to Gainsight

Once your users have connected their Gainsight account, you can use the Paragon SDK to access the Gainsight API on behalf of connected users.

See the Gainsight [REST API documentation](https://support.gainsight.com/Gainsight_NXT/API_and_Developer_Docs) for their full API reference.

Any Gainsight API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Playbooks
await paragon.request("gainsight", "/v2/cockpit/task/list", {
  method: "POST",
  body: {
    "select": [
        "Name"
    ]
 }
});

// Create CTAs from Cockpit
await paragon.request("gainsight", "/v2/cockpit/cta", {
  method: "POST",
  body: {
    "requests": [
      {
        "record": {
          "CompanyId": "1P02E3XFM9XIZFHS8U1E2JVX0AHMII6OIR1J",
          "OwnerId": "1P01KW4KG3SOEBEZMX7RSBJ0GI6BXXZ7NEX6",
          "referenceId": "1",
          "Name": "Potential Cancelation",
          "type": "Risk",
          "status": "New",
          "priority": "High",
          "reason": "Bugs Risk",
          "Comments": "test"
        }
      }
    ]
  }
});
  
```

## Building Gainsight workflows

Once your Gainsight account is connected, you use the [Gainsight Request](/workflows/requests#making-integration-requests) step to access any of Gainsight's API endpoints without the authentication piece.

When creating or updating records in Gainsight, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# GitHub
Source: https://docs.useparagon.com/resources/integrations/github

Connect to your users' GitHub accounts.

## Setup Guide

You can find your GitHub app credentials in your [GitHub Developer Account.](https://docs.github.com/en/rest)

You'll need the following information to set up your GitHub App with Paragon Connect:

* Client ID
* Client Secret

### Add the Redirect URL to your GitHub app

Paragon provides a redirect URL to send information to your GitHub app. To add the redirect URL to your GitHub app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log into your GitHub Account.

3. In the top-right corner, select **Settings**

4. Under **Developer Settings > OAuth Apps**, select your GitHub app.

<Info>
  **Note:** You'll need to create a new GitHub app if you don't already have one
</Info>

5. Under **General > Authorization callback URL**, paste the Redirect URL provided in Step 1.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20GitHub%20application%20for%20Paragon%20Connect.gif?maxW=964&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=e4c913c39a8f391da2550a4e3fac6637" alt="" width="964" height="755" data-path="assets/Adding the Redirect URL to your GitHub application for Paragon Connect.gif" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20GitHub%20application%20for%20Paragon%20Connect.gif?w=280&maxW=964&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3b209fda9c0766e88eeea510cf4c4688 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20GitHub%20application%20for%20Paragon%20Connect.gif?w=560&maxW=964&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=edc5149e72fa8b150fe4695351d09bee 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20GitHub%20application%20for%20Paragon%20Connect.gif?w=840&maxW=964&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=26dbf091e3cba14bdeb9ece98bd404d8 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20GitHub%20application%20for%20Paragon%20Connect.gif?w=1100&maxW=964&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=0c2a724f83371f71fff8ae80c6eb74ac 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20GitHub%20application%20for%20Paragon%20Connect.gif?w=1650&maxW=964&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a75927acd5a689d77a03ac9a8bb9469c 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20GitHub%20application%20for%20Paragon%20Connect.gif?w=2500&maxW=964&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=de7c296dde7fdd1d2b9e1ced29093d05 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your GitHub app to Paragon

Under **Integrations > Connected Integrations > GitHub > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Settings > Developer settings > \{YOUR APP} > Client ID on your GitHub App page.
* **Client Secret:** Found under Settings > Developer settings > \{YOUR APP} > Client Secret on your GitHub App page.

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20GitHub%20app%20to%20Paragon%20Connect.png?maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=027f11b328c92e7d194b7174def81ad0" alt="" width="1860" height="904" data-path="assets/Connecting your GitHub app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20GitHub%20app%20to%20Paragon%20Connect.png?w=280&maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=06a0fd37bc8cece6c3dfdb218ec6cdbe 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20GitHub%20app%20to%20Paragon%20Connect.png?w=560&maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c8167e8f46044e714df6781ca604c401 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20GitHub%20app%20to%20Paragon%20Connect.png?w=840&maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=afad290f310aaab11c0238c73e6369ae 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20GitHub%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=56590fe0ba6084ac4e06945b23a86d65 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20GitHub%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=36b45684abfb8dd1f3fb1db4c3e77096 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20GitHub%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1860&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e65cf5afc4e0e7159cd7c99521b009c3 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to GitHub

Once your users have connected their GitHub account, you can use the Paragon SDK to access the GitHub API on behalf of connected users.

See the GitHub [REST API documentation](https://docs.github.com/en/rest) for their full API reference.

Any GitHub API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get issues associated with a repository
paragon.request("github", "/repos/{owner}/{repo}/issues", {
  method: "GET"
});

// Create a comment on an issue
paragon.request("github", "/repos/{owner}/{repo}/issues/{issue_number}/comments", {
  method: "POST",
  body: {
    body: "Looks good to me!"
  }
});

// Specify labels for an issue
paragon.request("github", "/repos/{owner}/{repo}/issues/{issue_number}/labels
", {
  method: "PUT",
  body: {
    labels: [
      'bug',
      'enhancement'
    ]
  }
});
  
```

## Building GitHub workflows

Once your GitHub account is connected, you can add steps to perform the following actions:

* Create Issue
* Update Issue
* Get Issue by Number
* Lock Issue
* Search Issue
* Create Release
* Update Release
* Get Release by ID
* Get Release by Tag Name
* Delete Release

You can also use the [GitHub Request](/workflows/requests#making-integration-requests) step to access any of GitHub's API endpoints without the authentication piece.

When creating or updating issues in GitHub, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' GitHub account. For example, you might want to trigger a workflow whenever new issues are created in GitHub to sync your users' GitHub issues to your application in real-time.

You can find the full list of Webhook Triggers for GitHub below:

* **Issue Created**
* **Issue Updated**
* **PR Created**
* **PR Updated**
* **Project Created**
* **Project Updated**
* **Project Created (Classic)**
* **Project Updated (Classic)**
* **Project Item Created**
* **Project Item Updated**


# Gmail
Source: https://docs.useparagon.com/resources/integrations/gmail

Connect to your users' Gmail accounts.

## Setup Guide

You can find your Google app credentials by visiting your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project).

You'll need the following information to set up your Google App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Warning>
  Google Applications using scopes that permit access to certain user data must complete a verification process. [Read more](https://developers.google.com/identity/protocols/oauth2/scopes) about Google's various API scopes and procceses to verify your usage.
</Warning>

### Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Credentials** in the sidebar.

3. Press "**+ Create Credentials**", then select **OAuth client ID.**

4. Select "**Web application**" from the Application type drop-down menu.

<Info>
  **Note:** You'll need to configure Google's [consent screen](https://console.developers.google.com/apis/credentials) for access to **Client ID** and **Client Secret** if you haven't already.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1b9e06d58c0af9526d0717455bc7dfc2" alt="" width="1100" height="460" data-path="assets/Selecting Web Application in Google OAuth.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=280&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d51c0e8d2d42614976e477a9b406d05b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=560&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c586cfd9cb3101d95570703e4b9b4391 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=840&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ebd57b6af69773d922a982aba16b46d6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1100&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e79d58d62443ff5f84ff36188eef2431 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1650&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=25f8bcba040605492dc96066d8d7585d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=2500&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91bc9b710bd18e32c729785db0e68123 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Under **Authorized redirect URIs**, press the "**+ Add URI**" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "**Create**" button.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b920a76168a769c9a052eca8d97cb24" alt="" width="548" height="257" data-path="assets/Connect - Adding Google redirect URI for OAuth.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=280&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=080738ea9c75f4c982bc6fb64d217666 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=560&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5b09543fbb14db3fab8d0b8abeddadfb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=840&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f7c189919cdc9d0718954f1f154d992e 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1100&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3067bf209ba4185136976ab859009c09 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1650&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=52a3cd30df1425f5c2fa866c9df03643 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=2500&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e8e336914fc3971c7ea2c13710efe849 2500w" data-optimize="true" data-opv="2" />
</Frame>

Google provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Enable Email API in Google Cloud Console Dashboard

1. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Library** in the sidebar.

2. Search for "Gmail" from the API Library.

3. Select the "Gmail API".

4. Press the blue "**Enable**" button to enable the API for your application.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20the%20Gmail%20API%20in%20the%20Google%20Cloud%20Console%20Dashboard.png?maxW=996&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=74bd787b4be134cc5f2ee108dca89b5c" alt="" width="996" height="496" data-path="assets/Choosing the Gmail API in the Google Cloud Console Dashboard.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20the%20Gmail%20API%20in%20the%20Google%20Cloud%20Console%20Dashboard.png?w=280&maxW=996&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a1a4802616f22edf6718309e16abcb7d 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20the%20Gmail%20API%20in%20the%20Google%20Cloud%20Console%20Dashboard.png?w=560&maxW=996&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=7d101a0a8a5198eeef7316fe2dee2864 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20the%20Gmail%20API%20in%20the%20Google%20Cloud%20Console%20Dashboard.png?w=840&maxW=996&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=1df85a020967dfe10cad9c47094a872b 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20the%20Gmail%20API%20in%20the%20Google%20Cloud%20Console%20Dashboard.png?w=1100&maxW=996&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f77ea51055bb4974be094453b6f1e62b 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20the%20Gmail%20API%20in%20the%20Google%20Cloud%20Console%20Dashboard.png?w=1650&maxW=996&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=303c5b4c34c95e6c9a5656b30e5b2142 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20the%20Gmail%20API%20in%20the%20Google%20Cloud%20Console%20Dashboard.png?w=2500&maxW=996&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=6359c79fcac585ddde8bc333d88259a5 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Google app to Paragon

1. Select **Gmail** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Gmail > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/google-sheets#1-add-the-redirect-url-to-your-google-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com) They should begin with `gmail`.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5790675cf1c75ebfbcaf8425e83a022e" alt="" width="1764" height="1106" data-path="assets/Connecting a new Google app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=280&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b24271f5a6c15048b6892d2200aa1b42 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=560&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f78acb99ac7869f09bcbc0a073386745 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=840&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c14a7c6c75c8b0bd7e926629fc40e7c1 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=57d4d7a0218c8007f67a99684730d216 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8707dc94bd895f01269e9fd9656b4054 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e53cae7f5a05ff7a7dd2ce512ccc5287 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Gmail

Once your users have connected their Gmail account, you can use the Paragon SDK to access the Gmail API on behalf of connected users.

See the Gmail [REST API documentation](https://developers.google.com/gmail/api/reference/rest) for their full API reference.

Any Gmail API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Send an email on behalf of a specified user
paragon.request("gmail", "/upload/gmail/v1/users/{userId}/messages/send", {
  method: "POST",
  body: {
    "raw": <Base64-encoded email>
  }
});

// Get all emails associated with a specified user
paragon.request("gmail", "gmail/v1/users/{userId}/messages", {
  method: "GET"
});
  
```

## Building Gmail workflows

Once your Gmail account is connected, you can add steps to perform the following actions:

* Send Email
* Get Email by ID
* Search for Email
* Delete Email
* Create a Draft
* Create a Contact
* Get Contact by Resource Name
* Search for Contact
* Delete Contact

You can also use the [Gmail Request](/workflows/requests#making-integration-requests) step to access any of Gmail's API endpoints without the authentication piece.

When creating or getting emails in Gmail, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Gmail account. For example, you might want to trigger a workflow whenever new threads are created in Gmail to sync your users' Gmail threads to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Gmail%20Webhook%20Triggers%20in%20Paragon%20Connect.png?maxW=908&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=d666ef39b4bcf843ec2d01ec9f989cf9" alt="" width="908" height="641" data-path="assets/Gmail Webhook Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Gmail%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=908&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=ea2a9b301f65291262914b4f1b3249e4 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Gmail%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=908&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=59c51a84c0ac7d8c2dbb59b34e363f17 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Gmail%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=908&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=ece038b91f011dca5988a84a1bfed1ef 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Gmail%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=908&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=e9d2aa31608009ca48aca43892806251 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Gmail%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=908&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=8c6cbd0b334e6d81d896bf8852ab3d7e 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Gmail%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=908&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=09d56619345297f61d744c8871c3666f 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Gmail below:

* **Thread Created**
* **Thread Updated**
* **Thread Modified**

## Publishing your Gmail application

### Setting up a Redirect Page in your app

Your Gmail integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

* Receives a `GET` request with a number of query parameters.
* Redirect to `https://passport.useparagon.com/oauth` with the same query parameters.

```js
paragon.connect("gmail", {
  overrideRedirectUrl: "https://your-app.url/gmail-redirect"
});
```

### Updating the allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your Gmail Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and select your application.

2. Navigate to **APIs & Services > Credentials** and select the credentials you use with Paragon.

3. Under **Authorized redirect URIs**, provide the URL of your Redirect Page.


# Gong
Source: https://docs.useparagon.com/resources/integrations/gong

Connect to your users' Gong accounts.

## Setup Guide

<Info>
  **Note:** You'll need to create a new Gong app if you don't already have one.
</Info>

You can find your Gong app credentials in your [Gong Developer Account.](https://app.gong.io/settings/api/documentation#overview)

You'll need the following information to set up your Gong App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add the Redirect URL to your Calendly app

Paragon provides a redirect URL to send information to your Calendly app. To add the redirect URL to your Calendly app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log into your [Gong Developer Portal](https://developer.gong.com/).

3. Select your app from the list of apps.

4. Under **Redirect URL**, paste-in the redirect URL from Paragon. The redirect URL can be found in Step 1.

5. Press the `Save` button to confirm your changes.

### Add your Gong app to Paragon

Under **Integrations > Connected Integrations > Gong > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Gong App page.
* **Client Secret:** Found under Client Secret on your Gong App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gong%20app%20to%20Paragon%20Connect.png?maxW=1960&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=1723f46508e7c6434cfafd21d6a6c56f" alt="" width="1960" height="1166" data-path="assets/Connecting your Gong app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gong%20app%20to%20Paragon%20Connect.png?w=280&maxW=1960&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=be93bc4e1c7970ba9a15f3c5c2096883 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gong%20app%20to%20Paragon%20Connect.png?w=560&maxW=1960&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2a129a67d91d68daf8e41da3aaaf6362 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gong%20app%20to%20Paragon%20Connect.png?w=840&maxW=1960&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=8209c2c43684b709cfef9323cb0b134c 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gong%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1960&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a007aa3a83629dcaebaaa766bd697cd9 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gong%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1960&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=53201c293b8bfc9117c7798cced7e21e 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gong%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1960&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=afc93a19e74655f7cac83a3407030b0d 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Gong

Once your users have connected their Gong account, you can use the Paragon SDK to access the Gong API on behalf of connected users.

See the Gong [REST API documentation](https://app.gong.io/settings/api/documentation#overview) for their full API reference.

Any Gong API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get all Calls after a specified date
paragon.request("gong", "/v2/calls?fromDateTime=2018-02-18T02:30:00-07:00", {
  method: "GET"
});

// Create a new Call
paragon.request("gong", "/v2/calls", {
  method: "POST",
  body: {
    "actualStart": "2018-02-17T02:30:00-08:00",
    "callProviderCode": "clearslide",
    "clientUniqueId": "123abc",
    "context": [
      {
        "objects": [
          {
            "fields": [
              {
                "name": "name",
                "value": "Gong Inc."
              }
            ],
            "objectId": "0013601230sV7grAAC",
            "objectType": "Account"
          }
        ],
        "system": "Salesforce"
      }
    ],
    "direction": "Conference",
    "duration": 125.8,
    "meetingUrl": "https://www.conference.com/john.smith",
    "parties": [
      {
        "emailAddress": "test@test.com",
        "name": "Test User",
        "userId": "7387268041252473322"
      }
    ],
    "primaryUser": "7387268041252471122",
    "purpose": "Demo Call",
    "scheduledEnd": "2018-02-19T02:30:00-08:00",
    "scheduledStart": "2018-02-17T02:30:00-08:00",
    "title": "Demo Test Call",
    "workspaceId": "623457276584334"
  }
});

// Get Log Data after a specified date
paragon.request("gong", " /v2/logs?fromDateTime=2018-02-18T02:30:00-07:00", {
  method: "GET"
});
  
```

## Building Gong workflows

Once your Gong account is connected, you can add steps to perform the following actions:

* Add a New Call
* Get Call by ID
* Search for Call

You can also use the [Gong Request](/workflows/requests#making-integration-requests) step to access any of Gong's API endpoints without the authentication piece.

When creating or updating records in Gong, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Google
Source: https://docs.useparagon.com/resources/integrations/google

Connect to your users' Google applications

### Select your Google application

<Card href="/resources/integrations/bigquery">
  BigQuery
</Card>

<Card href="/resources/integrations/gmail">
  Gmail
</Card>

<Card href="/resources/integrations/googleads">
  Google Ad Manager
</Card>

<Card href="/resources/integrations/googleads">
  Google Ads
</Card>

<Card href="/resources/integrations/google-analytics">
  Google Analytics
</Card>

<Card href="/resources/integrations/googleanalyticsga4">
  Google Analytics GA4
</Card>

<Card href="/resources/integrations/google-calendar">
  Google Calendar
</Card>

<Card href="/resources/integrations/google-campaign-manager-360">
  Google Campaign Manager 360
</Card>

<Card href="/resources/integrations/googledocs">
  Google Docs
</Card>

<Card href="/resources/integrations/google-drive">
  Google Drive
</Card>

<Card href="/resources/integrations/google-search-console">
  Google Search Console
</Card>

<Card href="/resources/integrations/google-sheets">
  Google Sheets
</Card>


# Google Ad Manager
Source: https://docs.useparagon.com/resources/integrations/google-ad-manager

Connect to your users' Google Ad Manager accounts.

## Setup Guide

You can find your Google app credentials by visiting your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project).

You'll need the following information to set up your Google App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Warning>
  Google Applications using scopes that permit access to certain user data must complete a verification process. [Read more](https://developers.google.com/identity/protocols/oauth2/scopes) about Google's various API scopes and procceses to verify your usage.
</Warning>

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Credentials** in the sidebar.

3. Press "**+ Create Credentials**", then select **OAuth client ID.**

4. Select "**Web application**" from the Application type drop-down menu.

<Info>
  **Note:** You'll need to configure Google's [consent screen](https://console.developers.google.com/apis/credentials) for access to **Client ID** and **Client Secret** if you haven't already.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1b9e06d58c0af9526d0717455bc7dfc2" alt="" width="1100" height="460" data-path="assets/Selecting Web Application in Google OAuth.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=280&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d51c0e8d2d42614976e477a9b406d05b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=560&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c586cfd9cb3101d95570703e4b9b4391 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=840&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ebd57b6af69773d922a982aba16b46d6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1100&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e79d58d62443ff5f84ff36188eef2431 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1650&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=25f8bcba040605492dc96066d8d7585d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=2500&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91bc9b710bd18e32c729785db0e68123 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Under **Authorized redirect URIs**, press the "**+ Add URI**" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "**Create**" button.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b920a76168a769c9a052eca8d97cb24" alt="" width="548" height="257" data-path="assets/Connect - Adding Google redirect URI for OAuth.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=280&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=080738ea9c75f4c982bc6fb64d217666 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=560&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5b09543fbb14db3fab8d0b8abeddadfb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=840&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f7c189919cdc9d0718954f1f154d992e 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1100&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3067bf209ba4185136976ab859009c09 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1650&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=52a3cd30df1425f5c2fa866c9df03643 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=2500&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e8e336914fc3971c7ea2c13710efe849 2500w" data-optimize="true" data-opv="2" />
</Frame>

Google provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Add your Google app to Paragon

1. Select **Google Ad Manager** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Google Ad Manager > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/google-ad-manager#add-the-redirect-url-to-your-google-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5790675cf1c75ebfbcaf8425e83a022e" alt="" width="1764" height="1106" data-path="assets/Connecting a new Google app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=280&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b24271f5a6c15048b6892d2200aa1b42 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=560&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f78acb99ac7869f09bcbc0a073386745 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=840&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c14a7c6c75c8b0bd7e926629fc40e7c1 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=57d4d7a0218c8007f67a99684730d216 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8707dc94bd895f01269e9fd9656b4054 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e53cae7f5a05ff7a7dd2ce512ccc5287 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Google Ad Manager

Once your users have connected their Google Ad Manager account, you can use the Paragon SDK to access the Google Ad Manager API on behalf of connected users.

See the Google Ad Manager [REST API documentation](https://developers.google.com/ad-manager/api/rel_notes) for their full API reference.

Any Google Ad Manager API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create an Order
await paragon.request("googleadmanager", "/OrderService ", {
  method: "POST",
  body: `
    <createOrders xmlns="https://www.google.com/apis/ads/publisher/v202408">
      <orders>
          <name>[string?]</name>
          <status>[string?]</status>
          <isArchived>true</isArchived>
      </orders>
  </createOrders>`
});

// Query Line Items
await paragon.request("googleadmanager", "/LineItemService", {
  method: "POST",
  body: `
    <getLineItemsByStatement xmlns="https://www.google.com/apis/ads/publisher/v202408">
      <filterStatement/>
    </getLineItemsByStatement>`
});
  
```

## Building Google Ad Manager workflows

Once your Google Ad Manager account is connected, you use the [Google Ad Manager Request](/workflows/requests#making-integration-requests) step to access any of Google Ad Manager's API endpoints without the authentication piece.

When creating or updating records in Google Ad Manager, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Publishing your Google Ad Manager application

### Setting up a Redirect Page in your app

Your Google Ad Manager integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

* Receives a `GET` request with a number of query parameters.
* Redirect to `https://passport.useparagon.com/oauth` with the same query parameters.

```js
paragon.connect("googleadmanager", {
  overrideRedirectUrl: "https://your-app.url/google-ad-manager-redirect"
});
```

### Updating the allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your Google Ad Manager Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and select your application.

2. Navigate to **APIs & Services > Credentials** and select the credentials you use with Paragon.

3. Under **Authorized redirect URIs**, provide the URL of your Redirect Page.


# Google Analytics
Source: https://docs.useparagon.com/resources/integrations/google-analytics

Connect to your users' Google Analytics accounts.

## Setup Guide

You can find your Google app credentials by visiting your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project).

You'll need the following information to set up your Google App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Warning>
  Google Applications using scopes that permit access to certain user data must complete a verification process. [Read more](https://developers.google.com/identity/protocols/oauth2/scopes) about Google's various API scopes and procceses to verify your usage.
</Warning>

### Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Credentials** in the sidebar.

3. Press "**+ Create Credentials**", then select **OAuth client ID.**

4. Select "**Web application**" from the Application type drop-down menu.

<Info>
  **Note:** You'll need to configure Google's [consent screen](https://console.developers.google.com/apis/credentials) for access to **Client ID** and **Client Secret** if you haven't already.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1b9e06d58c0af9526d0717455bc7dfc2" alt="" width="1100" height="460" data-path="assets/Selecting Web Application in Google OAuth.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=280&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d51c0e8d2d42614976e477a9b406d05b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=560&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c586cfd9cb3101d95570703e4b9b4391 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=840&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ebd57b6af69773d922a982aba16b46d6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1100&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e79d58d62443ff5f84ff36188eef2431 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1650&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=25f8bcba040605492dc96066d8d7585d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=2500&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91bc9b710bd18e32c729785db0e68123 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Under **Authorized redirect URIs**, press the "**+ Add URI**" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "**Create**" button.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b920a76168a769c9a052eca8d97cb24" alt="" width="548" height="257" data-path="assets/Connect - Adding Google redirect URI for OAuth.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=280&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=080738ea9c75f4c982bc6fb64d217666 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=560&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5b09543fbb14db3fab8d0b8abeddadfb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=840&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f7c189919cdc9d0718954f1f154d992e 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1100&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3067bf209ba4185136976ab859009c09 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1650&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=52a3cd30df1425f5c2fa866c9df03643 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=2500&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e8e336914fc3971c7ea2c13710efe849 2500w" data-optimize="true" data-opv="2" />
</Frame>

Google provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Enable Google Analytics API in Google Cloud Console Dashboard

1. In your Google Cloud Console dashboard, navigate to **APIs & Services > Library** in the sidebar.

2. Search for "Google Analytics API" and "Google Analytics Reporting API" from the API Library.

3. Select the "Google Analytics API" and "Google Analytics Reporting API".

4. Press the blue "**Enable**" button to enable the API for your application.

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Analytics%20APIs%20for%20Paragon%20Connect.png?maxW=1978&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=fa95d5799333e2ecf331e98258c79ce9" alt="" width="1978" height="580" data-path="assets/Enabling the Google Analytics APIs for Paragon Connect.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Analytics%20APIs%20for%20Paragon%20Connect.png?w=280&maxW=1978&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=5d1e3e6c4cde49c69508cf4c424c125b 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Analytics%20APIs%20for%20Paragon%20Connect.png?w=560&maxW=1978&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=92b7ecd9a447b6d718776239c361c2ae 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Analytics%20APIs%20for%20Paragon%20Connect.png?w=840&maxW=1978&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=78917a504ebcf3f4b9da904fb701a905 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Analytics%20APIs%20for%20Paragon%20Connect.png?w=1100&maxW=1978&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=1e6ff0e0a225604aac70c915b1f35ef6 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Analytics%20APIs%20for%20Paragon%20Connect.png?w=1650&maxW=1978&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b57e8dd8858789bfc55b9243677128a6 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Analytics%20APIs%20for%20Paragon%20Connect.png?w=2500&maxW=1978&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=168dd22f77690fa4a53a748c7fcec7ab 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Google app to Paragon

1. Select **Google Analytics** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Google Analytics > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/google-analytics#add-the-redirect-url-to-your-google-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com) They should begin with `analytics`.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5790675cf1c75ebfbcaf8425e83a022e" alt="" width="1764" height="1106" data-path="assets/Connecting a new Google app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=280&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b24271f5a6c15048b6892d2200aa1b42 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=560&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f78acb99ac7869f09bcbc0a073386745 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=840&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c14a7c6c75c8b0bd7e926629fc40e7c1 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=57d4d7a0218c8007f67a99684730d216 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8707dc94bd895f01269e9fd9656b4054 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e53cae7f5a05ff7a7dd2ce512ccc5287 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Google Analytics

Once your users have connected their Google Analytics account, you can use the Paragon SDK to access the Google Analytics API on behalf of connected users.

See the Google Analytics [REST API documentation](https://developers.google.com/analytics/devguides/config/mgmt/v3) for their full API reference.

Any Google Analytics API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Get accounts the user has access to
await paragon.request("googleanalytics", "https://www.googleapis.com/analytics/v3/management/accounts", {
  method: "GET"
});
              
// Get goals for an account and web property
await paragon.request("googleanalytics","https://www.googleapis.com/analytics/v3/management/accounts/<Account ID>/webproperties/<Web Property ID>/profiles/<Profile ID>/goals", {
    method: "GET"
  });
  
// Run analytics query for a view
await paragon.request("googleanalytics", "https://analyticsreporting.googleapis.com/v4/reports:batchGet", {
  method: "POST",
  body: {
    reportRequests: [{
      viewId: "<View ID>"
    }],
    useResourceQuotas: true
  }
});
```

## Building Google Analytics workflows

Once your Google Analytics account is connected, you can add steps to perform the following actions:

* Run Report
* Get Realtime Data
* Get Custom Metrics
* Get Custom Dimensions

You can also use the [Google Analytics Request](/workflows/requests#making-integration-requests) step to access any of Google Analytics's API endpoints without the authentication piece.

When creating or updating events in Google Analytics, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Publishing your Google Analytics application

### Setting up a Redirect Page in your app

Your Google Analytics integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

* Receives a `GET` request with a number of query parameters.
* Redirect to `https://passport.useparagon.com/oauth` with the same query parameters.

```js
paragon.connect("googleanalytics", {
  overrideRedirectUrl: "https://your-app.url/google-analytics-redirect"
});
```

### Updating the allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your Google Analytics Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and select your application.

2. Navigate to **APIs & Services > Credentials** and select the credentials you use with Paragon.

3. Under **Authorized redirect URIs**, provide the URL of your Redirect Page.


# Google Calendar
Source: https://docs.useparagon.com/resources/integrations/google-calendar

Connect to your users' Google Calendar accounts.

## Setup Guide

You can find your Google app credentials by visiting your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project).

You'll need the following information to set up your Google App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Warning>
  Google Applications using scopes that permit access to certain user data must complete a verification process. [Read more](https://developers.google.com/identity/protocols/oauth2/scopes) about Google's various API scopes and procceses to verify your usage.
</Warning>

### Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Credentials** in the sidebar.

3. Press "**+ Create Credentials**", then select **OAuth client ID.**

4. Select "**Web application**" from the Application type drop-down menu.

<Info>
  **Note:** You'll need to configure Google's [consent screen](https://console.developers.google.com/apis/credentials) for access to **Client ID** and **Client Secret** if you haven't already.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1b9e06d58c0af9526d0717455bc7dfc2" alt="" width="1100" height="460" data-path="assets/Selecting Web Application in Google OAuth.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=280&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d51c0e8d2d42614976e477a9b406d05b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=560&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c586cfd9cb3101d95570703e4b9b4391 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=840&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ebd57b6af69773d922a982aba16b46d6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1100&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e79d58d62443ff5f84ff36188eef2431 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1650&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=25f8bcba040605492dc96066d8d7585d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=2500&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91bc9b710bd18e32c729785db0e68123 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Under **Authorized redirect URIs**, press the "**+ Add URI**" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "**Create**" button.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b920a76168a769c9a052eca8d97cb24" alt="" width="548" height="257" data-path="assets/Connect - Adding Google redirect URI for OAuth.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=280&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=080738ea9c75f4c982bc6fb64d217666 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=560&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5b09543fbb14db3fab8d0b8abeddadfb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=840&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f7c189919cdc9d0718954f1f154d992e 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1100&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3067bf209ba4185136976ab859009c09 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1650&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=52a3cd30df1425f5c2fa866c9df03643 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=2500&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e8e336914fc3971c7ea2c13710efe849 2500w" data-optimize="true" data-opv="2" />
</Frame>

Google provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Enable Google Calendar API in Google Cloud Console Dashboard

1. In your Google Cloud Console dashboard, navigate to **APIs & Services > Library** in the sidebar.

2. Search for "Google Calendar API" from the API Library.

3. Select the "Google Calendar API".

4. Press the blue "**Enable**" button to enable the API for your application.

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Calendar%20API.png?maxW=1158&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=7b23e0f3c1a29a9ce1a5718a6b66209c" alt="" width="1158" height="472" data-path="assets/Enabling Google Calendar API.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Calendar%20API.png?w=280&maxW=1158&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=2d1f22790aa671dd34d08aa3282de6d3 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Calendar%20API.png?w=560&maxW=1158&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=00a4721997844cbcb30e5dbe685aca79 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Calendar%20API.png?w=840&maxW=1158&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=f9a39d597988ede3ab6d370ef8d93344 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Calendar%20API.png?w=1100&maxW=1158&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=43e67e1fda9c155e3e1595a44b2ee512 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Calendar%20API.png?w=1650&maxW=1158&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=944f7072ede7165f9fb15a5821af9fe5 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Calendar%20API.png?w=2500&maxW=1158&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=03d4cd3bb2761123a772e9161f57e3ab 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Google app to Paragon

1. Select **Google Calendar** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Google Calendar > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/google-calendar#add-the-redirect-url-to-your-google-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com) They should begin with `calendar`.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5790675cf1c75ebfbcaf8425e83a022e" alt="" width="1764" height="1106" data-path="assets/Connecting a new Google app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=280&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b24271f5a6c15048b6892d2200aa1b42 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=560&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f78acb99ac7869f09bcbc0a073386745 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=840&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c14a7c6c75c8b0bd7e926629fc40e7c1 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=57d4d7a0218c8007f67a99684730d216 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8707dc94bd895f01269e9fd9656b4054 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e53cae7f5a05ff7a7dd2ce512ccc5287 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Google Calendar

Once your users have connected their Google Calendar account, you can use the Paragon SDK to access the Google Calendar API on behalf of connected users.

See the Google Calendar [REST API documentation](https://developers.google.com/calendar/v3/reference) for their full API reference.

Any Google Calendar API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Calendar List
await paragon.request("googleCalendar", "/users/me/calendarList", { 
  method: "GET"
});
  
  
// Create Event
await paragon.request("googleCalendar", "/calendars/{calendarId}/events", { 
  method: “POST”,
  body: { 
    "start": { "dateTime" : new Date("2021-01-02").toISOString() },
    "end": { "dateTime" : new Date("2021-01-02").toISOString() },
  }
});
```

## Building Google Calendar workflows

Once your Google Calendar account is connected, you can add steps to perform the following actions:

* Create Event
* Update Event
* List Events
* Get Event by ID
* Delete Event
* Get Contacts
* Search Contacts
* List Directory People
* Search Directory People
* List Other Contacts
* Search Other Contacts
* Get Availability

You can also use the [Google Calendar Request](/workflows/requests#making-integration-requests) step to access any of Google Calendar's API endpoints without the authentication piece.

When creating or updating events in Google Calendar, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Scheduling%20Google%20Calendar%20invites%20through%20Paragon.png?maxW=895&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=7904efab5d2bf1f2c78c6dd70d1d69fc" alt="" width="895" height="679" data-path="assets/Scheduling Google Calendar invites through Paragon.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Scheduling%20Google%20Calendar%20invites%20through%20Paragon.png?w=280&maxW=895&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=24fecfa5ed59558567912ddd8a6f69db 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Scheduling%20Google%20Calendar%20invites%20through%20Paragon.png?w=560&maxW=895&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=cfcc0e093af4ce04b85ce215b0bd6eab 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Scheduling%20Google%20Calendar%20invites%20through%20Paragon.png?w=840&maxW=895&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=86d04c80458912688b68e86d712a21d7 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Scheduling%20Google%20Calendar%20invites%20through%20Paragon.png?w=1100&maxW=895&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ac4f4038fbc89e25743708cc794aaa15 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Scheduling%20Google%20Calendar%20invites%20through%20Paragon.png?w=1650&maxW=895&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1739c264ab442f7c7a099e65e2e4cdf8 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Scheduling%20Google%20Calendar%20invites%20through%20Paragon.png?w=2500&maxW=895&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=43bd048fbf6cb744f6d01c865ee99c28 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Google Calendar. For example, you might want to trigger a workflow whenever events are created to sync your users' Google Calendar events to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Calendar%20Webhooks%20in%20Paragon%20Connect.png?maxW=2082&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=fe835b48f9b4336e80bc39d2dd2a42b0" alt="" width="2082" height="1456" data-path="assets/Google Calendar Webhooks in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Calendar%20Webhooks%20in%20Paragon%20Connect.png?w=280&maxW=2082&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c0f6ee7eb64b3c249fba8c4c116fb456 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Calendar%20Webhooks%20in%20Paragon%20Connect.png?w=560&maxW=2082&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=b8e5deb4cf46fa75fcec840ecb937672 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Calendar%20Webhooks%20in%20Paragon%20Connect.png?w=840&maxW=2082&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=4e7e80ede0bd11d8871fb4185853aeef 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Calendar%20Webhooks%20in%20Paragon%20Connect.png?w=1100&maxW=2082&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=22994752f94ca5ea825d6d0db2a0eb21 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Calendar%20Webhooks%20in%20Paragon%20Connect.png?w=1650&maxW=2082&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=f00d9b38d4b3573e8303f052b24268d9 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Calendar%20Webhooks%20in%20Paragon%20Connect.png?w=2500&maxW=2082&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9019e7cfc06c002d9151c5c91f629fb9 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Google Calendar below:

* **New Event**
* **Event Updated**
* **Event Cancelled**
* **Event Started**
* **Event Ended**

## Publishing your Google Calendar application

### Setting up a Redirect Page in your app

Your Google Calendar integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

* Receives a `GET` request with a number of query parameters.
* Redirect to `https://passport.useparagon.com/oauth` with the same query parameters.

```js
paragon.connect("googlecalendar", {
  overrideRedirectUrl: "https://your-app.url/google-calendar-redirect"
});
```

### Updating the allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your Google Calendar Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and select your application.

2. Navigate to **APIs & Services > Credentials** and select the credentials you use with Paragon.

3. Under **Authorized redirect URIs**, provide the URL of your Redirect Page.


# Google Campaign Manager 360
Source: https://docs.useparagon.com/resources/integrations/google-campaign-manager-360

Connect to your users' Google Campaign Manager 360 accounts.

## Setup Guide

You can find your Google app credentials by visiting your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project).

You'll need the following information to set up your Google App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Warning>
  Google Applications using scopes that permit access to certain user data must complete a verification process. [Read more](https://developers.google.com/identity/protocols/oauth2/scopes) about Google's various API scopes and procceses to verify your usage.
</Warning>

### Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Credentials** in the sidebar.

3. Press "**+ Create Credentials**", then select **OAuth client ID.**

4. Select "**Web application**" from the Application type drop-down menu.

<Info>
  **Note:** You'll need to configure Google's [consent screen](https://console.developers.google.com/apis/credentials) for access to **Client ID** and **Client Secret** if you haven't already.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1b9e06d58c0af9526d0717455bc7dfc2" alt="" width="1100" height="460" data-path="assets/Selecting Web Application in Google OAuth.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=280&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d51c0e8d2d42614976e477a9b406d05b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=560&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c586cfd9cb3101d95570703e4b9b4391 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=840&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ebd57b6af69773d922a982aba16b46d6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1100&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e79d58d62443ff5f84ff36188eef2431 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1650&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=25f8bcba040605492dc96066d8d7585d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=2500&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91bc9b710bd18e32c729785db0e68123 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Under **Authorized redirect URIs**, press the "**+ Add URI**" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "**Create**" button.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b920a76168a769c9a052eca8d97cb24" alt="" width="548" height="257" data-path="assets/Connect - Adding Google redirect URI for OAuth.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=280&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=080738ea9c75f4c982bc6fb64d217666 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=560&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5b09543fbb14db3fab8d0b8abeddadfb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=840&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f7c189919cdc9d0718954f1f154d992e 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1100&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3067bf209ba4185136976ab859009c09 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1650&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=52a3cd30df1425f5c2fa866c9df03643 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=2500&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e8e336914fc3971c7ea2c13710efe849 2500w" data-optimize="true" data-opv="2" />
</Frame>

Google provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Enable Google Campaign Manager 360 API in Google Cloud Console Dashboard

1. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Library** in the sidebar.

2. Search for "Google Campaign Manager 360" from the API Library.

3. Select the "Google Campaign Manager 360 API".

4. Press the blue "**Enable**" button to enable the API for your application.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Google%20Campaign%20Manager%20360%20API%20to%20your%20Google%20project.png?maxW=1182&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=73ef474f4278a1b3f86dfa8b123bc070" alt="" width="1182" height="480" data-path="assets/Adding the Google Campaign Manager 360 API to your Google project.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Google%20Campaign%20Manager%20360%20API%20to%20your%20Google%20project.png?w=280&maxW=1182&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a8dfb8c4e6e97b34909b2dbf3d6cd9be 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Google%20Campaign%20Manager%20360%20API%20to%20your%20Google%20project.png?w=560&maxW=1182&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=957e64c60d37f4c694250be2b20ec1b6 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Google%20Campaign%20Manager%20360%20API%20to%20your%20Google%20project.png?w=840&maxW=1182&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=e623a6a0758a3cd5dbef06c9294e1ab8 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Google%20Campaign%20Manager%20360%20API%20to%20your%20Google%20project.png?w=1100&maxW=1182&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a8fa2923acdaf6104b364a7a1202863a 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Google%20Campaign%20Manager%20360%20API%20to%20your%20Google%20project.png?w=1650&maxW=1182&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=15b3ad0dfb95458cc1f6309675903060 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Google%20Campaign%20Manager%20360%20API%20to%20your%20Google%20project.png?w=2500&maxW=1182&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=864d3d27debef6effdaabccb6529fa37 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Google app to Paragon

1. Select **Google Campaign Manager 360** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Google Campaign Manager 360 > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/google-campaign-manager-360#1-add-the-redirect-url-to-your-google-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com) They should begin with `sheets`.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5790675cf1c75ebfbcaf8425e83a022e" alt="" width="1764" height="1106" data-path="assets/Connecting a new Google app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=280&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b24271f5a6c15048b6892d2200aa1b42 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=560&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f78acb99ac7869f09bcbc0a073386745 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=840&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c14a7c6c75c8b0bd7e926629fc40e7c1 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=57d4d7a0218c8007f67a99684730d216 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8707dc94bd895f01269e9fd9656b4054 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e53cae7f5a05ff7a7dd2ce512ccc5287 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Google Campaign Manager 360

Once your users have connected their Google Campaign Manager 360 account, you can use the Paragon SDK to access the Google Campaign Manager 360 API on behalf of connected users.

See the Google Campaign Manager 360 [REST API documentation](https://developers.google.com/doubleclick-advertisers/rest/v3.5) for their full API reference.

Any Google Campaign Manager 360 API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// List accounts 
await paragon.request("googlecampaignmanager", "/userprofiles/{profileId}/accounts", { 
  method: "GET"
});
  
  
// Create ad
await paragon.request("googlecampaignmanager", "/userprofiles/{profileId}/ads", { 
  method: "POST",
  body: { 
    "accountId": <some-account-id>,
    "active": false,
    "advertiserId":  <some-advertiser-id>,
    "campaignId":  <some-campaign-id>,
    "endTime": new Date("2021-01-02").toISOString(),
    "startTime": new Date("2021-01-02").toISOString(),
    "name": "Ad name"
  } 
});
  
```

## Building Google Campaign Manager 360 **workflows**

Once your Google Campaign Manager 360 account is connected, you can add steps to perform the following actions:

* Create Ad
* Update Ad
* Get Ads
* Get Ad by ID
* Get Advertisers
* Get Advertiser by ID
* Create Campaign
* Update Campaign
* Get Campaigns
* Get Campaign by ID
* Create Creative
* Update Creative
* Get Creatives
* Get Creative by ID
* Create Creative Asset
* Create Campaign Creative Association
* Get Campaign Creative Association
* Create Creative Groups
* Update Creative Groups
* Get Creative Groups
* Get Creative Group by ID
* Create Placement
* Update Placement
* Get Placements
* Get Placement by ID
* Get Video Formats
* Get Video Formats by ID

You can also use the [Google Campaign Manager 360 Request](/workflows/requests#making-integration-requests) step to access any of Google Campaign Manager 360's API endpoints without the authentication piece.

When creating or getting ads in Google Campaign Manager 360, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Publishing your Google Campaign Manager 360 application

### Setting up a Redirect Page in your app

Your Google Campaign Manager 360 integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

* Receives a `GET` request with a number of query parameters.
* Redirect to `https://passport.useparagon.com/oauth` with the same query parameters.

```js
paragon.connect("googlecampaignmanager", {
  overrideRedirectUrl: "https://your-app.url/google-campaign-manager-redirect"
});
```

### Updating the allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your Google Campaign Manager 360 Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and select your application.

2. Navigate to **APIs & Services > Credentials** and select the credentials you use with Paragon.

3. Under **Authorized redirect URIs**, provide the URL of your Redirect Page.


# Google Drive
Source: https://docs.useparagon.com/resources/integrations/google-drive

Connect to your users' Google Drive accounts.

## Setup Guide

You can find your Google app credentials by visiting your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project).

You'll need the following information to set up your Google App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Warning>
  Google Applications using scopes that permit access to certain user data must complete a verification process. [Read more](https://developers.google.com/identity/protocols/oauth2/scopes) about Google's various API scopes and procceses to verify your usage.
</Warning>

### Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Credentials** in the sidebar.

3. Press "**+ Create Credentials**", then select **OAuth client ID.**

4. Select "**Web application**" from the Application type drop-down menu.

<Info>
  **Note:** You'll need to configure Google's [consent screen](https://console.developers.google.com/apis/credentials) for access to **Client ID** and **Client Secret** if you haven't already.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1b9e06d58c0af9526d0717455bc7dfc2" alt="" width="1100" height="460" data-path="assets/Selecting Web Application in Google OAuth.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=280&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d51c0e8d2d42614976e477a9b406d05b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=560&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c586cfd9cb3101d95570703e4b9b4391 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=840&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ebd57b6af69773d922a982aba16b46d6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1100&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e79d58d62443ff5f84ff36188eef2431 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1650&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=25f8bcba040605492dc96066d8d7585d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=2500&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91bc9b710bd18e32c729785db0e68123 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Under **Authorized redirect URIs**, press the "**+ Add URI**" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "**Create**" button.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b920a76168a769c9a052eca8d97cb24" alt="" width="548" height="257" data-path="assets/Connect - Adding Google redirect URI for OAuth.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=280&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=080738ea9c75f4c982bc6fb64d217666 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=560&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5b09543fbb14db3fab8d0b8abeddadfb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=840&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f7c189919cdc9d0718954f1f154d992e 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1100&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3067bf209ba4185136976ab859009c09 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1650&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=52a3cd30df1425f5c2fa866c9df03643 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=2500&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e8e336914fc3971c7ea2c13710efe849 2500w" data-optimize="true" data-opv="2" />
</Frame>

Google provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Enable Google Drive API in Google Cloud Console Dashboard

1. In your [Google Cloud Console dashboard,](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) navigate to **APIs & Services > Library** in the sidebar.

2. Search for "**Google Drive API**" from the API Library.

3. Select the "**Google Drive API**".

4. Press the blue "**Enable**" button to enable the API for your application.

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Drive%20API.png?maxW=1318&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=7b199fff12d6d653b1ac53b159519842" alt="" width="1318" height="474" data-path="assets/Enabling Google Drive API.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Drive%20API.png?w=280&maxW=1318&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=fdbb0f8bee1fce5d64cf34b340c77b8d 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Drive%20API.png?w=560&maxW=1318&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=2501931b003f42e7ce43690f99646aee 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Drive%20API.png?w=840&maxW=1318&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=189a132ee52d1fee47b0984738b348e6 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Drive%20API.png?w=1100&maxW=1318&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=2af4bd04de72cc0f3387dfb94c93d31b 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Drive%20API.png?w=1650&maxW=1318&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=715e2a363129ce49c0f4a3c3ab2694ab 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Drive%20API.png?w=2500&maxW=1318&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=73156ba0ab8cc4ba40b2dde64434cae2 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Google app to Paragon

1. Select **Google Drive** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Google Drive > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/google-drive#1-add-the-redirect-url-to-your-google-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com) They should begin with `drive`.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5790675cf1c75ebfbcaf8425e83a022e" alt="" width="1764" height="1106" data-path="assets/Connecting a new Google app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=280&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b24271f5a6c15048b6892d2200aa1b42 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=560&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f78acb99ac7869f09bcbc0a073386745 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=840&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c14a7c6c75c8b0bd7e926629fc40e7c1 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=57d4d7a0218c8007f67a99684730d216 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8707dc94bd895f01269e9fd9656b4054 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e53cae7f5a05ff7a7dd2ce512ccc5287 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Google Drive

Once your users have connected their Google Drive account, you can use the Paragon SDK to access the Google Drive API on behalf of connected users.

See the Google Drive [REST API documentation](https://developers.google.com/drive/api/v3/reference) for their full API reference.

Any Google Drive API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Query Files
await paragon.request("googledrive", `/files?q=${
  encodeURIComponent('name="test"')
}`, {
  method: "GET"
});
```

## Building Google Drive workflows

Once your Google Drive account is connected, you can add steps to perform the following actions:

* Get File Metadata
* Upload File
* Download Google Doc
* Create Folder
* Delete Folder
* Get Folder by ID
* Move Folder
* Get Files
* Search Folders

You can also use the [Google Drive Request](/workflows/requests#making-integration-requests) step to access any of Google Drive's API endpoints without the authentication piece.

When saving or getting files in Google Drive, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Google Drive account. For example, you might want to trigger a workflow whenever new files are created in Google Drive to sync your users' Google Drive files to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Drive%20Triggers%20in%20Paragon%20Connect.png?maxW=1004&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=f81ed0c5e2c12cd3c9d3528a00faeba3" alt="" width="1004" height="618" data-path="assets/Google Drive Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Drive%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=1004&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=5d85d3b34875b60e88fc7a64b0186dd0 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Drive%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=1004&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=cd9793d9f10e747a6730d48ba26001ec 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Drive%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=1004&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=4b159aacb9e7997d48535ec363db183a 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Drive%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=1004&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9890606dd969b7252efd955269e00bf8 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Drive%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=1004&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1765b2177d70eea22d80ef0559d21291 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Drive%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=1004&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7a735d267b75f72970d1ba2e34e8f484 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Google Drive below:

* **File Created**
* **File Updated**
* **File Deleted**

## Using the Google Drive File Picker

You can allow your user to select files from their Google Drive account in your app with the Paragon SDK.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-10-18%20at%2011.47.47.gif?maxW=800&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=bb1cf4e8da3db79afa85140d5006ac0e" alt="" width="563" width="800" height="614" data-path="assets/CleanShot 2023-10-18 at 11.47.47.gif" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-10-18%20at%2011.47.47.gif?w=280&maxW=800&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=cbbb11307d4a829b2548ebd7ae2a9021 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-10-18%20at%2011.47.47.gif?w=560&maxW=800&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=6b8d71a03dcdc631f086be46fddfa0a3 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-10-18%20at%2011.47.47.gif?w=840&maxW=800&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=4fd9cb3d55d1a0ec43ee4a81cc4b7348 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-10-18%20at%2011.47.47.gif?w=1100&maxW=800&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f792ae39334ebe437c1ea67687372731 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-10-18%20at%2011.47.47.gif?w=1650&maxW=800&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=6454256b75dfe6d6b324fadb3779cffb 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-10-18%20at%2011.47.47.gif?w=2500&maxW=800&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=76883819f926a4a339d9407eb4865c42 2500w" data-optimize="true" data-opv="2" />
</Frame>

**Enable the Google Picker API**

You will need to enable the Google Picker API for your application in order to access the File Picker.

1. In your [Google Cloud Console dashboard,](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) navigate to **APIs & Services > Library** in the sidebar for your app.

2. Search for "**Google Picker API**" from the API Library.

3. Select the "**Google Picker API**" and press the blue "**Enable**" button to enable the API for your application.

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Picker%20API%20for%20a%20Google%20Drive%20integraiton%20for%20Paragon%20Connect.png?maxW=1384&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=fd4cdb2e5e66716adeae017550561088" alt="" width="1384" height="506" data-path="assets/Enabling the Google Picker API for a Google Drive integraiton for Paragon Connect.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Picker%20API%20for%20a%20Google%20Drive%20integraiton%20for%20Paragon%20Connect.png?w=280&maxW=1384&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=5c1030b9ab0f5dc1b4068b1d10f099c2 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Picker%20API%20for%20a%20Google%20Drive%20integraiton%20for%20Paragon%20Connect.png?w=560&maxW=1384&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=439b1a558ec34942695620d888b6f611 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Picker%20API%20for%20a%20Google%20Drive%20integraiton%20for%20Paragon%20Connect.png?w=840&maxW=1384&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=ce8739d3b18a92730ab5ccb42b93b420 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Picker%20API%20for%20a%20Google%20Drive%20integraiton%20for%20Paragon%20Connect.png?w=1100&maxW=1384&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=66df0c3a01a0fa02e23d22cedb7f07d7 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Picker%20API%20for%20a%20Google%20Drive%20integraiton%20for%20Paragon%20Connect.png?w=1650&maxW=1384&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=c06d8d05866b5d793962d86266337172 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Picker%20API%20for%20a%20Google%20Drive%20integraiton%20for%20Paragon%20Connect.png?w=2500&maxW=1384&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=cfadab6c93e2fb9e8f487dcb6c216225 2500w" data-optimize="true" data-opv="2" />
</Frame>

**Creating a Google Drive API Key**

To show the Google Drive File Picker, you will need a **Google Drive API Key**. This key is a separate key from the Client ID you provided to Paragon during integration setup.

1. Navigate to [Google Cloud Console > APIs & Services > Credentials](https://console.cloud.google.com/apis/credentials). Make sure the selected project in the header is your app.

2. Click **Create Credentials** and select **API key**.

3. An API key value will appear. Copy this value to use in [Showing the File Picker](#showing-the-file-picker).

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/credentials_APIs_Services_example_Google_Cloud_console.png?maxW=2304&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=88ae7bc982bbc39d8f2bba643bb8b3b6" alt="" width="2304" height="804" data-path="assets/credentials_APIs_Services_example_Google_Cloud_console.png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/credentials_APIs_Services_example_Google_Cloud_console.png?w=280&maxW=2304&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=19fac49d09e250c89d2f33850fb9a066 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/credentials_APIs_Services_example_Google_Cloud_console.png?w=560&maxW=2304&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=9eac396ca980d12073590bab8ac33969 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/credentials_APIs_Services_example_Google_Cloud_console.png?w=840&maxW=2304&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=575cc71a4b449c4a267985d5a272393a 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/credentials_APIs_Services_example_Google_Cloud_console.png?w=1100&maxW=2304&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=a5eac0ad10cfe91ed3d05c3c8ff8ba51 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/credentials_APIs_Services_example_Google_Cloud_console.png?w=1650&maxW=2304&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=bc1fcaedd18d02155f2e1aff78e7842e 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/credentials_APIs_Services_example_Google_Cloud_console.png?w=2500&maxW=2304&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=47532ee12e21a77461f586706f984224 2500w" data-optimize="true" data-opv="2" />
</Frame>

**Note**: While the API Key value is not sensitive and can safely be used in your public application, we recommend restricting the API Key with the following settings:

* Application restrictions: Websites with your origin/domain
* API restrictions: Google Drive API

[Read more](https://cloud.google.com/docs/authentication/api-keys#api_key_restrictions) in Google's docs for API Key restrictions.

#### Showing the File Picker

Use the Paragon SDK in your frontend application to show the File Picker in your app.

The SDK provides an `ExternalFilePicker` class to load Google's JavaScript into your page and authenticate with your user's connected Google Drive account.

To initialize the picker you will need your Google Drive API key and your Google Cloud project number. The Google Cloud project number is a unique, numerical identifier for your project. You can find it within the Google Cloud Console from the sidebar navigation under [**IAM & Admin section > Settings**](https://console.cloud.google.com/iam-admin/settings).

```js
let picker = new paragon.ExternalFilePicker("googledrive", {
    onFileSelect: (files) => {
        // Handle file selection
    }
});

// Loads external dependencies and user's access token
await picker.init({ developerKey: "YOUR_GOOGLE_API_KEY", "appId": "YOUR_GOOGLE_PROJECT_NUMBER" });

// Open the File Picker
picker.open();
```

You can configure the File Picker to listen for additional callbacks or to restrict allowed file types. Learn more about configuring File Picker options in the [SDK Reference](/apis/api-reference#externalfilepicker).

#### Downloading the Selected File

The Google File Picker callback will return a `Response` object describing the user's file picker interaction including an array of any files selected. Using this array of `fileIds`, you can use the [Proxy API](/apis/proxy) to perform an authenticated proxy requests to download the files.

**Note:** Files containing binary content, including photos and videos, should be downloaded using the `files.get` endpoint whereas Google Workspace Documents can be downloaded using `files.export.`

<CodeGroup>
  ```javascript Downloadable files, e.g. images, videos, PDFs
  // Downloading a non-Google Workspace File like images and videos
  await paragon.request('googledrive', '/files/<fileId>?alt=media', {
  	method: 'GET'
  });
  ```

  ```javascript Google Workspace files, e.g. Google Docs, Slides, Sheets
  // Exports a Google Workspace document to the requested MIME type
  await paragon.request('googledrive', '/files/<fileId>/export?mimeType=<supportedMimeType>/pdf', {
  	method: 'GET'
  });
  ```

  ```plain REST API
  POST https://proxy.useparagon.com/projects/19d...012/sdk/proxy/googledrive/files/<fileId>/export?mimeType=<supportedMimeType>/pdf

  Authorization: Bearer eyJ...
  Content-Type: application/json
  ```
</CodeGroup>

## Publishing your Google Drive app

**Required for publishing**: In order to complete the Google application verification process, you must implement the following feature in your integration:

* [Setting up Redirect Pages](/resources/integrations/google-drive#setting-up-a-redirect-page-in-your-app)

For more information, see [Google's documentation on validation requirements](https://support.google.com/cloud/answer/13463073).

### Setting up a Redirect Page in your app

<Frame>
  <iframe width="768" height="432" src="https://www.youtube.com/embed/W8OGUn4ye3E" title="[Tutorial] Implementing the Google Redirect Page install flow with Paragon" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen />
</Frame>

Your Google Drive integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

* Able to receive a `GET` request with a number of query parameters.
* Redirect to `https://passport.useparagon.com/oauth` with the same query parameters.

```js
paragon.connect("googledrive", {
  overrideRedirectUrl: "https://your-app.url/google-drive-redirect"
});
```

### Updating the allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your Google Drive Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and select your application.

2. Navigate to **APIs & Services > Credentials** and select the credentials you use with Paragon.

3. Under **Authorized redirect URIs**, provide the URL of your Redirect Page.


# Google Search Console
Source: https://docs.useparagon.com/resources/integrations/google-search-console

Connect to your users' Google Search Console accounts.

## Setup Guide

You can find your Google app credentials by visiting your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project).

You'll need the following information to set up your Google App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Warning>
  Google Applications using scopes that permit access to certain user data must complete a verification process. [Read more](https://developers.google.com/identity/protocols/oauth2/scopes) about Google's various API scopes and procceses to verify your usage.
</Warning>

### Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Credentials** in the sidebar.

3. Press "**+ Create Credentials**", then select **OAuth client ID.**

4. Select "**Web application**" from the Application type drop-down menu.

<Info>
  **Note:** You'll need to configure Google's [consent screen](https://console.developers.google.com/apis/credentials) for access to **Client ID** and **Client Secret** if you haven't already.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1b9e06d58c0af9526d0717455bc7dfc2" alt="" width="1100" height="460" data-path="assets/Selecting Web Application in Google OAuth.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=280&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d51c0e8d2d42614976e477a9b406d05b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=560&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c586cfd9cb3101d95570703e4b9b4391 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=840&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ebd57b6af69773d922a982aba16b46d6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1100&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e79d58d62443ff5f84ff36188eef2431 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1650&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=25f8bcba040605492dc96066d8d7585d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=2500&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91bc9b710bd18e32c729785db0e68123 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Under **Authorized redirect URIs**, press the "**+ Add URI**" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "**Create**" button.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b920a76168a769c9a052eca8d97cb24" alt="" width="548" height="257" data-path="assets/Connect - Adding Google redirect URI for OAuth.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=280&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=080738ea9c75f4c982bc6fb64d217666 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=560&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5b09543fbb14db3fab8d0b8abeddadfb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=840&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f7c189919cdc9d0718954f1f154d992e 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1100&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3067bf209ba4185136976ab859009c09 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1650&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=52a3cd30df1425f5c2fa866c9df03643 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=2500&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e8e336914fc3971c7ea2c13710efe849 2500w" data-optimize="true" data-opv="2" />
</Frame>

Google provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Enable Google Campaign Manager 360 API in Google Cloud Console Dashboard

1. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Library** in the sidebar.

2. Search for "Google Search Console" from the API Library.

3. Select the "Google Campaign Manager 360 API".

4. Press the blue "**Enable**" button to enable the API for your application.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Search%20Console%20in%20Google%20Cloud%20Platform.png?maxW=1230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=8dec9f73345d547118d807927e92995b" alt="" width="1230" height="478" data-path="assets/Google Search Console in Google Cloud Platform.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Search%20Console%20in%20Google%20Cloud%20Platform.png?w=280&maxW=1230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7644b1e84872a902d153374bc3b1cb1d 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Search%20Console%20in%20Google%20Cloud%20Platform.png?w=560&maxW=1230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0aa5857928acc600bb9c332e65e66c94 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Search%20Console%20in%20Google%20Cloud%20Platform.png?w=840&maxW=1230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=92c2ea286f5fff4ed8733dcdfd8a52b7 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Search%20Console%20in%20Google%20Cloud%20Platform.png?w=1100&maxW=1230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=a3eb0499a59fcb612c52ab6d07b53ee3 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Search%20Console%20in%20Google%20Cloud%20Platform.png?w=1650&maxW=1230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0ee2a5f08f22fd61e1fa875afc1198da 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Google%20Search%20Console%20in%20Google%20Cloud%20Platform.png?w=2500&maxW=1230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=901154b74a1f69b737d0c2fb615a2092 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Google app to Paragon

1. Select **Google Search Console** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Google Search Console > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/google-search-console#1-add-the-redirect-url-to-your-google-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com) They should contain `/auth/`.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5790675cf1c75ebfbcaf8425e83a022e" alt="" width="1764" height="1106" data-path="assets/Connecting a new Google app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=280&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b24271f5a6c15048b6892d2200aa1b42 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=560&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f78acb99ac7869f09bcbc0a073386745 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=840&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c14a7c6c75c8b0bd7e926629fc40e7c1 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=57d4d7a0218c8007f67a99684730d216 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8707dc94bd895f01269e9fd9656b4054 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e53cae7f5a05ff7a7dd2ce512ccc5287 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Google Search Console

Once your users have connected their Google Search Console account, you can use the Paragon SDK to access the Google Search Console API on behalf of connected users.

See the Google Search Console [REST API documentation](https://developers.google.com/webmaster-tools/v1/api_reference_index) for their full API reference.

Any Google Search Console API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get top 10 search queries, sorted by click count, descending
await paragon.request(
  "googlesearchconsole",
  "/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query",
  {
    method: "POST",
    body: {
      startDate: "<Start Date>",
      endDate: "<End Date>",
      dimensions: ['query'],
      rowLimit: 10
    }
  }
});
  
// Get top 10 pages, sorted by click count, descending
await paragon.request(
  "googlesearchconsole",
  "/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query",
  {
    method: "POST",
    body: {
      startDate: "<Start Date>",
      endDate: "<End Date>",
      dimensions: ['page'],
      rowLimit: 10
    }
  }
);
  
```

## Building Google Search Console workflows

Once your Google Search Console account is connected, you can add steps to perform the following actions:

* Query Search Data
* Inspect Index Info for URL
* Get All Sites
* Create Site

You can also use the [Google Search Console Request](/workflows/requests#making-integration-requests) step to access any of Google Search Console's API endpoints without the authentication piece.

When creating or getting sites in Google Search Console, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Google%20Search%20Console%20workflow%20in%20Paragon%20Connect.png?maxW=2182&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7727f38885d03b6e8a8bdfb31a6b97c7" alt="" width="2182" height="1308" data-path="assets/Creating a Google Search Console workflow in Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Google%20Search%20Console%20workflow%20in%20Paragon%20Connect.png?w=280&maxW=2182&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=9334faac6bf2e698495ad576e62e5eac 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Google%20Search%20Console%20workflow%20in%20Paragon%20Connect.png?w=560&maxW=2182&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=8aa71e265782d1fb58d086c0b45399c8 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Google%20Search%20Console%20workflow%20in%20Paragon%20Connect.png?w=840&maxW=2182&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=0b6e0f9818a9fbb8b17eed94a8bb45f1 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Google%20Search%20Console%20workflow%20in%20Paragon%20Connect.png?w=1100&maxW=2182&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6d5e97bf6fb6d567c302133fe08ef4be 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Google%20Search%20Console%20workflow%20in%20Paragon%20Connect.png?w=1650&maxW=2182&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=5796e4e464a269746bc2f32c29d377c9 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Google%20Search%20Console%20workflow%20in%20Paragon%20Connect.png?w=2500&maxW=2182&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=43b81eabc831ece2d682348a72068949 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Publishing your Google Search Console application

### Setting up a Redirect Page in your app

Your Google Search Console integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

* Receives a `GET` request with a number of query parameters.
* Redirect to `https://passport.useparagon.com/oauth` with the same query parameters.

```js
paragon.connect("googlesearchconsole", {
  overrideRedirectUrl: "https://your-app.url/google-search-console-redirect"
});
```

### Updating the allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your Google Search Console Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and select your application.

2. Navigate to **APIs & Services > Credentials** and select the credentials you use with Paragon.

3. Under **Authorized redirect URIs**, provide the URL of your Redirect Page.


# Google Sheets
Source: https://docs.useparagon.com/resources/integrations/google-sheets

Connect to your users' Google Sheets accounts.

## Setup Guide

You can find your Google app credentials by visiting your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project).

You'll need the following information to set up your Google App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Warning>
  Google Applications using scopes that permit access to certain user data must complete a verification process. [Read more](https://developers.google.com/identity/protocols/oauth2/scopes) about Google's various API scopes and procceses to verify your usage.
</Warning>

### Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Credentials** in the sidebar.

3. Press "**+ Create Credentials**", then select **OAuth client ID.**

4. Select "**Web application**" from the Application type drop-down menu.

<Info>
  **Note:** You'll need to configure Google's [consent screen](https://console.developers.google.com/apis/credentials) for access to **Client ID** and **Client Secret** if you haven't already.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1b9e06d58c0af9526d0717455bc7dfc2" alt="" width="1100" height="460" data-path="assets/Selecting Web Application in Google OAuth.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=280&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d51c0e8d2d42614976e477a9b406d05b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=560&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c586cfd9cb3101d95570703e4b9b4391 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=840&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ebd57b6af69773d922a982aba16b46d6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1100&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e79d58d62443ff5f84ff36188eef2431 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1650&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=25f8bcba040605492dc96066d8d7585d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=2500&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91bc9b710bd18e32c729785db0e68123 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Under **Authorized redirect URIs**, press the "**+ Add URI**" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "**Create**" button.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b920a76168a769c9a052eca8d97cb24" alt="" width="548" height="257" data-path="assets/Connect - Adding Google redirect URI for OAuth.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=280&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=080738ea9c75f4c982bc6fb64d217666 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=560&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5b09543fbb14db3fab8d0b8abeddadfb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=840&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f7c189919cdc9d0718954f1f154d992e 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1100&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3067bf209ba4185136976ab859009c09 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1650&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=52a3cd30df1425f5c2fa866c9df03643 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=2500&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e8e336914fc3971c7ea2c13710efe849 2500w" data-optimize="true" data-opv="2" />
</Frame>

Google provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Enable Google Sheets API in Google Cloud Console Dashboard

1. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Library** in the sidebar.

2. Search for "Google Sheets API" from the API Library.

3. Select the "Google Sheets API".

4. Press the blue "**Enable**" button to enable the API for your application.

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Sheets%20API.png?maxW=1328&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=914aea137034e21c5ffd10f8d9aa7fad" alt="" width="1328" height="526" data-path="assets/Enabling Google Sheets API.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Sheets%20API.png?w=280&maxW=1328&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=5c0bbe8dd2a00f702a90774f328d4969 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Sheets%20API.png?w=560&maxW=1328&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=2292de5e734deeb176609b2e8e77b1bf 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Sheets%20API.png?w=840&maxW=1328&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=8d0b98d0a16d47a8e35df62b470a1fc4 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Sheets%20API.png?w=1100&maxW=1328&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=73547b1236652aed4e070ad094620051 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Sheets%20API.png?w=1650&maxW=1328&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=9f6b7fb360909e9a16e57a7f043faa2f 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Sheets%20API.png?w=2500&maxW=1328&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=5342239f2ea8a99b5076b3e234dba971 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Google app to Paragon

1. Select **Google Sheets** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Google Sheets > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/google-sheets#1-add-the-redirect-url-to-your-google-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com) They should begin with `sheets`.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5790675cf1c75ebfbcaf8425e83a022e" alt="" width="1764" height="1106" data-path="assets/Connecting a new Google app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=280&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b24271f5a6c15048b6892d2200aa1b42 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=560&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f78acb99ac7869f09bcbc0a073386745 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=840&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c14a7c6c75c8b0bd7e926629fc40e7c1 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=57d4d7a0218c8007f67a99684730d216 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8707dc94bd895f01269e9fd9656b4054 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20new%20Google%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1764&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e53cae7f5a05ff7a7dd2ce512ccc5287 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Google Sheets

Once your users have connected their Google Sheets account, you can use the Paragon SDK to access the Google Sheets API on behalf of connected users.

See the Google Sheets [REST API documentation](https://developers.google.com/sheets/api/reference/rest) for their full API reference.

Any Google Sheets API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get SpreadSheet 
await paragon.request("googlesheets", "/spreadsheets/{spreadsheetId}", { 
    method: "GET",
});
  
  
// Query SpreadSheet data
await paragon.request("googlesheets", "/spreadsheets/{spreadsheetId}/values/{range}", { 
    method: "GET",
});
  
```

## Building Google Sheets workflows

Once your Google Sheets account is connected, you can add steps to perform the following actions:

* Get Rows from Spreadsheet
* Create Row in Spreadsheet
* Update Row in Spreadsheet

You can also use the [Google Sheets Request](/workflows/requests#making-integration-requests) step to access any of Google Sheets's API endpoints without the authentication piece.

When saving or getting files in Google Sheets, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Google Sheets account. For example, you might want to trigger a workflow whenever new files are created in Google Sheets to sync your users' Google Sheets files to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screenshot%202023-08-30%20at%2011.26.43%20AM.png?maxW=2058&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=0d5a1c8d200dad2a02f50eea29097a44" alt="" width="2058" height="1166" data-path="assets/Screenshot 2023-08-30 at 11.26.43 AM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screenshot%202023-08-30%20at%2011.26.43%20AM.png?w=280&maxW=2058&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1af2ee81d21ffc4120c60a336af81277 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screenshot%202023-08-30%20at%2011.26.43%20AM.png?w=560&maxW=2058&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c7b1f01ab36186bf95e93c5459e02b19 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screenshot%202023-08-30%20at%2011.26.43%20AM.png?w=840&maxW=2058&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f9cb33c7f6d43bd84c7bc21f10b46b92 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screenshot%202023-08-30%20at%2011.26.43%20AM.png?w=1100&maxW=2058&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=6b146a2b8513271119fbcda2d82a288f 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screenshot%202023-08-30%20at%2011.26.43%20AM.png?w=1650&maxW=2058&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=7e272cb6a1127f20e713b9bf8de7da0e 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screenshot%202023-08-30%20at%2011.26.43%20AM.png?w=2500&maxW=2058&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=b48db87d64f459e914cf50a02516782c 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Google Sheets below:

* **File Created**
* **File Updated**

## Publishing your Google Sheets application

### Setting up a Redirect Page in your app

Your Google Sheets integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

* Receives a `GET` request with a number of query parameters.
* Redirect to `https://passport.useparagon.com/oauth` with the same query parameters.

```js
paragon.connect("googlesheets", {
  overrideRedirectUrl: "https://your-app.url/google-sheets-redirect"
});
```

### Updating the allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your Google Sheets Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and select your application.

2. Navigate to **APIs & Services > Credentials** and select the credentials you use with Paragon.

3. Under **Authorized redirect URIs**, provide the URL of your Redirect Page.


# Google Ads
Source: https://docs.useparagon.com/resources/integrations/googleads

Connect to your users' Google Ads accounts.

## Setup Guide

You can find your Google app credentials by visiting your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and your [Google Ads manager](https://ads.google.com/home/tools/manager-accounts/) account.

You'll need the following information to set up your Google App with Paragon Connect:

* Client ID
* Client Secret
* Google Ads Developer Token
* Scopes Requested

<Warning>
  Google Applications using scopes that permit access to certain user data must complete a verification process. [Read more](https://developers.google.com/identity/protocols/oauth2/scopes) about Google's various API scopes and procceses to verify your usage.
</Warning>

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Credentials** in the sidebar.

3. Press "**+ Create Credentials**", then select **OAuth client ID.**

4. Select "**Web application**" from the Application type drop-down menu.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1b9e06d58c0af9526d0717455bc7dfc2" alt="" width="1100" height="460" data-path="assets/Selecting Web Application in Google OAuth.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=280&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d51c0e8d2d42614976e477a9b406d05b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=560&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c586cfd9cb3101d95570703e4b9b4391 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=840&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ebd57b6af69773d922a982aba16b46d6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1100&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e79d58d62443ff5f84ff36188eef2431 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1650&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=25f8bcba040605492dc96066d8d7585d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=2500&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91bc9b710bd18e32c729785db0e68123 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Info>
  **Note:** You'll need to configure Google's [consent screen](https://console.developers.google.com/apis/credentials) for access to **Client ID** and **Client Secret** if you haven't already.
</Info>

5. Under **Authorized redirect URIs**, press the "**+ Add URI**" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "**Create**" button.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b920a76168a769c9a052eca8d97cb24" alt="" width="548" height="257" data-path="assets/Connect - Adding Google redirect URI for OAuth.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=280&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=080738ea9c75f4c982bc6fb64d217666 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=560&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5b09543fbb14db3fab8d0b8abeddadfb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=840&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f7c189919cdc9d0718954f1f154d992e 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1100&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3067bf209ba4185136976ab859009c09 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1650&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=52a3cd30df1425f5c2fa866c9df03643 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=2500&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e8e336914fc3971c7ea2c13710efe849 2500w" data-optimize="true" data-opv="2" />
</Frame>

Google provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Enable Google Ads API in Google Cloud Console Dashboard

1. In your Google Cloud Console dashboard, navigate to **APIs & Services > Library** in the sidebar.

2. Search for "Google Ads API" from the API Library.

3. Select the "Google Ads API".

4. Press the blue "**Enable**" button to enable the API for your application.

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Ads%20API%20for%20Paragon%20Connect.png?maxW=1230&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=4ed5e6adb91b618f0c5592a0683fb060" alt="" width="1230" height="434" data-path="assets/Enabling the Google Ads API for Paragon Connect.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Ads%20API%20for%20Paragon%20Connect.png?w=280&maxW=1230&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=d1697081100b7a3a397772105706e7d1 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Ads%20API%20for%20Paragon%20Connect.png?w=560&maxW=1230&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=632a5d1ea0091c26d6faf5b137d24d81 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Ads%20API%20for%20Paragon%20Connect.png?w=840&maxW=1230&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=311ac7a85efa25f6678766f03fa15b94 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Ads%20API%20for%20Paragon%20Connect.png?w=1100&maxW=1230&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=8e0b99677f8d70415c23ae9b004c5a97 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Ads%20API%20for%20Paragon%20Connect.png?w=1650&maxW=1230&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=c118b3ea46d5e769afdc88e257d665d3 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Ads%20API%20for%20Paragon%20Connect.png?w=2500&maxW=1230&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=1acbd9986e288bc5ad92aaa9f186b9d6 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Obtain a Google Ads Developer Token in Google Ads Manager Account

A Google Ads Developer Token is required to use the Google Ads API. This token serves as an identifier for your app when accessing the Google Ads API, and must be applied for within your [Google Ads Manager account](https://ads.google.com/home/tools/manager-accounts/).

* For initial testing, you may receive a Test Developer Token that allows API requests in a sandbox environment.
* For production use, you’ll need to get your Developer Token approved by Google. Once approved, it can be used to make real API calls.

Navigate to your [Google Ads Manager account](https://ads.google.com/home/tools/manager-accounts/) and search for the **API Center.** Here you can begin the process to request a Developer Token. [For more information, refer to the Google Ads API docs here.](https://developers.google.com/google-ads/api/docs/get-started/dev-token)

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-03%20at%2010.06.12@2x.png?maxW=1904&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c5b7736c4236ebfaaa31af3ef1036026" alt="" width="1904" height="676" data-path="assets/CleanShot 2024-10-03 at 10.06.12@2x.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-03%20at%2010.06.12@2x.png?w=280&maxW=1904&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=746e4c0c0a249bae3962b2136ae95efa 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-03%20at%2010.06.12@2x.png?w=560&maxW=1904&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c8beb493d856ed5fab5e04760c936619 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-03%20at%2010.06.12@2x.png?w=840&maxW=1904&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=eafdeaa47186bd5751f36e987fa8d56c 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-03%20at%2010.06.12@2x.png?w=1100&maxW=1904&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5dd89a36cce9e9e47202042c4b5f0580 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-03%20at%2010.06.12@2x.png?w=1650&maxW=1904&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=cd1985dc9d13ef0f247b961f3d91260a 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-03%20at%2010.06.12@2x.png?w=2500&maxW=1904&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=4a14a0995f230f97cf2c2e60400a2345 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Google app to Paragon

1. Select **Google Ads** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Google Ads > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/googleads#add-the-redirect-url-to-your-google-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.
* **Developer Token**: Found at the end of the previous step.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Credentials%20for%20Google%20Ads.png?maxW=801&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=29f49ca7ed5fc3003588180fbaf0df90" alt="" width="801" height="628" data-path="assets/Adding Credentials for Google Ads.png" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Credentials%20for%20Google%20Ads.png?w=280&maxW=801&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=1f47c15744bb5772a3fbc4fc72447a83 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Credentials%20for%20Google%20Ads.png?w=560&maxW=801&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=ef0f2873c42ffd0b400e16b382b95433 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Credentials%20for%20Google%20Ads.png?w=840&maxW=801&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=c702f625c9f6909185c6b15389dcba8b 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Credentials%20for%20Google%20Ads.png?w=1100&maxW=801&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=01286a111d1072fc19fb9271e2b4813d 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Credentials%20for%20Google%20Ads.png?w=1650&maxW=801&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=da580089e50f54c7a19435a6d3887929 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Credentials%20for%20Google%20Ads.png?w=2500&maxW=801&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=3009ac4e1dfae1a6c10b1b05f2bf5af9 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Google Ads

Once your users have connected their Google Ads account, you can use the Paragon SDK to access the Google Ads API on behalf of connected users.

See the Google Ads [REST API documentation](https://developers.google.com/google-ads/api/reference/rpc/v11/overview) for their full API reference.

Any Google Ads API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Fetch Campaign Data
paragon.request("googleads", "/customers/<Customer ID>/campaigns/<Campaign ID>", {
  method: "GET"
});

// Create a campaign with an existing Campaign Budget
paragon.request("googleads", "/customers/<Customer ID>/campaignBudgets:mutate", {
  method: "POST",
  body: {
    status: 'PAUSED',
    advertisingChannelType: 'SEARCH',
    geoTargetTypeSetting: {
      positiveGeoTargetType: 'PRESENCE_OR_INTEREST',
      negativeGeoTargetType: 'PRESENCE_OR_INTEREST'
    },
    name: 'My Search campaign',
    campaignBudget: 'customers/<Customer ID>/campaignBudgets/<Budget ID>',
    targetSpend: {}
  }
});
  
```

## Building Google Ads workflows

Once your Google Ads account is connected, you use the [Google Ads Request](/workflows/requests#making-integration-requests) step to access any of Google Ads's API endpoints without the authentication piece.

When creating or updating records in Google Ads, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Publishing your Google Ads application

### Setting up a Redirect Page in your app

Your Google Ads integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

* Receives a `GET` request with a number of query parameters.
* Redirect to `https://passport.useparagon.com/oauth` with the same query parameters.

```js
paragon.connect("googleads", {
  overrideRedirectUrl: "https://your-app.url/google-drive-redirect"
});
```

### Updating the allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your Google Ads Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and select your application.

2. Navigate to **APIs & Services > Credentials** and select the credentials you use with Paragon.

3. Under **Authorized redirect URIs**, provide the URL of your Redirect Page.


# Google Analytics GA4
Source: https://docs.useparagon.com/resources/integrations/googleanalyticsga4

Connect to your users' Google Analytics GA4 accounts.

## Setup Guide

You can find your Google app credentials by visiting your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project).

You'll need the following information to set up your Google App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Warning>
  Google Applications using scopes that permit access to certain user data must complete a verification process. [Read more](https://developers.google.com/identity/protocols/oauth2/scopes) about Google's various API scopes and procceses to verify your usage.
</Warning>

### Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Credentials** in the sidebar.

3. Press "**+ Create Credentials**", then select **OAuth client ID.**

4. Select "**Web application**" from the Application type drop-down menu.

<Info>
  **Note:** You'll need to configure Google's [consent screen](https://console.developers.google.com/apis/credentials) for access to **Client ID** and **Client Secret** if you haven't already.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1b9e06d58c0af9526d0717455bc7dfc2" alt="" width="1100" height="460" data-path="assets/Selecting Web Application in Google OAuth.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=280&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d51c0e8d2d42614976e477a9b406d05b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=560&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c586cfd9cb3101d95570703e4b9b4391 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=840&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ebd57b6af69773d922a982aba16b46d6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1100&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e79d58d62443ff5f84ff36188eef2431 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1650&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=25f8bcba040605492dc96066d8d7585d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=2500&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91bc9b710bd18e32c729785db0e68123 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Under **Authorized redirect URIs**, press the "**+ Add URI**" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "**Create**" button.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b920a76168a769c9a052eca8d97cb24" alt="" width="548" height="257" data-path="assets/Connect - Adding Google redirect URI for OAuth.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=280&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=080738ea9c75f4c982bc6fb64d217666 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=560&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5b09543fbb14db3fab8d0b8abeddadfb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=840&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f7c189919cdc9d0718954f1f154d992e 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1100&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3067bf209ba4185136976ab859009c09 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1650&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=52a3cd30df1425f5c2fa866c9df03643 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=2500&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e8e336914fc3971c7ea2c13710efe849 2500w" data-optimize="true" data-opv="2" />
</Frame>

Google provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Enable Google Analytics API in Google Cloud Console Dashboard

1. In your Google Cloud Console dashboard, navigate to **APIs & Services > Library** in the sidebar.

2. Search for "Google Analytics Data API" from the API Library.

3. Select the "Google Analytics Data API".

4. Press the blue "**Enable**" button to enable the API for your application.

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Analytics%20Data%20API.png?maxW=490&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=11fec460e7dafa890d66d133e8fb23fe" alt="" width="490" height="215" data-path="assets/Enabling Google Analytics Data API.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Analytics%20Data%20API.png?w=280&maxW=490&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=7f42af419335b8c76db65d83fcf6e4a0 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Analytics%20Data%20API.png?w=560&maxW=490&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=8a628258f57d131085e6def83e990ade 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Analytics%20Data%20API.png?w=840&maxW=490&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=2db0c60ea7084ebf8a2c9aeb86da5b6d 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Analytics%20Data%20API.png?w=1100&maxW=490&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=e5fae7846fb5b492b88786e6b01ebeae 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Analytics%20Data%20API.png?w=1650&maxW=490&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=56091e131be6e8ccb6d56cdc63f3cc2e 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Google%20Analytics%20Data%20API.png?w=2500&maxW=490&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=4482c9606dd046827515b0e5216c6e26 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Google app to Paragon

1. Select **Google Analytics GA4** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Google Analytics GA4 > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/googleanalyticsga4#add-the-redirect-url-to-your-google-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com) They should begin with `analytics`.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Analytics%20GA4%20app%20to%20Paragon%20Connect.png?maxW=978&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=9eaeda96ed3c5dd7317a34772035e66a" alt="" width="978" height="688" data-path="assets/Connecting your Google Analytics GA4 app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Analytics%20GA4%20app%20to%20Paragon%20Connect.png?w=280&maxW=978&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=8f610f916c221b726c149e9531bd7c44 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Analytics%20GA4%20app%20to%20Paragon%20Connect.png?w=560&maxW=978&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b0030b624da13054f444c9208a6c1da2 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Analytics%20GA4%20app%20to%20Paragon%20Connect.png?w=840&maxW=978&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c60b7fa43ad5b0a7dab0352f1dce05fd 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Analytics%20GA4%20app%20to%20Paragon%20Connect.png?w=1100&maxW=978&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2f367b47063ad4362dca99461bf10c57 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Analytics%20GA4%20app%20to%20Paragon%20Connect.png?w=1650&maxW=978&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=9b20496bd5dee433efbfdb8eb6abc1aa 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Analytics%20GA4%20app%20to%20Paragon%20Connect.png?w=2500&maxW=978&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c3cb95c334993b9a0bfb15cd8cea3ec0 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Google Analytics

Once your users have connected their Google Analytics account, you can use the Paragon SDK to access the Google Analytics API on behalf of connected users.

See the Google Analytics [REST API documentation](https://developers.google.com/analytics/devguides/config/mgmt/v3) for their full API reference.

Any Google Analytics API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Generate Realtime Reports in Google Analytics GA4
await paragon.request('googleanalyticsGA4', 'v1beta/properties/propertyId:runRealtimeReport', {
  method: 'POST',
  body: {
    "dimensions": [
        {
          "name": "country"
        }
      ],
      "metrics": [
        {
          "name": "activeUsers"
        }
      ]
    }
});
              
// Get Audience List from Google Analytics GA4
await paragon.request('googleanalyticsGA4', 'v1alpha/properties/propertyID/audienceLists', {
  method: 'GET'
});
```

## Building Google Analytics GA4 workflows

Once your Google Analytics GA4 account is connected, you use the [Google Analytics GA4 Request](/workflows/requests#making-integration-requests) step to access any of Google Analytics GA4 API endpoints without the authentication piece.

When creating or updating records in Google Analytics GA4, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Publishing your Google Analytics GA4 application

### Setting up a Redirect Page in your app

Your Google Analytics GA4 integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

* Receives a `GET` request with a number of query parameters.
* Redirect to `https://passport.useparagon.com/oauth` with the same query parameters.

```js
paragon.connect("googleanalyticsGA4", {
  overrideRedirectUrl: "https://your-app.url/google-analytics-GA4-redirect"
});
```

### Updating the allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your Google Analytics GA4 Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and select your application.

2. Navigate to **APIs & Services > Credentials** and select the credentials you use with Paragon.

3. Under **Authorized redirect URIs**, provide the URL of your Redirect Page.


# Google Docs
Source: https://docs.useparagon.com/resources/integrations/googledocs

Connect to your users' Google Docs accounts.

## Setup Guide

You can find your Google app credentials by visiting your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project).

You'll need the following information to set up your Google App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Warning>
  Google Applications using scopes that permit access to certain user data must complete a verification process. [Read more](https://developers.google.com/identity/protocols/oauth2/scopes) about Google's various API scopes and procceses to verify your usage.
</Warning>

### Add the Redirect URL to your Google app

Paragon provides a redirect URL to send information to your Google app. To add the redirect URL to your Google app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project), navigate to **APIs & Services > Credentials** in the sidebar.

3. Press "**+ Create Credentials**", then select **OAuth client ID.**

4. Select "**Web application**" from the Application type drop-down menu.

<Info>
  **Note:** You'll need to configure Google's [consent screen](https://console.developers.google.com/apis/credentials) for access to **Client ID** and **Client Secret** if you haven't already.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1b9e06d58c0af9526d0717455bc7dfc2" alt="" width="1100" height="460" data-path="assets/Selecting Web Application in Google OAuth.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=280&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d51c0e8d2d42614976e477a9b406d05b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=560&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c586cfd9cb3101d95570703e4b9b4391 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=840&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ebd57b6af69773d922a982aba16b46d6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1100&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e79d58d62443ff5f84ff36188eef2431 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=1650&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=25f8bcba040605492dc96066d8d7585d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20Web%20Application%20in%20Google%20OAuth.png?w=2500&maxW=1100&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91bc9b710bd18e32c729785db0e68123 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Under **Authorized redirect URIs**, press the "**+ Add URI**" button.

6. Paste-in the redirect URL from Paragon.

7. Press the blue "**Create**" button.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b920a76168a769c9a052eca8d97cb24" alt="" width="548" height="257" data-path="assets/Connect - Adding Google redirect URI for OAuth.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=280&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=080738ea9c75f4c982bc6fb64d217666 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=560&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5b09543fbb14db3fab8d0b8abeddadfb 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=840&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f7c189919cdc9d0718954f1f154d992e 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1100&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3067bf209ba4185136976ab859009c09 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=1650&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=52a3cd30df1425f5c2fa866c9df03643 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Adding%20Google%20redirect%20URI%20for%20OAuth.gif?w=2500&maxW=548&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e8e336914fc3971c7ea2c13710efe849 2500w" data-optimize="true" data-opv="2" />
</Frame>

Google provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Enable Google Docs API in Google Cloud Console Dashboard

1. In your [Google Cloud Console dashboard,](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) navigate to **APIs & Services > Library** in the sidebar.

2. Search for "Google Docs API" from the API Library.

3. Select the "Google Docs API".

4. Press the blue "**Enable**" button to enable the API for your application.

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Docs%20API.png?maxW=449&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=949a1349697f1f6300b6485bfc5f36e5" alt="" width="449" height="222" data-path="assets/Enabling the Google Docs API.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Docs%20API.png?w=280&maxW=449&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=42e7db3760335c5c107a905893cafd7e 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Docs%20API.png?w=560&maxW=449&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=bde313e29f39580ff15c977eaff7975a 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Docs%20API.png?w=840&maxW=449&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=ec194f248ae5d4825b9f16339e756646 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Docs%20API.png?w=1100&maxW=449&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=013fcb23adcf9376262d806b33505096 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Docs%20API.png?w=1650&maxW=449&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=acb2a2f6fec15cb1833af36e24d6ec57 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20the%20Google%20Docs%20API.png?w=2500&maxW=449&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=761c66ba35e968f27f7b00282ec1998d 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Google app to Paragon

1. Select **Google Docs** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Google Docs > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/googledocs#setup-guide) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com) They should contain `/documents`.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Docs%20app%20to%20Paragon%20Connect.png?maxW=1048&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=76a38cabc17547c66e74b0b5068b1f83" alt="" width="1048" height="598" data-path="assets/Connecting your Google Docs app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Docs%20app%20to%20Paragon%20Connect.png?w=280&maxW=1048&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=973e32b77303e8ab71327721240a1ce8 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Docs%20app%20to%20Paragon%20Connect.png?w=560&maxW=1048&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=58863aa5f0f6ef745c5e63f268e25382 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Docs%20app%20to%20Paragon%20Connect.png?w=840&maxW=1048&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=d8c840841acc836c8c783da62f140109 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Docs%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1048&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=d2170edb8756b5cfa9cf656d748f0188 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Docs%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1048&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=9ed6b6333982e49bf6431dabcd274cc3 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Google%20Docs%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1048&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f2957c2efad2f5f7f1a20272eff42bbc 2500w" data-optimize="true" data-opv="2" />
</Frame>

Once your users have connected their Google Docs account, you can use the Paragon SDK to access the Google Docs API on behalf of connected users.

See the Google Docs [REST API documentation](https://developers.google.com/docs/api/how-tos/overview) for their full API reference.

Any Google Docs API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get the latest version of the specified document
await paragon.request("googledocs", "/v1/documents/<documentId>", {
  method: "GET"
});

// Create a blank document with the provided title
await paragon.request("googledocs", "/v1/documents", {
  method: "POST",
  body: {
    "title": "My Document",
  }
});
```

## Building Google Docs workflows

Once your Google Docs account is connected, you use the [Google Docs Request](/workflows/requests#making-integration-requests) step to access any of Google Docs' API endpoints without the authentication piece.

When saving or getting files in Google Docs, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Publishing your Google Docs application

### Setting up a Redirect Page in your app

Your Google Docs integration requires a Redirect Page hosted in your application to support verification of your application by Google.

The Redirect Page should be implemented as follows:

* Receives a `GET` request with a number of query parameters.
* Redirect to `https://passport.useparagon.com/oauth` with the same query parameters.

```js
paragon.connect("googledocs", {
  overrideRedirectUrl: "https://your-app.url/google-docs-redirect"
});
```

### Updating the allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your Google Docs Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your [Google Cloud Console dashboard](https://console.cloud.google.com/projectselector2/home/dashboard?supportedpurview=project) and select your application.

2. Navigate to **APIs & Services > Credentials** and select the credentials you use with Paragon.

3. Under **Authorized redirect URIs**, provide the URL of your Redirect Page.


# Greenhouse
Source: https://docs.useparagon.com/resources/integrations/greenhouse

Connect to your users' Greenhouse accounts.

## Setup Guide

You can find your Greenhouse API Key in your [Greenhouse Developer Account.](https://developers.greenhouse.io/harvest.html)

You'll need the following information to set up your Greenhouse App with Paragon Connect:

* Greenhouse API Key

## Connecting to Greenhouse

Once your users have connected their Greenhouse account, you can use the Paragon SDK to access the Greenhouse API on behalf of connected users.

See the Greenhouse [REST API documentation](https://developers.greenhouse.io/harvest.html) for their full API reference.

Any Greenhouse API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Retrieve a single application
paragon.request("greenhouse", "/applications/<ID>", {
  method: "GET"
});

// Create a candidate
paragon.request("greenhouse", "/candidates", {
  method: "POST",
  body: {
    first_name: "John",
    last_name: "Appleseed",
    email_addresses: ["john@appleseed.com"]
  }
});

// List all of an organization's jobs
paragon.request("greenhouse", "/jobs", {
  method: "GET"
});
  
```

## Building Greenhouse workflows

Once your Greenhouse account is connected, you can add steps to perform the following actions:

* Create Application
* Update Application
* Get Application by ID
* Delete Application
* Create Candidate
* Update Candidate
* Get Candidate by ID
* Delete Candidate
* Create Job Opening
* Update Job Opening
* Get Job Opening by ID

You can also use the [Greenhouse Request](/workflows/requests#making-integration-requests) step to access any of Greenhouse's API endpoints without the authentication piece.

When creating or updating records in Greenhouse, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Greenhouse account. For example, you might want to trigger a workflow whenever new jobs are created in Greenhouse to sync your users' Greenhouse jobs to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Greenhouse%20Triggers%20in%20Paragon%20Connect.png?maxW=2220&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=397f09e778d3b6e7984966dfcb84b961" alt="" width="2220" height="1522" data-path="assets/Greenhouse Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Greenhouse%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=2220&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=f32ff322f221ceae289a975ab9ff0ab5 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Greenhouse%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=2220&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9ec5b38744bc802e7336d524adbe4d52 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Greenhouse%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=2220&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=f1e5564c50a67df6714684d9b003085e 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Greenhouse%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=2220&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=d9d4a15e74df4860884138af5cc4f88e 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Greenhouse%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=2220&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=a9beb483e5d460f8ae76af9eaac930b0 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Greenhouse%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=2220&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=057b98a097262565e2e530fa8bd58ed6 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Greenhouse below:

* **Candidate Created**
* **Candidate Updated**
* **Job Created**
* **Job Updated**


# Gusto
Source: https://docs.useparagon.com/resources/integrations/gusto

Connect to your users' Gusto accounts.

## Setup Guide

You can find your Gusto app credentials in your [Gusto Developer Account.](https://docs.gusto.com/app-integrations/reference)

You'll need the following information to set up your Gusto App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your Gusto app to Paragon

Under **Integrations > Connected Integrations > Gusto > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Gusto App page.
* **Client Secret:** Found under Client Secret on your Gusto App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gusto%20app%20to%20Paragon%20Connect.png?maxW=1019&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f647eea14565e0e7b621595ad5ed2c33" alt="" width="1019" height="624" data-path="assets/Connecting your Gusto app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gusto%20app%20to%20Paragon%20Connect.png?w=280&maxW=1019&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=57be9c48b920d4613c5f0b8cd0bd513a 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gusto%20app%20to%20Paragon%20Connect.png?w=560&maxW=1019&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=8117d25588670c123307a1c6dd55788d 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gusto%20app%20to%20Paragon%20Connect.png?w=840&maxW=1019&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=cfecfe044fc35e683528ef606e548c10 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gusto%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1019&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=39658256c2f5dac4db01a3e9593add91 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gusto%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1019&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=6fe2f36b9a3c949657f2ebcafa9c9357 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Gusto%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1019&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a4677ca059e80a339171330834ee9f8d 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Gusto

Once your users have connected their Gusto account, you can use the Paragon SDK to access the Gusto API on behalf of connected users.

See the Gusto [REST API documentation](https://docs.gusto.com/app-integrations/reference) for their full API reference.

Any Gusto API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get a company
await paragon.request("gusto", "/companies/<company_id>", {
  method: "GET"
});

// Create a Company bank account
await paragon.request("gusto", "/companies/<company_id>/bank_accounts", {
  method: "POST",
  body: {
    "routing_number": "115092013",
    "account_type": "Checking",
    "account_number": "9775014007"
  }
});

// Get a Location
await paragon.request("gusto", "/locations/<location_id>", {
  method: "GET"
});
  
```

## Building Gusto workflows

Once your Gusto account is connected, you can add steps to perform the following actions:

* Create Employee
* Update Employee
* Get Employee by ID
* Get Employee Directory

You can also use the [Gusto Request](/workflows/requests#making-integration-requests) step to access any of Gusto's API endpoints without the authentication piece.

When creating or updating records in Gusto, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Heap
Source: https://docs.useparagon.com/resources/integrations/heap

Connect to your users' Heap accounts.

## Setup Guide

You can find your Heap app credentials in your [Heap Developer Account.](https://developers.heap.io/reference/)

You'll need the following information to set up your Heap App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your Heap app to Paragon

Under **Integrations > Connected Integrations >** **Heap** **>** **Settings**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Heap App page.
* **Client Secret:** Found under Client Secret on your Heap App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Heap%20application%20to%20Paragon%20Connect.png?maxW=1996&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=d561aff54b6b3867fe92ad50f0bd3ba8" alt="" width="1996" height="1164" data-path="assets/Connecting your Heap application to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Heap%20application%20to%20Paragon%20Connect.png?w=280&maxW=1996&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ec1a78f6c4d45d9ab3abec392eda5bed 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Heap%20application%20to%20Paragon%20Connect.png?w=560&maxW=1996&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=cff4192cdeaf6f7ca2f7b25d6be87b63 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Heap%20application%20to%20Paragon%20Connect.png?w=840&maxW=1996&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ed19c7924438627377209eff468fb1c7 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Heap%20application%20to%20Paragon%20Connect.png?w=1100&maxW=1996&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=128eed8f625640e41a1eb5705e5f4aa3 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Heap%20application%20to%20Paragon%20Connect.png?w=1650&maxW=1996&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=69077a87ef73d687d419b0f9bcf85d26 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Heap%20application%20to%20Paragon%20Connect.png?w=2500&maxW=1996&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=76e8d0692f54fd79ca465531839ce24c 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Heap

Once your users have connected their Heap account, you can use the Paragon SDK to access the Heap API on behalf of connected users.

See the Heap [REST API documentation](https://developers.heap.io/reference/) for their full API reference.

Any Heap API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Add custom properties to users
paragon.request("heap", "/add_account_properties", {
  method: "POST",
  body: {
    "app_id": "123456789", 
    "account_id": "Fake Company",
    "properties": {
      "is_in_good_standing": "true",
      "revenue_potential": "123456",
      "account_hq": "United Kingdom",
      "subscription": "Monthly"
    }
  }
});

// Send a custom event in Heap
paragon.request("heap", "/track", {
  method: "POST",
  body: {
    "app_id": "11",
    "identity": "alice@example.com",
    "event": "Send Transactional Email",
    "timestamp": "2017-03-10T22:21:56+00:00", 
    "properties": {
      "subject": "Welcome to My App!",
      "variation": "A"
    }
  }
});
```

## Building Heap workflows

Once your Heap account is connected, you use the [Heap Request](/workflows/requests#making-integration-requests) step to access any of Heap's API endpoints without the authentication piece.

When creating or updating records in Heap, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Hive
Source: https://docs.useparagon.com/resources/integrations/hive

Connect to your users' Hive accounts.

## Setup Guide

You can find your Hive API credentials in your [Hive Account](https://hive.com/).

You'll need the following information to set up your Hive App with Paragon Connect:

* API Key
* User ID

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to Hive

Once your users have connected their Hive account, you can use the Paragon SDK to access the Hive API on behalf of connected users.

See the Hive [REST API documentation](https://developers.hive.com/reference/introduction) for their full API reference.

Any Hive API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get all actions in the provided Workspace
paragon.request("hive", "workspaces/<workspaceId>/actions", {
  method: "GET"
});

// Get an action by ID
paragon.request("hive", "actions/<actionId>", {
  method: "GET"
});
  
```

## Building Hive workflows

Once your Hive account is connected, you use the [Hive Request](/workflows/requests#making-integration-requests) step to access any of Hive's API endpoints without the authentication piece.

When creating or updating records in Hive, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# HubSpot
Source: https://docs.useparagon.com/resources/integrations/hubspot

Connect to your users' HubSpot accounts.

## Setup Guide

You can find your HubSpot application credentials by visiting your [HubSpot developer dashboard](https://app.hubspot.com/login?hubs_signup-url=developers.hubspot.com/\&hubs_signup-cta=cta--small).

You'll need the following information to set up your HubSpot App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Prerequisites

* HubSpot Developer Account. You can create one [here](https://app.hubspot.com/signup/developers).
* HubSpot application. Learn more about creating a HubSpot application [here](https://legacydocs.hubspot.com/docs/faq/how-do-i-create-an-app-in-hubspot).

### Add the Redirect URL to your HubSpot app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your HubSpot app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to your [HubSpot developer dashboard](https://developers.hubspot.com/).

3. Click **Manage apps**, then select the app you'd like to connect to Paragon.

4. Under **Auth > Auth settings > Redirect URL**, paste-in Paragon Connect's redirect URL found in Step 1.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Connect%20Redirect%20URL%20to%20a%20HubSpot%20application%20for%20Paragon%20Connect.png?maxW=1739&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=4e175aee4748e6a580b3464c9796c7ba" alt="" width="1739" height="1269" data-path="assets/Adding the Paragon Connect Redirect URL to a HubSpot application for Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Connect%20Redirect%20URL%20to%20a%20HubSpot%20application%20for%20Paragon%20Connect.png?w=280&maxW=1739&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=04292dba2175e111c57a91929ebefc0b 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Connect%20Redirect%20URL%20to%20a%20HubSpot%20application%20for%20Paragon%20Connect.png?w=560&maxW=1739&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=db79f47748e341f930c9a8da574bd029 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Connect%20Redirect%20URL%20to%20a%20HubSpot%20application%20for%20Paragon%20Connect.png?w=840&maxW=1739&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=bb8fe77acbdf6afd9ea56b876e3778fc 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Connect%20Redirect%20URL%20to%20a%20HubSpot%20application%20for%20Paragon%20Connect.png?w=1100&maxW=1739&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=0a3f2c115a2579e2ccf3a4433cac57d1 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Connect%20Redirect%20URL%20to%20a%20HubSpot%20application%20for%20Paragon%20Connect.png?w=1650&maxW=1739&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=d9799ffcbffee034a525ce576418055b 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Paragon%20Connect%20Redirect%20URL%20to%20a%20HubSpot%20application%20for%20Paragon%20Connect.png?w=2500&maxW=1739&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=99472c74c1d3b757ff724465dc60b4f2 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Select any scopes you'd like to use in your application. Note whether the scopes you permit are **required** or **optional** in HubSpot.

<Info>
  **Note:** `crm.schemas.custom.read` is a **required** scope to enable Field Mapping in the Connect Portal.
</Info>

6. Press the **Save** button at the bottom of the page.

HubSpot provides your **Client ID** and **Client Secret** needed for the next step.

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20HubSpot%20Scopes.gif?maxW=1050&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=c6eda2d815e51a9266276a6972b34120" alt="" width="1050" height="344" data-path="assets/Adding HubSpot Scopes.gif" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20HubSpot%20Scopes.gif?w=280&maxW=1050&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=8e3944d7ffc42bd0fe93df9320b56efb 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20HubSpot%20Scopes.gif?w=560&maxW=1050&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=dfd881e90144d692e1af582800bc14a2 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20HubSpot%20Scopes.gif?w=840&maxW=1050&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=e0943d0021f1b4f5bbe6cfbe3581ac42 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20HubSpot%20Scopes.gif?w=1100&maxW=1050&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=5b49ff28937372b47a13d2dadb7fb060 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20HubSpot%20Scopes.gif?w=1650&maxW=1050&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=87308f60e7e36c89a22c5da8497d74b6 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20HubSpot%20Scopes.gif?w=2500&maxW=1050&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=09bbd7ef47fb6adff69e9c1c0c96dc1d 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your HubSpot app to Paragon

1. Select **HubSpot** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > HubSpot >** **Settings**, fill out your credentials from the end of [Step 1](/resources/integrations/hubspot#1-add-the-redirect-url-to-your-hubspot-app) in their respective sections:

* **Client ID:** Found under Auth > Auth settings > Client ID on your HubSpot App page.
* **Client Secret:** Found under Auth > Auth settings > Client secret on your HubSpot App page.
* **Permissions:** Select the required scopes you've indicated as *Required scopes* for your HubSpot application.
* **Optional Scopes**: Select any optional scopes indicated as *Optional scopes* in your HubSpot application.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** The scopes you specify in Paragon should exactly match the scopes you permitted in your HubSpot application page.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/hubspot_scopes.png?maxW=1967&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=11c6308629057b9f3ce96e722376f58e" alt="" width="1967" height="1025" data-path="assets/hubspot_scopes.png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/hubspot_scopes.png?w=280&maxW=1967&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=fd4e3414d7bc3a8535b31a8ca1e2c43b 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/hubspot_scopes.png?w=560&maxW=1967&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=2bd12614d2f408602c04c50b7f49552d 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/hubspot_scopes.png?w=840&maxW=1967&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=d5ee915cd1263291ac9eabb2890bd2ba 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/hubspot_scopes.png?w=1100&maxW=1967&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=8834f89e84f45d26fc9fed95eea9cd73 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/hubspot_scopes.png?w=1650&maxW=1967&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=f9d4ea87df4b899f5ac954f69702334f 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/hubspot_scopes.png?w=2500&maxW=1967&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=61a858867f3f57665ece93fc116d6b78 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to HubSpot

Once your users have connected their HubSpot account, you can use the Paragon SDK to access the HubSpot API on behalf of connected users.

See the HubSpot [REST API documentation](https://developers.hubspot.com/docs/api/overview) for their full API reference.

Any HubSpot API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
             
// List Companies
await paragon.request("hubspot", "/crm/v3/objects/companies", { 
  method: "GET"
});
  
  
// Create Company
await paragon.request("hubspot", "/crm/v3/objects/companies", { 
  method: "POST",
  body: {
    "properties": {
      "city": "Cambridge",
      "domain": "biglytics.net",
      "industry": "Technology",
      "name": "Biglytics",
      "phone": "(877) 929-0687",
      "state": "Massachusetts"
    }
  }
});
    
```

## Building HubSpot workflows

Once your HubSpot account is connected, you can add steps to perform the following actions:

* Create Record
* Update Record
* Get Records
* Get Record by ID
* Search Records
* Delete Record by ID
* Get Contacts by List ID

You can also use the [HubSpot Request](/workflows/requests#making-integration-requests) step to access any of HubSpot's API endpoints without the authentication piece.

When creating or updating records in HubSpot, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20HubSpot%20contacts%20in%20Paragon%20(1).png?maxW=1140&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=b160593134c8c99bdc97ffc3793397ee" alt="" width="1140" height="774" data-path="assets/Creating HubSpot contacts in Paragon (1).png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20HubSpot%20contacts%20in%20Paragon%20(1).png?w=280&maxW=1140&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=cfbcdc893f4378387062537b509c5403 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20HubSpot%20contacts%20in%20Paragon%20(1).png?w=560&maxW=1140&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d09058da7b0367f5c280c4cc2a073828 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20HubSpot%20contacts%20in%20Paragon%20(1).png?w=840&maxW=1140&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=82efd9d1f00e092fa547fef226416c2a 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20HubSpot%20contacts%20in%20Paragon%20(1).png?w=1100&maxW=1140&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=18811995a37b66427658c29f9f39855c 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20HubSpot%20contacts%20in%20Paragon%20(1).png?w=1650&maxW=1140&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=44ddcdc4f9b8d16f52134a4e6a9d5d3a 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20HubSpot%20contacts%20in%20Paragon%20(1).png?w=2500&maxW=1140&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=1373d60b621ca8da327fa2d14b7b6ad7 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Working with HubSpot Custom Objects and Custom Fields

It's common that different HubSpot instances may be configured with different Custom Objects or Custom Fields. Paragon provides the ability for your users to choose their own Custom Object mapping.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20object%20mapping%20for%20HubSpot%20in%20Paragon.png?maxW=1746&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=01b31a6b9993c42e1b7488520ae6a961" alt="" width="1746" height="1634" data-path="assets/Custom object mapping for HubSpot in Paragon.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20object%20mapping%20for%20HubSpot%20in%20Paragon.png?w=280&maxW=1746&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2d55cda8e316adf30ad7bc43b300a554 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20object%20mapping%20for%20HubSpot%20in%20Paragon.png?w=560&maxW=1746&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=4bdc1427e4bf4f767598fdc1540a8df4 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20object%20mapping%20for%20HubSpot%20in%20Paragon.png?w=840&maxW=1746&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=4dc63a05bd9dbc6c9409fc08da8815bd 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20object%20mapping%20for%20HubSpot%20in%20Paragon.png?w=1100&maxW=1746&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=b64a55701151681954fc9c90f2d06a14 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20object%20mapping%20for%20HubSpot%20in%20Paragon.png?w=1650&maxW=1746&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=71c94bc1d36700ffcd18655317780c4c 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Custom%20object%20mapping%20for%20HubSpot%20in%20Paragon.png?w=2500&maxW=1746&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=a68d72283f9482961f779514180cdb70 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Custom Object Mapping

To allow your users to choose their own Custom Object Mapping, add the **Custom Object Mapping** user setting in your Connect Portal Editor. You should give this setting a descriptive user-setting name, for example, if you're mapping contacts from your app to HubSpot, you might call this "Map Contacts to this object".

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20Custom%20Object%20Mapping%20for%20HubSpot%20in%20Paragon.png?maxW=3086&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=cd29f126afd8b6466e13b9dcf6f608fa" alt="" width="3086" height="1628" data-path="assets/Editing Custom Object Mapping for HubSpot in Paragon.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20Custom%20Object%20Mapping%20for%20HubSpot%20in%20Paragon.png?w=280&maxW=3086&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=517c769a71ca3d853b7d8288aa2d59eb 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20Custom%20Object%20Mapping%20for%20HubSpot%20in%20Paragon.png?w=560&maxW=3086&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=72191f019bc0804bceedf776f4c77ba6 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20Custom%20Object%20Mapping%20for%20HubSpot%20in%20Paragon.png?w=840&maxW=3086&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=1bea51ef0021a3a112779ffcc0ddd4de 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20Custom%20Object%20Mapping%20for%20HubSpot%20in%20Paragon.png?w=1100&maxW=3086&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=484a86788da67318370bb650771e3155 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20Custom%20Object%20Mapping%20for%20HubSpot%20in%20Paragon.png?w=1650&maxW=3086&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=f7654970ef4037e78be42759d48354fe 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Editing%20Custom%20Object%20Mapping%20for%20HubSpot%20in%20Paragon.png?w=2500&maxW=3086&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=4b3eb627452b8ebd59af04bd70d53f93 2500w" data-optimize="true" data-opv="2" />
</Frame>

Below, **add a label for each object property that should be mapped from your app to a HubSpot object field**. In our contacts example, you might add labels for "First Name", "Last Name", and "Email".

In your Connect Portal, your users will be prompted to select an object from their HubSpot instance when enabling this workflow. For each of the object properties you labeled, your users will be prompted to select which object field that property should be mapped to.

In the workflow editor, you can now access your user's custom object mapping in the variable menu. For example:

<Frame>
    <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=3b3d5b2ae79a09a53f730b031a85b873" alt="" width="699" height="956" data-path="assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?w=280&maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=11b83660b4560018d5af78ebf0b7cc76 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?w=560&maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=fccf3a2730e7d954a670533915571d93 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?w=840&maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=cec1f7b703219c3e861d15f767565df3 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?w=1100&maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=95b02ac8ceef79b76d02d353c8ab4a81 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?w=1650&maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=1db8b1abc5b19368385ddb2e953c6384 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?w=2500&maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ae1f04d5b8299f63e27c7954d054694e 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' HubSpot account. For example, you might want to trigger a workflow whenever new contacts are created HubSpot to sync your users' HubSpot contacts to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Webhook%20Triggers%20in%20Paragon%20Connect.png?maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=581c36e810c970f75de994dcded36f29" alt="" width="2230" height="1228" data-path="assets/HubSpot Webhook Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=a8688a3d8ecf9c6160036b5938594580 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=93e694869607dc5f3b30c7da6f2e7dc1 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=fd95d4106cfd37ebce3bedc18f0425b9 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=bc03634ad0040ac6ca536db50c298959 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=931cd3833ce2405c4dd45f217a41efa5 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=430670f5b94291862efe7ec87bfbf605 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for HubSpot below:

* **New Record**
* **Record Updated**
* **Record Deleted**
* **Record Deleted for Privacy (GDPR)**

### Add the Target URL to your HubSpot app

Paragon provides a webhook Target URL to subscribe your HubSpot app to events in your users' HubSpot instances. To add the target URL to your HubSpot app:

1. In the Settings tab of your HubSpot integration in Paragon, copy the link under "**Webhook URL".**

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.05.13.png?maxW=949&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=6d070de1346d0b1651eecde473d5ca41" alt="" width="949" height="530" data-path="assets/CleanShot 2024-09-17 at 14.05.13.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.05.13.png?w=280&maxW=949&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=4f736fac164af3dc09642f5a997108fa 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.05.13.png?w=560&maxW=949&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=cfed2596327367a9d5b8f5f9870456e3 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.05.13.png?w=840&maxW=949&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f5e770f3bba60d8570cf462f8e65c18b 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.05.13.png?w=1100&maxW=949&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=fa72a46668f225ca5cbd5e75766ca240 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.05.13.png?w=1650&maxW=949&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=2a4786d4979f3e7052eaf083f42a29f8 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.05.13.png?w=2500&maxW=949&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=4bd4c55e0450a94ed2fe0e46a0984bcb 2500w" data-optimize="true" data-opv="2" />
</Frame>

2. Log in to your [HubSpot App dashboard](https://app.hubspot.com/develope), select your HubSpot developer account, and navigate to your HubSpot app in **Apps.**

3. In your HubSpot App page sidebar, navigate to **Features > Webhooks**.

4. Provide the "**Target URL.**" Paragon will automatically begin listening to events on behalf of your app.

5. Click **Save** at the bottom of the HubSpot App dashboard.

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.04.22.png?maxW=1210&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=7461608ff9103737ea985edfc5efd5e3" alt="" width="1210" height="644" data-path="assets/CleanShot 2024-09-17 at 14.04.22.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.04.22.png?w=280&maxW=1210&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=7bf5370bae46d91e5949cda50ea09d25 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.04.22.png?w=560&maxW=1210&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f49cb102476fbdb328d9f92e07886296 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.04.22.png?w=840&maxW=1210&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=abeef804aec5a58394c9f993b159aef5 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.04.22.png?w=1100&maxW=1210&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3b5143c5c300d851ce2ebb2d8f4e1658 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.04.22.png?w=1650&maxW=1210&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=167a7260dfd327cd6d66b52e0cafb9d8 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-09-17%20at%2014.04.22.png?w=2500&maxW=1210&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=afcc0074d161f94f2321df11fbe39da0 2500w" data-optimize="true" data-opv="2" />
</Frame>

You are now able to **Create subscriptions** against the events you want to subscribe to within HubSpot.


# iManage
Source: https://docs.useparagon.com/resources/integrations/imanage

Connect to your users' iManage accounts.

## Setup Guide

You can find your iManage app credentials in your [iManage Developer Account.](https://docs.imanage.com/cc-help/10.3.2/en/Applications.html)

You'll need the following information to set up your iManage App with Paragon Connect:

* Client Key
* Client Secret
* Scopes Requested

### Add your iManage app to Paragon

Under **Integrations > Connected Integrations > iManage > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client Key:** Found under Client Key on your iManage App page.
* **Client Secret:** Found under Client Secret on your iManage App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20iManage%20app%20to%20Paragon%20Connect.png?maxW=1920&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ee7353521fd76f971c76f5a7014e23d5" alt="" width="1920" height="1138" data-path="assets/Connecting your iManage app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20iManage%20app%20to%20Paragon%20Connect.png?w=280&maxW=1920&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=1521c042f0d5ebb81f591f38fe567491 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20iManage%20app%20to%20Paragon%20Connect.png?w=560&maxW=1920&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=81592584df04f05c903e8d1e7db5fea8 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20iManage%20app%20to%20Paragon%20Connect.png?w=840&maxW=1920&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=471e2f7e261c50632e485d60a050ac93 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20iManage%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1920&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=20d1fae3e654e937cec58d22d70a94b3 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20iManage%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1920&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=23ec6eaa6cc7106f6abe03434b29ef14 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20iManage%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1920&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ab8f03adaf5f4a9c3b002cc3f39d2727 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to iManage

Once your users have connected their iManage account, you can use the Paragon SDK to access the iManage API on behalf of connected users.

See the iManage [REST API documentation](https://docs.imanage.com/cc-help/10.3.2/en/Applications.html) for their full API reference.

Any iManage API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get library folders
paragon.request("imanage", "/work/api/v2/customers/{customerId}/libraries/{libraryId}/folders", {
  method: "GET"
});

// Create a library folder
paragon.request("imanage", "/customers/{customerId}/libraries/{libraryId}/folders/{folderId}/subfolders", {
  method: "POST",
  body: {
    "name": "Employee Agreements",
    "default_security": "inherit",
    "description": "Contract documents",
    "profile": {
      "custom1": "001",
      "custom1_description": "Microsoft"
    },
    "group_trustees": [],
    "user_trustees": [
      {
        "id": "CPIERCE",
        "access_level": "read_write"
      }
    ]
  }
});
  
```

## Building iManage workflows

Once your iManage account is connected, you use the [iManage Request](/workflows/requests#making-integration-requests) step to access any of iManage's API endpoints without the authentication piece.

When creating or updating records in iManage, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Insightly
Source: https://docs.useparagon.com/resources/integrations/insightly

Connect to your users' Insightly accounts.

## Setup Guide

You can find your Insightly app credentials in your [Insightly Developer Account.](https://api.insightly.com/v3.1/Help#!/Overview/Introduction)

You'll need the following information to set up your Insightly App with Paragon Connect:

* API Key
* Instance Pod

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to Insightly

Once your users have connected their Insightly account, you can use the Paragon SDK to access the Insightly API on behalf of connected users.

See the Insightly [REST API documentation](https://api.insightly.com/v3.1/Help#!/Overview/Introduction) for their full API reference.

Any Insightly API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create a Contact
await paragon.request("insightly", "/Contacts", {
  method: "POST",
  body: {
    "FIRST_NAME": "John",
    "LAST_NAME": "Doe",
    "EMAIL_ADDRESS": "john.doe@useparagon.com"
  }
});

// Get all Leads
await paragon.request("insightly", "/Leads", {
  method: "GET"
});

// Get all Opportunities
await paragon.request("insightly", "/Opportunities", {
  method: "GET"
});
```

## Building Insightly workflows

Once your Insightly account is connected, you use the [Insightly Request](/workflows/requests#making-integration-requests) step to access any of Insightly's API endpoints without the authentication piece.

When creating or updating records in Insightly, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Intellum
Source: https://docs.useparagon.com/resources/integrations/intellum

Connect to your users' Intellum accounts.

## Setup Guide

You can find your Intellum app credentials in your [Intellum Account](https://www.intellum.com/).

You'll need the following information to set up your Intellum App with Paragon Connect:

* Organization Domain
* Application UID
* Private Key

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to Intellum

Once your users have connected their Intellum account, you can use the Paragon SDK to access the Intellum API on behalf of connected users.

See the Intellum [REST API documentation](https://experience.intellum.com/student/path/643313-intellum-api-v3) for their full API reference.

Any Intellum API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Users
paragon.request("intellum", "/api/v3/users", {
  method: "GET"
});
// Get Enrollments for a particular user ID
paragon.request("intellum", "/api/v3/enrollments?user_id=<User ID>,", {
  method: "GET"
});
  
```

## Building Intellum workflows

Once your Intellum account is connected, you use the [Intellum Request](/workflows/requests#making-integration-requests) step to access any of Intellum's API endpoints without the authentication piece.

When creating or updating records in Intellum, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Intercom
Source: https://docs.useparagon.com/resources/integrations/intercom

Connect to your users' Intercom accounts.

## Setup Guide

<Info>
  **Note:** You'll need to create a new Intercom app if you don't already have one. To access your customer's Intercom data by using OAuth, you'll need to [submit your app for a review](https://developers.intercom.com/building-apps/docs/review-publish-your-app#changing-your-review-or-listing).
</Info>

You can find your Intercom app credentials by visiting your [Intercom Developer Hub](https://developers.intercom.com/).

You'll need the following information to set up your Intercom App with Paragon Connect:

* Client ID
* Client Secret

### Add the Redirect URL to your Intercom app

Paragon provides a redirect URL to send information to your Intercom app. To add the redirect URL to your Intercom app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Intercom developer dashboard](https://developers.intercom.com/), select your application.

3. Under **Configure > Authentication**, click the **Edit** button.

4. Tick the **Use OAuth** option.

5. Under **Redirect URLs**, paste-in Paragon Connect's redirect URL found in Step 1. Click the **Save** button to save your changes.

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Authorizing%20Intercom%20OAuth%20for%20Paragon%20Connect.gif?maxW=625&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=355f80391bdf5334f99cd8ce463c60a2" alt="" width="625" height="224" data-path="assets/Connect - Authorizing Intercom OAuth for Paragon Connect.gif" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Authorizing%20Intercom%20OAuth%20for%20Paragon%20Connect.gif?w=280&maxW=625&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=a6652622c77cadd30873856de26fea43 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Authorizing%20Intercom%20OAuth%20for%20Paragon%20Connect.gif?w=560&maxW=625&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=033cf6d0712ed8129c94879a2714c7f5 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Authorizing%20Intercom%20OAuth%20for%20Paragon%20Connect.gif?w=840&maxW=625&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c4a73b2fbbb49fc2b4926ae00d670357 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Authorizing%20Intercom%20OAuth%20for%20Paragon%20Connect.gif?w=1100&maxW=625&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=0f81bf69e9c2c20aa669c613051338bc 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Authorizing%20Intercom%20OAuth%20for%20Paragon%20Connect.gif?w=1650&maxW=625&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=00da409a88224c96d17441a9e8d1eff7 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connect%20-%20Authorizing%20Intercom%20OAuth%20for%20Paragon%20Connect.gif?w=2500&maxW=625&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=2970d945542c1f971d32b9a8d294ce3c 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Intercom app to Paragon

1. Select Intercom from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Intercom > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/intercom#1-add-the-redirect-url-to-your-intercom-app) in their respective sections:

* **Client ID:** Found under Configure > Basic Information > Client ID on your Intercom app page.
* **Client Secret:** Found under Configure > Basic Information > Client Secret on your Intercom app page.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Intercom%20app%20to%20Paragon%20Connect.png?maxW=1710&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=46b3f3e0b957a069de4229e8d547cc93" alt="" width="1710" height="894" data-path="assets/Connecting your Intercom app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Intercom%20app%20to%20Paragon%20Connect.png?w=280&maxW=1710&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=75e368109669becb90fefdc1ac636e59 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Intercom%20app%20to%20Paragon%20Connect.png?w=560&maxW=1710&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=d26914392a8e3aaaa39f748752e4f56b 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Intercom%20app%20to%20Paragon%20Connect.png?w=840&maxW=1710&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=acfa8c024952e408c497d623b1c77d4e 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Intercom%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1710&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=40e02ca4bf4e07dcfb0ccb863a1122ce 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Intercom%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1710&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=7c71fca35d639c9c135392f44eb0ef80 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Intercom%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1710&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=3affa05a6d8f38f6840058d1996d6305 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Intercom

Once your users have connected their Intercom account, you can use the Paragon SDK to access the Intercom API on behalf of connected users.

See the Intercom [REST API documentation](https://developers.intercom.com/building-apps/docs/rest-apis) for their full API reference.

Any Intercom API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create Contact
await paragon.request("intercom", "/contacts", { 
  method: "POST",
  body: {
    "role": "user",
	  "external_id": "25",
	  "email": "wash@serenity.io",
    "phone": "+1123456789",
    "name": "Hoban Washburn",
    "avatar": "https://example.org/128Wash.jpg",
    "last_seen_at": 1571069751,
    "signed_up_at": 1571069751,
    "owner_id": 127,
    "unsubscribed_from_emails": false,
    "custom_attributes": {
      "paid_subscriber": true,
      "monthly_spend": 155.5,
      "team_mates": 1
    }
  }
});

// Query Contacts
await paragon.request("intercom", "/contacts", { 
  method: "GET"
});
  
```

## Building Intercom workflows

Once your Intercom account is connected, you can add steps to perform the following actions:

* Create Contact
* Update Contact
* Get Contact by ID
* Search Contacts
* Send Message

You can also use the [Intercom Request](/workflows/requests#making-integration-requests) step to access any of Intercom's API endpoints without the authentication piece.

When creating or updating contacts in Intercom, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20lead%20in%20Intercom%20with%20Paragon.png?maxW=1798&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=5fde3b88250348644bd4de679f1a8328" alt="" width="1798" height="1654" data-path="assets/Creating a lead in Intercom with Paragon.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20lead%20in%20Intercom%20with%20Paragon.png?w=280&maxW=1798&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=92996ab407f49538043cb49964803a19 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20lead%20in%20Intercom%20with%20Paragon.png?w=560&maxW=1798&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7a6fb175c544539344119e766dc550b4 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20lead%20in%20Intercom%20with%20Paragon.png?w=840&maxW=1798&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ec0a501db11566f4e798b5103a5c0de2 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20lead%20in%20Intercom%20with%20Paragon.png?w=1100&maxW=1798&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=08364b8bd1ef2688acaef260b2d64387 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20lead%20in%20Intercom%20with%20Paragon.png?w=1650&maxW=1798&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d280303358d9c0b84762d82f6499373b 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20lead%20in%20Intercom%20with%20Paragon.png?w=2500&maxW=1798&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=b55ca0690913841ab8bb3d84de0af43b 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Intercom account. For example, you might want to trigger a workflow whenever new companies are created in Intercom to sync your users' Intercom companies to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Intercom%20Webhook%20Triggers%20in%20Paragon%20Connect.png?maxW=2046&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=a2575a2442ce69f3953a6286f2b33c58" alt="" width="2046" height="1520" data-path="assets/Intercom Webhook Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Intercom%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=2046&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=804b67aeeeb68939f0ffeca3d7533367 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Intercom%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=2046&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=ebebc016fac5dff509a754721e52532e 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Intercom%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=2046&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=2a99963628ab86700c1543bca3f72411 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Intercom%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=2046&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=6fd48cf4947580ba8cd44866678dbd6e 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Intercom%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=2046&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=07238d917eb86a2f0abd8a4cb876f247 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Intercom%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=2046&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=55d1bc54e4c42d12b216862fa1ef7d99 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Intercom below:

* **Contact Created**
* **Contact Updated**
* **Company Created**
* **Company Updated**


# Jira
Source: https://docs.useparagon.com/resources/integrations/jira

Connect to your users' Jira accounts.

## Setup Guide

<Info>
  **Note:** You'll need to create a new Jira app and Jira site if you don't already have one.
</Info>

You can find your Jira app credentials by visiting your [Jira developer portal](https://developer.atlassian.com/apps/).

You'll need the following information to set up your Jira app with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add the Redirect URL to your Jira app

Paragon provides a redirect URL to send information to your Jira app. To add the redirect URL to your Jira app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Jira developer dashboard](https://developer.atlassian.com/apps/), select your application.

3. Under **APIS and Features > OAuth 2.0 (3LO) > Callback URL**, paste-in the Paragon Connect redirect URL found in Step 1.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20your%20JIRA%20application%20and%20callback%20URL.gif?maxW=1220&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=630b298ace89b6fec21ce14eb1a0e8e0" alt="" width="1220" height="420" data-path="assets/Selecting your JIRA application and callback URL.gif" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20your%20JIRA%20application%20and%20callback%20URL.gif?w=280&maxW=1220&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=b8e959791f3653c82db678a76ff539d9 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20your%20JIRA%20application%20and%20callback%20URL.gif?w=560&maxW=1220&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c661c31e15fe5dd1db99c7bf99ad760e 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20your%20JIRA%20application%20and%20callback%20URL.gif?w=840&maxW=1220&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1388e219448a54dd799de1b2a53d8477 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20your%20JIRA%20application%20and%20callback%20URL.gif?w=1100&maxW=1220&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=b99bd3947b6bc514bc2397aa70cfa677 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20your%20JIRA%20application%20and%20callback%20URL.gif?w=1650&maxW=1220&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=4905c15a4b42214e4a31fc206a05a3c7 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Selecting%20your%20JIRA%20application%20and%20callback%20URL.gif?w=2500&maxW=1220&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e76b441dd1447f5ab3bf383d88b68f96 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Jira app to Paragon

1. Select **Jira** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Jira > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/jira#add-the-redirect-url-to-your-jira-app) in their respective sections:

* **Client ID:** Found under App Details > Client ID on your Jira App page.
* **Client Secret:** Found under App Details > Secret on your Jira App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20JIRA%20app%20to%20Paragon%20Connect.png?maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e759b12288b21add30e29507cd892fbe" alt="" width="1730" height="1112" data-path="assets/Connecting your JIRA app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20JIRA%20app%20to%20Paragon%20Connect.png?w=280&maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=7b1c3a193c8f9596b7ed28603cd301ab 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20JIRA%20app%20to%20Paragon%20Connect.png?w=560&maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=bc26d8d04bdd018f6bfdc31bd35aab61 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20JIRA%20app%20to%20Paragon%20Connect.png?w=840&maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=522008d84caf548fe95b81bd4b1319b7 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20JIRA%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=daca42b201645f43218f4f934e90c927 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20JIRA%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b47f52d77b10285a7a9097ae2e2a80d2 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20JIRA%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=877077272eaf4f7eb7cad7eadcde472c 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Jira

Once your users have connected their Jira account, you can use the Paragon SDK to access the Jira API on behalf of connected users.

See the Jira [REST API documentation](https://developer.atlassian.com/server/jira/platform/rest-apis/) for their full API reference.

Any Jira API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Create Issue
await paragon.request("jira", "/rest/api/3/issue", {
  method: "POST",
  body: {
    "fields": {
      "summary": "Main order flow broken",
      "issuetype": { "id": "10003" },
      "project": { "id": "10000" }
    }
  }
});


// Get Issue
await paragon.request("jira", "/rest/api/3/search", { 
  method: "GET",
});
  
```

## Building Jira workflows

Once your Jira account is connected, you can add steps to perform the following actions:

* Create Issue
* Update Issue
* Get Issue
* Search Issues
* Search Issues by JQL Query

You can also use the [Jira Request](/workflows/requests#making-integration-requests) step to access any of Jira's API endpoints without the authentication piece.

When creating or updating cards in Jira, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20JIRA%20Issue%20in%20Paragon.png?maxW=1784&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=bf877baf399a731b191859a7816cf335" alt="" width="1784" height="1530" data-path="assets/Creating a JIRA Issue in Paragon.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20JIRA%20Issue%20in%20Paragon.png?w=280&maxW=1784&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=c9d7fd64550ba6d3cc093ce6b483398b 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20JIRA%20Issue%20in%20Paragon.png?w=560&maxW=1784&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=03a99e03c725b8199bb422f6dff9c362 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20JIRA%20Issue%20in%20Paragon.png?w=840&maxW=1784&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=5e62e4721cc024bc305cf59af0edde2c 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20JIRA%20Issue%20in%20Paragon.png?w=1100&maxW=1784&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=f3bd7bc1a75fc78ce2bee3ac0f58edc9 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20JIRA%20Issue%20in%20Paragon.png?w=1650&maxW=1784&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=b9d7981e6d7aaa21bc1e674c7ccdffc7 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20JIRA%20Issue%20in%20Paragon.png?w=2500&maxW=1784&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=40029739d14b214144787fe1499a577e 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Jira account. For example, you might want to trigger a workflow whenever Issues are updated to sync your users' Jira Issues to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Jira%20Webhook%20Triggers%20in%20Paragon%20Connect.png?maxW=2028&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=73abc65b8d86be19c31e1aa0127287f6" alt="" width="2028" height="1322" data-path="assets/Jira Webhook Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Jira%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=2028&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7e151c5f325dca9dca2f2592f4f45cbe 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Jira%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=2028&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=3bd2bd96d397ee5d8331104fb4c39d9a 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Jira%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=2028&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=60840f726af8c776a76ed019ca1bd7f3 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Jira%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=2028&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=8ea4169055b4d6279de409250c7db8f7 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Jira%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=2028&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1a3292fd3d46209410dd092b82ef218d 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Jira%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=2028&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0965c66fcc1db5a33b2a733c4d15e976 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Jira below:

* **New Issue**
* **Issue Updated**
* **New Comment**
* **Project Created**
* **Project Updated**

<Info>
  In order to use the **Project Created** and **Project Updated** triggers, you will need to add the `manage:jira-configuration` scope to your Jira application.
</Info>


# Keap
Source: https://docs.useparagon.com/resources/integrations/keap

Connect to your users' Keap accounts.

## Setup Guide

You can find your Keap app credentials in your [Keap Developer Account.](https://developer.infusionsoft.com/docs/rest/)

You'll need the following information to set up your Keap App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your Keap app to Paragon

Under **Integrations > Connected Integrations > Keap > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Keap App page.
* **Client Secret:** Found under Client Secret on your Keap App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Keap%20app%20to%20Paragon%20Connect.png?maxW=1828&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=9cc8fd7352fb67b35ca218f2ee985dd2" alt="" width="1828" height="928" data-path="assets/Connecting your Keap app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Keap%20app%20to%20Paragon%20Connect.png?w=280&maxW=1828&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=86343d03d55cfed3ca48e9784f396cd4 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Keap%20app%20to%20Paragon%20Connect.png?w=560&maxW=1828&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b27a0705abe6b3dbe0879d0ec94d156b 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Keap%20app%20to%20Paragon%20Connect.png?w=840&maxW=1828&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ec3a7882ef2200da9c3046c9d10f51e3 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Keap%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1828&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=6499328649df20248b68550776b366b9 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Keap%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1828&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=8b4256b2aa7fac0face148889424f1be 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Keap%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1828&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c9d445767f85f997e01747cab8491436 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Keap

Once your users have connected their Keap account, you can use the Paragon SDK to access the Keap API on behalf of connected users.

See the Keap [REST API documentation](https://developer.infusionsoft.com/docs/rest/) for their full API reference.

Any Keap API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create Company
await paragon.request("keap", "/v1/companies", {
  method: "POST",
  body: {
    "company_name": "string",
    "email_address": "string",
    "notes": "string",
    "opt_in_reason": "string",
    "phone_number": {
      "extension": "string",
      "number": "string",
      "type": "string"
    },
    "website": "string"
  }
});

// List Companies
await paragon.request("keap", "/v1/companies", {
  method: "GET"
});
  
```

## Building Keap workflows

Once your Keap account is connected, you use the [Keap Request](/workflows/requests#making-integration-requests) step to access any of Keap's API endpoints without the authentication piece.

When creating or updating records in Keap, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Klaviyo
Source: https://docs.useparagon.com/resources/integrations/klaviyo

Connect to your users' Klaviyo accounts.

## Setup Guide

You can find your Klaviyo API Keys by visiting your [Klaviyo Account dashboard](https://www.klaviyo.com/account#api-keys-tab).

### Prerequisites

* Klaviyo Account. You can create one [here](https://www.klaviyo.com/).

## Connecting to Klaviyo

Once your users have connected their Klaviyo account, you can use the Paragon SDK to access the Klaviyo API on behalf of connected users.

See the Klaviyo [REST API documentation](https://www.klaviyo.com/docs/api/v2/lists) for their full API reference.

Any Klaviyo API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create List
await paragon.request("klaviyo", "/v2/lists", {
  method: "POST",
  body: { "list_name": "your_list_name" }
});


// Query Lists
await paragon.request("klaviyo", "/v2/lists", {
  method: "GET"
});
```

## Creating your Klaviyo Private API Key

Your end-users will be required to enter their Klaviyo Private API Key as authentication when first connecting to your application.

To create a Klaviyo Private API Key:

1. Login to [Klaviyo Account](https://www.klaviyo.com/account#api-keys-tab).

2. Navigate to **Accounts > App Configuration > Configure > API Keys**, and click the blue "**Create Private API Key**" button.

3. Copy your private API key

4. Paste your private API key to authenticate your account.

## Building Klaviyo workflows

Once your Klaviyo account is connected, you can add steps to perform the following actions:

* Create Campaign
* Get Campaigns
* Send Campaign
* Create List
* Add Subscriber to List
* Remove Subscriber from List
* Get Lists
* Get List Subscribers
* Get Profile
* Update Profile
* Create Template
* Get Templates
* Get Segments
* Get Segment Subscribers

You can also use the [Klaviyo Request](/workflows/requests#making-integration-requests) step to access any of Klaviyo's API endpoints without the authentication piece.

When creating or updating campaigns and lists in Klaviyo, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20new%20subscriber%20to%20Klaviyo%20in%20Paragon%20Connect.png?maxW=1894&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=d294ac0281c358b19217bf34750b91b9" alt="" width="1894" height="1320" data-path="assets/Adding a new subscriber to Klaviyo in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20new%20subscriber%20to%20Klaviyo%20in%20Paragon%20Connect.png?w=280&maxW=1894&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=08029f248b9b2f2b232b185cf6f9b0b7 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20new%20subscriber%20to%20Klaviyo%20in%20Paragon%20Connect.png?w=560&maxW=1894&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=e90239fdd517f98eb08d520b9a96f58d 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20new%20subscriber%20to%20Klaviyo%20in%20Paragon%20Connect.png?w=840&maxW=1894&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f05c36706b6085cba6232af89094edf4 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20new%20subscriber%20to%20Klaviyo%20in%20Paragon%20Connect.png?w=1100&maxW=1894&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=c242c935b3a9bc3430e473762163209b 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20new%20subscriber%20to%20Klaviyo%20in%20Paragon%20Connect.png?w=1650&maxW=1894&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=79397bdbdf0be18edc3bd97cf7ed54a0 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20new%20subscriber%20to%20Klaviyo%20in%20Paragon%20Connect.png?w=2500&maxW=1894&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=54d88f49f8eaf82d375a43670a9dbe99 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Lever
Source: https://docs.useparagon.com/resources/integrations/lever

Connect to your users' Lever accounts.

## Setup Guide

You can find your Lever app credentials in your [Lever Developer Account.](https://hire.lever.co/developer/documentation)

You'll need the following information to set up your Lever App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your Lever app to Paragon

Under **Integrations > Connected Integrations > Lever > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Lever App page.
* **Client Secret:** Found under Client Secret on your Lever App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Lever%20app%20to%20Paragon%20Connect.png?maxW=1948&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b4d4e82280b00a4f6ee2e730d769e0eb" alt="" width="1948" height="1576" data-path="assets/Connecting your Lever app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Lever%20app%20to%20Paragon%20Connect.png?w=280&maxW=1948&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=386557a803bfad7f7887d468635dca41 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Lever%20app%20to%20Paragon%20Connect.png?w=560&maxW=1948&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=09d0dcadcb9c04ae1c478291f7878aa7 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Lever%20app%20to%20Paragon%20Connect.png?w=840&maxW=1948&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=66f3dbcd856e4a55d240d56cb055c9e9 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Lever%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1948&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=3048e9d43598984d1ae5c561cbbb51b2 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Lever%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1948&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=d464b68e0286e609e90670d9d87a8115 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Lever%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1948&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=70be60f4dcfbeb78625b6b67c36a07f1 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Lever

Once your users have connected their Lever account, you can use the Paragon SDK to access the Lever API on behalf of connected users.

See the Lever [REST API documentation](https://hire.lever.co/developer/documentation) for their full API reference.

Any Lever API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Retrieve a single application
paragon.request("lever", "/opportunities/:opportunity/applications/:application", {
  method: "GET"
});

// Retrieve a single opportunity
paragon.request("lever", "/opportunities/:opportunity", {
  method: "GET"
});

// Create an opportunity
paragon.request("lever", "[relative URL]", {
  method: "POST",
  body: {
    "name": "John Appleseed",
    "email": "john@domain.com",
    "phone": "1012223333"
  }
});
  
```

## Building Lever workflows

Once your Lever account is connected, you can add steps to perform the following actions:

* Create an Opportunity
* Get Opportunity by ID
* Get Opportunities
* Update Contact
* Get Contact by ID
* Create a Posting
* Update Posting
* Get Posting by ID
* Get Postings

You can also use the [Lever Request](/workflows/requests#making-integration-requests) step to access any of Lever's API endpoints without the authentication piece.

When creating or updating records in Lever, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Lever account. For example, you might want to trigger a workflow whenever new candidates are created in Lever to sync your users' Lever candidates to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Lever%20Webhook%20Triggers%20in%20Paragon%20Connect.png?maxW=923&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1221f2b88ce1cf6b8eced132adc742d6" alt="" width="923" height="760" data-path="assets/Lever Webhook Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Lever%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=923&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=78783ae4a7a742d273f1b7bede82c46a 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Lever%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=923&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=5dc55d4223d5014496ea8687ea90cdab 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Lever%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=923&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=785a7fdd9486929b9b38c03c45c8521c 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Lever%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=923&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=12be6445d3f888f20633d017ba6ca671 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Lever%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=923&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=3a5b01988775727e2bacf5442bf1f95e 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Lever%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=923&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=704230a28fbab536260913631665a0a6 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Lever below:

* **Candidate Created**
* **Candidate Updated**
* **Posting Created**
* **Posting Updated**


# Linear
Source: https://docs.useparagon.com/resources/integrations/linear

Connect to your users' Linear accounts.

## Setup Guide

You can find your Linear app credentials in your [Linear Developer Account.](https://developers.linear.app/docs/graphql/working-with-the-graphql-api)

You'll need the following information to set up your Linear App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your Linear app to Paragon

Under **Integrations > Connected Integrations > Linear > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Production > Client ID on your Linear App page.
* **Client Secret:** Found under Production > Client Secret on your Linear App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Linear%20app%20to%20Paragon%20Connect.png?maxW=2076&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ecf13af324824108f470d95d36b63f63" alt="" width="2076" height="1186" data-path="assets/Connecting your Linear app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Linear%20app%20to%20Paragon%20Connect.png?w=280&maxW=2076&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=3492b7217908f87c88f3d425e65ab5dc 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Linear%20app%20to%20Paragon%20Connect.png?w=560&maxW=2076&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=bc8a885ebf41e60aed27d0126dc5b3d8 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Linear%20app%20to%20Paragon%20Connect.png?w=840&maxW=2076&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=6891987742ac5aadb3e2a795fa7e6eb2 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Linear%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2076&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=dc7b9a068391acdb09d7b843a831145b 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Linear%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2076&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=8e6d2954d4aff4b7bf0e93b0db586f04 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Linear%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2076&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c12a9e8d1c50605dfc4dbee5b2ec4717 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Linear

Once your users have connected their Linear account, you can use the Paragon SDK to access the Linear API on behalf of connected users.

See the Linear [REST API documentation](https://developers.linear.app/docs/graphql/working-with-the-graphql-api) for their full API reference.

Any Linear API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get all issues associated with a given team ID
paragon.request("linear", "/", {
  method: "POST",
  body: {
    "query": `
      query Team {
      team(id: "<Team ID>") {
        id
        name
    
        issues {
          nodes {
            id
            title
            description
            assignee {
              id
              name
            }
            createdAt
            archivedAt
          }
        }
      }
    }` 
  }
});

// Get an issue by ID
paragon.request("linear", "/", {
  method: "POST",
  body: {
    "query": `query Issue {
      issue(id: "<Issue ID>") {
        id
        title
        description
      }
    }`
  }
});
  
```

## Building Linear workflows

Once your Linear account is connected, you can add steps to perform the following actions:

* Create Issue
* Update Issue
* Get Issue by ID
* Get Issue by Issue Identifier
* Search Issues
* Delete Issue
* Archive Issue
* Create Sub-Issue
* Create Project
* Update Project
* Get Project by ID
* Delete Project
* Search Teams

You can also use the [Linear Request](/workflows/requests#making-integration-requests) step to access any of Linear's API endpoints without the authentication piece.

When creating or updating issues and projects in Linear, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Linear account. For example, you might want to trigger a workflow whenever new issues are created in Linear to sync your users' Linear issues to your application in real-time.

You can find the full list of Webhook Triggers for Linear below:

* Issue Created
* Issue Status Updated
* Label Added or Removed from Issue
* Issue Deleted


# LinkedIn
Source: https://docs.useparagon.com/resources/integrations/linkedin

Connect to your users' LinkedIn accounts.

## Setup Guide

You can find your LinkedIn app credentials in your [LinkedIn Developer Account.](https://learn.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/share-on-linkedin?context=linkedin%2Fconsumer%2Fcontext)

You'll need the following information to set up your LinkedIn App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your LinkedIn app to Paragon

Under **Integrations > Connected Integrations > LinkedIn > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your LinkedIn App page.
* **Client Secret:** Found under Auth > OAuth 2.0 Client Secret on your LinkedIn App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20app%20to%20Paragon%20Connect.png?maxW=1203&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=1e5418c74f0eaafb68d810990147c499" alt="Connecting your LinkedIn app to Paragon Connect" width="1203" height="590" data-path="assets/Connecting your LinkedIn app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20app%20to%20Paragon%20Connect.png?w=280&maxW=1203&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b20b1a20441b29de48e1782a92a3a4e8 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20app%20to%20Paragon%20Connect.png?w=560&maxW=1203&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=4164e9ce0bef8c38f1b3ac8642a1bf5e 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20app%20to%20Paragon%20Connect.png?w=840&maxW=1203&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=008a7bc04020108811ed1739848ecf62 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1203&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=10342c293148a21c2a46cb43c2f09d87 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1203&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=da655481d60840b8decd406e2aa9732d 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1203&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=d0512a0e19333570d9a02cc45203c861 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to LinkedIn

Once your users have connected their LinkedIn account, you can use the Paragon SDK to access the LinkedIn API on behalf of connected users.

See the LinkedIn [REST API documentation](https://learn.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/share-on-linkedin?context=linkedin%2Fconsumer%2Fcontext) for their full API reference.

Any LinkedIn API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create a post on LinkedIn
await paragon.request("linkedin", "/v2/ugcPosts", {
  method: "POST",
  body: {
      "author": "urn:li:organization:5515715",
      "commentary": "Sample text Post",
      "visibility": "PUBLIC",
      "distribution": {
        "feedDistribution": "MAIN_FEED",
        "targetEntities": [],
        "thirdPartyDistributionChannels": []
      },
      "lifecycleState": "PUBLISHED",
      "isReshareDisabledByAuthor": false
    }
});

// Get a profile by ID
await paragon.request("linkedin", "/v2/people/:id", {
  method: "GET",
});  
```

## Building LinkedIn workflows

Once your LinkedIn account is connected, you can add steps to perform the following actions:

* Get Profile by ID
* Create Post

You can also use the [LinkedIn Request](/workflows/requests#making-integration-requests) step to access any of LinkedIn's API endpoints without the authentication piece.

When creating or updating records in LinkedIn, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# LinkedIn Marketing
Source: https://docs.useparagon.com/resources/integrations/linkedinmarketing

Connect to your users' LinkedIn Marketing accounts.

## Setup Guide

You can find your LinkedIn Marketing app credentials in your [LinkedIn Marketing Developer Account.](https://learn.microsoft.com/en-us/linkedin/marketing/integrations/ads/getting-started?view=li-lms-2023-11)

You'll need the following information to set up your LinkedIn Marketing App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your LinkedIn Marketing app to Paragon

Under **Integrations > Connected Integrations > LinkedIn Marketing > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your LinkedIn Marketing App page.
* **Client Secret:** Found under Client Secret on your LinkedIn Marketing App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20Marketing%20app%20to%20Paragon%20Connect.png?maxW=1838&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=de80465bd97e12d309c09edb20c7fa3a" alt="" width="1838" height="1200" data-path="assets/Connecting your LinkedIn Marketing app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20Marketing%20app%20to%20Paragon%20Connect.png?w=280&maxW=1838&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=3b4a96b87a67068722fd82b3cad7770d 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20Marketing%20app%20to%20Paragon%20Connect.png?w=560&maxW=1838&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=6ff725a6a9e20ed608b6cd5efc427896 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20Marketing%20app%20to%20Paragon%20Connect.png?w=840&maxW=1838&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=71f0ef07f9970a937e89855704ec298c 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20Marketing%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1838&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=1078b292b5d0cf199dc1cee767d06e33 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20Marketing%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1838&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=8204ea221b179604ad533c03ed5ad1d8 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20LinkedIn%20Marketing%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1838&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2902acc3d601ff7256278661c4a2349c 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to LinkedIn Marketing

Once your users have connected their LinkedIn Marketing account, you can use the Paragon SDK to access the LinkedIn Marketing API on behalf of connected users.

See the LinkedIn Marketing [REST API documentation](https://learn.microsoft.com/en-us/linkedin/marketing/integrations/ads/getting-started?view=li-lms-2023-11) for their full API reference.

Any LinkedIn Marketing API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Search Campaigns
paragon.request("linkedinmarketing", "/adAccounts/<adAccountId>/adCampaigns?q=search&search=(searchCriteria:(values:List(searchValue)))", {
  method: "GET"
});

// Get Page Statistics
paragon.request("linkedinmarketing", "/organizationPageStatistics?q=organization&organization=<organization URN>", {
  method: "GET"
});
  
```

## Building LinkedIn Marketing workflows

Once your LinkedIn Marketing account is connected, you use the [LinkedIn Marketing Request](/workflows/requests#making-integration-requests) step to access any of LinkedIn Marketing's API endpoints without the authentication piece.

When creating or updating records in LinkedIn Marketing, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Magento
Source: https://docs.useparagon.com/resources/integrations/magento

Connect to your users' Magento accounts.

## Setup Guide

You'll need the following information to set up your Magento App with Paragon Connect:

* Magento Store Domain
* Username
* Password

### Add your Magento app to Paragon

Under **Integrations > Connected Integrations > Magento > App Configuration > Configure**, fill out your credentials from your store in their respective sections:

* **Magento Store Domain**
* **Username**
* **Password**

## Connecting to Magento

Once your users have connected their Magento account, you can use the Paragon SDK to access the Magento API on behalf of connected users.

See the Magento [REST API documentation](https://magento.redoc.ly/2.3.7-admin/) for their full API reference.

Any Magento API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Fetch all products
paragon.request("magento", "/V1/products?searchCriteria=", {
  method: "GET"
});

// Create a customer
paragon.request("magento", "/V1/customers", {
  method: "POST",
  body: {
    "customer": {
      "email": "user@domain.com",
      "firstname": "John",
      "lastname": "Appleseed",
    }
  }
});

// Get order by ID
paragon.request("magento", "/V1/orders/{id}", {
  method: "GET"
});
  
```

## Building Magento workflows

Once your Magento account is connected, you can add steps to perform the following actions:

* Create Customer
* Update Customer
* Get Customer by ID
* Search Customers
* Delete Customer
* Create Order
* Update Order
* Get Order by ID
* Search Orders
* Create Product
* Update Product
* Get Product by SKU
* Search Products
* Delete Product

You can also use the [Magento Request](/workflows/requests#making-integration-requests) step to access any of Magento's API endpoints without the authentication piece.

When creating or updating records in Magento, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Mailchimp
Source: https://docs.useparagon.com/resources/integrations/mailchimp

Connect to your users' Mailchimp accounts.

## Setup Guide

You can find your Mailchimp app credentials by visiting your [Mailchimp Account Settings.](https://mailchimp.com/)

<Info>
  **Note:** You'll need to create a new Mailchimp app if you don't already have one.
</Info>

You'll need the following information to set up your Mailchimp App with Paragon Connect:

* Client ID
* Client Secret

### Add the Redirect URL to your Mailchimp app

Paragon provides a redirect URL to send information to your Mailchimp app. To add the redirect URL to your Mailchimp app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Click your account by selecting the account icon.

3. Select **Account** from the dropdown list.

4. Under **Extras > Registered apps**, select your application or create a new one if you don't already have one.

5. Under **Redirect URI**, paste-in the redirect URL from Paragon. The redirect URL can be found in Step 1.

6. Press the green `Update` button to confirm your changes.

### Add your Mailchimp app to Paragon

1. Select **Mailchimp** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Mailchimp > App Configuration > Configure**, fill out your credentials in their respective sections:

* **Client ID:**

  1. Log in to your [Mailchimp dashboard](https://mailchimp.com/).

  2. Select "**Account"** from the Account dropdown.

  3. Under **Extras > Registered apps**, select your application.

  4. Copy the **Client ID** to use in Paragon Connect.

* **Client Secret:**

  1. Log in to your [Mailchimp dashboard](https://mailchimp.com/).

  2. Click on "**Account**" in the Account dropdown.

  3. Under **Extras > Registered apps**, select your application.

  4. Copy your **Client ID** to use in Paragon Connect.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Mailchimp%20to%20Paragon%20Connect.png?maxW=2198&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=293b94082515e421e2d95e4b24625316" alt="" width="2198" height="886" data-path="assets/Connecting Mailchimp to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Mailchimp%20to%20Paragon%20Connect.png?w=280&maxW=2198&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=25f5a6c96331666a49d1764a46bd2399 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Mailchimp%20to%20Paragon%20Connect.png?w=560&maxW=2198&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=4e56033fed4542332a4e5e921623c7fc 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Mailchimp%20to%20Paragon%20Connect.png?w=840&maxW=2198&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=7345fe068efe8a950a1043fef28e1ce4 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Mailchimp%20to%20Paragon%20Connect.png?w=1100&maxW=2198&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=fd8f93269d6cba0e6c9cb8353b95b8cf 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Mailchimp%20to%20Paragon%20Connect.png?w=1650&maxW=2198&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3ca295281b2d0725493b80b4ddb84080 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Mailchimp%20to%20Paragon%20Connect.png?w=2500&maxW=2198&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=01305a8b4d18cbaa75b5bba381be4f39 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Mailchimp

Once your users have connected their Mailchimp account, you can use the Paragon SDK to access the Mailchimp API on behalf of connected users.

See the Mailchimp [REST API documentation](https://mailchimp.com/developer/marketing/api/lists) for their full API reference.

Any Mailchimp API endpoints can be accessed with the Paragon SDK as shown in this example.

```js JavaScript
// You can find your project ID in the Overview tab of any Integration.

// Authenticate the user
paragon.authenticate(<ProjectID>, <Paragon User Token>);

// Create a List
await paragon.request("mailchimp", "/lists/<List ID>", {
  method: "POST",
  body: {
    "members": [{ email_address: "test@gmail.com" }],
    "update_existing": true
  }
});

// List all Campaigns
await paragon.request("mailchimp", "/campaigns",
  method: “GET”
});
```

## Building Mailchimp workflows

Once your Mailchimp account is connected, you can add steps to perform the following actions:

* Create Campaign
* Update Campaign
* Send Campaign
* Search Campaigns
* Get Campaign by ID
* Delete Campaign by ID
* Create List
* Get List by ID
* Search Lists
* Add Contact to List
* Update Contact in List
* Get Contacts from List

You can also use the [Mailchimp Request](/workflows/requests#making-integration-requests) step to access any of Mailchimp's API endpoints without the authentication piece.

When using Mailchimp, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Mailchimp account. For example, you might want to trigger a workflow whenever new contacts are added to a Mailchimp list to sync your users' Mailchimp contacts to your application in real-time.

You can find the full list of Webhook Triggers for Mailchimp below:

* **Mailchimp Lists**


# Marketo
Source: https://docs.useparagon.com/resources/integrations/marketo

Connect to your users' Marketo accounts.

## Setup Guide

You can find your Marketo application credentials by visiting LaunchPoint in the Admin section of your [Marketo Dashboard](https://www.marketo.com/).

You'll need the following information to set up your Marketo App with Paragon Connect:

* Client ID
* Client Secret
* Endpoint URL
* Identity URL

### Prerequisites

* A Marketo Account. You can create one [here](https://www.marketo.com/).
* A Custom Service. Learn more about creating Custom Services in Marketo [here](https://developers.marketo.com/rest-api/custom-services/).

## Gathering your Credentials

Your end-users will be required to enter their Marketo Client ID, Client Secret, Endpoint URL, and Identity URL as authentication when first connecting to your application.

You can find the credentials for your Marketo account in their respective sections:

* **Client ID:** Found under Admin > Integration > LaunchPoint > View Details > Client Id on your Marketo dashboard.
* **Client Secret:** Found under Admin > Integration > LaunchPoint > View Details > Client Secret on your Marketo dashboard.
* **Endpoint URL:** Found under Admin > Integration > Web Services in the REST API section.
* **Identity URL:** Found under Admin > Integration > Web Services in the REST API section.

Press the blue "**Continue**" button to save your credentials.

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Marketo%20account%20to%20Paragon.png?maxW=793&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=921b82547917a6c1dd54a60d8fd5ab4e" alt="" width="793" height="961" data-path="assets/Connecting your Marketo account to Paragon.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Marketo%20account%20to%20Paragon.png?w=280&maxW=793&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f321fdec3a7c1b8652462900416be67a 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Marketo%20account%20to%20Paragon.png?w=560&maxW=793&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b77df1eca31bddd3bca23de8ffdc0c9b 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Marketo%20account%20to%20Paragon.png?w=840&maxW=793&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=bfb90fa4269fe770963d5373376faad9 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Marketo%20account%20to%20Paragon.png?w=1100&maxW=793&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=96eac49ad6421a19b4e48ca421f7b96d 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Marketo%20account%20to%20Paragon.png?w=1650&maxW=793&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=8ce3b2112307992c5c0a5b191af35ecc 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Marketo%20account%20to%20Paragon.png?w=2500&maxW=793&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=894dc733c40e30891983da6993d85444 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Marketo

Once your users have connected their Marketo account, you can use the Paragon SDK to access the Marketo API on behalf of connected users.

See the Marketo [REST API documentation](https://developers.marketo.com/getting-started/) for their full API reference.

Any Marketo API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Get Leads
await paragon.request("marketo", "leads.json?filterType=id&filterValues=1", {
  method: "GET",
});


// Create a new Lead
await paragon.request("marketo", "leads.json", {
  method: "POST",
  body: { 
      "input": [
        {  
          "email":"kjashaedd-1@klooblept.com",
          "firstName":"Kataldar-1"
        },
      ]
  }
});
```

## Building Marketo workflows

Once your Marketo account is connected, you can add steps to perform the following actions:

* Create or Update Lead
* Get Leads
* Get Lead by ID
* Add Leads to List
* Create Custom Object

You can also use the [Marketo Request](/workflows/requests#making-integration-requests) step to access any of Marketo's API endpoints without the authentication piece.

When creating or updating leads in Marketo, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Marketo%20in%20Paragon.png?maxW=1369&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=9a3542198f29fb393c3735e736eff90e" alt="" width="1369" height="1037" data-path="assets/Using Marketo in Paragon.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Marketo%20in%20Paragon.png?w=280&maxW=1369&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=9a7eae56c9d9f66a0e530d9951633176 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Marketo%20in%20Paragon.png?w=560&maxW=1369&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=53694a8ea8fc4ab6e7c3aabcc55dc217 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Marketo%20in%20Paragon.png?w=840&maxW=1369&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=23f00e57652cc0fc745b5865e07276bf 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Marketo%20in%20Paragon.png?w=1100&maxW=1369&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=a6ee69772d178b15c20de7e11a05915b 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Marketo%20in%20Paragon.png?w=1650&maxW=1369&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=d0e6cd5ac3be0c97fbf5699b1b544a03 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Marketo%20in%20Paragon.png?w=2500&maxW=1369&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=f57125121dfbf9fc64e4df5b630af9e9 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Marketo account. For example, you might want to trigger a workflow whenever new leads are added to a list in Marketo to sync your users' Marketo leads to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Marketo%20Webhook%20Triggers%20in%20Paragon%20Connect.png?maxW=2298&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=e026f55c9929d7569c2963865a58a429" alt="" width="2298" height="1444" data-path="assets/Marketo Webhook Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Marketo%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=2298&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1794328af4da04c52a903e4a2ec6a3f8 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Marketo%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=2298&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=4202e622d2fc85117d257dcab492aad9 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Marketo%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=2298&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=fdd0c42885159ccbd5d5de191a1ba2f6 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Marketo%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=2298&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7a9fb3d5994ec5c2de42def7650bafcd 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Marketo%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=2298&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=d9237476b2c329f2be1b5050eaa63be6 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Marketo%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=2298&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=771b2dd46066a334840fd50ac37ccd18 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Marketo below:

* **Lead Added to a List**


# Microsoft Dynamics 365
Source: https://docs.useparagon.com/resources/integrations/microsoft-dynamics-365

Connect to your users' Microsoft Dynamics 365 accounts.

## Setup Guide

You can find your Microsoft Dynamics 365 application credentials by visiting your Microsoft Azure Portal.

You'll need the following information to set up your Microsoft Dynamics 365 app with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Prerequisites

* A [Microsoft Azure](https://azure.microsoft.com/) account

### Add the Redirect URL to your Microsoft Dynamics 365 app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Microsoft Dynamics 365 app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

3. Navigate to **All Services > App Registrations** and select your application.

4. Select **Authentication** from the sidebar.

5. Under **Platform configurations**, press the **"Add a platform"** button.

6. Select the **Web** platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the **Save** button at the top of the page.

### Generate a Client Secret

Since Microsoft Dynamics 365 does not automatically provide you with a Client Secret for your application, we'll need to make one. To get your Client Secret:

1. Navigate to **Manage > Certificates & secrets** in the sidebar.

2. Under **Client Secrets**, press the **+ New client secret** button.

3. Name your client credentials and select an expiry that works best for your application. Press **Add** to create your credentials.

4. Copy the displayed Client Secret under the **Value** column.

<Info>
  **Note:** You will need to periodically create new and update your Client Secret as they expire for all Microsoft integrations.
</Info>

### Add your Microsoft Dynamics app to Paragon

1. Select **Microsoft Dynamics** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Microsoft Dynamics 365 > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/microsoft-dynamics-365#add-the-redirect-url-to-your-microsoft-dynamics-365-app)in their respective sections:

* **Client ID:** Found under **Essentials > Application (client) ID** on your Microsoft Azure Portal app page.

* **Client Secret:** Found under **Manage > Certificates & secrets** on your Microsoft Azure Portal app page.

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** You should only add the scopes you've requested in your application page to Paragon.
</Info>

## Connecting to Microsoft Dynamics 365

Once your users have connected their Microsoft Dynamics 365 account, you can use the Paragon SDK to access the Microsoft Dynamics 365 API on behalf of connected users.

See the Microsoft Dynamics 365 [REST API documentation](https://docs.microsoft.com/en-us/dynamics365/sales-enterprise/help-hub) for their full API reference.

Any Microsoft Dynamics 365 API endpoints can be accessed with the Paragon SDK as shown in this example:

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Create an Account
await paragon.request("microsoftDynamics", "/accounts", {
  method: "POST",
  body: { "name": "Sample Account" }
});


// Query Accounts by number of employees
await paragon.request("microsoftDynamics", "/accounts?$filter=Microsoft.Dynamics.CRM.Between(PropertyName='numberofemployees',PropertyValues=["5","2000"])”
    method: "GET"
});
```

## Building Microsoft Dynamics 365 workflows

Once your Microsoft Dynamics 365 account is connected, you can add steps to perform the following actions:

* Create Record
* Update Record
* Get Record by ID
* Search Records
* Delete Record by ID

You can also use the [Microsoft Dynamics 365 Request](/workflows/requests#making-integration-requests) step to access any of Microsoft Dynamics 365's API endpoints without the authentication piece.

When creating or updating records in Microsoft Dynamics 365, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Microsoft%20Dynamics%20365%20in%20Paragon.png?maxW=2326&auto=format&n=867oBBVpxd2C3zc4&q=85&s=63351f5482f07edd57255a5a7180da56" alt="" width="2326" height="1324" data-path="assets/Using Microsoft Dynamics 365 in Paragon.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Microsoft%20Dynamics%20365%20in%20Paragon.png?w=280&maxW=2326&auto=format&n=867oBBVpxd2C3zc4&q=85&s=b28caf868b0eaab3c28252d42879dfd4 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Microsoft%20Dynamics%20365%20in%20Paragon.png?w=560&maxW=2326&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9be5deecb5db9a36679a83ee73564e0c 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Microsoft%20Dynamics%20365%20in%20Paragon.png?w=840&maxW=2326&auto=format&n=867oBBVpxd2C3zc4&q=85&s=12d791a03a054f783450e5c06a04f2b3 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Microsoft%20Dynamics%20365%20in%20Paragon.png?w=1100&maxW=2326&auto=format&n=867oBBVpxd2C3zc4&q=85&s=e9e230eebd35afc4d7cb42e168918c9a 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Microsoft%20Dynamics%20365%20in%20Paragon.png?w=1650&maxW=2326&auto=format&n=867oBBVpxd2C3zc4&q=85&s=8030bb6fd23e5b2a869578ccfe33cbd5 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Microsoft%20Dynamics%20365%20in%20Paragon.png?w=2500&maxW=2326&auto=format&n=867oBBVpxd2C3zc4&q=85&s=82d720cd7a6990b074f96183a2199d8d 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Microsoft Dynamics 365 account. For example, you might want to trigger a workflow whenever new accounts are created Microsoft Dynamics 365 to sync your users' Microsoft Dynamics 365 accounts to your application in real-time.

You can find the full list of Webhook Triggers for Microsoft Dynamics 365 below:

* **New Record**
* **Record Updated**


# Microsoft Teams
Source: https://docs.useparagon.com/resources/integrations/microsoft-teams

Connect to your users' Microsoft Teams accounts.

## Setup Guide

You can find your Microsoft Teams application credentials by visiting the [Microsoft Developer Portal for Teams](https://dev.teams.microsoft.com/).

You'll need the following information to set up your Microsoft Teams app with Paragon Connect:

* App ID
* Bot ID
* Bot Client Secret
* Scopes Requested

### Prerequisites

* A [Microsoft Azure](https://azure.microsoft.com/) account
* A bot registered in the Microsoft Developer Portal for Teams (*See* [*Creating a Microsoft Teams bot*](/resources/integrations/microsoft-teams#undefined) *for setup instructions*)

### Creating a Microsoft Teams bot

You will need to create a bot user in the [Microsoft Developer Portal for Teams](https://dev.teams.microsoft.com/) to build your integration.

1. Log in to the Developer Portal for Teams using the same Microsoft account that you use to log in to the Microsoft Azure Portal.

2. Navigate to **Tools** in the sidebar.

3. Select **Bot Management**.

4. Click **New Bot** and provide a name for your bot. *This is not the name that appears to your users*; we recommend appending "(Bot)" to the name for clarity.

Next, you will need to associate this new bot with your Teams application.

1. In the Developer Portal for Teams, navigate to **Apps** in the sidebar.

2. If you do not have a Teams app yet, click **New app** and provide a name. This name will be the one displayed in the Microsoft Teams store and to your users.

   1. In **Basic information**, you will need to minimally provide a short description and URLs for your application's website, Privacy Policy, and Terms of Use.

   2. Click **Save** below.

3. In your Teams app settings, navigate to **App features** (under the **Configure** section).

4. Select **Bot**.

5. Select the bot user you created above.

6. Check any applicable capabilities for your bot user.

7. Click **Save** below.

8. Optionally, upload an icon for your app in **Branding**.

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(12).png?maxW=2458&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=4a0184549c43423708011643c1036533" alt="" width="2458" height="1544" data-path="assets/image (12).png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(12).png?w=280&maxW=2458&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=8fb5e10e1afb51100af407dab597963e 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(12).png?w=560&maxW=2458&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=b3e601d82feef49cc36f93c5a1206112 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(12).png?w=840&maxW=2458&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=beec81a65fd5bd438843a3b359d93cbc 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(12).png?w=1100&maxW=2458&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=2532290e21adf2ce49813c0f057845b0 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(12).png?w=1650&maxW=2458&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=551e2bfaf9522f82a0ef2a4280b2f722 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(12).png?w=2500&maxW=2458&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=8c07a1f2ce2e33ea688b65c4060fe3a8 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### Testing your Microsoft Teams bot

If your application is not yet published to the Microsoft Teams store, you can test your app by uploading your app's package directly into your Teams account.

1. In the [Developer Portal for Teams](https://dev.teams.microsoft.com/), navigate to your list of Apps.

2. Click the triple-dot menu in your app's row and click **Download app package**. Your app's package will be downloaded as a .zip file.

<Frame>
    <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(73).png?maxW=488&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=2473cdfe80b1b9d52cac9503a8438f11" alt="" width="488" height="394" data-path="assets/image (73).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(73).png?w=280&maxW=488&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=85037d7f8281081e92b0bb6ef7fbc20e 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(73).png?w=560&maxW=488&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=8a85d081e10fa94fec7aabf1e3d2dcee 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(73).png?w=840&maxW=488&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=404ffb8f8bd9025241aa72119a8e901e 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(73).png?w=1100&maxW=488&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=56c7d9098f7166c94b7266635ffde78c 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(73).png?w=1650&maxW=488&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=cb9b65739053141b0d884792847b7744 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(73).png?w=2500&maxW=488&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=5bd9c618235754f85ff4cc7a85269def 2500w" data-optimize="true" data-opv="2" />
</Frame>

3. Log in to Microsoft Teams with the account you would like to test your bot in.

4. Click **Apps** in the left sidebar (one of the last options):

<Frame>
    <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(14).png?maxW=58&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=1331721a2dba3ed5684160e407236ffb" alt="" width="58" height="56" data-path="assets/image (14).png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(14).png?w=280&maxW=58&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=fbc6403cc7f0c93675f009228567e50d 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(14).png?w=560&maxW=58&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=a8e925259385ae730285e77ef6a94ff8 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(14).png?w=840&maxW=58&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=fe2d1431184fc7fc5807a8adbd10ef6b 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(14).png?w=1100&maxW=58&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=3ba2e5b0fa3d396aa7cda741d9e2f52e 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(14).png?w=1650&maxW=58&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=bdf4446aedccd06ead1f49847b37e75d 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(14).png?w=2500&maxW=58&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=dbbdaa3d3108c44cb4f8d01e1a9c2e5c 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Click **Manage your apps** (at the bottom of the App categories sidebar).

6. Click **Upload an app** and **Upload your app to your org's app catalog**.

7. Select the .zip file with your app's package. After a successful upload, you will be navigated to the "Built for your org" page.

8. Select the name of your app in the list.

9. Click **Add** and **Add to a team**.

<Frame>
    <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(74).png?maxW=798&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=5cf2e66d2fc6e96c1e41055f6d402d4f" alt="" width="798" height="472" data-path="assets/image (74).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(74).png?w=280&maxW=798&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=8270c1a02e50f969f5869d3b43771c07 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(74).png?w=560&maxW=798&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=1502a2b1c1a9b9c00519f657fa4cff52 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(74).png?w=840&maxW=798&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=78c97fce8277674968681d9340ebca92 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(74).png?w=1100&maxW=798&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=da55db52feff536bed58fd89315b2998 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(74).png?w=1650&maxW=798&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=2d7066f0620809ece8c8bafb53e761f6 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(74).png?w=2500&maxW=798&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=27cd4c844e84e70bfc67e5c6d2a4ec9b 2500w" data-optimize="true" data-opv="2" />
</Frame>

10. Select a team and channel to add your bot.

### Add the Redirect URL to your Microsoft Teams app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Microsoft Teams app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is `https://passport.useparagon.com/oauth`

2. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

3. Navigate to **All Services > App Registrations** and select the app registration *representing your bot, not your Microsoft Teams app*. You can check to make sure that the ID matches the one you selected for your associated bot: *In Developer Portal for Teams > \[Your App] > App Features:*

<Frame>
    <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=0c6a8aea6a50eba233be00cf48cff79a" alt="" width="490" height="194" data-path="assets/image (67).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?w=280&maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=9a946549deb7a2d0e6708670cc0cb5e1 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?w=560&maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=913adfaeeaaa3cf38a0bc8e538a54277 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?w=840&maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=91c5b783a301ff6a5cc32dc555b8b9b0 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?w=1100&maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=68639b839212f9592ac44fe46f50bb21 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?w=1650&maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=93b460dfee12311c774513690787cdef 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?w=2500&maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=58b948f0e131833f15c5297653190a96 2500w" data-optimize="true" data-opv="2" />
</Frame>

4. Select **Authentication** from the sidebar.

5. Under **Platform configurations**, press the **"Add a platform"** button.

6. Select the **Web** platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the **Save** button at the top of the page.

### Generate a Bot Client Secret

Since Microsoft Teams does not automatically provide you with a Bot Client Secret for your application, we'll need to make one. To get your Bot Client Secret:

1. Navigate to **All Services > App Registrations** and select the app registration *representing your bot, not your Microsoft Teams app*. You can check to make sure that the ID matches the one you selected for your associated bot: *In Developer Portal for Teams > \[Your App] > App Features:* <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=0c6a8aea6a50eba233be00cf48cff79a" alt="" width="490" height="194" data-path="assets/image (67).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?w=280&maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=9a946549deb7a2d0e6708670cc0cb5e1 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?w=560&maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=913adfaeeaaa3cf38a0bc8e538a54277 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?w=840&maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=91c5b783a301ff6a5cc32dc555b8b9b0 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?w=1100&maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=68639b839212f9592ac44fe46f50bb21 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?w=1650&maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=93b460dfee12311c774513690787cdef 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(67).png?w=2500&maxW=490&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=58b948f0e131833f15c5297653190a96 2500w" data-optimize="true" data-opv="2" /> *In Azure Portal > App Registrations:* <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(23).png?maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=08d81420ce9c68e13d36af284f3e993d" alt="" width="1146" height="74" data-path="assets/image (23).png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(23).png?w=280&maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=559d90e35bca8d27aae480fba7460298 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(23).png?w=560&maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ca521dcd5180ecfdf42f85cea9e11162 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(23).png?w=840&maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=6665cbc317b46c97067723b5448eea8d 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(23).png?w=1100&maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ed6bddbf8bca736e98d6d4d714cdc650 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(23).png?w=1650&maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=a0106f46b82c9b6d3fa641e0d2f85249 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(23).png?w=2500&maxW=1146&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=dd6a1c5b357e40b8aa560331c56014e6 2500w" data-optimize="true" data-opv="2" />

2. Navigate to **Manage > Certificates & secrets** in the sidebar.

3. Under **Client Secrets**, click the **+ New client secret** button.

4. Name your client credentials and select an expiry that works best for your application. Press **Add** to create your credentials.

5. Copy the displayed Bot Client Secret under the **Value** column.

<Info>
  **Note:** You will need to periodically create new and update your Bot Client Secret as they expire for all Microsoft integrations.
</Info>

### Add your Microsoft Teams app to Paragon

1. Select **Microsoft Teams** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Microsoft Teams > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/microsoft-teams#add-the-redirect-url-to-your-microsoft-teams-app) and [Step 2](/resources/integrations/microsoft-teams#generate-a-client-id-and-client-secret) in their respective sections:

* **App/Manifest ID:** Found in the [Microsoft Developer Portal for Teams](https://dev.teams.microsoft.com/), as the **App ID:**

  <Frame>
      <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(47).png?maxW=862&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=ad47ffcb3aed8a4d8aa988e936e61750" alt="" width="862" height="230" data-path="assets/image (47).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(47).png?w=280&maxW=862&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=7271fed3f27e4b57a42c86f6363fe975 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(47).png?w=560&maxW=862&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=e4aed3d8b10130f96f5c4ea8343e66f6 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(47).png?w=840&maxW=862&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=947da6eeb9ae04ec0bd80b546b62abef 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(47).png?w=1100&maxW=862&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=973cc8e412331780fc8eb7a140422b82 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(47).png?w=1650&maxW=862&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=59ab0dd3c0e9880824aa637779615f3f 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(47).png?w=2500&maxW=862&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6b8c42d84229af92c09b5e19e07c1b81 2500w" data-optimize="true" data-opv="2" />
  </Frame>

* **Bot ID:** Found in the Microsoft Azure Portal, under App registrations > Application (client) ID. This should be the Client ID of the app registration *representing your bot, not your Microsoft Teams app.*

* **Bot Client Secret:** See [Generate a Bot Client Secret](/resources/integrations/microsoft-teams#generate-a-bot-client-secret).

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** You should only add the scopes you've requested in your application page to Paragon.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Teams%20applications%20to%20Paragon%20Connect.png?maxW=1832&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=acffd067e495e1a04f1006be22a71815" alt="" width="1832" height="978" data-path="assets/Connecting your Microsoft Teams applications to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Teams%20applications%20to%20Paragon%20Connect.png?w=280&maxW=1832&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e5b538232ab63a6947ef3a4147f9391f 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Teams%20applications%20to%20Paragon%20Connect.png?w=560&maxW=1832&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=67bfe5daf0d83a5b81e52a77025a03ca 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Teams%20applications%20to%20Paragon%20Connect.png?w=840&maxW=1832&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f86d1de512aaf80361eb37f962eb4d7e 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Teams%20applications%20to%20Paragon%20Connect.png?w=1100&maxW=1832&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=0d735a973f51bd4b0f69510fd8f0a73e 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Teams%20applications%20to%20Paragon%20Connect.png?w=1650&maxW=1832&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=1217f051481ca570d5f5994450cc671e 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Teams%20applications%20to%20Paragon%20Connect.png?w=2500&maxW=1832&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a94808c09a57a72773d98ec544300ffe 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Microsoft Teams

Once your users have connected their Microsoft Teams account, you can use the Paragon SDK to access the Microsoft Teams API on behalf of connected users.

See the Microsoft Teams [REST API documentation](https://docs.microsoft.com/en-us/graph/api/resources/teams-api-overview?view=graph-rest-1.0) for their full API reference.

Any Microsoft Teams API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// List Channels
paragon.request("microsoftTeams", "channels", {
  method: "GET",
});


// Send message in a channel
paragon.request("microsoftTeams", "channels/<channel-id>/messages", {
  method: "POST",
  body: { "content": "Hello World!" }
});
```

## Building Microsoft Teams workflows

Once your Microsoft Teams account is connected, you can add steps to perform the following actions:

* Send Message in Channel
* Send Message in Chat
* Get User by Email

You can also use the [Microsoft Teams Request](/workflows/requests#making-integration-requests) step to access any of Microsoft Teams's API endpoints without the authentication piece.

When creating messages in Microsoft Teams, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20messages%20to%20Microsoft%20Teams%20using%20Paragon%20Connect%20(1).png?maxW=2178&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=b0a5f2f6955bd6c11afac227cfbfe73a" alt="" width="2178" height="1462" data-path="assets/Sending messages to Microsoft Teams using Paragon Connect (1).png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20messages%20to%20Microsoft%20Teams%20using%20Paragon%20Connect%20(1).png?w=280&maxW=2178&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=f20bca63c02504187720aa211f2ee402 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20messages%20to%20Microsoft%20Teams%20using%20Paragon%20Connect%20(1).png?w=560&maxW=2178&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=3b185b1da394d42d19b1bf4112b1c670 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20messages%20to%20Microsoft%20Teams%20using%20Paragon%20Connect%20(1).png?w=840&maxW=2178&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=728933ea25c089d4a0768f3b5c2282a2 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20messages%20to%20Microsoft%20Teams%20using%20Paragon%20Connect%20(1).png?w=1100&maxW=2178&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=f0b56a2d6c0479e81cb9375031abb4a9 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20messages%20to%20Microsoft%20Teams%20using%20Paragon%20Connect%20(1).png?w=1650&maxW=2178&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=58e52805fffc24f40f308fe0b86562c2 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20messages%20to%20Microsoft%20Teams%20using%20Paragon%20Connect%20(1).png?w=2500&maxW=2178&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=76893cd8d5c08a34c516813d22053aed 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Microsoft Teams account. For example, you might want to trigger a workflow whenever new chats are created in Microsoft Teams to sync your users' Microsoft Teams chats to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Teams%20triggers%20in%20Paragon%20Connect.png?maxW=2196&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=509729a67f1df922090ee5fdbd4c4b96" alt="" width="2196" height="1398" data-path="assets/Microsoft Teams triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Teams%20triggers%20in%20Paragon%20Connect.png?w=280&maxW=2196&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=cc6746c3ea9925b6f4903155abbc879a 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Teams%20triggers%20in%20Paragon%20Connect.png?w=560&maxW=2196&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=000774d8210966133f6fe0098fde9503 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Teams%20triggers%20in%20Paragon%20Connect.png?w=840&maxW=2196&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=332e1a2293b35fa7314373b151b958d9 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Teams%20triggers%20in%20Paragon%20Connect.png?w=1100&maxW=2196&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=d398e99452903587805491bc036491f4 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Teams%20triggers%20in%20Paragon%20Connect.png?w=1650&maxW=2196&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=3e08c274f1a22e159957f3c28ac6f3c9 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Teams%20triggers%20in%20Paragon%20Connect.png?w=2500&maxW=2196&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=6664dd103ba4fbeca4027d1a65dc336f 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Microsoft Teams below:

* **Channel Created**
* **Chat Created**
* **Chat Updated**


# Microsoft Excel
Source: https://docs.useparagon.com/resources/integrations/microsoftexcel

Connect to your users' Microsoft Excel accounts.

## Setup Guide

You can find your Microsoft Excel application credentials by visiting your Microsoft Azure Portal.

You'll need the following information to set up your Microsoft Excel app with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Prerequisites

* A [Microsoft Azure](https://azure.microsoft.com/) account

### Add the Redirect URL to your Microsoft Excel app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Microsoft Excel app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

3. Navigate to **All Services > App Registrations** and select your application.

4. Select **Authentication** from the sidebar.

5. Under **Platform configurations**, press the **"Add a platform"** button.

6. Select the **Web** platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the **Save** button at the top of the page.

### Generate a Client Secret

Since Microsoft Excel does not automatically provide you with a Client Secret for your application, we'll need to make one. To get your Client Secret:

1. Navigate to **Manage > Certificates & secrets** in the sidebar.

2. Under **Client Secrets**, press the **+ New client secret** button.

3. Name your client credentials and select an expiry that works best for your application. Press **Add** to create your credentials.

4. Copy the displayed Client Secret under the **Value** column.

<Info>
  **Note:** You will need to periodically create new and update your Client Secret as they expire for all Microsoft integrations.
</Info>

### Add your Microsoft Excel app to Paragon

1. Select **Microsoft Excel** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Microsoft Excel > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/microsoftexcel#add-the-redirect-url-to-your-microsoft-excel-app) in their respective sections:

* **Client ID:** Found under **Essentials > Application (client) ID** on your Microsoft Azure Portal app page.

* **Client Secret:** Found under **Manage > Certificates & secrets** on your Microsoft Azure Portal app page.

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** You should only add the scopes you've requested in your application page to Paragon.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Excel%20app%20to%20Paragon%20Connect.png?maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ca3ae3b6697b4956c8ec5afe160182e8" alt="" width="1570" height="1026" data-path="assets/Connecting your Microsoft Excel app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Excel%20app%20to%20Paragon%20Connect.png?w=280&maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a7f17311066c3d04f424fe24385b1d58 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Excel%20app%20to%20Paragon%20Connect.png?w=560&maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2fa439e42ce4b8c9fc18b34913399581 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Excel%20app%20to%20Paragon%20Connect.png?w=840&maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=07d528729098a5e6d9b69fa9309ac984 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Excel%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c9650ec9a1ece0888cd10ccaa1ebd10a 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Excel%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2f60aed274f64ea8d9d693161e12b651 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Microsoft%20Excel%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1570&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c7d9b50f11e4c0c387894c80f2f834c1 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Microsoft Excel

Once your users have connected their Microsoft Excel account, you can use the Paragon SDK to access the Microsoft Excel API on behalf of connected users.

See the Microsoft Excel [REST API documentation](https://learn.microsoft.com/en-us/graph/api/resources/excel?view=graph-rest-1.0\&preserve-view=true) for their full API reference.

Any Microsoft Excel API endpoints can be accessed with the Paragon SDK as shown in this example:

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Get Spreadsheet
await paragon.request('excel', '<workbook id>/workbook/worksheets/<worksheet name>', {
    method: 'GET'
});

// Query Spreadsheet data
await paragon.request('excel', '[relative URL]', {
    method: 'GET'
});
```

## Building Microsoft Excel workflows

Once your Microsoft Excel account is connected, you use the [Microsoft Excel Request](/workflows/requests#making-integration-requests) step to access any of Microsoft Excel's API endpoints without the authentication piece.

When creating or updating records in Microsoft Excel, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Miro
Source: https://docs.useparagon.com/resources/integrations/miro

Connect to your users' Miro accounts.

## Setup Guide

You can find your Miro app credentials in your [Miro Developer Account.](https://developers.miro.com/docs/getting-started-with-oauth)

You'll need the following information to set up your Miro App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.

### Add your Miro app to Paragon

Under **Integrations > Connected Integrations > Miro > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Miro App page.
* **Client Secret:** Found under Client Secret on your Miro App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Leaving the Client ID and Client Secret blank will use Paragon development keys.

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Miro%20app%20to%20Paragon%20Connect.png?maxW=1886&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=76999a2be4d602ac280d61f261720f00" alt="" width="1886" height="928" data-path="assets/Connecting your Miro app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Miro%20app%20to%20Paragon%20Connect.png?w=280&maxW=1886&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=cde98a85c47344a15420ded6f471d594 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Miro%20app%20to%20Paragon%20Connect.png?w=560&maxW=1886&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=0cd5048a753a5b41c9edec033a5f2580 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Miro%20app%20to%20Paragon%20Connect.png?w=840&maxW=1886&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=11c568ff8d82a8b5aa29b85787370456 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Miro%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1886&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=56aa502b6c63310e0e6e5c37f174cc3f 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Miro%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1886&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=3ef1354e28c980f497a5b8efcb10dac3 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Miro%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1886&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=5ea679aa17ce024dd4de881eb95ba0fd 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Miro

Once your users have connected their Miro account, you can use the Paragon SDK to access the Miro API on behalf of connected users.

See the Miro [REST API documentation](https://developers.miro.com/docs/getting-started-with-oauth) for their full API reference.

Any Miro API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Boards
paragon.request("miro", "/boards", {
  method: "GET"
});

// Create a Board
paragon.request("miro", "/boards", {
  method: "POST",
  body: {
    description: 'This board was created over the API',
    name: 'My Board',
    policy: {
      permissionsPolicy: {
        collaborationToolsStartAccess: 'all_editors',
        copyAccess: 'anyone',
        sharingAccess: 'team_members_with_editing_rights'
      },
      sharingPolicy: {
        access: 'private',
        inviteToAccountAndBoardLinkAccess: 'no_access',
        organizationAccess: 'private',
        teamAccess: 'private'
      }
    },
    teamId: '<MIRO_TEAM_ID>',
    projectId: '<MIRO_PROJECT_ID>'
  }
});
  
```

## Building Miro workflows

Once your Miro account is connected, you use the [Miro Request](/workflows/requests#making-integration-requests) step to access any of Miro's API endpoints without the authentication piece.

When creating or updating records in Miro, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Mixpanel
Source: https://docs.useparagon.com/resources/integrations/mixpanel

Connect to your users' Mixpanel accounts.

## Setup Guide

You can find your Mixpanel service account credentials in your [Mixpanel Account](https://mixpanel.com/).

You'll need the following information to set up your Mixpanel App with Paragon Connect:

* Mixpanel Service Account Username
* Mixpanel Service Account Password

This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.

## Connecting to Mixpanel

Once your users have connected their Mixpanel account, you can use the Paragon SDK to access the Mixpanel API on behalf of connected users.

See the Mixpanel [REST API documentation](https://developer.mixpanel.com/reference/query-api) for their full API reference.

Any Mixpanel API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Fetch data from your insights reports
paragon.request("mixpanel", "/insights?project_id=<PROJECT ID>&bookmark_id=<BOOKMARK ID>", {
  method: "GET"
});

// Fetch segmented data for an event
paragon.request("mixpanel", "/segmentation?project_id=<PROJECT ID>&event=<EVENT>&from_date=<DATE>&to_date=<DATE>&format=csv", {
  method: "GET"
});
  
```

## Building Mixpanel workflows

Once your Mixpanel account is connected, you use the [Mixpanel Request](/workflows/requests#making-integration-requests) step to access any of Mixpanel's API endpoints without the authentication piece.

When creating or updating records in Mixpanel, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Monday.Com
Source: https://docs.useparagon.com/resources/integrations/monday

Connect to your users' Monday.com accounts.

## Setup Guide

You can find your Monday.com app credentials by visiting your [Monday.com account](https://monday.com/).

You'll need the following information to set up your Monday.com app with Paragon:

* API Key

### Getting your Monday.com API Key

1. Go to your Monday.com account.

2. Click the Account icon in the bottom-left corner

3. Select **Administration**

4. Select **"Connections"**

5. Select **"API"** from the top sidebar.

6. Copy the API Key under **Personal API Token**.

## Connecting to Monday.com

Once your users have connected their Monday.com account, you can use the Paragon SDK to access the Monday.com API on behalf of connected users.

See the Monday.com [REST API documentation](https://api.developer.monday.com/docs/basics) for their full API reference.

Any Monday.com API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Query Items
await paragon.request("monday.com", "/", { 
  method: "POST",
  body: {"query":"query { items (ids: [157244624, 201781760, 239164869]) { name } }"}
});

// Create an item
await paragon.request("monday.com", "/", { 
  method: "POST",
  body: {"query":"mutation { create_item (board_id: 1234567, group_id: \"today\", item_name: \"new item\") { id }}
});
```

## Building Monday.com workflows

Once your Monday.com account is connected, you can add steps to perform the following actions:

* Create Item
* Update Item
* Get Item by ID
* Get Item by External ID
* Search Items
* Delete Item
* Archive Item
* Create Subitem
* Search Users

You can also use the [Monday.com Request](/workflows/requests#making-integration-requests) step to access any of Monday.com's API endpoints without the authentication piece.

When creating or updating items in Monday.com, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Monday.com account. For example, you might want to trigger a workflow whenever items are updated to sync your users' Monday.com items to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Monday.com%20webhook%20triggers%20in%20Paragon%20Connect.png?maxW=1846&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=2fa121d852e3fe8b1c11fc5e84bba721" alt="" width="1846" height="1278" data-path="assets/Monday.com webhook triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Monday.com%20webhook%20triggers%20in%20Paragon%20Connect.png?w=280&maxW=1846&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=a71778da470aedd73626a67f663e9afe 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Monday.com%20webhook%20triggers%20in%20Paragon%20Connect.png?w=560&maxW=1846&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=3ee886e9afcf6634b748cdb771339708 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Monday.com%20webhook%20triggers%20in%20Paragon%20Connect.png?w=840&maxW=1846&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=ff3389083fea3f1b6493a4a914763c2e 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Monday.com%20webhook%20triggers%20in%20Paragon%20Connect.png?w=1100&maxW=1846&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=24b1a13ab3404d7554742fe634fa3187 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Monday.com%20webhook%20triggers%20in%20Paragon%20Connect.png?w=1650&maxW=1846&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c37edd750fb1437680e8bd1fe50c546f 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Monday.com%20webhook%20triggers%20in%20Paragon%20Connect.png?w=2500&maxW=1846&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=52ee4c77d466c4e13fa2cb5b30314827 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Monday.com below:

* **Item Created**
* **Item Updated** Trigger when Monday.com items have either a name change or a column value change.


# NetSuite
Source: https://docs.useparagon.com/resources/integrations/netsuite

Connect to your users' NetSuite accounts.

## Setup Guide

### Select an authentication strategy for your users

Selecting an authentication strategy is the first step to building a NetSuite integration on Paragon. Paragon supports three methods for authenticating against your users' NetSuite systems, **Authorization Code,** **Client Credentials,** and **Client Credentials with User Certificates**. Your selection will affect the user experience of your connected users.

* **Authorization Code –** Paragon will use the Client ID and Client Secret from the NetSuite integration record you create to initiate OAuth 2.0 flow on behalf of your connecting users.

* **Client Credentials –** your connecting users are required to create their own NetSuite integration record within their NetSuite instances.

* **Client Credentials with User Certificates –** your connecting users are required to create their own NetSuite integration record and additionally generate a certificate to authenticate requests.

#### How do I choose which authentication strategy to use?

We recommend developers who want to perform a one-time ingestion of records use the **Authorization Code** method to optimize for a more seamless user experience for your connecting users. For use-cases that require a longer, persisted connection, we recommend using the **Client Credentials with User Certificates** method.

|                                           | Authentication Lifetime                       | User Effort                                                                                      |
| ----------------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| Authorization Code                        | Requires user re-authentication every 14 days | Lowest effort. Consent access via OAuth prompt.                                                  |
| Client Credentials                        | Requires user re-authentication every 14 days | Medium effort. Required to create an integration record in NetSuite.                             |
| Client Credentials with User Certificates | Two years                                     | Highest effort. Required to create an integration record in NetSuite and generate a certificate. |

### Preparing your NetSuite test instance for Paragon

Enabling the OAuth 2.0 and SuiteScript features in NetSuite are the first steps for configuring your NetSuite sandbox instance with Paragon Connect. This setup in NetSuite will mimic what all of your connecting users will have to do when connecting to your integration regardless of the authentication strategy selected.

1. Navigate to **Setup > Company > Enable Features** then select the **SuiteCloud** tab.

2. Check the boxes for enabling **Client SuiteScript**, **Server SuiteScript**, and **OAuth 2.0**.

3. Click **Save.**

### Creating a NetSuite integration record for Authorization Code and Client Credentials

<Warning>
  When using **Authorization Code** authentication, you as the developer must perform the following steps. When using **Client Credentials**, you must instruct your connecting users through the following steps.
</Warning>

Create your NetSuite integration credentials in your NetSuite instance's Integration Management Settings. This is found under **Setup > Integration > Manage Integrations > New**.

1. Add a **Name**, a **Description**, and click to change the **State** dropdown to ***Enabled***.

2. Enable the ***Token-Based Authentication*** checkbox, ***Authorization Code Grant***, and ***Public Client*** options under **Authorization**.

3. Add the Paragon ***Redirect URL***

```
https://passport.useparagon.com/oauth
```

4. Select the three scopes: `RESTLETS`, `REST WEB SERVICES`, and `SUITEANALYTICS`.

5. Retain the following details from the NetSuite application registration to set up your NetSuite integration record with Paragon Connect:

* Consumer Key

* Consumer Secret

* Scopes Requested

### Creating a NetSuite integration record and certificate mapping for Client Credentials with User Certificates

The following section covering **Client Credentials with User Certificates** requires the Connecting User to perform the steps.

<Frame>
  <iframe width="560" height="315" src="https://www.youtube.com/embed/HW-8a7mKIl4?si=f5E9bsTCPend_efT" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen />
</Frame>

Create your NetSuite integration credentials in your NetSuite instance's Integration Management Settings. This is found under **Setup > Integration > Manage Integrations > New**.

1. Add a **Name**, a **Description**, and click to change the **State** dropdown to ***Enabled***.

2. Disable ***TBA: Authorization Flow,*** then ***Token-Based Authentication***, and ***Authorization Code Grant*** checkboxes.

3. Enable ***Client Credentials (Machine to Machine) Grant.***

4. Select the `REST WEB SERVICES` scope.

5. Save the app and retain the *Consumer Key* from the NetSuite integration registration to set up your NetSuite integration with Paragon Connect:

#### Generating a Certificate

After creating the integration record in NetSuite, the connecting user is required to generate an `openssl` certificate for upload at the time of integration connection.

1. On your local machine, create a certificate following [these conditions enforced by NetSuite](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_162686838198.html#subsect_162755332391). Paragon currently only supports authentication of certificates created using the RSA algorithm. This will create two files, a `public.pem`and a `private.pem.`

   ```sh
   openssl req -new -x509 -newkey rsa:4096 -keyout private.pem -sigopt rsa_padding_mode:pss -sha256 -sigopt rsa_pss_saltlen:64 -out public.pem -nodes -days 730
   ```

2. In NetSuite navigate to **Setup > Integration > OAuth 2.0 Client Credentials (M2M) Setup** and then select **Create New.**

3. Select an Entity to own the OAuth Mapping, their role, and the OAuth app created in the previous section. For the *Certificate* input, upload the `public.pem` from step one. Save the mapping.

   1. If encountering an "Unable to parse provided x509 certificate" error, use a stable version of `openssl` downloaded via Homebrew for macOS.

After generating the NetSuite integration record and completing the certificate mapping, the connecting user is ready to connect the integration via the Paragon Connect Portal.

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-12-13%20at%2014.49.31@2x.png?maxW=1380&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=a3ddf4f440219a76b4c7a0874e2c83d9" alt="" width="1380" height="1532" data-path="assets/CleanShot 2024-12-13 at 14.49.31@2x.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-12-13%20at%2014.49.31@2x.png?w=280&maxW=1380&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=1f626570f52986d4dcbcd3d1ad3d8482 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-12-13%20at%2014.49.31@2x.png?w=560&maxW=1380&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c1c64fc75decac76a36e365b0114bb5b 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-12-13%20at%2014.49.31@2x.png?w=840&maxW=1380&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=49810b292ea3969ae20bad9fa1e58b82 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-12-13%20at%2014.49.31@2x.png?w=1100&maxW=1380&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=62d614d2b24da5b74f3c86f6f36cddd0 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-12-13%20at%2014.49.31@2x.png?w=1650&maxW=1380&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8f09b0fb765bc7ddf694afed47bd2ad4 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-12-13%20at%2014.49.31@2x.png?w=2500&maxW=1380&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f2685fe9eb1035cf8ca020831976cbf8 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Authorization Code: Add your NetSuite app to Paragon

In the Paragon Dashboard under **Integrations > Connected Integrations >** **NetSuite** **>** **Settings**, fill out your credentials from your NetSuite integration record in their respective sections:

* **Client ID:** Found under **Setup > Integration > Manage Integrations** in your NetSuite integration record page.

* **Client Secret:** Found under **Setup > Integration > Manage Integrations** on your NetSuite integration record page.

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Leaving the Client ID and Client Secret blank will use Paragon **Authorization Code** development integration record.

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20NetSuite%20application%20to%20Paragon%20Connect.png?maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f6df16f422b30641a9e7ea3643891e00" alt="" width="1916" height="1114" data-path="assets/Connecting your NetSuite application to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20NetSuite%20application%20to%20Paragon%20Connect.png?w=280&maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=d8f2a95450af554996b745a998fe3ebe 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20NetSuite%20application%20to%20Paragon%20Connect.png?w=560&maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=200951e68ea6c1cc31354e603e2a0e7e 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20NetSuite%20application%20to%20Paragon%20Connect.png?w=840&maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c6ffebef4b76d27c95091d326d215ab7 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20NetSuite%20application%20to%20Paragon%20Connect.png?w=1100&maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=966af1ea24e71c9549bc9f43f83fff08 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20NetSuite%20application%20to%20Paragon%20Connect.png?w=1650&maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a2e28ad0534b07382edd51500742081e 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20NetSuite%20application%20to%20Paragon%20Connect.png?w=2500&maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=64c13a3a00fd4af36923c2fe1ee178ad 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to NetSuite

Once your users have connected their NetSuite account, you can use the Paragon SDK to access the NetSuite API on behalf of connected users.

See the NetSuite [REST API documentation](https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2021.2/index.html) for their full API reference.

Any NetSuite API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Get a list of purchase orders filtered by a search
paragon.request("netsuite", "/purchaseOrder?q=[Query]", {
  method: "GET"
});

// Get a list of vendors
paragon.request("netsuite", "/vendor", {
  method: "GET"
});

```

## Building NetSuite workflows

Once your NetSuite account is connected, you can add steps to perform the following actions:

* Create Vendor
* Update Vendor
* Get Vendor by ID
* Search Vendors
* Delete Vendor
* Create Bill
* Update Bill
* Get Bill by ID
* Search Bills
* Delete Bill
* Create Account
* Update Account
* Get Account by ID
* Search Accounts
* Delete Account
* Create Tax Group
* Update Tax Group
* Get Tax Group by ID
* Delete Tax Group
* Search Tax Codes
* Search Payment Terms
* Get Payment Term by ID
* Search Posting Periods

You can also use the [NetSuite Request](/workflows/requests#making-integration-requests) step to access any of NetSuite's API endpoints without the authentication piece.

When using NetSuite, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Notion
Source: https://docs.useparagon.com/resources/integrations/notion

Connect to your users' Notion accounts.

## Setup Guide

You can find your Notion app credentials on your [Notion Integrations Page](https://www.notion.so/my-integrations).

You'll need the following information to set up your Notion App with Paragon Connect:

* Client ID
* Client Secret

### Add your Notion app to Paragon

Under **Integrations > Connected Integrations > Notion > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Notion App page.
* **Client Secret:** Found under Client Secret on your Notion App page.

Leaving the Client ID and Client Secret blank will use Paragon development keys.

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Notion%20application%20to%20Paragon%20Connect.png?maxW=874&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=61a8770337d397b9c7f84af73670372d" alt="" width="874" height="447" data-path="assets/Connecting your Notion application to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Notion%20application%20to%20Paragon%20Connect.png?w=280&maxW=874&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b2ecc899f18c86332e448a242d88a5e8 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Notion%20application%20to%20Paragon%20Connect.png?w=560&maxW=874&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=390a81cb076786f39d14d3b82734e58f 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Notion%20application%20to%20Paragon%20Connect.png?w=840&maxW=874&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=31285d82ba979cd5351a783a539ebc4c 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Notion%20application%20to%20Paragon%20Connect.png?w=1100&maxW=874&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=8d4fe5b6817258bb4a8fd17c46900fbc 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Notion%20application%20to%20Paragon%20Connect.png?w=1650&maxW=874&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=72649b556e5f644bbab4dd008f70b235 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Notion%20application%20to%20Paragon%20Connect.png?w=2500&maxW=874&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=aa7ab5472dbce1654414498799d9d40a 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Notion

Once your users have connected their Notion account, you can use the Paragon SDK to access the Notion API on behalf of connected users.

See the Notion [REST API documentation](https://developers.notion.com/reference) for their full API reference.

Any Notion API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create a page in Notion
paragon.request("notion", "/v1/pages", {
  method: "POST",
  body: {
  	"parent": { "page_id": "d9824bdc84454327be8b5b47500af6ce" },
    "icon": {
        "emoji": ""
    },
	"properties": {
		"Title": {
            "text": "My page"
		},
	},
	"children": []
  }
});

// Retrieve a Notion page
paragon.request("notion", "/v1/pages/<page ID>", {
  method: "GET"
});
  
```

## Building Notion workflows

Once your Notion account is connected, you can add steps to perform the following actions:

* Create a Page
* Update Page
* Get Page's Details
* Archive a Page
* Search Pages
* Get a Page's Contents
* Update a Block
* Retrieve a Block
* Delete a Block

You can also use the [Notion Request](/workflows/requests#making-integration-requests) step to access any of Notion's API endpoints without the authentication piece.

When creating or updating records in Notion, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Notion account. For example, you might want to trigger a workflow whenever new pages are created or updated in Notion to sync your users' Notion pages to your application in real-time.

You can find the full list of Webhook Triggers for Notion below:

* **Page Created**
* **Page Updated**


# OneDrive
Source: https://docs.useparagon.com/resources/integrations/onedrive

Connect to your users' OneDrive accounts.

## Setup Guide

You can find your OneDrive application credentials by visiting your Microsoft Azure Portal.

You'll need the following information to set up your OneDrive app with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Prerequisites

* A [Microsoft Azure](https://azure.microsoft.com/) account

### Add the Redirect URL to your OneDrive app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your OneDrive app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

3. Navigate to **All Services > App Registrations** and select your application.

4. Select **Authentication** from the sidebar.

5. Under **Platform configurations**, press the **"Add a platform"** button.

6. Select the **Web** platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the **Save** button at the top of the page.

### Generate a Client Secret

Since OneDrive does not automatically provide you with a Client Secret for your application, we'll need to make one. To get your Client Secret:

1. Navigate to **Manage > Certificates & secrets** in the sidebar.

2. Under **Client Secrets**, press the **+ New client secret** button.

3. Name your client credentials and select an expiry that works best for your application. Press **Add** to create your credentials.

4. Copy the displayed Client Secret under the **Value** column.

<Info>
  **Note:** You will need to periodically create new and update your Client Secret as they expire for all Microsoft integrations.
</Info>

### Enable Multi-tenancy to your OneDrive app

To allow Microsoft users from outside of your organization to connect to your OneDrive application, you must specify this as an option within the OneDrive application registration.

1. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

2. Navigate to **All Services > App Registrations** and select your application.

3. Select **Authentication** from the sidebar.

4. Under **Supported account types**, press the **"Accounts in any organizational directory"** option.

5. Click Save.

### Add your OneDrive app to Paragon

1. Select **OneDrive** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > OneDrive > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/onedrive#add-the-redirect-url-to-your-onedrive-app) in their respective sections:

* **Client ID:** Found under **Essentials > Application (client) ID** on your Microsoft Azure Portal app page.

* **Client Secret:** Found under **Manage > Certificates & secrets** on your Microsoft Azure Portal app page.

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** You should only add the scopes you've requested in your application page to Paragon.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneDrive%20app%20to%20Paragon%20Connect.png?maxW=1942&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=d172679ccfb7b42883c869d2a994f021" alt="" width="1942" height="1158" data-path="assets/Connecting your OneDrive app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneDrive%20app%20to%20Paragon%20Connect.png?w=280&maxW=1942&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ba92cba6c96fb8123cd3c8299768aa9d 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneDrive%20app%20to%20Paragon%20Connect.png?w=560&maxW=1942&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=8e7ce88391cf87468408429d789de710 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneDrive%20app%20to%20Paragon%20Connect.png?w=840&maxW=1942&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=4067183ecf42cbbb8b98c929784b832e 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneDrive%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1942&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a1958c2d8e0151805ed6e054569f88dc 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneDrive%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1942&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=76146ff45826d07276ae3a261ebab4e2 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneDrive%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1942&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=dcf393ca34db3aba821e8c0a6c9917ea 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to OneDrive

Once your users have connected their OneDrive account, you can use the Paragon SDK to access the OneDrive API on behalf of connected users.

See the OneDrive [REST API documentation](https://docs.microsoft.com/en-us/dynamics365/sales-enterprise/help-hub) for their full API reference.

Any OneDrive API endpoints can be accessed with the Paragon SDK as shown in this example:

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// List files in the root of the drive
await paragon.request("onedrive", "/me/drive/root/children", {
  method: "GET"
});


// Download a specific file in a drive
await paragon.request("onedrive", "/me/drive/items/<item-id>/content", {
  method: "GET"
})
```

## Building OneDrive workflows

Once your OneDrive account is connected, you can add steps to perform the following actions:

* Upload File
* Get File Metadata
* List Files
* Download File
* Create Folder
* Get Folder by ID
* Search Folders
* Move Folder
* Delete Folder

You can also use the [OneDrive Request](/workflows/requests#making-integration-requests) step to access any of OneDrive's API endpoints without the authentication piece.

When creating or updating records in OneDrive, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' OneDrive account. For example, you might want to trigger a workflow whenever files are changed in OneDrive to sync your users' OneDrive files to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/OneDrive%20Webhook%20Triggers%20in%20Paragon%20Connect.png?maxW=1848&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1d53873f0f87912db52c2ff4b3c80550" alt="" width="1848" height="1214" data-path="assets/OneDrive Webhook Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/OneDrive%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=1848&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=d570736bcbf5f110fce30affb4a2c9ad 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/OneDrive%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=1848&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9787d9c64361d65803063f5a57f984a6 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/OneDrive%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=1848&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9c8b72c4f2470df8d45b7f40c5addede 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/OneDrive%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=1848&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=bd4fd33b8eb329453e1972ee33d5aa65 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/OneDrive%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=1848&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=91eacbd46bce574f58e9a84bc737f5d7 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/OneDrive%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=1848&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=4b03821851b53f6bd88c6aa523523350 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for OneDrive below:

* **File Change**

## Using the OneDrive File Picker

You can allow your user to select files from their OneDrive account in your app with the Paragon SDK.

**Showing the File Picker**

Use the Paragon SDK in your frontend application to show the File Picker in your app.

The SDK provides an `ExternalFilePicker` class to load OneDrive's JavaScript into your page and authenticate with your user's connected OneDrive account.

```javascript
let picker = new paragon.ExternalFilePicker("onedrive", {
    onFileSelect: (files) => {
        // Handle file selection
    }
});

// Loads external dependencies and user's access token
await picker.init();

// Open the File Picker
picker.open();
```

You can configure the File Picker to listen for additional callbacks or to restrict allowed file types. Learn more about configuring File Picker options in the [SDK Reference](/apis/api-reference#externalfilepicker).

#### Downloading the Selected File

The OneDrive File Picker callback will return a `Response` object describing the user's file picker interaction including an array of any files selected. Using this array of `fileIds`, you can use the [Proxy API](/apis/proxy) to perform an authenticated proxy requests to download the files.

<CodeGroup>
  ```javascript JavaScript
  await paragon.request('onedrive', '/me/drive/items/<fileId>/content', {
  	method: 'GET'
  });
  ```

  ```bash REST API
  POST https://proxy.useparagon.com/projects/19d...012/sdk/proxy/onedrive/me/drive/items/<fileId>/content

  Authorization: Bearer eyJ...
  Content-Type: application/json
  ```
</CodeGroup>


# OneNote
Source: https://docs.useparagon.com/resources/integrations/onenote

Connect to your users' OneNote accounts.

## Setup Guide

You can find your OneNote application credentials by visiting your Microsoft Azure Portal.

You'll need the following information to set up your OneNote app with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Prerequisites

* A [Microsoft Azure](https://azure.microsoft.com/) account

### Add the Redirect URL to your OneNote app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your OneNote app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

3. Navigate to **All Services > App Registrations** and select your application.

4. Select **Authentication** from the sidebar.

5. Under **Platform configurations**, press the **"Add a platform"** button.

6. Select the **Web** platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the **Save** button at the top of the page.

### Generate a Client Secret

Since OneNote does not automatically provide you with a Client Secret for your application, we'll need to make one. To get your Client Secret:

1. Navigate to **Manage > Certificates & secrets** in the sidebar.

2. Under **Client Secrets**, press the **+ New client secret** button.

3. Name your client credentials and select an expiry that works best for your application. Press **Add** to create your credentials.

4. Copy the displayed Client Secret under the **Value** column.

<Info>
  **Note:** You will need to periodically create new and update your Client Secret as they expire for all Microsoft integrations.
</Info>

### Add your OneNote app to Paragon

1. Select OneNote from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > OneNote > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/onenote#add-the-redirect-url-to-your-onenote-app) in their respective sections:

* **Client ID:** Found under **Essentials > Application (client) ID** on your Microsoft Azure Portal app page.

* **Client Secret:** Found under **Manage > Certificates & secrets** on your Microsoft Azure Portal app page.

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** You should only add the scopes you've requested in your application page to Paragon.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneNote%20app%20to%20Paragon%20Connect.png?maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b598bb5e6b7d643f8a100b9d7df693f2" alt="" width="1916" height="1148" data-path="assets/Connecting your OneNote app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneNote%20app%20to%20Paragon%20Connect.png?w=280&maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=378664be68682493c66f0d55eaeb97f5 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneNote%20app%20to%20Paragon%20Connect.png?w=560&maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=4b4a71000e64e9c904e90235762c2781 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneNote%20app%20to%20Paragon%20Connect.png?w=840&maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a282ce94816533492d77e01f7777e703 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneNote%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=11cd5f3543a0eba5faa577499fd1d2d6 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneNote%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=065f71c5493852f32e04e75138465794 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20OneNote%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1916&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b85847fb87bb720fb1ba34751439e51d 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to OneNote

Once your users have connected their OneNote account, you can use the Paragon SDK to access the OneNote API on behalf of connected users.

See the OneNote [REST API documentation](https://learn.microsoft.com/en-us/graph/api/resources/onenote-api-overview?view=graph-rest-1.0\&preserve-view=true) for their full API reference.

Any OneNote API endpoints can be accessed with the Paragon SDK as shown in this example:

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Retrieve a Page
await paragon.request('onenote', '/groups/<Group-ID>/onenote/pages/<Page-ID>', {
  method: 'GET'
});


// Create a Page
await paragon.request('onenote', '/me/onenote/sections/<Section-ID>/pages', {
  method: 'POST',
  body: `
    <!DOCTYPE html>
    <html>
      <head>
          <title>A page with a block of HTML</title>
      </head>
      <body>
          <p>This page contains some <i>formatted</i> <b>text</b>.</p>
      </body>
    </html>`
});
```

## Building OneNote workflows

Once your OneNote account is connected, you can add steps to perform the following actions:

* Create a Page
* Update Page
* Get Page by ID
* Delete Page
* Search Pages

You can also use the [OneNote Request](/workflows/requests#making-integration-requests) step to access any of OneNote's API endpoints without the authentication piece.

When creating or updating records in OneNote, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# OpenAI
Source: https://docs.useparagon.com/resources/integrations/openai

Connect to your users' OpenAI accounts.

## Setup Guide

You can find your OpenAI app credentials in your [OpenAI Developer Account.](https://platform.openai.com/docs/api-reference/introduction)

You'll need the following information to set up your OpenAI App with Paragon Connect:

* [OpenAI API Key](https://platform.openai.com/account/api-keys)

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to OpenAI

Once your users have connected their OpenAI account, you can use the Paragon SDK to access the OpenAI API on behalf of connected users.

See the OpenAI [REST API documentation](https://platform.openai.com/docs/api-reference/introduction) for their full API reference.

Any OpenAI API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Perform a completion
paragon.request("openai", "/completions", {
  method: "POST",
  body: {
    "model": "text-davinci-003",
    "prompt": "Say this is a test",
    "max_tokens": 7,
    "temperature": 0,
    "top_p": 1,
    "n": 1,
    "stream": false,
    "logprobs": null,
    "stop": "\n"
  }
});

// Create an image
paragon.request("openai", "/images/generations", {
  method: "POST",
  body: {
    "prompt": "A cute baby sea otter",
    "n": 2,
    "size": "1024x1024"
  }
});
  
```

## Building OpenAI workflows

Once your OpenAI account is connected, you use the [OpenAI Request](/workflows/requests#making-integration-requests) step to access any of OpenAI's API endpoints without the authentication piece.

When creating or updating records in OpenAI, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Oracle Financials Cloud
Source: https://docs.useparagon.com/resources/integrations/oracle-financials-cloud

Connect to your users' Oracle Financials Cloud accounts.

## Setup Guide

You'll need the following information to set up your Oracle Financials Cloud App with Paragon Connect:

* App Name
* Scopes Requested

### Add your Oracle Financials Cloud app to Paragon

1. Select Oracle Financials Cloud from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Oracle Financials Cloud > App Configuration > Configure**, fill out your credentials in their respective sections:

* **App Name:**

  * Specify an app name to appear on Oracle Financials Cloud

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the App Name blank will use Paragon development keys.
</Info>

## Connecting to Oracle Financials Cloud

Once your users have connected their Oracle Financials Cloud account, you can use the Paragon SDK to access the Oracle Financials Cloud API on behalf of connected users.

See the Oracle Financials Cloud [REST API documentation](https://docs.oracle.com/en/cloud/saas/financials/21d/farfa/) for their full API reference.

Any Oracle Financials Cloud API endpoints can be accessed with the Paragon SDK as shown in this example

```js JavaScript
// You can find your project ID in the Overview tab of any Integration.

// Authenticate the user
paragon.authenticate(<ProjectID>, <Paragon User Token>);

// Get an Invoice
await paragon.request("oraclefinancialscloud", "/invoices/<Invoice ID>", {
  method: “GET”,
});

// Calculate Tax for an Invoice
await paragon.request("oraclefinancialscloud", "/invoices", {
  method: “POST”,
  body: {
    name: “calculateTax”,
    parameters: [“<Invoice ID>”, “<Business Unit>”, “<Supplier>”]
  }
});
```

## Building Oracle Financials Cloud workflows

Once your Oracle Financials Cloud account is connected, you can add steps to perform the following actions:

* Search Invoices
* Create Invoice
* Update Invoice
* Build Invoice Line Item
* Validate Invoice

You can also use the [Oracle Financials Cloud Request](/workflows/requests#making-integration-requests) step to access any of Oracle Financials Cloud's API endpoints without the authentication piece.

When using Oracle Financials Cloud, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Microsoft Outlook
Source: https://docs.useparagon.com/resources/integrations/outlook

Connect to your users' Microsoft Outlook accounts.

## Setup Guide

You can find your Microsoft Outlook application credentials by visiting your Microsoft Azure Portal.

You'll need the following information to set up your Microsoft Outlook app with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Prerequisites

* A [Microsoft Azure](https://azure.microsoft.com/) account

### Add the Redirect URL to your Microsoft Outlook app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Microsoft Outlook app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

3. Navigate to **All Services > App Registrations** and select your application.

4. Select **Authentication** from the sidebar.

5. Under **Platform configurations**, press the **"Add a platform"** button.

6. Select the **Web** platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the **Save** button at the top of the page.

### Generate a Client Secret

Since Microsoft Outlook does not automatically provide you with a Client Secret for your application, we'll need to make one. To get your Client Secret:

1. Navigate to **Manage > Certificates & secrets** in the sidebar.

2. Under **Client Secrets**, press the **+ New client secret** button.

3. Name your client credentials and select an expiry that works best for your application. Press **Add** to create your credentials.

4. Copy the displayed Client Secret under the **Value** column.

<Info>
  **Note:** You will need to periodically create new and update your Client Secret as they expire for all Microsoft integrations.
</Info>

### Enable Multi-tenancy to your Outlook app

To allow Microsoft users from outside of your organization to connect to your Outlook application, you must specify this as an option within the Outlook application registration.

1. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

2. Navigate to **All Services > App Registrations** and select your application.

3. Select **Authentication** from the sidebar.

4. Under **Supported account types**, press the **"Accounts in any organizational directory"** option.

5. Click Save.

### Add your Microsoft Outlook app to Paragon

1. Select **Microsoft Outlook** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Microsoft Outlook > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/outlook#add-the-redirect-url-to-your-microsoft-outlook-app) in their respective sections:

* **Client ID:** Found under **Essentials > Application (client) ID** on your Microsoft Azure Portal app page.

* **Client Secret:** Found under **Manage > Certificates & secrets** on your Microsoft Azure Portal app page.

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** You should only add the scopes you've requested in your application page to Paragon.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20Microsoft%20Outlook%20application%20to%20Paragon%20Connect.png?maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f757fef66fd18759dfcebdac8ccf60f8" alt="" width="1860" height="1168" data-path="assets/Connecting a Microsoft Outlook application to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20Microsoft%20Outlook%20application%20to%20Paragon%20Connect.png?w=280&maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f600159e34f7a914b778d71c570ee75e 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20Microsoft%20Outlook%20application%20to%20Paragon%20Connect.png?w=560&maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=111b2785488e7b3d6509cbaebb1b133f 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20Microsoft%20Outlook%20application%20to%20Paragon%20Connect.png?w=840&maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=0b932ba31ff331951459859af1efdce6 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20Microsoft%20Outlook%20application%20to%20Paragon%20Connect.png?w=1100&maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=6ae60216db8ed5d70378215a9837042d 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20Microsoft%20Outlook%20application%20to%20Paragon%20Connect.png?w=1650&maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=eb74dbc5ddc6604609266e6dc245c36f 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20a%20Microsoft%20Outlook%20application%20to%20Paragon%20Connect.png?w=2500&maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=6f1d4264349613c287307aab6bb1ed2d 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Microsoft Outlook

Once your users have connected their Microsoft Outlook account, you can use the Paragon SDK to access the Microsoft Outlook API on behalf of connected users.

See the Microsoft Outlook [REST API documentation](https://docs.microsoft.com/en-us/graph/api/resources/calendar?view=graph-rest-1.0) for their full API reference.

Any Microsoft Outlook API endpoints can be accessed with the Paragon SDK as shown in this example:

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Get user's calendar events
await paragon.request("outlook", "/me/calendar/events", { 
  method: "GET",
});

// Get messages in user’s mailbox
await paragon.request("outlook", "/me/messages", {
  method: "GET",
});

// Create a calendar event
await paragon.request("outlook", "/me/calendar/events", {
  method: "POST",
  body: {
    "subject": "Let's go for lunch",
    "body": {
      "contentType": "HTML",
      "content": "Does mid month work for you?"
    },
    "start": {
      "dateTime": "2019-03-15T12:00:00",
      "timeZone": "Pacific Standard Time"
    },
    "end": {
      "dateTime": "2019-03-15T14:00:00",
      "timeZone": "Pacific Standard Time"
    },
    "location":{
      "displayName":"Harry's Bar"
    },
    "attendees": [
      {
        "emailAddress": {
          "address":"adelev@contoso.onmicrosoft.com",
          "name": "Adele Vance"
        },
      "type": "required"
      }
    ]
}
});
```

## Building Microsoft Outlook workflows

Once your Microsoft Outlook account is connected, you can add steps to perform the following actions:

* Create Event
* Update Event
* Get Event by ID
* Get Events
* Delete Event
* Get Messages
* Send Message

You can also use the [Microsoft Outlook Request](/workflows/requests#making-integration-requests) step to access any of Microsoft Outlook's API endpoints without the authentication piece.

When creating or updating events in Microsoft Outlook, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Microsoft%20Outlook%20workflow%20in%20Paragon%20Connect.png?maxW=2194&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=9c7d1019b91e95d0e4c1cd4cead0d839" alt="" width="2194" height="1276" data-path="assets/Creating a Microsoft Outlook workflow in Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Microsoft%20Outlook%20workflow%20in%20Paragon%20Connect.png?w=280&maxW=2194&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=77224702f16ce908f035ca924d6735cd 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Microsoft%20Outlook%20workflow%20in%20Paragon%20Connect.png?w=560&maxW=2194&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2caed472aaef408dd71e74d0aa1ca380 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Microsoft%20Outlook%20workflow%20in%20Paragon%20Connect.png?w=840&maxW=2194&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=22aac8544fce09201a86f19182878e10 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Microsoft%20Outlook%20workflow%20in%20Paragon%20Connect.png?w=1100&maxW=2194&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=a3f92b2750cf7d4818d3066c07a4a8fb 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Microsoft%20Outlook%20workflow%20in%20Paragon%20Connect.png?w=1650&maxW=2194&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=3b2ab64d374da64a5b41d21b4833cc2c 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Microsoft%20Outlook%20workflow%20in%20Paragon%20Connect.png?w=2500&maxW=2194&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=1788a92b475c1a83e64a894c3dc88cf8 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Microsoft Outlook accounts. For example, you might want to trigger a workflow whenever new events are created Microsoft Outlook to sync your users' Microsoft Outlook events to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Outlook%20triggers%20in%20Paragon%20Connect.png?maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=b7a122edab1edc527c817d0096965ef4" alt="" width="2230" height="1332" data-path="assets/Microsoft Outlook triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Outlook%20triggers%20in%20Paragon%20Connect.png?w=280&maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=21aec8564ceaaa3b412799cfe61b1e0a 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Outlook%20triggers%20in%20Paragon%20Connect.png?w=560&maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7a230fb85e173b21a9c770f52182dfec 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Outlook%20triggers%20in%20Paragon%20Connect.png?w=840&maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1840cb12b8323db3c87413e98d9bc7a7 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Outlook%20triggers%20in%20Paragon%20Connect.png?w=1100&maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0882866aff3f64549f050ff1f6e29e21 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Outlook%20triggers%20in%20Paragon%20Connect.png?w=1650&maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9f36ee8c800d9df018c5140b8710ec02 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Microsoft%20Outlook%20triggers%20in%20Paragon%20Connect.png?w=2500&maxW=2230&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=ca3c42ce746838cccc54838cafe84051 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Microsoft Outlook below:

* **Event Created**
* **Event Updated**
* **Event Removed**
* **New Message**


# Outreach
Source: https://docs.useparagon.com/resources/integrations/outreach

Connect to your users' Outreach accounts.

## Setup Guide

<Info>
  **Note:** You'll need to create a new Outreach app if you don't already have one.
</Info>

You can find your Outreach app credentials by visiting your [Outreach developer portal](https://developers.outreach.io/).

You'll need the following information to set up your Outreach App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Prerequisites

* An [Outreach Developer account](https://www.outreach.io/product/platform/api).
* An Outreach app.

### Add the Redirect URL to your Outreach app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Outreach app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Reach out to your Outreach API Integrations Specialist and ask to change the default redirect URL for your application to the one Paragon provides.

### Add your Outreach app to Paragon

1. Select **Outreach** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Outreach > App Configuration > Configure**, fill out your credentials in their respective sections:

* **Client ID:** Provided by Outreach's team.
* **Client Secret:** Provided by Outreach's team.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

## Connecting to Outreach

Once your users have connected their Outreach account, you can use the Paragon SDK to access the Outreach API on behalf of connected users.

See the Outreach [REST API documentation](https://api.outreach.io/api/v2/docs) for their full API reference.

Any Outreach API endpoints can be accessed with the Paragon SDK as shown in this example.

```js JavaScript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Get accounts
await paragon.request("outreach", "/accounts", { 
    method: "GET"
  });

// Create a project
await paragon.request("outreach", "/prospect", { 
    method: "POST",
      body: {  
       "type": "prospect",
        "attributes": {
           "emails": ["sally.smith@acme.example.com"],
            "firstName": "Sally",
            "title": "CEO"
          }
        } 
      });
```

## Building Outreach workflows

Once your Outreach account is connected, you can add steps to perform the following actions:

* Create Account
* Update Account
* Get Accounts
* Get Account by ID
* Create Opportunity
* Update Opportunity
* Get Opportunities
* Get Opportunity by ID
* Create Prospect
* Update Prospect
* Get Prospects
* Get Prospect by ID
* Add Prospect to Sequence

You can also use the [Outreach Request](/workflows/requests#making-integration-requests) step to access any of Outreach's API endpoints without the authentication piece.

When creating or updating events in Outreach, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20an%20Opportunity%20using%20Outreach%20in%20Paragon.png?maxW=1772&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=381c829b5db57120e08457d5566361d6" alt="" width="1772" height="982" data-path="assets/Creating an Opportunity using Outreach in Paragon.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20an%20Opportunity%20using%20Outreach%20in%20Paragon.png?w=280&maxW=1772&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=477ea116e89c473be812c6f6c48ed524 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20an%20Opportunity%20using%20Outreach%20in%20Paragon.png?w=560&maxW=1772&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=c73d740dd58ef9889850dc1c4f5f9aaf 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20an%20Opportunity%20using%20Outreach%20in%20Paragon.png?w=840&maxW=1772&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=bc957622a751d3c4a211d79ea9f501f5 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20an%20Opportunity%20using%20Outreach%20in%20Paragon.png?w=1100&maxW=1772&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=f50462c47a3cdd9b094306bd46c7d042 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20an%20Opportunity%20using%20Outreach%20in%20Paragon.png?w=1650&maxW=1772&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=b1ff9e17527726f810de0ae445f9bd78 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20an%20Opportunity%20using%20Outreach%20in%20Paragon.png?w=2500&maxW=1772&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7bbf50d093f9aaefebecae7e2f51dafd 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Outreach account. For example, you might want to trigger a workflow whenever new opportunities are created Outreach to sync your users' Outreach contacts to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Outreach%20triggers%20in%20Paragon%20Connect.png?maxW=994&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=464b78bf1797f57248ea1ff9299a9c7a" alt="" width="994" height="663" data-path="assets/Outreach triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Outreach%20triggers%20in%20Paragon%20Connect.png?w=280&maxW=994&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=e61ffc1136bc74cbb252c8533c1e65ad 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Outreach%20triggers%20in%20Paragon%20Connect.png?w=560&maxW=994&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=6c70c291e302352cd9d32299413f940f 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Outreach%20triggers%20in%20Paragon%20Connect.png?w=840&maxW=994&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=f00c533699131f9b9e9f793b26d61ce8 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Outreach%20triggers%20in%20Paragon%20Connect.png?w=1100&maxW=994&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=04b77c39e10166b53f96188b826c6a1d 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Outreach%20triggers%20in%20Paragon%20Connect.png?w=1650&maxW=994&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=f70defbd5cb860e147458ed147c3647e 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Outreach%20triggers%20in%20Paragon%20Connect.png?w=2500&maxW=994&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0efeec425defe27e2e63df5fedc15ad2 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Outreach below:

* **New Account**
* **Account Updated**
* **New Opportunity**
* **Opportunity Updated**
* **New Prospect**
* **Prospect Updated**


# PagerDuty
Source: https://docs.useparagon.com/resources/integrations/pagerduty

Connect to your users' PagerDuty accounts.

## Setup Guide

You can find your PagerDuty app credentials in your [PagerDuty Developer Account.](https://developer.pagerduty.com/api-reference/)

You'll need the following information to set up your PagerDuty App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your PagerDuty app to Paragon

Under **Integrations > Connected Integrations > PagerDuty > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your PagerDuty App page.
* **Client Secret:** Found under Client Secret on your PagerDuty App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20PagerDuty%20app%20to%20Paragon%20Connect.png?maxW=980&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=64913e80d6b30abc3873b4b795e77578" alt="" width="980" height="584" data-path="assets/Connecting your PagerDuty app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20PagerDuty%20app%20to%20Paragon%20Connect.png?w=280&maxW=980&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=08164b455450be2517f4794418ae6796 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20PagerDuty%20app%20to%20Paragon%20Connect.png?w=560&maxW=980&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=5a3240228e93db6fd603cd1eadf9097d 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20PagerDuty%20app%20to%20Paragon%20Connect.png?w=840&maxW=980&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=3520e6cc3b8b0b3fed3eb32c74ec4062 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20PagerDuty%20app%20to%20Paragon%20Connect.png?w=1100&maxW=980&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a82aee9d34034af3191a8f9e7f49499a 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20PagerDuty%20app%20to%20Paragon%20Connect.png?w=1650&maxW=980&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c882e3cd174d2d7cb126310bc1ab50c1 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20PagerDuty%20app%20to%20Paragon%20Connect.png?w=2500&maxW=980&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=04c6d1211382984c9a93a0bbfa00c63e 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to PagerDuty

Once your users have connected their PagerDuty account, you can use the Paragon SDK to access the PagerDuty API on behalf of connected users.

See the PagerDuty [REST API documentation](https://developer.pagerduty.com/api-reference/) for their full API reference.

Any PagerDuty API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Incidents
paragon.request("pagerduty", "/incidents", {
  method: "GET"
});

// Create an Incident
paragon.request("pagerduty", "[relative URL]", {
  method: "POST",
  body: {
    "incident": {
      "type": "incident",
      "title": "The server is on fire.",
      "service": {
        "id": "PWIXJZS",
        "type": "service_reference"
      },
      "priority": {
        "id": "P53ZZH5",
        "type": "priority_reference"
      },
      "urgency": "high",
      "body": {
        "type": "incident_body",
        "details": "A disk is getting full on this machine. You should investigate what is causing the disk to fill, and ensure that there is an automated process in place for ensuring data is rotated (eg. logs should have logrotate around them). If data is expected to stay on this disk forever, you should start planning to scale up to a larger disk."
      },
    }
  }
});

// Get Users
paragon.request("pagerduty", "users", {
  method: "GET"
});
  
```

## Building PagerDuty workflows

Once your PagerDuty account is connected, you use the [PagerDuty Request](/workflows/requests#making-integration-requests) step to access any of PagerDuty's API endpoints without the authentication piece.

When creating or updating records in PagerDuty, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# PandaDoc
Source: https://docs.useparagon.com/resources/integrations/pandadoc

Connect to your users' PandaDoc accounts.

## Setup Guide

You can find your PandaDoc app credentials in your [PandaDoc Developer Account.](https://api.pandadoc.com/public/v1)

You'll need the following information to set up your PandaDoc App with Paragon Connect:

* PandaDoc API Key

## Connecting to PandaDoc

Once your users have connected their PandaDoc account, you can use the Paragon SDK to access the PandaDoc API on behalf of connected users.

See the PandaDoc [REST API documentation](https://api.pandadoc.com/public/v1) for their full API reference.

Any PandaDoc API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Send a document
paragon.request("pandadoc", "/documents/<ID>/send", {
  method: "POST",
  body: {
     "message": "Hello! This document was sent from the PandaDoc API.",
     "subject": "Please check this test API document from PandaDoc",
     "silent": false,
     "sender": {
          "membership_id": "gEy74Zx4VjNfV3Q2rHdgZW"
     }
  }
});

// List documents
paragon.request("pandadoc", "/documents?", {
  method: "GET"
});

// Create a contact
paragon.request("pandadoc", "/contacts", {
  method: "POST",
  body: {
     "email": "john@appleseed.com",
     "first_name": "John",
     "last_name": "Appleseed",
     "company": "Apples & Company",
  }
});
  
```

## Building PandaDoc workflows

Once your PandaDoc account is connected, you can add steps to perform the following actions:

* Create a Document
* Update a Document
* Get Document by ID
* Delete Document
* Send a Document
* Search Documents

You can also use the [PandaDoc Request](/workflows/requests#making-integration-requests) step to access any of PandaDoc's API endpoints without the authentication piece.

When creating or updating records in DocuSign, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Pardot
Source: https://docs.useparagon.com/resources/integrations/pardot

Connect to your users' Pardot accounts.

## Setup Guide

You can find your Salesforce app credentials in your [Salesforce Developer Account.](https://developer.salesforce.com/)

You'll need the following information to set up your Salesforce App with Paragon Connect:

* Consumer Key
* Consumer Secret
* Scopes Requested

### Add the Redirect URL to your Pardot app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Salesforce app:

1. Log in to your [Salesforce dashboard](https://www.salesforce.com/).

2. Navigate to the gear icon at the top of the page and click **Setup.**

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=e85a83b13c63bccf7d67751450034166" alt="" width="390" height="145" data-path="assets/Going to Setup in Salesforce.gif" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?w=280&maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0a592fe1190b09d670493c145e51d415 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?w=560&maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=659f19a83caf1a19cf18ac982b57f286 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?w=840&maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=06468a226f90f1b1c0aa655bb5d9384a 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?w=1100&maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1bd7e74a51c03d3ef59cd7ac5000ab16 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?w=1650&maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c15b795ebbc4778ab1d8af5747cf1bdb 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?w=2500&maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=3b23117c9b774fd6dbe96c9bceeac210 2500w" data-optimize="true" data-opv="2" />
</Frame>

3. In the left-hand sidebar, go to **Platform Tools > Apps > App Manager**.

<Info>
  **Note:** You must have the proper admin permissions on your Salesforce account to access the App Manager. If you don't, please speak to your admin.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d2f3af559b1b6f839693cf5217b7187c" alt="" width="222" height="267" data-path="assets/Platform tools to Apps to App Manager in Salesforce.gif" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?w=280&maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=dc9df5fc576f854e4fbfe11518a1a201 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?w=560&maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a6feb322b243be99703bd4cd668fdfa1 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?w=840&maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=6a38ed84739bd3274cfb6937d680a33e 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?w=1100&maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e9e821110573a1f96ee606fe53cfe256 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?w=1650&maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8c7d5ff3b6c85e359d5c95e8ce8a9fea 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?w=2500&maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=94ec1c12dcf897fbdba79bc91d0f21c4 2500w" data-optimize="true" data-opv="2" />
</Frame>

4. Click on the registered application you'd like to use. If you don't already have one, click **New Connected App**.

5. Under **API (Enable OAuth Settings)**, mark the "**Enable OAuth Settings**" checkbox.

6. Under **Callback URL**, paste-in Paragon Connect's redirect URL:

```
https://passport.useparagon.com/oauth
```

7. Select any scopes you'd like to use in your application.

8. Press the **Save** button at the bottom of the page.

Salesforce provides your **Consumer Key** and **Consumer Secret** needed for the next step once you register your application.

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20OAuth%20Scopes%20to%20Salesforce.gif?maxW=935&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=e9f10f67ba00e6fb4518e6287b5233f0" alt="" width="935" height="402" data-path="assets/Adding OAuth Scopes to Salesforce.gif" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20OAuth%20Scopes%20to%20Salesforce.gif?w=280&maxW=935&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=fd33fafd2691bc627009aea1bbb85ef2 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20OAuth%20Scopes%20to%20Salesforce.gif?w=560&maxW=935&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=b4c4be1245e61c9358ef2d484b03edab 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20OAuth%20Scopes%20to%20Salesforce.gif?w=840&maxW=935&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=4808bf938c9ebcf06bce9f3d61fa2d58 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20OAuth%20Scopes%20to%20Salesforce.gif?w=1100&maxW=935&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=b5d4e734cf97259a067e5d126bba15fb 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20OAuth%20Scopes%20to%20Salesforce.gif?w=1650&maxW=935&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=72c0072785c6d849f1f9cd3ff968b498 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20OAuth%20Scopes%20to%20Salesforce.gif?w=2500&maxW=935&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=dd049c0fbbfb63b33de8b258492e20f9 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Pardot app to Paragon

Under **Integrations > Connected Integrations > Pardot > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/salesforce#1-add-the-redirect-url-to-your-salesforce-app) in their respective sections:

* **Consumer Key:** Found under Manage Connected Apps > API (Enable OAuth Settings) > Consumer Key on your Salesforce App page.
* **Consumer Secret:** Found under Manage Connected Apps > API (Enable OAuth Settings) > Consumer Secret on your Salesforce App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=b28b224e4be6518d81ab5ace19061ddd" alt="" width="2000" height="1200" data-path="assets/Connectng your Salesforce app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?w=280&maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=4a233fd91ad10ce1a0316da2b88c8e8d 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?w=560&maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e5c0f5190e75887f1ba4e5fd6329a037 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?w=840&maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ec23f6cc1cce2d67fbdb489dc7f29c29 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=9c74339da4f8b0aae901df66aebbfb44 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=bd74d1d2efcce7987211447ce6026c92 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7f9106c0c53894424f897573ca4b6dd9 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Pardot

Once your users have connected their Pardot account, you can use the Paragon SDK to access the Pardot API on behalf of connected users.

See the Pardot [REST API documentation](https://developer.salesforce.com/docs/) for their full API reference.

Any Pardot API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
          
// Get Prospects
await paragon.request("pardot", "/api/prospect/version/4/do/query/?format=json", {
  method:"GET",
});


// Create a new Prospect
await paragon.request("pardot", "/api/prospect/version/4/do/create?format=json", {
  method: "POST",
  body: "email=b%40useparagon.com&first_name=Brandon&last_name=Foo",
  headers:{
    'Content-Type': 'application/x-www-form-urlencoded',
  }
});
  
```

## Building Pardot workflows

Once your Pardot account is connected, you can add steps to perform the following actions:

* Create or Update Prospect
* Search Prospects
* Get Prospect by ID
* Delete Prospect by ID
* Add Prospect to List
* Remove Prospect from List

You can also use the [Pardot Request](/workflows/requests#making-integration-requests) step to access any of Pardot's API endpoints without the authentication piece.

When creating or updating prospects in Pardot, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Pardot account. For example, you might want to trigger a workflow whenever new contacts are created Pardot to sync your users' Pardot contacts to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Pardot%20triggers%20in%20Paragon%20Connect.png?maxW=879&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=16e3d840fa7a4dffab5a89cf9f215409" alt="" width="879" height="448" data-path="assets/Salesforce Pardot triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Pardot%20triggers%20in%20Paragon%20Connect.png?w=280&maxW=879&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=4c04f94b67c2c1b468a4c3dce4ca5db2 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Pardot%20triggers%20in%20Paragon%20Connect.png?w=560&maxW=879&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=682ae9e90e04084cf24dbd86c0270b48 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Pardot%20triggers%20in%20Paragon%20Connect.png?w=840&maxW=879&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8d5502eadd5a40dcc27926451434c71f 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Pardot%20triggers%20in%20Paragon%20Connect.png?w=1100&maxW=879&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c17039ed2ec75c611f085efaab0e215e 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Pardot%20triggers%20in%20Paragon%20Connect.png?w=1650&maxW=879&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c6eea9c507dbff04757e9fd3900d22cc 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Pardot%20triggers%20in%20Paragon%20Connect.png?w=2500&maxW=879&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=00f135b152a26eec9b687fda0dd0a2c2 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Pardot below:

* **Prospect Created**
* **List Membership Created**


# Pipedrive
Source: https://docs.useparagon.com/resources/integrations/pipedrive

Connect to your users' Pipedrive accounts.

## Setup Guide

### Creating a Pipedrive App

To get started, you'll need to create an app in the Developer Hub of a Pipedrive account.

1. Sign up for a free [Pipedrive developer sandbox here](https://developers.pipedrive.com/).
2. Click the **Profile Icon** in the top right and select **Developer Hub**:

<Frame>
  <img src="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/pipedrive-create-dev-app-1.png?maxW=2528&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=c92e0633910c93320c521892b8d3dbf0" alt="" width="2528" height="1156" data-path="assets/pipedrive-create-dev-app-1.png" srcset="https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/pipedrive-create-dev-app-1.png?w=280&maxW=2528&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=8269f3e6996c19c123284cd847f10e00 280w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/pipedrive-create-dev-app-1.png?w=560&maxW=2528&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=fc7ae442d162dbce792abf0fc8de8017 560w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/pipedrive-create-dev-app-1.png?w=840&maxW=2528&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=d48d27b22ee634d811e588702b2e1c80 840w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/pipedrive-create-dev-app-1.png?w=1100&maxW=2528&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=14c72cec18900e9b6b6fe5e8dd73edbf 1100w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/pipedrive-create-dev-app-1.png?w=1650&maxW=2528&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=f510cefd07fd31bbe7be49272e05c85b 1650w, https://mintcdn.com/paragon/R4LLy7K_LlshO0Ad/assets/pipedrive-create-dev-app-1.png?w=2500&maxW=2528&auto=format&n=R4LLy7K_LlshO0Ad&q=85&s=74868bcd93f3ace04e721463cac92a36 2500w" data-optimize="true" data-opv="2" />
</Frame>

3. Click **Create an app** and select **Create public app**. Public apps are intended to allow your users to connect their
   Pipedrive accounts to your app.

4. Name the app and add [https://passport.useparagon.com/oauth](https://passport.useparagon.com/oauth) as the **Callback URL**. Click **Save**.

<Warning>While testing your integration, you can use `https://passport.useparagon.com/oauth` as your Callback URL.
Once you [set up a Redirect Page](/resources/integrations/pipedrive#setting-up-a-redirect-page-in-your-app) to go live, you will need to change this to the URL of your Redirect Page.</Warning>

6. Configure your app to use the least privileged scopes required for it to function.

7. Copy the following information to set up your Pipedrive app with Paragon.

* Client ID
* Client Secret

### Add your Pipedrive App to Paragon

Complete configuration within the [Paragon Dashboard](https://dashboard.useparagon.com/) and test authentication for your integration.

1. Select Pipedrive from the **Integrations Catalog**.
2. Under **Integrations > Connected Integrations > Pipedrive > Configure**, fill out your OAuth client credentials from the end of [Step 1](/resources/integrations/pipedrive#creating-a-pipedrive-app):

   * **Client ID**
   * **Client Secret**

Click "**Save changes**" button to save your credentials.

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Pipedrive%20application%20to%20Paragon%20Connect.png?maxW=1290&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=23d773857cb64e1d5b5ce3329abf582e" alt="" width="1290" height="592" data-path="assets/Connecting your Pipedrive application to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Pipedrive%20application%20to%20Paragon%20Connect.png?w=280&maxW=1290&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e2ee8fb1e56704cd1030e84919fe0f89 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Pipedrive%20application%20to%20Paragon%20Connect.png?w=560&maxW=1290&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=42e9e5ad52074336dc554fa13fd33be2 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Pipedrive%20application%20to%20Paragon%20Connect.png?w=840&maxW=1290&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=0724562377e5b9cf9f80221a2d81a29d 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Pipedrive%20application%20to%20Paragon%20Connect.png?w=1100&maxW=1290&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f348ae2dac2a4844752eda52edfe8d74 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Pipedrive%20application%20to%20Paragon%20Connect.png?w=1650&maxW=1290&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ba35290bc021a38b69a25adb33bb0f1c 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Pipedrive%20application%20to%20Paragon%20Connect.png?w=2500&maxW=1290&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=4f6a2be038ca75426b134c7b43ecf61a 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys for user authentication. This is intended for development use only.
</Info>

You can now test user authentication with the Connect Portal, build workflows, make Pipedrive requests using the SDK, and call Pipedrive ActionKit actions.

## Connecting to Pipedrive

Once your users have connected their Pipedrive account, you can use the Paragon SDK to access the Pipedrive API on behalf of connected users.

See the Pipedrive REST API documentation for their full API reference.

Any Pipedrive API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Get all persons
await paragon.request("pipedrive", "/persons", {
  method: "GET",
});
            
// Create a person
await paragon.request("pipedrive", "/persons", {
  method: "POST",
  body: {
    "name": "David Bowie",
    "email": "name@domain.com"
  }
});
```

## Building Pipedrive Workflows

Once your Pipedrive account is connected, you can add steps to perform the following actions:

* Create Record
* Update Record
* Get Record by ID
* Get Records
* Delete Record

You can also use the [Pipedrive Request](/workflows/requests#making-integration-requests) step to access any of Pipedrive's API endpoints without the authentication piece.

When creating or updating records in Pipedrive, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Pipedrive%20workflow%20in%20Paragon%20Connect.png?maxW=2262&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=5ed9e081ad02fe1971858ee2051c5b3a" alt="" width="2262" height="1242" data-path="assets/Creating a Pipedrive workflow in Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Pipedrive%20workflow%20in%20Paragon%20Connect.png?w=280&maxW=2262&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=a167aa7c9292f8d50b5ba60852d4df2c 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Pipedrive%20workflow%20in%20Paragon%20Connect.png?w=560&maxW=2262&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=05fc0f4aac00b81a855320565c67afff 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Pipedrive%20workflow%20in%20Paragon%20Connect.png?w=840&maxW=2262&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2878e5d405cec9bd1b08929c764fb6e3 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Pipedrive%20workflow%20in%20Paragon%20Connect.png?w=1100&maxW=2262&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6c70f125e60a1ba18a91fd22a2db6ecd 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Pipedrive%20workflow%20in%20Paragon%20Connect.png?w=1650&maxW=2262&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7c8b30009b20d9a8bf85f318e25d31b7 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Pipedrive%20workflow%20in%20Paragon%20Connect.png?w=2500&maxW=2262&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=fd5ef7901ffc822114c3ccc9cf0f54c3 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Pipedrive account. For example, you might want to trigger a workflow whenever new leads are created in Pipedrive to sync your users' Pipedrive leads to your application in real-time. To use Pipedrive's webhook triggers, you'll need to enable the "Administer account" scope in your Pipedrive application:

1. Log in to the [Pipedrive Developer Portal](https://developers.pipedrive.com/).

2. Navigate to **Tools > Marketplace manager** and select your application.

3. Under **OAuth & Access scopes**, enable **Administer account**.

You can find the full list of Webhook Triggers for Pipedrive below:

* **Record Created**
* **Record Updated**
* **Lead Created**

## Publishing your Pipedrive app

<Warning>
  **Required:** Setting up a Redirect Page is a requirement for allowing customers outside of your Pipedrive Developer account to connect an integration.

  If you do not set up this page, the Pipedrive team will not approve your app for public use.
</Warning>

### Setting up a Redirect Page in your App

Your Pipedrive integration requires a Redirect Page hosted in your application to support an installation flow that *begins* in the Pipedrive Marketplace (i.e., a user searches the Pipedrive Marketplace for your published app and clicks **Install**).

For an example implementation of the Redirect Page using React (based on our Next.js sample app), [see here](https://github.com/ethanlee16/paragon-connect-nextjs-example/blob/redirect-page/pages/integrations/pipedrive.js).

The Redirect Page should be implemented as follows:

* Import the Paragon SDK and authenticate a user.

  * **Note**: If a user is not yet logged into your app, [Pipedrive's requirements](https://pipedrive.readme.io/docs/app-installation-flows#the-user-isnt-logged-into-your-app) suggest that you redirect to a login form, while preserving the intended URL to redirect to upon successful login. In other words, after logging in, your user should see your Redirect Page.

* Accept and read query parameters, which will be:

  * `code` in case of a successful installation

  * `error` in case of an unsuccessful installation or denied consent

* If the `code` query parameter is present,

  * Call `paragon.completeInstall` to complete the OAuth exchange and save a new connected Pipedrive account.

```javascript
 paragon.completeInstall("pipedrive", {
  authorizationCode: codeQueryParam,
  redirectUrl: "https://your-app.url/pipedrive-redirect"
 }).then(() => {
   // Redirect to your app's integrations page
 });
```

* If the `error` query parameter is present,

  * Show this error in your app and allow your user to retry the process.

### Updating the Allowed Redirect URL

If you were previously testing with `https://passport.useparagon.com/oauth` as your Pipedrive Redirect URL, you will need to update this value after implementing a Redirect Page:

1. Log into your Pipedrive [Developer Portal](https://developers.pipedrive.com/).

2. Navigate to **Tools > Marketplace manager** and select your application.

3. Under **OAuth & Access scopes > Callback URL**, provide the URL of your Redirect Page.


# Power BI
Source: https://docs.useparagon.com/resources/integrations/powerbi

Connect to your users' Power BI accounts.

## Setup Guide

You can find your Power BI application credentials by visiting your Microsoft Azure Portal.

You'll need the following information to set up your Power BI app with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Prerequisites

* A [Microsoft Azure](https://azure.microsoft.com/) account

### Add the Redirect URL to your Power BI app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Power BI app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

3. Navigate to **All Services > App Registrations** and select your application.

4. Select **Authentication** from the sidebar.

5. Under **Platform configurations**, press the **"Add a platform"** button.

6. Select the **Web** platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the **Save** button at the top of the page.

### Generate a Client Secret

Since Power BI does not automatically provide you with a Client Secret for your application, we'll need to make one. To get your Client Secret:

1. Navigate to **Manage > Certificates & secrets** in the sidebar.

2. Under **Client Secrets**, press the **+ New client secret** button.

3. Name your client credentials and select an expiry that works best for your application. Press **Add** to create your credentials.

4. Copy the displayed Client Secret under the **Value** column.

<Info>
  **Note:** You will need to periodically create new and update your Client Secret as they expire for all Microsoft integrations.
</Info>

### Add your Power BI app to Paragon

1. Select **Power BI** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Power BI > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/powerbi#add-the-redirect-url-to-your-power-bi-app) in their respective sections:

* **Client ID:** Found under **Essentials > Application (client) ID** on your Microsoft Azure Portal app page.

* **Client Secret:** Found under **Manage > Certificates & secrets** on your Microsoft Azure Portal app page.

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** You should only add the scopes you've requested in your application page to Paragon.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Power%20BI%20app%20to%20Paragon%20Connect.png?maxW=964&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c7f483305fa6995e2bf351e070c4f129" alt="" width="964" height="580" data-path="assets/Connecting your Power BI app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Power%20BI%20app%20to%20Paragon%20Connect.png?w=280&maxW=964&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=d5ede2a68128c65b7390f150184aba1a 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Power%20BI%20app%20to%20Paragon%20Connect.png?w=560&maxW=964&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=80f9137bba08d72d7729b0251e61e407 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Power%20BI%20app%20to%20Paragon%20Connect.png?w=840&maxW=964&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=9d388199ec1e699c566dfcd8773ac1df 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Power%20BI%20app%20to%20Paragon%20Connect.png?w=1100&maxW=964&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=07621b215753bbe5167af10db910141d 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Power%20BI%20app%20to%20Paragon%20Connect.png?w=1650&maxW=964&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=123b37b181ad14dbeb08630affd74198 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Power%20BI%20app%20to%20Paragon%20Connect.png?w=2500&maxW=964&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f55e837e644a947a08b941d141d672be 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Power BI

Once your users have connected their Power BI account, you can use the Paragon SDK to access the Power BI API on behalf of connected users.

See the Power BI [REST API documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/) for their full API reference.

Any Power BI API endpoints can be accessed with the Paragon SDK as shown in this example:

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// List Datasets
await paragon.request("powerbi", "myorg/datasets", {
    method: "GET"
});

// List Reports by ID
await paragon.request("powerbi", "myorg/reports/{reportId}", {
    method: "GET"
});

// Query Accounts by number of employees
await paragon.request("microsoftDynamics", "/accounts?$filter=Microsoft.Dynamics.CRM.Between(PropertyName='numberofemployees',PropertyValues=["5","2000"])”
    method: "GET"
});
```

## Building Power BI workflows

Once your Power BI account is connected, you use the [Power BI Request](/workflows/requests#making-integration-requests) step to access any of Power BI's API endpoints without the authentication piece.

When creating or updating records in Power BI, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Productboard
Source: https://docs.useparagon.com/resources/integrations/productboard

Connect to your users' Productboard accounts.

## Setup Guide

You can find your Productboard app credentials in your [Productboard Integration Settings](https://paragon-sandbox.productboard.com/settings/integrations).

<Info>
  **Note:** Productboard API access is restricted to Productboard Pro plans and above. Your users will need to have Productboard Pro plans or above to use this integration.
</Info>

### Getting your Productboard API Key

1. Login to your Productboard account

2. Navigate to **Workspace Settings** > **Integrations** > **Public API** > **Access Token**

3. Click **+** to generate a new token.

## Connecting to Productboard

Once your users have connected their Productboard account, you can use the Paragon SDK to access the Productboard API on behalf of connected users.

See the Productboard [REST API documentation](https://developer.productboard.com/) for their full API reference.

Any Productboard API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get a Feature by ID
paragon.request("productboard", "/features/{id}", {
  method: "GET"
});

// Update a Feature
paragon.request("productboard", "/features/{id}", {
  method: "PATCH",
  body: {
    "data": {
      "name": "Custom branding",
      "description": "<p>Custom <s>branding</s> for the agent and user portals.</p>",
      "archived": true,
      "status": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "In Progress"
      },
      "timeframe": {
        "startDate": "2022-01-01",
        "endDate": "2022-03-31",
        "granularity": "quarter"
      },
      "parent": {
        "feature": {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      },
      "owner": {
        "email": "email@example.com"
      }
    }
  }
});

// Create a new Release
paragon.request("productboard", "/releases", {
  method: "POST",
  body: {
    "data": {
      "name": "R123",
      "description": "<p>Release <s>R123</s></p>",
      "releaseGroup": {
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "timeframe": {
        "startDate": "2023-01-01",
        "endDate": "2023-03-31",
        "granularity": "quarter"
      },
      "state": "upcoming"
    }
  }
});
  
```

## Building Productboard workflows

Once your Productboard account is connected, you can add steps to perform the following actions:

* Create Feature
* Update Feature
* Get Feature by ID
* Delete Feature
* Create Component
* Update Component
* Get Component by ID
* Get Product by ID

You can also use the [Productboard Request](/workflows/requests#making-integration-requests) step to access any of Productboard's API endpoints without the authentication piece.

When creating or updating records in Productboard, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# QuickBooks
Source: https://docs.useparagon.com/resources/integrations/quickbooks

Connect to your users' QuickBooks accounts.

## Setup Guide

<Info>
  **Note:** You'll need to create a new QuickBooks app if you don't already have one.
</Info>

You can find your QuickBooks app credentials by visiting your [QuickBooks developer portal](https://developer.intuit.com/app/developer/homepage).

You'll need the following information to set up your QuickBooks App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Prerequisites

* An [Intuit Developer account](https://developer.intuit.com/app/developer/homepage).
* A QuickBooks app.

### Add the Redirect URL to your QuickBooks app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your QuickBooks app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to your [QuickBooks developer dashboard](https://developer.intuit.com/app/developer/dashboard) and select your application.

3. Depending on whether your application is in **Development** **(Sandbox)** or **Production**, go to **Keys & OAuth > Redirect URIs**.

4. Paste-in Paragon Connect's redirect URL found in Step 1.

5. Press the blue **Save** button at the bottom of the page to save your updates.

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20QuickBooks%20app.gif?maxW=771&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=59e437953f842cd2a40ea8d0dde0c711" alt="" width="771" height="524" data-path="assets/Enabling OAuth for your QuickBooks app.gif" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20QuickBooks%20app.gif?w=280&maxW=771&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=cc7ea407f65736299a86cc9d1c4ea94f 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20QuickBooks%20app.gif?w=560&maxW=771&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=27bf12ee1985fe0c9a323ec42961eb0a 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20QuickBooks%20app.gif?w=840&maxW=771&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=01db1300edde37050ee3ec4147ea9f7f 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20QuickBooks%20app.gif?w=1100&maxW=771&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=f73ddcdbcccae69992fa971b992e3868 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20QuickBooks%20app.gif?w=1650&maxW=771&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=b165fa883bfa59b65b59330fd01da687 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20QuickBooks%20app.gif?w=2500&maxW=771&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=ab2f2d409d2d2affd346a59a54ebf1f0 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your QuickBooks app to Paragon

Under **Integrations > Connected Integrations > QuickBooks > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/quickbooks#1-add-the-redirect-url-to-your-quickbooks-app) in their respective sections:

* **Client ID:** Found under Keys & OAuth > Keys > Client ID on your QuickBooks App page.
* **Client Secret:** Found under Keys & OAuth > Keys > Client Secret on your QuickBooks App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20QuickBooks%20app%20to%20Paragon%20Connect.png?maxW=987&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a434e2a67eaa6e91356beb18f11a233b" alt="" width="987" height="703" data-path="assets/Connecting your QuickBooks app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20QuickBooks%20app%20to%20Paragon%20Connect.png?w=280&maxW=987&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=56ef055cdb9b83aef1daae1c4078a79d 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20QuickBooks%20app%20to%20Paragon%20Connect.png?w=560&maxW=987&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b2323ce12532953452d04217d39c31c8 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20QuickBooks%20app%20to%20Paragon%20Connect.png?w=840&maxW=987&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=8b0af6da91c0a3f9a6df94087f008a88 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20QuickBooks%20app%20to%20Paragon%20Connect.png?w=1100&maxW=987&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=4d59927691f62b557f65dce9c0875465 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20QuickBooks%20app%20to%20Paragon%20Connect.png?w=1650&maxW=987&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=fb6b9cfda452768849b165cf8b2a6930 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20QuickBooks%20app%20to%20Paragon%20Connect.png?w=2500&maxW=987&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f3c7771057ba457d7729392bdee87481 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to QuickBooks

Once your users have connected their QuickBooks account, you can use the Paragon SDK to access the QuickBooks API on behalf of connected users.

See the QuickBooks [REST API documentation](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/most-commonly-used/account) for their full API reference.

Any QuickBooks API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Create Customer
await paragon.request("quickbooks", "/customer", { 
  method: "POST",
  body: {
    "FullyQualifiedName": "King Groceries", 
    "PrimaryEmailAddr": {
      "Address": "jdrew@myemail.com"
    }, 
    "DisplayName": "King's Groceries", 
    "Suffix": "Jr", 
    "Title": "Mr", 
    "MiddleName": "B", 
    "Notes": "Here are other details.", 
    "FamilyName": "King", 
    "PrimaryPhone": {
      "FreeFormNumber": "(555) 555-5555"
    }, 
    "CompanyName": "King Groceries", 
    "BillAddr": {
      "CountrySubDivisionCode": "CA", 
      "City": "Mountain View", 
      "PostalCode": "94042", 
      "Line1": "123 Main Street", 
      "Country": "USA"
    }, 
    "GivenName": "James"
  }
});


// Query Customers
await paragon.request("quickbooks", "/query?query=select * from Customer", { 
  method: "GET"
});
```

## Building QuickBooks workflows

Once your QuickBooks account is connected, you can add steps to perform the following actions:

* Get Accounts
* Get Customers
* Create Customer
* Update Customer
* Get Invoices
* Create Invoice
* Update Invoice
* Send Invoice
* Get Payments
* Create Payments

You can also use the [QuickBooks Request](/workflows/requests#making-integration-requests) step to access any of QuickBooks's API endpoints without the authentication piece.

When creating or updating records in QuickBooks, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Quickbooks%20in%20Paragon.png?maxW=2314&auto=format&n=867oBBVpxd2C3zc4&q=85&s=601b490817123c2ca152db69307e6287" alt="" width="2314" height="1792" data-path="assets/Using Quickbooks in Paragon.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Quickbooks%20in%20Paragon.png?w=280&maxW=2314&auto=format&n=867oBBVpxd2C3zc4&q=85&s=199175074c0a3a61650573208ee5a44b 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Quickbooks%20in%20Paragon.png?w=560&maxW=2314&auto=format&n=867oBBVpxd2C3zc4&q=85&s=28ecebd4896beb2639107d10fed8f9c4 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Quickbooks%20in%20Paragon.png?w=840&maxW=2314&auto=format&n=867oBBVpxd2C3zc4&q=85&s=5829cbc359686d2a4ef0e8b2363b5149 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Quickbooks%20in%20Paragon.png?w=1100&maxW=2314&auto=format&n=867oBBVpxd2C3zc4&q=85&s=e5c2583bee6a7096983847ee14facaed 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Quickbooks%20in%20Paragon.png?w=1650&maxW=2314&auto=format&n=867oBBVpxd2C3zc4&q=85&s=d96802667a8d575c38613cabe0b583b1 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Quickbooks%20in%20Paragon.png?w=2500&maxW=2314&auto=format&n=867oBBVpxd2C3zc4&q=85&s=df5b743b4fc327ef60a93c1462877f4c 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' QuickBooks account. For example, you might want to trigger a workflow whenever new invoices are created QuickBooks to sync your users' QuickBooks invoices to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/QuickBooks%20webhook%20triggers%20in%20Paragon%20Connect.png?maxW=2184&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ac7894f48346c1121defe20631ebc6ff" alt="" width="2184" height="1324" data-path="assets/QuickBooks webhook triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/QuickBooks%20webhook%20triggers%20in%20Paragon%20Connect.png?w=280&maxW=2184&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=5af8ef570431494cbcea8033a7d2f109 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/QuickBooks%20webhook%20triggers%20in%20Paragon%20Connect.png?w=560&maxW=2184&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e1e7a75611baddbc4eb93b476769c86c 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/QuickBooks%20webhook%20triggers%20in%20Paragon%20Connect.png?w=840&maxW=2184&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=fa8dbabac4a0879c09c04683cd0c11ef 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/QuickBooks%20webhook%20triggers%20in%20Paragon%20Connect.png?w=1100&maxW=2184&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d4839ccafeb22bc8d21674313d9d600b 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/QuickBooks%20webhook%20triggers%20in%20Paragon%20Connect.png?w=1650&maxW=2184&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=0b3d46ddf6b61d763de31042bffdff60 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/QuickBooks%20webhook%20triggers%20in%20Paragon%20Connect.png?w=2500&maxW=2184&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=33b3441b3d5b3866fa2da2ee9e241776 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for QuickBooks below:

* **New Account**
* **New Customer**
* **Customer Updated**
* **New Invoice**
* **Invoice Updated**
* **New Purchase**
* **Purchase Updated**


# Quip
Source: https://docs.useparagon.com/resources/integrations/quip

Connect to your users' Quip accounts.

## Setup Guide

You can find your Quip app credentials in your [Quip Developer Account.](https://quip.com/dev/automation/documentation/current)

You'll need the following information to set up your Quip App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your Quip app to Paragon

Under **Integrations > Connected Integrations > Quip > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Quip App page.
* **Client Secret:** Found under Client Secret on your Quip App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Quip%20app%20to%20Paragon%20Connect.png?maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=7b424c301d675b3bbb73c60d288e4bdd" alt="" width="2044" height="1160" data-path="assets/Connecting your Quip app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Quip%20app%20to%20Paragon%20Connect.png?w=280&maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b0df932c609399b501e7e2db01bc3ed3 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Quip%20app%20to%20Paragon%20Connect.png?w=560&maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=0e0e476be830fc4524c1d11332ea5cc2 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Quip%20app%20to%20Paragon%20Connect.png?w=840&maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=2bab747929c248fe8542f89113c9856e 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Quip%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=f732e3c92611c7dcb1e6342343cde2f2 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Quip%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=90332534989084c80f33dcb640973fb6 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Quip%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2044&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=15c0035f22bd1aca8a99d37617587721 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Quip

Once your users have connected their Quip account, you can use the Paragon SDK to access the Quip API on behalf of connected users.

See the Quip [REST API documentation](https://quip.com/dev/automation/documentation/current) for their full API reference.

Any Quip API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Retrieve Documents, Spreadsheets, or Chat
paragon.request("quip", "/2/threads/<threadIdOrSecretPath>", {
  method: "GET"
});

// Create a Document
paragon.request("quip", "/1/threads/new-document, {
  method: "POST",
  body: {
    title: "My Quip Document"
    content: "<html></html>",
    type: "document"
  }
});
  
```

## Building Quip workflows

Once your Quip account is connected, you can add steps to perform the following actions:

* Get Thread by ID
* Get Recent Threads

You can also use the [Quip Request](/workflows/requests#making-integration-requests) step to access any of Quip's API endpoints without the authentication piece.

When creating or updating records in Quip, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Ramp
Source: https://docs.useparagon.com/resources/integrations/ramp

Connect to your users' Ramp accounts.

## Setup Guide

You can find your Ramp app credentials in your [Ramp Developer Dashboard](https://ramp.com/developer-api).

You'll need the following information to set up your Ramp App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your Ramp app to Paragon

Under **Integrations > Connected Integrations > Ramp > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID in your Ramp Developer API settings.
* **Client Secret:** Found under Client Secret in your Ramp Developer API settings.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Ramp%20app%20to%20Paragon%20Connect.png?maxW=1564&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=4d1086bb2675d8c49d1d5a9a45c403d9" alt="" width="1564" height="1516" data-path="assets/Connecting your Ramp app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Ramp%20app%20to%20Paragon%20Connect.png?w=280&maxW=1564&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=895944276698d6ad9904288b980f11a8 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Ramp%20app%20to%20Paragon%20Connect.png?w=560&maxW=1564&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=cce4f521ceef0b6038a48f4ce035227d 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Ramp%20app%20to%20Paragon%20Connect.png?w=840&maxW=1564&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=22dff096d0c3674db45b339b482dfb5c 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Ramp%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1564&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=23e4fb69ad2c130929e8d72f4aea7cc1 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Ramp%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1564&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e3f81be15d512c1997a459ed19294772 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Ramp%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1564&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=dd3d2a194e044b623acfbf8f8dd0eb19 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Ramp

Once your users have connected their Ramp account, you can use the Paragon SDK to access the Ramp API on behalf of connected users.

See the Ramp [API documentation](https://docs.ramp.com/developer-api/v1/guides/getting-started) for their full API reference.

Any Ramp API endpoints can be accessed with the Paragon SDK as shown in this example.

```js
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Transactions
await paragon.request("ramp", "v1/transactions", {
  method: "GET"
});

// Get Card Details
await paragon.request("ramp", "v1/cards/{card_id}", {
  method: "GET"
});

// Create a Memo
await paragon.request("ramp", "v1/memos", {
  method: "POST",
  body: {
    "memo": "Business lunch with client",
    "transaction_token": "txn_123"
  }
});
```

## Building Ramp workflows

Once your Ramp account is connected, you use the [Ramp Request](/workflows/requests#making-integration-requests) step to access any of Ramp's API endpoints without the authentication piece.

When creating or updating records in Ramp, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Sage Accounting
Source: https://docs.useparagon.com/resources/integrations/sage-accounting

Connect to your users' Sage Accounting systems

## Setup Guide

<Info>
  **Note:** You'll need to create a new ClickUp app if you don't already have one.
</Info>

You can find your Sage Accounting app credentials in your [Sage Accounting Developer Account.](https://developer.sage.com/api/accounting/api/)

You'll need the following information to set up your Sage Accounting App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add the Redirect URL to your Sage Accounting app

Paragon provides a redirect URL to send information to your Sage Accounting app. To add the redirect URL to your Sage Accounting app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log into your [Sage Accounting Developer Portal](https://developer.sage.com/api/accounting/api/).

3. Navigate to **My Account > Applications** and select your application.

4. Under **App Details**, click the edit button.

5. Under **Callback URLs**, paste the Redirect URL provided in Step 1.

ServiceNow provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your project.

### Add your Sage Accounting app to Paragon

Under **Integrations > Connected Integrations > Sage Accounting > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID** Found under App Credentials > Client ID on your Sage Accounting App page.
* **Client Secret:** Found under App Credentials > Client Secret on your Sage Accounting App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Accounting%20app%20to%20Paragon%20Connect.png?maxW=1866&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=991bf8e18b76f9c4cbd8ce571e7482ce" alt="" width="1866" height="1158" data-path="assets/Connecting your Sage Accounting app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Accounting%20app%20to%20Paragon%20Connect.png?w=280&maxW=1866&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b9596502d0778e3d66e8a34f290b2e48 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Accounting%20app%20to%20Paragon%20Connect.png?w=560&maxW=1866&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=b3e8c129f982499a4e5e5cffd7484a9c 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Accounting%20app%20to%20Paragon%20Connect.png?w=840&maxW=1866&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=bd0e394e5214e71e6b8ad9c834044ab5 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Accounting%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1866&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=def5ae5bb02540edf525e21328682dc7 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Accounting%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1866&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a2962e802ee8d8471c92ca8f09b88654 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Accounting%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1866&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=934c89815d54fc69d50c01052aa09b8c 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Sage Accounting

Once your users have connected their Sage Accounting account, you can use the Paragon SDK to access the Sage Accounting API on behalf of connected users.

See the Sage Accounting [REST API documentation](https://developer.sage.com/api/accounting/api/) for their full API reference.

Any Sage Accounting API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Search for a contact by an email address
paragon.request("sageaccounting", "/contacts?email=<Email>", {
  method: "GET"
});

// Create an invoice
paragon.request("sageaccounting", "/sales_invoices", {
  method: "POST",
  body: {
    contact_id: "<Contact ID>",
    date: "2022-01-31",
    invoice_lines: [{
      description: "Item 1",
      ledger_account_id: "<Ledger Account ID>",
      unit_price: "25.99"
    }]
  }
});

// Create a payment for an invoice
paragon.request("sageaccounting", "/contact_payments", {
  method: "POST",
  body: {
    contact_payment: {
      transaction_type_id: "CUSTOMER_RECEIPT",
      payment_method_id: "CREDIT_DEBIT",
      contact_id: "<Contact ID>",
      bank_account_id: "<Bank Account ID>",
      date: "2022-02-01",
      total_amount: "25.99",
      allocated_artefacts: [{
        artefact_id: "<Invoice ID>",
        amount: "25.99"
      }]
    }
  }
});
  
```

## Building Sage Accounting workflows

Once your Sage Accounting account is connected, you use the [Sage Accounting Request](/workflows/requests#making-integration-requests) step to access any of Sage Accounting's API endpoints without the authentication piece.

When creating or updating records in Sage Accounting, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Sage Intacct
Source: https://docs.useparagon.com/resources/integrations/sage-intacct

Connect to your users' Sage Intacct accounts.

## Setup Guide

You can find your Sage Intacct app credentials in your [Sage Intacct Developer Account.](https://developer.intacct.com/api/)

You'll need the following information to set up your Sage Intacct App with Paragon Connect:

* Sender ID
* Sender Password

### Add your Sage Intacct app to Paragon

Under **Integrations > Connected Integrations > Sage Intacct > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Sender ID:** Your Sage Intacct User ID
* **Sender Password:** Your Sage Intacct User Password

<Info>
  Leaving the Sender ID and Sender Password blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Intacct%20application%20to%20Paragon%20Connect.png?maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ee291aa5298d702543feca463a90d00e" alt="" width="1730" height="726" data-path="assets/Connecting your Sage Intacct application to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Intacct%20application%20to%20Paragon%20Connect.png?w=280&maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=0d799ded8085cacb4a8fdff2e3f4476e 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Intacct%20application%20to%20Paragon%20Connect.png?w=560&maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=ff2bf315342b445ff8ab22c78271f2e3 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Intacct%20application%20to%20Paragon%20Connect.png?w=840&maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=a1618e47f01a412585700aa5914f433f 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Intacct%20application%20to%20Paragon%20Connect.png?w=1100&maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=1b2e92a56bb47c99faca7c067e8bb43e 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Intacct%20application%20to%20Paragon%20Connect.png?w=1650&maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=53ce4db80d24a74c89da8418945feadf 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Sage%20Intacct%20application%20to%20Paragon%20Connect.png?w=2500&maxW=1730&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=498a9889edbad4fad8b858ff43efebc8 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Sage Intacct

Once your users have connected their Sage Intacct account, you can use the Paragon SDK to access the Sage Intacct API on behalf of connected users.

See the Sage Intacct [REST API documentation](https://developer.intacct.com/api/) for their full API reference.

Any Sage Intacct API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Query IDs of vendors owed
paragon.request("sageintacct", "/", {
  method: "POST",
  body: `
    <query>
      <object>VENDOR</object>
      <select>
        <field>RECORDNO</field>
      </select>
      <filter>
        <greaterthan>
          <field>TOTALDUE</field>
          <value>0</value>
        </greaterthan>
      </filter>
  </query>
  `
})

// Get a single bill by a record number
paragon.request("sageintacct", "/", {
  method: "POST",
  body: `
    <read>
      <object>APBILL</object>
      <keys>[Bill RECORDNO]</keys>
      <fields>*</fields>
    </read>
  `
});

// Update the header of a bill
paragon.request("sageintacct", "/", {
  method: "POST",
  body: `
    <update>
      <APBILL>
        <RECORDNO>[Bill RECORDNO]</RECORDNO>
        <DESCRIPTION>Changing the description</DESCRIPTION>
      </APBILL>
    </update>
  `
});
  
```

## Building Sage Intacct workflows

Once your Sage Intacct account is connected, you can add steps to perform the following actions:

* Create Vendor
* Update Vendor
* Delete Vendor
* Search Vendors
* Get Vendor by ID
* Search Vendor Types
* Create Bill
* Update Bill
* Delete Bill
* Search Bills
* Get Bill by ID
* Search Payment Terms
* Get Payment Term by ID
* Search Accounts
* Get Account by ID
* Get Dimensions

You can also use the [Sage Intacct Request](/workflows/requests#making-integration-requests) step to access any of Sage Intacct's API endpoints without the authentication piece.

When creating or updating records in Sage Intacct, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Sage Intacct account. For example, you might want to trigger a workflow whenever new bills are created Sage Intacct to sync your users' Sage Intacct bills to your application in real-time.

You can find the full list of Webhook Triggers for Sage Intacct below:

* **New Record**
* **Record Updated**


# Sailthru
Source: https://docs.useparagon.com/resources/integrations/sailthru

Connect to your users' Sailthru accounts.

## Setup Guide

You can find your Sailthru API credentials in your [Sailthru account](https://my.sailthru.com/settings/api_postbacks).

You'll need the following information to set up your Sailthru App with Paragon Connect:

* Company Key
* Company Secret

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to Sailthru

Once your users have connected their Sailthru account, you can use the Paragon SDK to access the Sailthru API on behalf of connected users.

See the Sailthru [REST API documentation](https://getstarted.sailthru.com/developers/api/) for their full API reference.

Any Sailthru API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create a list
paragon.request("sailthru", "[relative URL]", {
  method: "POST",
  body: {
   "list":"My Email List",
   "primary":1,
   "vars":{"color":"blue"},
   "public_name":"My Email List's public name",
   "type":"natural"
  }
});

// List all campaigns
paragon.request("sailthru", "[relative URL]", {
  method: "GET"
});
  
```

## Building Sailthru workflows

Once your Sailthru account is connected, you use the [Sailthru Request](/workflows/requests#making-integration-requests) step to access any of Sailthru's API endpoints without the authentication piece.

When creating or updating records in Sailthru, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Salesforce
Source: https://docs.useparagon.com/resources/integrations/salesforce

Connect to your users' Salesforce accounts.

## Setup Guide

You can find your Salesforce app credentials in your [Salesforce Developer Account.](https://developer.salesforce.com/)

You'll need the following information to set up your Salesforce App with Paragon Connect:

* Consumer Key
* Consumer Secret
* Scopes Requested

### Add the Redirect URL to your Salesforce app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Salesforce app:

1. Log in to your [Salesforce dashboard](https://www.salesforce.com/).

2. Navigate to the gear icon at the top of the page and click **Setup.**

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=e85a83b13c63bccf7d67751450034166" alt="" width="390" height="145" data-path="assets/Going to Setup in Salesforce.gif" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?w=280&maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0a592fe1190b09d670493c145e51d415 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?w=560&maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=659f19a83caf1a19cf18ac982b57f286 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?w=840&maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=06468a226f90f1b1c0aa655bb5d9384a 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?w=1100&maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1bd7e74a51c03d3ef59cd7ac5000ab16 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?w=1650&maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c15b795ebbc4778ab1d8af5747cf1bdb 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20Setup%20in%20Salesforce.gif?w=2500&maxW=390&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=3b23117c9b774fd6dbe96c9bceeac210 2500w" data-optimize="true" data-opv="2" />
</Frame>

3. In the left-hand sidebar, go to **Platform Tools > Apps > App Manager**.

<Info>
  **Note:** You must have the proper admin permissions on your Salesforce account to access the App Manager. If you don't, please speak to your admin.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d2f3af559b1b6f839693cf5217b7187c" alt="" width="222" height="267" data-path="assets/Platform tools to Apps to App Manager in Salesforce.gif" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?w=280&maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=dc9df5fc576f854e4fbfe11518a1a201 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?w=560&maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a6feb322b243be99703bd4cd668fdfa1 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?w=840&maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=6a38ed84739bd3274cfb6937d680a33e 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?w=1100&maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e9e821110573a1f96ee606fe53cfe256 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?w=1650&maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8c7d5ff3b6c85e359d5c95e8ce8a9fea 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Platform%20tools%20to%20Apps%20to%20App%20Manager%20in%20Salesforce.gif?w=2500&maxW=222&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=94ec1c12dcf897fbdba79bc91d0f21c4 2500w" data-optimize="true" data-opv="2" />
</Frame>

4. Click on the registered application you'd like to use. If you don't already have one, click **New Connected App**.

5. Under **API (Enable OAuth Settings)**, mark the "**Enable OAuth Settings**" checkbox.

6. Under **Callback URL**, paste-in Paragon Connect's redirect URL:

```
https://passport.useparagon.com/oauth
```

7. Select any scopes you'd like to use in your application.

8. **Disable “Require Proof Key for Code Exchange (PKCE)”** if it is enabled in your Salesforce Connected App.

9. Press the **Save** button at the bottom of the page.

Salesforce provides your **Consumer Key** and **Consumer Secret** needed for the next step once you register your application.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20Redirect%20URL%20to%20a%20Salesforce%20Integration%20for%20Paragon%20Connect.gif?maxW=1173&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=c5103c18c52b6d2018837a10e5378498" alt="" width="1173" height="541" data-path="assets/Adding a Redirect URL to a Salesforce Integration for Paragon Connect.gif" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20Redirect%20URL%20to%20a%20Salesforce%20Integration%20for%20Paragon%20Connect.gif?w=280&maxW=1173&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=02b918d81fdb689fd65ffa42bbf34f8e 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20Redirect%20URL%20to%20a%20Salesforce%20Integration%20for%20Paragon%20Connect.gif?w=560&maxW=1173&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=10e542db8dd907d18ce7699fbbbb768c 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20Redirect%20URL%20to%20a%20Salesforce%20Integration%20for%20Paragon%20Connect.gif?w=840&maxW=1173&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a040d8027a02344121ec100ec62f5b68 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20Redirect%20URL%20to%20a%20Salesforce%20Integration%20for%20Paragon%20Connect.gif?w=1100&maxW=1173&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=c352988041204156c057cab600430688 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20Redirect%20URL%20to%20a%20Salesforce%20Integration%20for%20Paragon%20Connect.gif?w=1650&maxW=1173&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=85a34979eb96c1fcf564ecc78cc5ae9d 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20Redirect%20URL%20to%20a%20Salesforce%20Integration%20for%20Paragon%20Connect.gif?w=2500&maxW=1173&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=8beff355179506590ad0295fccd4401a 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Salesforce app to Paragon

Under **Integrations > Connected Integrations > Salesforce >** **Settings**, fill out your credentials from the end of [Step 1](/resources/integrations/salesforce#1-add-the-redirect-url-to-your-salesforce-app) in their respective sections:

* **Consumer Key:** Found under Manage Connected Apps > API (Enable OAuth Settings) > Consumer Key on your Salesforce App page.
* **Consumer Secret:** Found under Manage Connected Apps > API (Enable OAuth Settings) > Consumer Secret on your Salesforce App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=b28b224e4be6518d81ab5ace19061ddd" alt="" width="2000" height="1200" data-path="assets/Connectng your Salesforce app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?w=280&maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=4a233fd91ad10ce1a0316da2b88c8e8d 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?w=560&maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e5c0f5190e75887f1ba4e5fd6329a037 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?w=840&maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ec23f6cc1cce2d67fbdb489dc7f29c29 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=9c74339da4f8b0aae901df66aebbfb44 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=bd74d1d2efcce7987211447ce6026c92 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connectng%20your%20Salesforce%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2000&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7f9106c0c53894424f897573ca4b6dd9 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Salesforce

<Info>
  **Note**: Salesforce API access is limited to Enterprise, Unlimited, and Performance Editions of Salesforce, as well as Professional Editions with the paid API add-on. [See Salesforce documentation](https://help.salesforce.com/s/articleView?id=000326486\&type=1) for more information.
</Info>

Once your users have connected their Salesforce account, you can use the Paragon SDK to access the Salesforce API on behalf of connected users.

See the Salesforce [REST API documentation](https://developer.salesforce.com/docs/) for their full API reference.

Any Salesforce API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
          
// Create an Account
await paragon.request("salesforce", "/sobjects/Account", { 
  method: "POST",
  body: { "Name": "Express Logistics and Transport" }
});


// Query Accounts
await paragon.request("salesforce", "/query/Account", { 
  method: "GET",
  body: { "q": "SELECT+name+from+Account" }
});
  
```

## Building Salesforce workflows

Once your Salesforce account is connected, you can add steps to perform the following actions:

* Create Record
* Update Record
* Get Record by ID
* Search Records
* Search Records by SOQL Query
* Deploy Custom Field
* Deploy Custom Object
* Get Records by List View

You can also use the [Salesforce Request](/workflows/requests#making-integration-requests) step to access any of Salesforce's API endpoints without the authentication piece.

When creating or updating records in Salesforce, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Salesforce%20Lead%20in%20Paragon.png?maxW=1005&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d1fe1db4f7e4b4b87772ee3e6f4147a7" alt="" width="1005" height="872" data-path="assets/Creating a Salesforce Lead in Paragon.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Salesforce%20Lead%20in%20Paragon.png?w=280&maxW=1005&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=76d286317fcd0624d56747800b618c2f 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Salesforce%20Lead%20in%20Paragon.png?w=560&maxW=1005&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7e93fddf09e5e437b0249d1e7584131c 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Salesforce%20Lead%20in%20Paragon.png?w=840&maxW=1005&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=91b33e83d522e50e4cfc2efa7b50ea71 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Salesforce%20Lead%20in%20Paragon.png?w=1100&maxW=1005&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d6e2eeebf296186d5fca11d91e3d1197 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Salesforce%20Lead%20in%20Paragon.png?w=1650&maxW=1005&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=434d09ef39baf2c8ec6dfbef21a8a1cd 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20Salesforce%20Lead%20in%20Paragon.png?w=2500&maxW=1005&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=f8ab402af9c1ccb70bdffcbabe961819 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Working with Salesforce Custom Objects and Custom Fields

It's common that different Salesforce instances may be configured with different Custom Objects or Custom Fields. Paragon provides the ability for your users to choose their own Custom Object mapping. You can also deploy Custom Objects or Custom Fields that may be specific to your application to your users' Salesforce instances.

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/4eb88bc1-205e-48d7-82fc-67a70b92650b.gif?maxW=948&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=b6cd6f0337152d6a4f03e153c1434973" alt="" width="948" height="655" data-path="assets/4eb88bc1-205e-48d7-82fc-67a70b92650b.gif" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/4eb88bc1-205e-48d7-82fc-67a70b92650b.gif?w=280&maxW=948&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=f3a32c581d100e525f39543b0731c2e3 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/4eb88bc1-205e-48d7-82fc-67a70b92650b.gif?w=560&maxW=948&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=7a361733f9abd1cd5491022d15ba3985 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/4eb88bc1-205e-48d7-82fc-67a70b92650b.gif?w=840&maxW=948&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=4e49ec250dbc3e5d7b0d9461483bb1a5 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/4eb88bc1-205e-48d7-82fc-67a70b92650b.gif?w=1100&maxW=948&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=a0de28d6111781783e3599359c495736 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/4eb88bc1-205e-48d7-82fc-67a70b92650b.gif?w=1650&maxW=948&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=af045ff0bd046e79fb74b6237d38d639 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/4eb88bc1-205e-48d7-82fc-67a70b92650b.gif?w=2500&maxW=948&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=579b6fb4d6afae8d2203714b09b3501a 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Custom Object Mapping

To allow your users to choose their own Custom Object Mapping, add the **Custom Object Mapping** user setting in your Connect Portal Editor. You should give this setting a descriptive user-setting name, for example, if you're mapping contacts from your app to Salesforce, you might call this "Map Contacts to this object".

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%2010.34.55%20AM.png?maxW=2334&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=de18a66291559fa7d74c0944cf00fa6f" alt="" width="2334" height="1880" data-path="assets/Screen Shot 2021-05-19 at 10.34.55 AM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%2010.34.55%20AM.png?w=280&maxW=2334&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=5917633e85f95776a0fe65cd17a35683 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%2010.34.55%20AM.png?w=560&maxW=2334&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3143cd4243d530b2db837580da47dbc3 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%2010.34.55%20AM.png?w=840&maxW=2334&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=77052f1a315dd50eee5bc418a6fc451d 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%2010.34.55%20AM.png?w=1100&maxW=2334&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=fd0693114d4f5b447bc38be632aa5dd1 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%2010.34.55%20AM.png?w=1650&maxW=2334&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=9c216680fea73e120d29929102f2de40 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%2010.34.55%20AM.png?w=2500&maxW=2334&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f52875ebeb95d3defb92ad1ec898ad75 2500w" data-optimize="true" data-opv="2" />
</Frame>

Below, **add a label for each object property that should be mapped from your app to a Salesforce object field**. In our contacts example, you might add labels for "First Name", "Last Name", and "Email".

In your Connect Portal, your users will be prompted to select an object from their Salesforce instance when enabling this workflow. For each of the object properties you labeled, your users will be prompted to select which object field that property should be mapped to.

In the workflow editor, you can now access your user's custom object mapping in the variable menu. For example:

<Frame>
    <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=3b3d5b2ae79a09a53f730b031a85b873" alt="" width="699" height="956" data-path="assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?w=280&maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=11b83660b4560018d5af78ebf0b7cc76 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?w=560&maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=fccf3a2730e7d954a670533915571d93 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?w=840&maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=cec1f7b703219c3e861d15f767565df3 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?w=1100&maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=95b02ac8ceef79b76d02d353c8ab4a81 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?w=1650&maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=1db8b1abc5b19368385ddb2e953c6384 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/f073e110-9be8-460b-9322-f0b6cbf9d660.gif?w=2500&maxW=699&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ae1f04d5b8299f63e27c7954d054694e 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Deploying Custom Objects or Custom Fields

To deploy Custom Objects or Custom Fields to your users' Salesforce instances, use the **Deploy Custom Object** or **Deploy Custom Field** Salesforce workflow actions.

Both **Deploy Custom Object** and **Deploy Custom Field** will upsert by default, for example, if you run **Deploy Custom Field** on an existing Custom Field, it will apply any relevant updates to the Custom Field.

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/08d54802-d01d-4bfc-b03f-43566af47441.gif?maxW=1143&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=c25b63faf535c21aa21f14c5052c83f6" alt="" width="1143" height="846" data-path="assets/08d54802-d01d-4bfc-b03f-43566af47441.gif" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/08d54802-d01d-4bfc-b03f-43566af47441.gif?w=280&maxW=1143&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=08f8f7d6dd26c3fcb8e1959a1c9d50bd 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/08d54802-d01d-4bfc-b03f-43566af47441.gif?w=560&maxW=1143&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=7eb1bab76f60dd9e8e338234d36d3ba1 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/08d54802-d01d-4bfc-b03f-43566af47441.gif?w=840&maxW=1143&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=111775e6e0ba152e0c03a33ed79a570f 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/08d54802-d01d-4bfc-b03f-43566af47441.gif?w=1100&maxW=1143&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=d3e91f29931927dd61cae1a59ba95043 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/08d54802-d01d-4bfc-b03f-43566af47441.gif?w=1650&maxW=1143&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=9c1735f9b22a5985457ef5b8cea376cc 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/08d54802-d01d-4bfc-b03f-43566af47441.gif?w=2500&maxW=1143&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=3273d3fe53872a4edaa5733025de28c0 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Referencing Custom Objects and Fields

You can reference any Salesforce object (provided that the object exists in your user's Salesforce instance) when creating, updating, or searching records by selecting **Custom Object** under **Record Type** and referencing the **Object Name**.

Similarly, you can reference any Salesforce field (provided that the field exists on the target object) when creating or updating records.

The Object Name for Custom Objects and the Field Name for Custom Fields are both suffixed with `__c`.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%201.07.08%20PM.png?maxW=1272&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c582b645cd259ff2d8651cb5b3883218" alt="" width="1272" height="1306" data-path="assets/Screen Shot 2021-05-19 at 1.07.08 PM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%201.07.08%20PM.png?w=280&maxW=1272&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=868164b2152767e14f652039229cfe47 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%201.07.08%20PM.png?w=560&maxW=1272&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=10dcd7da1d74d72953736367d0c46b45 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%201.07.08%20PM.png?w=840&maxW=1272&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=4d10faecb768362c93e8c937c35b6431 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%201.07.08%20PM.png?w=1100&maxW=1272&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1bd4c24121340490cf719362947e1f80 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%201.07.08%20PM.png?w=1650&maxW=1272&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=6c10cd7d3b961edd54a1750589d79cef 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-05-19%20at%201.07.08%20PM.png?w=2500&maxW=1272&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=55eb8c544221b283c185e8af8f3f78e5 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Salesforce account. For example, you might want to trigger a workflow whenever new contacts are created in Salesforce to sync your users' Salesforce contacts to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Triggers%20in%20Paragon%20Connect.png?maxW=1772&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e5875b0f79484669439a00694d963b96" alt="" width="1772" height="1546" data-path="assets/Salesforce Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=1772&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=b1296fc8325f3421d18c1b54c211439b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=1772&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=6471907ea100bba3e0d660cc9e20cfc4 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=1772&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=63f72f7109349c8aa50b78963701e9f7 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=1772&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=54888758840486b458a35ac6fb98d270 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=1772&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f0f8d6c75a6a888e4c9ec21b1a9544e4 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=1772&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3a5100e0f13b1b56b006ca58b0b09c30 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Salesforce below:

* **New Record**
* **Record Deleted**
* **Record Updated**
* **Campaign Member Added**
* **Campaign Opportunity Added**


# Salesloft
Source: https://docs.useparagon.com/resources/integrations/salesloft

Connect to your users' Salesloft accounts.

## Setup Guide

You can find your Salesloft app credentials in your [Salesloft Developer Account.](https://developers.salesloft.com/api.html)

You'll need the following information to set up your Salesloft App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your Salesloft app to Paragon

Under **Integrations > Connected Integrations > Salesloft > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Salesloft App page.
* **Client Secret:** Found under Client Secret on your Salesloft App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Leaving the Client ID and Client Secret blank will use Paragon development keys.

<Frame>
  <img src="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Salesloft%20app%20to%20Paragon%20Connect.png?maxW=2218&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=c84f9c65c9cf2592ff2f03f556941b09" alt="Connecting your Salesloft app to Paragon Connect" width="2218" height="908" data-path="assets/Connecting your Salesloft app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Salesloft%20app%20to%20Paragon%20Connect.png?w=280&maxW=2218&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=5e0d7647f38655685edc9e130bf87ae6 280w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Salesloft%20app%20to%20Paragon%20Connect.png?w=560&maxW=2218&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=e55b95190bfc1578ad1c60c1a7baea93 560w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Salesloft%20app%20to%20Paragon%20Connect.png?w=840&maxW=2218&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=224fbd65afc39716acb42f5179d2acc3 840w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Salesloft%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2218&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=76025516a7cf81f215fb78847342d996 1100w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Salesloft%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2218&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=dd1a139a86617857571be96485737fbf 1650w, https://mintcdn.com/paragon/JtnB3_DeUOyB_qxZ/assets/Connecting%20your%20Salesloft%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2218&auto=format&n=JtnB3_DeUOyB_qxZ&q=85&s=3b797048700f28693b36c0f3c6284aba 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Salesloft

Once your users have connected their Salesloft account, you can use the Paragon SDK to access the Salesloft API on behalf of connected users.

See the Salesloft [REST API documentation](https://developers.salesloft.com/api.html) for their full API reference.

Any Salesloft API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Fetch a call by ID
await paragon.request("salesloft", "/v2/activities/calls/<CALL ID>.json", {
  method: "GET"
});

// List people
await paragon.request("salesloft", "/v2/people.json", {
  method: "GET"
});
  
```

## Building Salesloft workflows

Once your Saleloft account is connected, you can add steps to perform the following actions:

* Create an Account
* Update an Account
* Get an Account
* Delete an Account
* Search Accounts
* Create a Custom Field
* Update a Custom Field
* Get a Custom Field
* Delete a Custom Field
* Search Custom Fields
* Create a Call
* Get a Call
* Search Calls
* Create a Person
* Update a Person
* Get a Person
* Delete a Person
* Search Persons
* Create a Task
* Update a Task
* Get a Task
* Search Tasks

You can also use the [Salesloft Request](/workflows/requests#making-integration-requests) step to access any of Salesloft's API endpoints without the authentication piece.

When creating or updating records in Salesloft, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Salesloft account. For example, you might want to trigger a workflow whenever new people are created in Salesloft to sync your users' Salesloft contacts to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesloft%20Triggers%20in%20Paragon%20Connect.png?maxW=1108&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8683924f9ca4bfbea4487707c368d05b" alt="" width="1108" height="764" data-path="assets/Salesloft Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesloft%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=1108&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=37f7efaa62e7883d4f17940a0a108a39 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesloft%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=1108&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=7ee55b6f4ffaebc7fc18f4a8608cd4c7 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesloft%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=1108&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d64070697698a653a37cae1fc47ae9fb 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesloft%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=1108&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1f4a5254bceaccce7931d1c06d4ad82f 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesloft%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=1108&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3482cfc6e856adde8c8769fb04d25a71 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesloft%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=1108&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c4215148e715dd798ad1caf7778a4437 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Salesloft below:

* **New Person Created**
* **Person Updated**
* **New Account Created**
* **Account Updated**


# SAP S/4HANA
Source: https://docs.useparagon.com/resources/integrations/saps4hana

Connect to your users' SAP S/4HANA accounts.

## Setup Guide

You can find your SAP S/4HANA app credentials in your [SAP S/4HANA Developer Account.](https://api.sap.com/)

You'll need the following information to set up your SAP S/4HANA App with Paragon Connect:

* SAP Host URL
* Username
* Password

## Connecting to SAP S/4HANA

Once your users have connected their SAP S/4HANA account, you can use the Paragon SDK to access the SAP S/4HANA API on behalf of connected users.

See the SAP S/4HANA [REST API documentation](https://api.sap.com/) for their full API reference.

Any SAP S/4HANA API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get the top 50 supplier invoices
paragon.request("saps4hana", "/odata/sap/API_SUPPLIERINVOICE_PROCESS_SRV/A_SupplierInvoice?$top=50&$inlinecount=allpages", {
  method: "GET"
});

// Release an invoice by ID
paragon.request("saps4hana", "/odata/sap/API_SUPPLIERINVOICE_PROCESS_SRV/Release?SupplierInvoice=<SupplierInvoiceID>&FiscalYear=2022&DiscountDaysHaveToBeShifted=true", {
  method: "POST"
});

// Get a customer by ID
paragon.request("saps4hana", "/odata/sap/API_BUSINESS_PARTNER/A_Customer(%27<Customer ID>%27)", {
  method: "GET"
});
  
```

## Building SAP S/4HANA workflows

Once your SAP S/4HANA account is connected, you can add steps to perform the following actions:

* Create Supplier Invoice
* Get Supplier Invoice by ID
* Search Supplier Invoices
* Delete Supplier Invoice
* Get Supplier by ID
* Search Suppliers
* Update Supplier
* Get Customer by ID
* Search Customer
* Update Customer

You can also use the [SAP S/4HANA Request](/workflows/requests#making-integration-requests) step to access any of SAP S/4HANA's API endpoints without the authentication piece.

When creating or updating records in SAP S/4HANA, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# SAP SuccessFactors
Source: https://docs.useparagon.com/resources/integrations/sapsuccessfactors

Connect to your users' SAP SuccessFactors accounts.

## Setup Guide

You'll need the following information to set up your SAP SuccessFactors App with Paragon Connect:

* SAP SuccessFactor API Server
* Username
* Password

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to SAP SuccessFactors

Once your users have connected their SAP SuccessFactors account, you can use the Paragon SDK to access the SAP SuccessFactors API on behalf of connected users.

See the SAP SuccessFactors [REST API documentation](https://api.sap.com/package/SuccessFactorsEmployeeCentral/all) for their full API reference.

Any SAP SuccessFactors API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Company Directory
paragon.request("sapsucessfactors", "/", {
  method: "GET"
});

// Create a time-off request
paragon.request("sapsucessfactors", "/WorkScheduleDay", {
  method: "POST"
});

// Get benefit deduction types
paragon.request("sapsucessfactors", "/BenefitDeductionDetails?$top=10", {
  method: "GET"
});
  
```

## Building SAP SuccessFactors workflows

Once your SAP SuccessFactors account is connected, you use the [SAP SuccessFactors Request](/workflows/requests#making-integration-requests) step to access any of SAP SuccessFactors's API endpoints without the authentication piece.

When creating or updating records in SAP SuccessFactors, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Segment
Source: https://docs.useparagon.com/resources/integrations/segment

Connect to your users' Segment accounts.

## Setup Guide

You can find your Segment account credentials in your [Segment Account](https://segment.com/).

You'll need the following information to set up your Segment App with Paragon Connect:

* Segment API Key

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to Segment

Once your users have connected their Segment account, you can use the Paragon SDK to access the Segment API on behalf of connected users.

See the Segment [REST API documentation](https://docs.segmentapis.com/) for their full API reference.

Any Segment API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create a new source
paragon.request("segment", "/sources", {
  method: "POST",
  body: {
    "slug": "my-test-source-r-dsv2",
    "name": "My Source",
    "enabled": true,
    "metadataId": "IqDTy1TpoU",
    "settings": { ... }
  }
});

// List all warehouses
paragon.request("segment", "/warehouses", {
  method: "GET"
});
  
```

## Building Segment workflows

Once your Segment account is connected, you use the [Segment Request](/workflows/requests#making-integration-requests) step to access any of Segment's API endpoints without the authentication piece.

When creating or updating records in Segment, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# ServiceNow
Source: https://docs.useparagon.com/resources/integrations/servicenow

Connect to your users' ServiceNow accounts.

## Setup Guide

### Creating a ServiceNow Test Account

You can create a ServiceNow test account from the [ServiceNow Developer Portal](https://developer.servicenow.com/dev.do).

In the ServiceNow Developer Portal, you can create a free developer instance by clicking the **Request Instance** button in the page header.

To connect to ServiceNow, your users will need to provide an **Instance URL**, **Username**, and **Password**. You can find these values for your test account by going to the **User Icon > Manage instance password.**

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-03%20at%2014.56.04@2x.png?maxW=1664&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=e2d9dbb9b1c211ade17e0927d61ae8cb" alt="" width="1664" height="1582" data-path="assets/CleanShot 2023-11-03 at 14.56.04@2x.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-03%20at%2014.56.04@2x.png?w=280&maxW=1664&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=105ace05f813f71a940099222d7eb51e 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-03%20at%2014.56.04@2x.png?w=560&maxW=1664&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=2ad15cdbf4178ab6ebec3d7e21c68f6d 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-03%20at%2014.56.04@2x.png?w=840&maxW=1664&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=78670740df019297901de1516b26244c 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-03%20at%2014.56.04@2x.png?w=1100&maxW=1664&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ece7a1b66b53fa73afb9d4e3e1e224db 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-03%20at%2014.56.04@2x.png?w=1650&maxW=1664&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=0b5c5c0320a88412f0236506256f6d34 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-03%20at%2014.56.04@2x.png?w=2500&maxW=1664&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=2e29b2fcfd4fc17ef8693cf466d2f058 2500w" data-optimize="true" data-opv="2" />
</Frame>

Creating a developer instance within ServiceNow's Developer Portal is a self-service process.

## Using the Paragon SDK for ServiceNow

Once your users have connected their ServiceNow account, you can use the Paragon SDK to access the ServiceNow API on behalf of connected users.

See the ServiceNow [REST API documentation](https://docs.servicenow.com/bundle/paris-application-development/page/build/applications/concept/api-rest.html) for their full API reference.

Any ServiceNow API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Get incident records
await paragon.request("servicenow", "/now/table/incident", {
  method: "GET",
});
            
// Create incident records
await paragon.request("servicenow", "/now/table/incident", {
  method: "POST",
  body: {
    "short_description":"Test incident creation",
    "comments":"These are my comments"
  }
});
```

## Building ServiceNow workflows

Once your ServiceNow account is connected, you can add steps to perform the following actions:

* Create Ticket
* Update Ticket
* Get Tickets
* Get Ticket by ID

You can also use the [ServiceNow Request](/workflows/requests#making-integration-requests) step to access any of ServiceNow's API endpoints without the authentication piece.

When creating or updating records in ServiceNow, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20ServiceNow%20workflow%20in%20Paragon%20Connect.png?maxW=2224&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=19831116721ec7873739c1c4977016d8" alt="" width="2224" height="1248" data-path="assets/Creating a ServiceNow workflow in Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20ServiceNow%20workflow%20in%20Paragon%20Connect.png?w=280&maxW=2224&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=f20e0e6509561602e02725dcd3948e44 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20ServiceNow%20workflow%20in%20Paragon%20Connect.png?w=560&maxW=2224&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=396feba05524a5216a53e4829b47f391 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20ServiceNow%20workflow%20in%20Paragon%20Connect.png?w=840&maxW=2224&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=9c311ba3803fc3fc98f630459e9968c8 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20ServiceNow%20workflow%20in%20Paragon%20Connect.png?w=1100&maxW=2224&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=3a5fec011cd9aa3fa83c8ab1158f68ed 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20ServiceNow%20workflow%20in%20Paragon%20Connect.png?w=1650&maxW=2224&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=35e2e90cc712cce4096526de4d7f2165 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20a%20ServiceNow%20workflow%20in%20Paragon%20Connect.png?w=2500&maxW=2224&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=08e81dd66a7ebc8562c11599ff156287 2500w" data-optimize="true" data-opv="2" />
</Frame>


# SharePoint
Source: https://docs.useparagon.com/resources/integrations/sharepoint

Connect to your users' SharePoint accounts.

Setup Guide

You can find your SharePoint application credentials by visiting your Microsoft Azure Portal.

You'll need the following information to set up your SharePoint app with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Prerequisites

* A [Microsoft Azure](https://azure.microsoft.com/) account

### Add the Redirect URL to your SharePoint app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your SharePoint app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

3. Navigate to **All Services > App Registrations** and select your application.

4. Select **Authentication** from the sidebar.

5. Under **Platform configurations**, press the **"Add a platform"** button.

6. Select the **Web** platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the **Save** button at the top of the page.

### Generate a Client Secret

Since SharePoint does not automatically provide you with a Client Secret for your application, we'll need to make one. To get your Client Secret:

1. Navigate to **Manage > Certificates & secrets** in the sidebar.

2. Under **Client Secrets**, press the **+ New client secret** button.

3. Name your client credentials and select an expiry that works best for your application. Press **Add** to create your credentials.

4. Copy the displayed Client Secret under the **Value** column.

<Info>
  **Note:** You will need to periodically create new and update your Client Secret as they expire for all Microsoft integrations.
</Info>

### Enable Multi-tenancy to your SharePoint app

To allow Microsoft users from outside of your organization to connect to your SharePoint application, you must specify this as an option within the SharePoint application registration.

1. Log in to the [Microsoft Azure Portal](https://azure.microsoft.com/) using your Microsoft account.

2. Navigate to **All Services > App Registrations** and select your application.

3. Select **Authentication** from the sidebar.

4. Under **Supported account types**, press the **"Accounts in any organizational directory"** option.

5. Click Save.

### Add your SharePoint app to Paragon

1. Select **SharePoint** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > SharePoint > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/sharepoint#add-the-redirect-url-to-your-sharepoint-app) and [Step 2](/resources/integrations/sharepoint#generate-a-client-secret) in their respective sections:

* **Client ID:** Found under Essentials > Application (client) ID on your Microsoft Azure Portal app page.
* **Client Secret:** Found at the end of [Step 2](/resources/integrations/sharepoint#generate-a-client-secret).
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** You should only add the scopes you've requested in your application page to Paragon.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Sharepoint%20to%20Paragon%20Connect.png?maxW=2008&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c385a0c450411de909dc074d96f48f48" alt="" width="2008" height="1182" data-path="assets/Connecting Sharepoint to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Sharepoint%20to%20Paragon%20Connect.png?w=280&maxW=2008&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=865f058f7e67655746d6fcd0e762d40d 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Sharepoint%20to%20Paragon%20Connect.png?w=560&maxW=2008&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=a1fe64814807e857d60e62229f376b5d 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Sharepoint%20to%20Paragon%20Connect.png?w=840&maxW=2008&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=d47b5d3806139064ce6423b2f55c9930 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Sharepoint%20to%20Paragon%20Connect.png?w=1100&maxW=2008&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=91dd58c51fe2f447127e2b0ed4648aae 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Sharepoint%20to%20Paragon%20Connect.png?w=1650&maxW=2008&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e9896bad6f78728788d3c22b72e0ddd4 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20Sharepoint%20to%20Paragon%20Connect.png?w=2500&maxW=2008&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8285184f9605632a03f66766e0e97cca 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to SharePoint

Once your users have connected their SharePoint account, you can use the Paragon SDK to access the SharePoint API on behalf of connected users.

See the SharePoint [REST API documentation](https://docs.microsoft.com/en-us/graph/api/resources/sharepoint?view=graph-rest-1.0) for their full API reference.

Any SharePoint API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Get organization’s default site
await paragon.request("sharepoint", "/sites/root", { 
  method: "GET",
});


// Get list under a site
await paragon.request("sharepoint", "/sites/{site-id}/lists", { 
  method: "GET",
});

// Create task in list
await paragon.request("sharepoint", "sites/{site-id}/lists/{list-id}/items", { 
  method: "POST",
  body: {
    "fields": {
      "Title": "Widget",
      "Color": "Purple",
      "Weight": 32
    }
}
});
```

## Building SharePoint workflows

Once your SharePoint account is connected, you can add steps to perform the following actions:

* Create Item
* Update Item
* Get Item by ID
* Get Items in a List
* Delete Item
* Create List
* Get List by ID
* Get Lists
* Create List Column
* Get List Columns

You can also use the [SharePoint Request](/workflows/requests#making-integration-requests) step to access any of SharePoint's API endpoints without the authentication piece.

When creating messages in SharePoint, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Sharepoint account. For example, you might want to trigger a workflow whenever new items are created in Sharepoint to sync your users' Sharepoint items to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sharepoint%20Triggers%20in%20Paragon%20Connect.png?maxW=1018&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=40ab7970745601741f24ea6b50491d27" alt="" width="1018" height="714" data-path="assets/Sharepoint Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sharepoint%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=1018&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=bd3dabf0ab8494f345be3df64e4802a4 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sharepoint%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=1018&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=02a64b1530658abe3cdc0c8f726726aa 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sharepoint%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=1018&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=cb7fff2f60c5d5c25df732f72cdb4d5e 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sharepoint%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=1018&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=7cfdf5c85b169f6ccaa8eeb6d1cff401 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sharepoint%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=1018&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=5a1c115fcea3a20fb3802e4ae99dcb8d 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sharepoint%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=1018&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=63dde669452d77df9ec9cada702d8de4 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Sharepoint below:

* **Item Created**
* **Item Updated**
* **File Deleted**
* **Page Modified**

## Using the SharePoint File Picker

You can allow your user to select files from their SharePoint account in your app with the Paragon SDK.

**Showing the File Picker**

Use the Paragon SDK in your frontend application to show the File Picker in your app.

The SDK provides an `ExternalFilePicker` class to load SharePoint's JavaScript into your page and authenticate with your user's connected SharePoint account.

```javascript
let picker = new paragon.ExternalFilePicker("sharepoint", {
    onFileSelect: (files) => {
        // Handle file selection
    }
});

// Loads external dependencies and user's access token
await picker.init();

// Open the File Picker
picker.open();
```

You can configure the File Picker to listen for additional callbacks or to restrict allowed file types. Learn more about configuring File Picker options in the [SDK Reference](/apis/api-reference#externalfilepicker).

#### Downloading the Selected File

The SharePoint File Picker callback will return a `Response` object describing the user's file picker interaction including an array of any files selected. Using this array of `fileIds`, you can use the [Proxy API](/apis/proxy) to perform an authenticated proxy requests to download the files.

<CodeGroup>
  ```javascript JavaScript
  await paragon.request('sharepoint', '/_api/web/GetFileById(<fileID>)/$value', {
  	method: 'GET'
  });
  ```

  ```plain REST API
  POST https://proxy.useparagon.com/projects/19d...012/sdk/proxy/sharepoint/_api/web/GetFileById(<fileID>)/$value

  Authorization: Bearer eyJ...
  Content-Type: application/json
  ```
</CodeGroup>


# Shopify
Source: https://docs.useparagon.com/resources/integrations/shopify

Connect to your users' Shopify accounts.

You can find your Shopify application credentials by visiting your [Shopify Partner Dashboard](https://partners.shopify.com/organizations).

You'll need the following information to set up your Shopify App with Paragon:

* Client ID
* Client Secret
* Scopes Requested
* Shopify Developer account, also known as a Shopify Partner account. You can create one [here](https://developers.shopify.com/).
* Shopify development store. Learn more about creating a development store [here](https://help.shopify.com/en/partners/dashboard/managing-stores/development-stores#create-a-development-store-for-testing-apps-or-themes).
* Shopify application. Learn more about creating a Shopify application [here](https://shopify.dev/tutorials/authenticate-a-public-app-with-oauth#generate-credentials-from-your-partner-dashboard).

### Add the Redirect URL to your Shopify app

Paragon provides a redirect URL to send information to your Shopify app. To add the redirect URL to your Shopify app:

1. Log in to your Shopify [Partner Dashboard](https://partners.shopify.com/current/resources) and select your app.

2. Navigate to **App setup > URLs > Allowed redirection URL(s)**

3. Add your app's Initial Redirect URL to "**App URL**". While testing your integration, you can use your app's root URL. Once you [set up an Initial Redirect](/resources/integrations/shopify#initial-redirect) to go live, you will need to change this to the URL of your Initial Redirect.

4. Add your app's Redirect Callback URL to "**Allowed redirection URL(s)**". While testing your integration, you can use `https://passport.useparagon.com/oauth`. Once you [set up a Redirect Callback](/resources/integrations/shopify#setting-up-redirect-pages-in-your-app) to go live, you will need to change this to the URL of your Redirect Callback.

5. Press the **Save** button at the top of the page to save your changes.

<Info>
  **Note:** You'll need a Shopify application to connect your application to Paragon. Learn more about creating a Shopify application [here](https://shopify.dev/tutorials/authenticate-a-public-app-with-oauth#generate-credentials-from-your-partner-dashboard).
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20Shopify%20app.gif?maxW=889&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=5d4c1fe81019e08086902382837167c2" alt="" width="889" height="650" data-path="assets/Enabling OAuth for your Shopify app.gif" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20Shopify%20app.gif?w=280&maxW=889&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=6dfc044ef26d5b2198c1e35ffc0177c2 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20Shopify%20app.gif?w=560&maxW=889&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=398ac2858a37735ebe2c295c77d51e56 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20Shopify%20app.gif?w=840&maxW=889&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=8061dc5a4efa3c2fddef5edb3d6d55ab 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20Shopify%20app.gif?w=1100&maxW=889&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=512fd0d8bdcc3fcb179c925395f12e8a 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20Shopify%20app.gif?w=1650&maxW=889&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=9c20b80a91187f0ad47715164e9f5555 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20OAuth%20for%20your%20Shopify%20app.gif?w=2500&maxW=889&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=17f4f7ce5685d25c90a178da3309073c 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add a development store to your Shopify app

1. Log in to your Shopify [Partner Dashboard](https://partners.shopify.com/current/resources).

2. Click **Apps** on the sidebar.

3. Select your Shopify application.

4. In the **Test your app** section, press the **Select store** button.

5. Choose the development store you'd like to connect to.

<Info>
  **Note:** You'll need to create a development store if you don't already have one. Learn more about creating a Shopify development store [here](https://help.shopify.com/en/partners/dashboard/managing-stores/development-stores#create-a-development-store-for-testing-apps-or-themes).
</Info>

### Add your Shopify app to Paragon

1. Select **Shopify** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Shopify > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/shopify#1-add-the-redirect-url-to-your-shopify-app) in their respective sections:

* **Client ID:** Found under Apps > Client credentials > Client ID on your Shopify app page.
* **Client Secret:** Found under Apps > Client credentials > Client Secret on your Shopify app page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com) A complete list of Shopify's scopes is [here](https://shopify.dev/docs).

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** You should only add the scopes you've requested in your application page to Paragon.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-03-21%20at%2012.17.39@2x.png?maxW=1342&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=624c510c60711c54bd93083f39f49afa" alt="" width="1342" height="1156" data-path="assets/CleanShot 2024-03-21 at 12.17.39@2x.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-03-21%20at%2012.17.39@2x.png?w=280&maxW=1342&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3f32c7470142b5fc0204110108afda6a 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-03-21%20at%2012.17.39@2x.png?w=560&maxW=1342&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=baeb91a15dfcb0f40fddabc862d43d84 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-03-21%20at%2012.17.39@2x.png?w=840&maxW=1342&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3d388d14a9caea6ecc3beb041995851d 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-03-21%20at%2012.17.39@2x.png?w=1100&maxW=1342&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=838ae6a3878b610dd3c917c613c863c6 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-03-21%20at%2012.17.39@2x.png?w=1650&maxW=1342&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=d45a7710b644b47ec89670f23de44690 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-03-21%20at%2012.17.39@2x.png?w=2500&maxW=1342&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=fc0ceabad08b160dc9f003bfc69c27b4 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Shopify

Once your users have connected their Shopify account, you can use the Paragon SDK to access the Shopify API on behalf of connected users.

See the Shopify [REST API documentation](https://shopify.dev/docs/admin-api/rest/reference) for their full API reference.

Any Shopify API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Create Customer
await paragon.request("shopify", "/admin/api/2020-10/customers.json", { 
  method: "POST",
  body: { 
    "first_name": "John",
    "last_name": "Norman",
    "email": "example@example.com",
    "phone": "+16135551111",
    "note": "Creating customer for testing",
    "tags": ["tag1","tag2"]
   }
});


// Query Customers
await paragon.request("shopify", "/admin/api/2020-10/customers.json", { 
  method: "GET"
});
  
```

## Building Shopify workflows

Once your Shopify account is connected, you can add steps to perform the following actions:

* Get Customers
* Search Customers
* Create Customer
* Update Customer
* Get Orders
* Create Order
* Update Order
* Get Abandoned Carts
* Get Products
* Create Product
* Update Product

You can also use the [Shopify Request](/workflows/requests#making-integration-requests) step to access any of Shopify's API endpoints without the authentication piece.

When creating or updating records in Shopify, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/A%20Shopify%20Workflow%20in%20Paragon.png?maxW=1228&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=3ee3357fa2e0c43d650acb54c1715697" alt="" width="1228" height="888" data-path="assets/A Shopify Workflow in Paragon.png" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/A%20Shopify%20Workflow%20in%20Paragon.png?w=280&maxW=1228&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=9c72a25672326127d63360de625e0194 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/A%20Shopify%20Workflow%20in%20Paragon.png?w=560&maxW=1228&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=3fd8860047cf5520404a96f50769e79a 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/A%20Shopify%20Workflow%20in%20Paragon.png?w=840&maxW=1228&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=c37bf667768e09238bf8887c49201438 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/A%20Shopify%20Workflow%20in%20Paragon.png?w=1100&maxW=1228&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=deadd3f4febd817f7cf11a2f65920b95 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/A%20Shopify%20Workflow%20in%20Paragon.png?w=1650&maxW=1228&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=ff752c6045316aa43a17b64759fdc44b 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/A%20Shopify%20Workflow%20in%20Paragon.png?w=2500&maxW=1228&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=387baa10704074be661b12da2ef6087b 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

<Info>
  **Requirement for using Shopify triggers:** Configuring triggers for Shopify events that involve customer data requires you as the Shopify app owner to request access to protected data. Navigate to **Apps > Your App > API Access > Access Requests** to request access before using the Paragon Shopify trigger. [Learn more here.](https://shopify.dev/docs/apps/launch/protected-customer-data)
</Info>

Webhook triggers can be used to run workflows based on events in your users' Shopify account. For example, you might want to trigger a workflow whenever new orders are created Shopify to sync your users' Shopify orders to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20Webhook%20Triggers%20in%20Paragon%20Connect.png?maxW=976&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=727a1419c18a112c622ed1171c3744e0" alt="" width="976" height="788" data-path="assets/Shopify Webhook Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=976&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=ea150721ea9e91aeb14c1756e1561d4d 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=976&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=e5bb523f44cac70448c681dc873ae060 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=976&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=ff6e675610c0f3fb5ba873675c5a6315 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=976&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=9c6af37052cb2576fc1f9eb3fc512bc4 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=976&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=1968000748e417d20356b17690645d72 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=976&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=d9454600a1b63c00ac3b112489943997 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Shopify below:

* **New Order**
* **Order Updated**
* **New Customer**
* **Customer Updated**
* **New Product**
* **Product Updated**
* **Customer Data Request**
* **Customer Data Erasure Request**
* **Shop Data Erasure Request**

## Publishing your Shopify app

<Info>
  **Required for publishing:** In order to list your app on the Shopify App Store, you must implement the following additional features in your integration:

  * [Setting up Redirect Pages](/resources/integrations/shopify#setting-up-redirect-pages-in-your-app)
  * [Subscribing to mandatory privacy webhooks](/resources/integrations/shopify#subscribing-to-mandatory-privacy-webhooks)

  For more information, see [Shopify's documentation on publishing requirements](https://shopify.dev/docs/apps/store/requirements).
</Info>

### Setting up Redirect Pages in your app

Your Shopify integration requires two types of pages hosted in your application to support an installation flow that *begins* in the Shopify App Store (i.e., a user searches the Shopify App Store for your published app and clicks **Add app**).

Here is an annotated version of the [Shopify OAuth flow](https://shopify.dev/docs/apps/auth/oauth) diagram outlining what pages you will need to implement:

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20OAuth%20Flow%20(1).png?maxW=3338&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=7e9a6c5f9a1aad0fae8afe3ef621712a" alt="" width="3338" height="2925" data-path="assets/Shopify OAuth Flow (1).png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20OAuth%20Flow%20(1).png?w=280&maxW=3338&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=81e56cb21e8a52325bb9737ab4de457f 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20OAuth%20Flow%20(1).png?w=560&maxW=3338&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=aafbf7d258bd6195be13b03b037f82f7 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20OAuth%20Flow%20(1).png?w=840&maxW=3338&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=0a146c7b8aa2c19085aad83a54b273ea 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20OAuth%20Flow%20(1).png?w=1100&maxW=3338&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=0ad3f720853cd51ca4b92935f42330cf 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20OAuth%20Flow%20(1).png?w=1650&maxW=3338&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=c1855f4bbd68bd68ea0954aa5bf1667c 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Shopify%20OAuth%20Flow%20(1).png?w=2500&maxW=3338&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=7080b78bd2736bc172c79687a3a8ca93 2500w" data-optimize="true" data-opv="2" />
</Frame>

The pages you will need to implement include:

* **Initial Redirect**: This page will take in a `shop` query parameter and redirect to Shopify's OAuth flow.
* **Redirect Callback**: This page will receive the OAuth authorization code after the Shopify user grants consent and call `paragon.completeInstall` to save the user's account connection.

For an example implementation of the redirect pages using React (based on our Next.js sample app), see:

* [Example Initial Redirect](https://github.com/ethanlee16/paragon-connect-nextjs-example/blob/redirect-page/pages/integrations/index.js#L13-L20)
* [Example Redirect Callback](https://github.com/ethanlee16/paragon-connect-nextjs-example/blob/redirect-page/pages/integrations/shopify.js)

#### Initial Redirect

The Initial Redirect should be implemented as follows:

* Accept and read the query parameter `shop`. If the query parameter is present, redirect to the following URL to start the Shopify OAuth flow:

```
https://{shopQueryParam}/admin/oauth/authorize?client_id={SHOPIFY_CLIENT_ID}&redirect_uri={REDIRECT_CALLBACK_URL}&scope={SHOPIFY_SCOPES}
```

* The `SHOPIFY_CLIENT_ID` should match the Client ID that you use in your Shopify integration settings.
* The `REDIRECT_CALLBACK_URL` should be the URL of the Redirect Callback page in your app.
* The `SHOPIFY_SCOPES` should match the scopes that you use in your Shopify integration settings.

#### Redirect Callback

The Redirect Callback should be implemented as follows:

* Import the Paragon SDK and authenticate a user.

  * **Note**: If a user is not yet logged into your app, you can redirect to a login form, while preserving the intended URL to redirect to upon successful login. In other words, after logging in, your user should see your Redirect Page.

* Accept and read query parameters, which will be:

  * `code` and `shop` in case of a successful installation

  * `error` in case of an unsuccessful installation or denied consent

* If the `code` query parameter is present,

  * Read the `shop` query parameter and capture the shop name in the pattern `{shop}.myshopify.com`. See the regular expression used below.

  * Call `paragon.completeInstall` to complete the OAuth exchange and save a new connected Shopify account.

```javascript
let params = new URLSearchParams(window.location.search);
let authorizationCode = params.get("code");
let [, shopName] = params.get("shop").match(/^([a-zA-Z0-9][a-zA-Z0-9\-]*).myshopify.com/);

if (authorizationCode && shopName) {
   paragon.completeInstall("shopify", {
    authorizationCode: authorizationCode,
    redirectUrl: "https://your-app.url/shopify-redirect",
    integrationOptions: {
      SHOP_NAME: shopName,
    }
  }).then(() => {
     // Redirect to your app's integrations page
  });
} else {
  let error = params.get("error");
  // Handle error
}
```

* If the `error` query parameter is present,

  * Show this error in your app and allow your user to retry the process.

#### Updating your app's redirect and app URLs

1. Log in to your Shopify [Partner Dashboard](https://partners.shopify.com/current/resources) and select your app.

2. Navigate to **App setup > URLs > Allowed redirection URL(s)**

3. Set your **App URL** to your app's Initial Redirect URL.

4. Add your app's Redirect Callback URL to **Allowed redirection URL(s).**

### Subscribing to mandatory privacy webhooks

Shopify requires you to subscribe to 3 privacy webhooks to request or erase personal data that your integration may store in your application.

Paragon's Shopify integration allows you to subscribe and take action on these webhooks via workflows.

#### Setting the Shopify Webhook URL

To get started, visit the Paragon dashboard and navigate to your Shopify integration.

* Click on the **Settings** tab and copy the **Webhook URL** value.

<Frame>
  <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BCleanShot%5D%202024-02-01%20at%2011.09.29%20AM.png?maxW=2783&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=34fcc2d491eb1d1dfedf19001986db3c" alt="" width="2783" height="1762" data-path="assets/[CleanShot] 2024-02-01 at 11.09.29 AM.png" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BCleanShot%5D%202024-02-01%20at%2011.09.29%20AM.png?w=280&maxW=2783&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=708345f935aef462cca35c8d0db5024e 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BCleanShot%5D%202024-02-01%20at%2011.09.29%20AM.png?w=560&maxW=2783&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=fd0ff473ce94e6428bf45bc5304792ac 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BCleanShot%5D%202024-02-01%20at%2011.09.29%20AM.png?w=840&maxW=2783&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=803ae9ac4c71c0f5bcb57888daea127c 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BCleanShot%5D%202024-02-01%20at%2011.09.29%20AM.png?w=1100&maxW=2783&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=db6d6986a643acdb332d72aa3d70d5eb 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BCleanShot%5D%202024-02-01%20at%2011.09.29%20AM.png?w=1650&maxW=2783&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=1099c9c13967e4abd75373cafdd4308b 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BCleanShot%5D%202024-02-01%20at%2011.09.29%20AM.png?w=2500&maxW=2783&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=944205c70f97ae44b0fc4f1ca772310b 2500w" data-optimize="true" data-opv="2" />
</Frame>

Next, log in to [Shopify Partners](https://partners.shopify.com) and navigate to **Apps**.

* Select the app that you are using in the environment or project you have opened in Paragon.
* Navigate to **Configuration** (under the Build section) and scroll to **Compliance Webhooks**.
* For each of the endpoints (Customer data request endpoint, Customer data erasure endpoint, Shop data erasure endpoint), paste in the Webhook URL value you copied from the Paragon dashboard.
* Click **Save and release** at the top to save your changes.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(80).png?maxW=2821&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=37e142ff7cf1b5fc329d20b75e9d80f9" alt="" width="2821" height="724" data-path="assets/image (80).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(80).png?w=280&maxW=2821&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=0e8a7b4c93bec0f697c8ff49f234cd8d 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(80).png?w=560&maxW=2821&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=1ca7c2353abd11ba51837d27240a1c4d 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(80).png?w=840&maxW=2821&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6a42f3f2749ca2786a3338f1d3bd3a10 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(80).png?w=1100&maxW=2821&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=b1d2cb89eac28204e4f3c6beaf6c0211 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(80).png?w=1650&maxW=2821&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=a42ac4b3525b81ecaaad90c0280a36ae 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(80).png?w=2500&maxW=2821&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=25a77cb3217aa756a527b760f879c870 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### Creating workflows to respond to privacy webhooks

Next, create 3 workflows that listen for these triggers and take action on events received:

* Customer data request
* Customer data erasure
* Shop data erasure

You can create new workflows in the Paragon dashboard, from the **Overview** tab of your Shopify integration and click **Create Workflow**.

For each of the new workflows you create, select a **Shopify** trigger and select one of the Shopify privacy webhook events as the Trigger Event:

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(81).png?maxW=810&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=53aa75daf175035698879d15ca211992" alt="" width="810" height="287" data-path="assets/image (81).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(81).png?w=280&maxW=810&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=fdb53ed3302850834bfacc2464ef6c4e 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(81).png?w=560&maxW=810&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=8bfc4ff51b0b23fc48a93bc8e88e0291 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(81).png?w=840&maxW=810&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=86a0f11c5cdaa9b4a4c437a825ef4154 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(81).png?w=1100&maxW=810&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=58942035106a9e7c55f30c23edd57fc8 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(81).png?w=1650&maxW=810&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=d09a2d48a8673f48c4281ce003814eb0 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(81).png?w=2500&maxW=810&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=432a6db42bd98022b43cb7a79a0486d3 2500w" data-optimize="true" data-opv="2" />
</Frame>

Define the steps under the workflow to respond to the event type you selected.

From [Shopify's documentation](https://shopify.dev/docs/apps/webhooks/configuration/mandatory-webhooks), here is how you should handle each event type:

* **Customer data request**: If your app has been granted access to [customer or order data](https://shopify.dev/docs/api/usage/access-scopes#authenticated-access-scopes), then it will receive a data request webhook. The webhook contains the resource IDs of the customer data that you need to provide to the store owner. It's your responsibility to provide this data to the store owner directly.

  * **Note**: This request does not require the data to be provided in a response to the webhook. This process happens outside of Shopify and should be provided to the user who connected this Shopify account directly, e.g. through email, within 30 days of receiving the request.

* **Customer data erasure**: Shopify store owners can request that data is deleted on behalf of a customer. When this happens, Shopify sends a Customer Data Erasure event to the apps installed on that store so that you can erase any data for a certain customer of a store from your database.

* **Shop data erasure**: 48 hours after a store owner uninstalls your app, Shopify sends a Shop Data Erasure event. This webhook provides the store's `shop_id` and `shop_domain` so that you can erase data for that store from your database.

<Accordion title="Example Implementation">
  Example implementation

  Add a Request step under the Trigger to send the privacy event information to your API. We recommend including the following values in the request body for your reference:

  * `{{1.result}}`: This is the full event payload received from Shopify. You will see an example of the event in your workflow Test Data. See [Shopify's documentation on event payloads](https://shopify.dev/docs/apps/webhooks/configuration/mandatory-webhooks#customers-data_request) for more details.
  * `{{userSettings.userId}}`: This is the User ID of the Connected User that received the event. You can use this ID to relate the event to a user in your application.

  <Frame>
    <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(82).png?maxW=951&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=132cd2ff8259c32ba6f71db4319e8681" alt="" width="951" height="1218" data-path="assets/image (82).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(82).png?w=280&maxW=951&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=23cc7f7eede710d611480044de60ac98 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(82).png?w=560&maxW=951&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=e57ae2cf9580aa6542b8440e2a713c3b 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(82).png?w=840&maxW=951&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6366c1c8c9b69095df9071e3799e3d1d 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(82).png?w=1100&maxW=951&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=90dace649589a4d2f70e4ed1be14939f 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(82).png?w=1650&maxW=951&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=b05223aae4897238fee81233c00687e6 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(82).png?w=2500&maxW=951&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=a5547bfefdc688d0e3abe9b4644d80c7 2500w" data-optimize="true" data-opv="2" />
  </Frame>
</Accordion>

Finally, configure your 3 workflows to be [hidden from the Connect Portal and enabled by default](/connect-portal/connect-portal-customization#workflows):

* Click the context menu in the Workflow Editor toolbar and click **Edit Connect Portal Workflow Settings**.
* Switch on **Default to enabled** and **Hide workflow from Portal for all users**.

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Default%20Enabled%20%20Hide%20Workflow%20On.png?maxW=1002&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=90b7639ca901b6fcefafa53c4adccf5c" alt="" width="1002" height="266" data-path="assets/Default Enabled  Hide Workflow On.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Default%20Enabled%20%20Hide%20Workflow%20On.png?w=280&maxW=1002&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=bed90602c873b732732fb32272ab44ce 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Default%20Enabled%20%20Hide%20Workflow%20On.png?w=560&maxW=1002&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=50444a15d4b14800d2475b4ff23a7140 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Default%20Enabled%20%20Hide%20Workflow%20On.png?w=840&maxW=1002&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=1f7fed0e43852142821233103910071f 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Default%20Enabled%20%20Hide%20Workflow%20On.png?w=1100&maxW=1002&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=f38f27bc0f7147cb4138b8b7a12bca74 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Default%20Enabled%20%20Hide%20Workflow%20On.png?w=1650&maxW=1002&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=372593c8f3ee220a86ebd45b05615d4f 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Default%20Enabled%20%20Hide%20Workflow%20On.png?w=2500&maxW=1002&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2500364125321da50e5701134d0d7e36 2500w" data-optimize="true" data-opv="2" />
</Frame>

* Repeat for each workflow that has a Shopify privacy event trigger.

Having both options on will mean that this workflow will run for all users of your Shopify integration, and users will not see or need to configure the workflow from your Connect Portal.

#### Testing and validating privacy webhooks

To test your privacy webhook implementation end-to-end:

* Verify that each of your workflows are [deployed](/workflows/building-workflows#deploying-workflows).
* In your application, connect a Shopify store to the Connect Portal. Remember the store and account that you have connected.
* In the [Shopify Admin](https://admin.shopify.com) page for the same store, request or erase a customer's data ([see Shopify documentation](https://help.shopify.com/en/manual/privacy-and-security/privacy/processing-customer-data-requests)). These actions will trigger the "Customer data request" and "Customer data erasure" events, respectively.
* In the Paragon dashboard, visit [Task History](/monitoring/viewing-task-history) and verify that your workflow has executed.


# Shortcut
Source: https://docs.useparagon.com/resources/integrations/shortcut

Connect to your users' Shortcut accounts.

## Setup Guide

You can find your Shortcut app credentials in your [Shortcut Developer Account.](https://developer.shortcut.com/)

You'll need the following information to set up your Shortcut App with Paragon Connect:

* Shortcut API Token

## Connecting to Shortcut

Once your users have connected their Shortcut account, you can use the Paragon SDK to access the Shortcut API on behalf of connected users.

See the Shortcut [REST API documentation](https://developer.shortcut.com/) for their full API reference.

Any Shortcut API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create an Epic
await paragon.request("shortcut", "api/v3/epics", {
   method: "POST",
   body: { 
     "name": "My Work Epic",
     "description": "This is a sample Epic"
   }
});

// Get an Epic by ID
await paragon.request("shortcut", "api/v3/epics/<epic-public-id>", {
   method: "GET"
});
  
```

## Building Shortcut workflows

Once your Shortcut account is connected, you can add steps to perform the following actions:

* Create Story
* Update Story
* Get Story by ID
* Get Stories by Project
* Get Stories by Epic
* Search Stories
* Delete Story
* Create Epic
* Update Epic
* Get Epic by ID
* Delete Epic
* Create Project
* Update Project
* Get Project by ID
* Delete Project

You can also use the [Shortcut Request](/workflows/requests#making-integration-requests) step to access any of Shortcut's API endpoints without the authentication piece.

When creating or updating records in Shortcut, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Slack
Source: https://docs.useparagon.com/resources/integrations/slack

Connect to your users' Slack accounts.

## Setup Guide

You can find your Slack app credentials by visiting your [Slack App dashboard](https://api.slack.com/apps).

<Info>
  **Note:** You'll need to create a new Slack app if you don't already have one.
</Info>

You'll need the following information to set up your Slack App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add the Redirect URL to your Slack app

Paragon provides a redirect URL to send information to your Slack app. To add the redirect URL to your Slack app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to your [Slack App dashboard](https://api.slack.com/apps) and select your Slack app.

3. In your Slack App page sidebar, navigate to **OAuth & Permissions > Redirect URLs**.

4. Press "**Add New Redirect URL**".

5. Paste-in the redirect URL from Paragon. The redirect URL can be found in Step 1.

6. Press "**Add**", then press "**Save URLs**".

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Slack%20redirect%20URL.gif?maxW=635&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=88347ee6832bd3af37e6a1b4dddb66c7" alt="" width="635" height="430" data-path="assets/Adding Slack redirect URL.gif" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Slack%20redirect%20URL.gif?w=280&maxW=635&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=3e766b8a1b0aa1fe5f2744e3b0eda751 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Slack%20redirect%20URL.gif?w=560&maxW=635&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=7035b4ac9bbc28b289824fbd3dd43ff1 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Slack%20redirect%20URL.gif?w=840&maxW=635&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=2f37ec3642605eecd2fba420554b2bdd 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Slack%20redirect%20URL.gif?w=1100&maxW=635&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=e08f35e6bb34f739ee74d71cf3b078c2 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Slack%20redirect%20URL.gif?w=1650&maxW=635&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=69ea6652eb257c667b047d2d38275804 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Slack%20redirect%20URL.gif?w=2500&maxW=635&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=69bff8226892b227eebd1e7f60996d89 2500w" data-optimize="true" data-opv="2" />
</Frame>

Slack provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your application. You can find the credentials under **Basic Information > App Credentials** in the Slack app sidebar.

7. Enable your Slack app in other workspaces. Under **Settings > Managed Distribution > Share Your App with Other Workspaces**, complete the listed steps to allow your Slack app to be installed by your customers.

<Frame>
  <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Other%20Workspaces%20for%20your%20Slack%20app%20for%20Paragon%20Connect.png?maxW=1352&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=9a0b4b71bd60c49f0be33e120346fc7d" alt="" width="1352" height="952" data-path="assets/Enabling Other Workspaces for your Slack app for Paragon Connect.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Other%20Workspaces%20for%20your%20Slack%20app%20for%20Paragon%20Connect.png?w=280&maxW=1352&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=3491ba20bfa085322ed5e1294dc16206 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Other%20Workspaces%20for%20your%20Slack%20app%20for%20Paragon%20Connect.png?w=560&maxW=1352&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=04339edfc8a318420dd03a34f9ccb740 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Other%20Workspaces%20for%20your%20Slack%20app%20for%20Paragon%20Connect.png?w=840&maxW=1352&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=910dfae237f90d60226eebb51035569c 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Other%20Workspaces%20for%20your%20Slack%20app%20for%20Paragon%20Connect.png?w=1100&maxW=1352&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=54521d9fe9501969baf463d0866f7bca 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Other%20Workspaces%20for%20your%20Slack%20app%20for%20Paragon%20Connect.png?w=1650&maxW=1352&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=263c79e8ffa7aeff286fbac1914d7ea1 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Other%20Workspaces%20for%20your%20Slack%20app%20for%20Paragon%20Connect.png?w=2500&maxW=1352&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=1e4149cd9895a4e92380de0d05e3ad44 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Slack app to Paragon

1. Select **Slack** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Slack >** **Settings**, fill out your credentials from the end of [Step 1](/resources/integrations/slack#add-the-redirect-url-to-your-slack-app) in their respective sections:

* **Client ID:** Found under Basic Information > App Credentials > Client ID on your Slack App page.
* **Client Secret:** Found under Basic Information > App Credentials > Client Secret on your Slack App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon
  development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Slack%20app%20to%20Paragon%20Connect.png?maxW=1974&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=0b5fdc0a5a39e210f6fb4f9d03125d66" alt="" width="1974" height="1210" data-path="assets/Connecting your Slack app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Slack%20app%20to%20Paragon%20Connect.png?w=280&maxW=1974&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=128549c1c919e3987327c1c3c72d52ba 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Slack%20app%20to%20Paragon%20Connect.png?w=560&maxW=1974&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ba6894c79d1a1eb89bb5cc6a284f37f6 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Slack%20app%20to%20Paragon%20Connect.png?w=840&maxW=1974&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=90ed24e212b07713a949f0938e1898eb 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Slack%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1974&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=9f540a4adb208749cc546e30bd701c64 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Slack%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1974&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=b9d51cf78b204b689a1af5208282c4d4 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Slack%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1974&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=5ddf08fa76d7bd29c6e70d3c1eece7d1 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Bot and user permissions in Slack

Slack offers two different versions of permission for your Slack App. **Bot scopes** give your app’s bot permission to perform actions like posting messages or reading channels, acting as the bot itself. **User scopes** on the other hand, let your app perform actions **on behalf** of a real user, like accessing private channels or user-specific data. Use bot scopes for general automation and user scopes when you need to act with a user’s privileges.

You'll find the two categories in the **OAuth & Permissions > Scopes** section.

### Specifying bot and user tokens

You can specify in Paragon the type of token permission you'd like to use based on the workflow, action, or API request.

1. Under **Integrations > Connected Integrations > Slack > App Configuration > Configure**, you can enable the toggle to use ***bot scopes only***

2. While building Slack workflows an authorization option can be set for bot or user token

<Frame>
    <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20request%20token%20type.png?maxW=2272&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=bf7987b2ef7e891e39ac8784d6818dbc" alt="" width="2272" height="592" data-path="assets/Slack request token type.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20request%20token%20type.png?w=280&maxW=2272&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=e35057690953c280555ff4075f60a50a 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20request%20token%20type.png?w=560&maxW=2272&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=b3a8119fd5d4c48ab181317278437759 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20request%20token%20type.png?w=840&maxW=2272&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=32f831d1d75812a542d017cfc3f82bdc 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20request%20token%20type.png?w=1100&maxW=2272&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=6b38314aca9b133054f991a47961f67d 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20request%20token%20type.png?w=1650&maxW=2272&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=43d54e5cf3447db031fdbba2f81770b0 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20request%20token%20type.png?w=2500&maxW=2272&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=3bd86994b68515f758d45c3a2da2f4e5 2500w" data-optimize="true" data-opv="2" />
</Frame>

3. During a [Proxy API](/apis/proxy) request add a `x-paragon-use-slack-token-type` header as either `user` or `bot`

## Connecting to Slack

Once your users have connected their Slack account, you can use the Paragon SDK to access the Slack API on behalf of connected users.

See the Slack [REST API documentation](https://api.slack.com/reference) for their full API reference.

Any Slack API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Get All Channels
await paragon.request("slack", "/conversations.list", {
  method: "GET"
});

// Send Message to Channel
await paragon.request("slack", "/chat.postMessage", {
  method: "POST",
  body: {
    "channel": "YOUR_CHANNEL_ID",
    "text": "Hello, world",
    "as_user": true
  }
});
```

## Building Slack workflows

Once your Slack account is connected, you can add steps to perform the following actions.

* Send Message in Channel
* Send Direct Message
* Get User by Email
* Search Messages
* Get Users by Name in Slack

You can also use the [Slack Request](/workflows/requests#making-integration-requests) step to access any of Slack's API endpoints without the authentication piece.

When composing your Slack message, you can reference data from previous steps by typing `{{` to invoke the variable menu.

Additionally, you can choose whether to send a message as a bot or your user. If you choose to send as a bot, you can choose to give your bot a custom name and icon.

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.png?maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=3408f1c1310fc8a4f3ab5a6a15c360fa" alt="" width="2398" height="1094" data-path="assets/Using the Dynamic Variable Menu in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.png?w=280&maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=cd6f72de832bfc66a37cd9dd8922a6ba 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.png?w=560&maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=d7950294b9e93302b1f898983bbbdd7f 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.png?w=840&maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=582d987f063a60113b8a929fa6d3f674 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.png?w=1100&maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=58942819d39727ef1af8a9cd240000d0 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.png?w=1650&maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=835a496de79e80d2f757a035833c1268 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.png?w=2500&maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=b1fee1e17cb43174480b4f95a204ade2 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Slack account. For example, you might want to trigger a workflow whenever new messages are created in Slack to sync your users' Slack messages to your application in real-time.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Triggers%20in%20Paragon%20Connect.png?maxW=1123&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=cda7a8fc195e1590d0ea12d1a65eafe0" alt="" width="1123" height="989" data-path="assets/Slack Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=1123&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=e819664cdde06809711e2e34bea91721 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=1123&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=a6c760e8619862cce70d10d85a4e25fa 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=1123&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=1d80137f0b9ff5bfb7b8e24da9bf2551 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=1123&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=02b1156f8bb24f4d2e3487889fc8cc2d 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=1123&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=4daa4e595e731325cc8f774dceff2ad7 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=1123&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=3545c2ad4a3720ee51093f158c42c59a 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Slack below:

* **Direct Message Created**
* **Channel Created**
* **Direct Message Sent**
* **File Deleted**
* **Group Message Sent**
* **Channel Message Sent**
* **Direct Message Updated**
* **Group Message Updated**
* **Channel Message Updated**
* **App Mentioned**
* **New Message Reaction**
* **Message Reaction Removed**
* **Message Interaction**

### Subscribing to Slack Events

Paragon provides a request URL to subscribe your Slack app to events in Slack. To add the request URL to your Slack app:

1. In the Settings tab of your Slack integration in Paragon, copy the link under "**Webhook URL".**

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.34.12@2x.png?maxW=1712&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=b37893051739831325f13b605c7b39dd" alt="" width="1712" height="1368" data-path="assets/CleanShot 2023-11-17 at 13.34.12@2x.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.34.12@2x.png?w=280&maxW=1712&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=6a0fe9587bc171a05cfd8c29e2208990 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.34.12@2x.png?w=560&maxW=1712&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f01d9f5e6b5e7c25b60eb7b522b11d79 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.34.12@2x.png?w=840&maxW=1712&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=4bf62275a741405b9e4266ec3df61597 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.34.12@2x.png?w=1100&maxW=1712&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=8586a0dd274d5f8f9278657d142f8504 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.34.12@2x.png?w=1650&maxW=1712&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=5eaa94633897c151658bde8cfee4b0e0 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.34.12@2x.png?w=2500&maxW=1712&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=0d559a4d131b8efb0b846576a0f1f9e7 2500w" data-optimize="true" data-opv="2" />
</Frame>

2. Log in to your [Slack App dashboard](https://api.slack.com/apps) and select your Slack app.

3. In your Slack App page sidebar, navigate to **Event Subscriptions > Enable Events**.

4. Provide the "**Request URL**." Paragon will automatically respond to Slack's `challenge` request and begin listening to events on behalf of your app.

5. Click **Save Changes** at the bottom of the Slack App dashboard.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.38.38@2x.png?maxW=2410&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ce6da171edf6577e25f2be4215046c85" alt="" width="2410" height="1604" data-path="assets/CleanShot 2023-11-17 at 13.38.38@2x.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.38.38@2x.png?w=280&maxW=2410&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=b3ab457129606ac4e7f01606302bfe42 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.38.38@2x.png?w=560&maxW=2410&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=7f6d758b6e37c42a2153c2ef94d2d082 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.38.38@2x.png?w=840&maxW=2410&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=43a6b2fff12ecec5c87f9b8aa2d882f8 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.38.38@2x.png?w=1100&maxW=2410&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=b12714decd532ce26aa4f43dfe0fe237 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.38.38@2x.png?w=1650&maxW=2410&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=b907ba4a8c465e7f3fa7cc492d6fa228 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202023-11-17%20at%2013.38.38@2x.png?w=2500&maxW=2410&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=0a82d02102eabc6a5b2bd13b91fcbf12 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Snowflake
Source: https://docs.useparagon.com/resources/integrations/snowflake

Connect to your users' Snowflake accounts.

## Setup Guide

You can find your Snowflake app credentials in your [Snowflake Developer Account.](https://docs.snowflake.com/en/developer-guide/sql-api/index.html)

You'll need the following information to set up your Snowflake App with Paragon Connect:

* Snowflake subdomain
* Snowflake Private Key
* Snowflake Passphrase
* Snowflake Username

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to Snowflake

Once your users have connected their Snowflake account, you can use the Paragon SDK to access the Snowflake API on behalf of connected users.

See the Snowflake [REST API documentation](https://docs.snowflake.com/en/developer-guide/sql-api/index.html) for their full API reference.

Any Snowflake API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Perform a simple select query
await paragon.request('snowflake', '/statements', {
  method: 'POST',
  body: {
    "statement": "SELECT * FROM country",
    "schema": "LOCATION",
    "warehouse": "COMPUT_WH"
  });

// Using Bind Variables in a select query
await paragon.request('snowflake', '/statements', {
  method: 'POST',
  body: {
    {
      "statement": "select * from T where c1=?",
      "timeout": 60,
      "database": "TESTDB",
      "schema": "TESTSCHEMA",
      "warehouse": "TESTWH",
      "role": "TESTROLE",
      "bindings": {
        "1": {
          "type": "FIXED",
          "value": "123"
        }
      }
    }
  });
  
```

## Building Snowflake workflows

Once your Snowflake account is connected, you use the [Snowflake Request](/workflows/requests#making-integration-requests) step to access any of Snowflake's API endpoints without the authentication piece.

When creating or updating records in Snowflake, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Stack Overflow For Teams
Source: https://docs.useparagon.com/resources/integrations/stackoverflowteams

Connect to your users' Stack Overflow for Teams accounts.

## Setup Guide

You'll need the following information to set up your Stack Overflow for Teams App with Paragon Connect:

* Personal Access Token
* Team Name

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to Stack Overflow for Teams

Once your users have connected their Stack Overflow for Teams account, you can use the Paragon SDK to access the Stack Overflow for Teams API on behalf of connected users.

See the Stack Overflow for Teams [REST API documentation](https://api.stackoverflowteams.com/docs) for their full API reference.

Any Stack Overflow for Teams API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get all Posts for the associated user(s)
paragon.request("stackoverflowteams", "/users/<ids>/posts", {
  method: "GET"
});

// Get a Post by ID
paragon.request("stackoverflowteams", "/questions/<ids>", {
  method: "GET"
});
  
```

## Building Stack Overflow for Teams workflows

Once your Stack Overflow for Teams account is connected, you use the [Stack Overflow for Teams Request](/workflows/requests#making-integration-requests) step to access any of Stack Overflow for Teams's API endpoints without the authentication piece.

When creating or updating records in Stack Overflow for Teams, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Stripe
Source: https://docs.useparagon.com/resources/integrations/stripe

Connect to your users' Stripe accounts.

## Setup Guide

You can find your Stripe app credentials by visiting your Stripe API Key Settings

<Info>
  **Note:** You'll need to create a new Stripe API Key if you don't already have one.
</Info>

You'll need the following information to set up your Stripe API Key with Paragon Connect:

* [Stripe API Key](https://dashboard.stripe.com/apikeys)

## Connecting to Stripe

Once your users have connected their Stripe account, you can use the Paragon SDK to access the Stripe API on behalf of connected users.

See the Stripe [REST API documentation](https://stripe.com/docs/api) for their full API reference.

Any Stripe API endpoints can be accessed with the Paragon SDK as shown in this example

```js JavaScript
// You can find your project ID in the Overview tab of any Integration.

// Authenticate the user
paragon.authenticate(<ProjectID>, <Paragon User Token>);

// Create Customer
await paragon.request("stripe", "/v1/customers", {
  method: "POST",
  body: {
    name: "test",
    email: "example@example.com",
    description: "Create customer for test",
    }
});

// Get Customers
await paragon.request("stripe", "/v1/customers", {
  method: "GET",
});
```

## Building Stripe workflows

Once your Stripe account is connected, you can add steps to perform the following actions:

* Create Customer
* Update Customer
* Get Customer by ID
* List Customers
* Create Subscription
* List Subscriptions
* Create Product
* Get Product by ID
* List Products
* List Balance Transaction
* List Plans

You can also use the [Stripe Request](/workflows/requests#making-integration-requests) step to access any of Stripe's API endpoints without the authentication piece.

When using Stripe, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Stripe%20workflows%20in%20Paragon%20Connect.png?maxW=885&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=bdb51d0c99bd11fc883b1ec6265ea359" alt="" width="885" height="690" data-path="assets/Creating Stripe workflows in Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Stripe%20workflows%20in%20Paragon%20Connect.png?w=280&maxW=885&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=cf002b67a656af5c8a267656df24b356 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Stripe%20workflows%20in%20Paragon%20Connect.png?w=560&maxW=885&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2191b9d640e0057cb42d9c7a98477548 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Stripe%20workflows%20in%20Paragon%20Connect.png?w=840&maxW=885&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=1a75278be3667087c3444f1312e0ef6d 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Stripe%20workflows%20in%20Paragon%20Connect.png?w=1100&maxW=885&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=86ef14e66eb3f841665650463f30b41e 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Stripe%20workflows%20in%20Paragon%20Connect.png?w=1650&maxW=885&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7cc0fd64fee871607e989ca9516975a0 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20Stripe%20workflows%20in%20Paragon%20Connect.png?w=2500&maxW=885&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=41462363e1c195c829111e41b4525bc4 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using the Connect Portal

The Connect Portal supports Secret API keys and Restricted API keys. While Secret API keys can be used immediately, some configuration is required for Restricted API keys.

The Restricted API key must allow the `rak_connected_account_read` permission (called “All Connect resources” in the Resource Types section of configuring a Restricted API key). The Connect Portal cannot save the key if it does not include this permission.


# Tableau
Source: https://docs.useparagon.com/resources/integrations/tableau

Connect to your users' Tableau accounts.

## Setup Guide

You can find your Tableau app credentials in your [Tableau Developer Account.](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm)

You'll need the following information to set up your Tableau App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your Tableau app to Paragon

Under **Integrations > Connected Integrations > Tableau > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Tableau App page.
* **Client Secret:** Found under Client Secret on your Tableau App page.
* **Client Secret Value:** Found under Value on your Tableau App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Leaving the Client ID and Client Secret blank will use Paragon development keys.

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Tableau%20app%20to%20Paragon%20Connect.png?maxW=1192&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=275176e1864730937dcb2535308fe85e" alt="" width="1192" height="574" data-path="assets/Connecting your Tableau app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Tableau%20app%20to%20Paragon%20Connect.png?w=280&maxW=1192&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=318f1c58682f5f1c25b1a02daf16044c 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Tableau%20app%20to%20Paragon%20Connect.png?w=560&maxW=1192&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=03aa28d42d5418cd5cae3cb8bf220dce 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Tableau%20app%20to%20Paragon%20Connect.png?w=840&maxW=1192&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7bb308ddd6e46ce4f0ebc4c8e754a11d 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Tableau%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1192&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=605a3070c7d2f7d63eb01090cc68119f 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Tableau%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1192&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=fa484dbb192b969d8edd6848685b49bd 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Tableau%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1192&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=18acac6352d3a0037986b041d55c425e 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Tableau

Once your users have connected their Tableau account, you can use the Paragon SDK to access the Tableau API on behalf of connected users.

See the Tableau [REST API documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm) for their full API reference.

Any Tableau API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get all Projects
paragon.request("tableau, "/projects", {
  method: "GET"
});

// Get all Jobs
paragon.request("tableau", "/jobs", {
  method: "GET"
});
```

## Building Tableau workflows

Once your Tableau account is connected, you use the [Tableau Request](/workflows/requests#making-integration-requests) step to access any of Tableau's API endpoints without the authentication piece.

When creating or updating records in Tableau, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# TikTok Ads
Source: https://docs.useparagon.com/resources/integrations/tiktokads

Connect to your users' TikTok Ads accounts.

## Setup Guide

You can find your TikTok Ads app credentials in your [TikTok for Business Developers](https://ads.tiktok.com/marketing_api/homepage) portal.

You'll need the following information to set up your TikTok Ads App with Paragon Connect:

* App ID
* App Secret

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your TikTok Ads app to Paragon

Under **Integrations > Connected Integrations > TikTok Ads > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **App ID:** Found under App ID on your TikTok Ads App page.
* **App Secret:** Found under App Secret on your TikTok Ads App page.

<Info>
  Leaving the App ID and App Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20TikTok%20Ads%20app%20to%20Paragon%20Connect.png?maxW=1822&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=1a04090b17fd1a5405aaef2d2a3d501b" alt="" width="1822" height="900" data-path="assets/Connecting your TikTok Ads app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20TikTok%20Ads%20app%20to%20Paragon%20Connect.png?w=280&maxW=1822&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ca7cb89b385f3baef50d2c40c9107172 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20TikTok%20Ads%20app%20to%20Paragon%20Connect.png?w=560&maxW=1822&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=359155a0310eaf9444e682526d151846 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20TikTok%20Ads%20app%20to%20Paragon%20Connect.png?w=840&maxW=1822&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=fe39a95e82b4a9aae8eb7a9cb6baa743 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20TikTok%20Ads%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1822&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=b8435ab612562204f230ae22336cbe31 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20TikTok%20Ads%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1822&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=96e8ad49b639e6863a74d5c684b0973f 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20TikTok%20Ads%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1822&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=c356e84376355150a12617cde9f58870 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to TikTok Ads

Once your users have connected their TikTok Ads account, you can use the Paragon SDK to access the TikTok Ads API on behalf of connected users.

See the TikTok Ads [REST API documentation](https://ads.tiktok.com/marketing_api/docs) for their full API reference.

Any TikTok Ads API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Campaigns
paragon.request("tiktokads", "v1.3/campaign/get/", {
  method: "GET"
});

// Create a Campaign
paragon.request("tiktokads", "v1.3/campaign/create/", {
  method: "POST",
  body: {
    "advertiser_id": "ADVERTISER_ID",
    "budget_mode": "BUDGET_MODE",
    "objective_type": "OBJECTIVE_TYPE",
    "budget": "BUDGET",
    "campaign_name": "CAMPAIGN_NAME"
  }
});
  
```

## Building TikTok Ads workflows

Once your TikTok Ads account is connected, you use the [TikTok Ads Request](/workflows/requests#making-integration-requests) step to access any of TikTok Ads's API endpoints without the authentication piece.

When creating or updating records in TikTok Ads, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Todoist
Source: https://docs.useparagon.com/resources/integrations/todoist

Connect to your users' Todoist accounts.

## Setup Guide

You can find your Todoist app credentials in your [Todoist Developer Account](https://developer.todoist.com/guides/#oauth).

You'll need the following information to set up your Todoist App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add your Todoist app to Paragon

Under **Integrations > Connected Integrations > Todoist > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Todoist App page.
* **Client Secret:** Found under Client Secret on your Todoist App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Todoist%20app%20to%20Paragon%20Connect.png?maxW=1084&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=340d720305bfd370fb9bb1141903d3d1" alt="" width="1084" height="577" data-path="assets/Connecting your Todoist app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Todoist%20app%20to%20Paragon%20Connect.png?w=280&maxW=1084&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=1e9da4042b44095c7beeb77e17210c0e 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Todoist%20app%20to%20Paragon%20Connect.png?w=560&maxW=1084&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e6118490db15b0f23260d859b31bceaf 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Todoist%20app%20to%20Paragon%20Connect.png?w=840&maxW=1084&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=157bb5e07241ac1902b4d58300246396 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Todoist%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1084&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=924d8ee85d6ea69969b7f43f5ef1f35d 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Todoist%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1084&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2a23a848d93c92e8fbf8bdf6ca4ef58e 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Todoist%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1084&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=1dee6029f90077208654351e33d70e3d 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Todoist

Once your users have connected their Todoist account, you can use the Paragon SDK to access the Todoist API on behalf of connected users.

See the Todoist [REST API documentation](https://developer.todoist.com/rest/v2/#overview) for their full API reference.

Any Todoist API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Create a Project
await paragon.request("todoist", "/rest/v2/projects", {
  method: "POST",
  body: {
    "name": "My Project",
    "parent_id":"Parent project ID"
  }
});

// Get a Project
await paragon.request("todoist", "/sync/v9/projects/get?project_id=<project_id>", {
  method: "GET"
});

// Get a Task
await paragon.request("todoist", "/rest/v2/tasks/<task_id>", {
  method: "GET"
});
  
```

## Building Todoist workflows

Once your Todoist account is connected, you can add steps to perform the following actions:

* Create Project
* Update Project
* Get Project by ID
* Get All Projects
* Delete Project
* Create Task
* Update Task
* Get Task by ID
* Search Tasks
* Close Task
* Delete Task

You can also use the [Todoist Request](/workflows/requests#making-integration-requests) step to access any of Todoist's API endpoints without the authentication piece.

When creating or updating records in Todoist, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Trello
Source: https://docs.useparagon.com/resources/integrations/trello

Manage boards and cards in Trello

## Setup Guide

You'll need the following information to set up your Trello App with Paragon Connect:

* API Key
* API Secret
* Scopes Requested

### Generate a Trello API Key and API Secret

1. Log in to Trello. If you don't have an account, you can create one [here](https://trello.com/).

2. Access the [Power-Up Admin Portal](https://trello.com/power-ups/admin). If you haven't created a Power-Up yet, click on "New" to create one.

3. Within your Power-Up's settings, go to the **API Key** tab.

4. Your **API Secret** will be displayed in the same section.

### Add your Trello app to Paragon

1. Select Trello from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Trello >** **Settings**, fill out your credentials in their respective sections:

* **API Key:** Found under API Key > API Key.
* **API Secret:** Found under API Key > API Secret.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the API Key and API Secret blank will use Paragon development keys.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Trello%20app%20to%20Paragon%20Connect.png?maxW=2040&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=372928bee05bb6356f8512d46aad9cd8" alt="" width="2040" height="1172" data-path="assets/Connecting your Trello app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Trello%20app%20to%20Paragon%20Connect.png?w=280&maxW=2040&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=32046eaab6db9394067a2ddb96a28189 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Trello%20app%20to%20Paragon%20Connect.png?w=560&maxW=2040&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=67b360b7bdd0c6a17281d03fbc965a58 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Trello%20app%20to%20Paragon%20Connect.png?w=840&maxW=2040&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=9d5d69bd0705a1abdca378e93c41674c 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Trello%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2040&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7ba4886e98a0750a79d011e2e90ed749 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Trello%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2040&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=8c8538532d3ea4f04d13e9be1299be3c 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Trello%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2040&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=95ca0fcf2de854289f3347844f71bcd1 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Trello

Once your users have connected their Trello account, you can use the Paragon SDK to access the Trello API on behalf of connected users.

See the Trello [REST API documentation](https://developer.atlassian.com/cloud/trello/rest/) for their full API reference.

Any Trello API endpoints can be accessed with the Paragon SDK as shown in this example

```js JavaScript
// You can find your project ID in the Overview tab of any Integration.

// Authenticate the user
paragon.authenticate(<ProjectID>, <Paragon User Token>);

// Get a board
await paragon.request("trello", "/boards/<Board ID>", {
  method: “GET”,
});

// Create a new card
await paragon.request("trello", "/cards",
  method: “POST”,
  body: {
    idList: “<List ID>”,
    name: “New task”,
    desc: “Integrate all productivity apps using Paragon”
  }
});
```

## Building Trello workflows

Once your Trello account is connected, you can add steps to perform the following actions:

* Search Cards
* Get Cards in Board
* Create Card
* Update Card
* Delete Card
* Get Lists in Board
* Search Boards

You can also use the [Trello Request](/workflows/requests#making-integration-requests) step to access any of Trello's API endpoints without the authentication piece.

When using Trello, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Trello account. For example, you might want to trigger a workflow whenever Cards are updated to sync your users' Trello Cards to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Trello%20Triggers%20in%20Paragon%20Connect.png?maxW=1752&auto=format&n=867oBBVpxd2C3zc4&q=85&s=5b11732b5b0b3f18a1deef97d8234014" alt="" width="1752" height="758" data-path="assets/Using Trello Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Trello%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=1752&auto=format&n=867oBBVpxd2C3zc4&q=85&s=10bab0bebc3c535e323063c016f21cb5 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Trello%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=1752&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7feb8cc9ec75972562496c38dc5fc67f 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Trello%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=1752&auto=format&n=867oBBVpxd2C3zc4&q=85&s=e64b081678ca24861e8105b090855239 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Trello%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=1752&auto=format&n=867oBBVpxd2C3zc4&q=85&s=102f6e80b1280b8cd0fc3ebcdeebb43e 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Trello%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=1752&auto=format&n=867oBBVpxd2C3zc4&q=85&s=d64dac1d4484c41a504e37e8894036f3 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Trello%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=1752&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9127b961d63efde4c3507a2b0455cc80 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Trello below:

* **Board Created**
* **Board Updated**
* **Card Created**
* **Card Updated**
* **New Comment**


# Typeform
Source: https://docs.useparagon.com/resources/integrations/typeform

Connect to your users' Typeform accounts.

## Setup Guide

You can find your Typeform app credentials in your [Typeform Developer Account.](https://www.typeform.com/developers/get-started/)

You'll need the following information to set up your Typeform App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your Typeform app to Paragon

Under **Integrations > Connected Integrations > Typeform > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Typeform App page.
* **Client Secret:** Found under Client Secret on your Typeform App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Typeform%20app%20to%20Paragon%20Connect.png?maxW=980&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=51fee23ea409f64ab66ef33ec6732c5d" alt="" width="980" height="599" data-path="assets/Connecting your Typeform app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Typeform%20app%20to%20Paragon%20Connect.png?w=280&maxW=980&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=99c4baae57766cd2b83f60d522fb81da 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Typeform%20app%20to%20Paragon%20Connect.png?w=560&maxW=980&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=f482db5e2e2537c6e53f6306763ef848 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Typeform%20app%20to%20Paragon%20Connect.png?w=840&maxW=980&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=1c9886f4fe4af91cce47f0ec772396fc 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Typeform%20app%20to%20Paragon%20Connect.png?w=1100&maxW=980&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ab0e914a288a07889162b3192696b61e 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Typeform%20app%20to%20Paragon%20Connect.png?w=1650&maxW=980&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=bff1fa41e61655cf547026a8a5cdbc82 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Typeform%20app%20to%20Paragon%20Connect.png?w=2500&maxW=980&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=73084f2d67a8d44bee6c79f69205fdce 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Typeform

Once your users have connected their Typeform account, you can use the Paragon SDK to access the Typeform API on behalf of connected users.

See the Typeform [REST API documentation](https://www.typeform.com/developers/get-started/) for their full API reference.

Any Typeform API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Retrieve all Forms
paragon.request("typeform", "forms", {
  method: "GET"
});

// Retrieve Responses for a specific form
paragon.request("typeform", "/forms/<form_id>/responses", {
  method: "GET"
});
  
```

## Building Typeform workflows

Once your Typeform account is connected, you use the [Typeform Request](/workflows/requests#making-integration-requests) step to access any of Typeform's API endpoints without the authentication piece.

When creating or updating records in Typeform, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Unleashed
Source: https://docs.useparagon.com/resources/integrations/unleashed

Connect to your users' Unleashed accounts.

## Setup Guide

You can find your Unleashed app credentials in your [Unleashed Account.](https://www.unleashedsoftware.com)

You'll need the following information to set up your Unleashed Account with Paragon Connect:

* API ID
* API Key

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your Unleashed app to Paragon

Under **Integrations > Connected Integrations > Unleashed > App Configuration > Configure**, fill out your credentials from your account in their respective sections:

* **API ID:** Found under Integration > Unleashed API Access on your Unleashed App page.
* **API Key** Found under Integration > Unleashed API Access on your Unleashed App page.

## Connecting to Unleashed

Once your users have connected their Unleashed account, you can use the Paragon SDK to access the Unleashed API on behalf of connected users.

See the Unleashed [REST API documentation](https://apidocs.unleashedsoftware.com/) for their full API reference.

Any Unleashed API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get Customers
paragon.request('unleashed', '/Customers', {
  method: 'GET'
});

// Get Products
paragon.request('unleashed', '/Products', {
  method: 'GET'
});
  
```

## Building Unleashed workflows

Once your Unleashed account is connected, you use the [Unleashed Request](/workflows/requests#making-integration-requests) step to access any of Unleashed's API endpoints without the authentication piece.

When creating or updating records in Unleashed, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Vanta
Source: https://docs.useparagon.com/resources/integrations/vanta

Connect to your users' Vanta accounts.

## Setup Guide

You can find your Vanta app credentials in your [Vanta Developer Account.](https://developer.vanta.com/reference)

You'll need the following information to set up your Vanta App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your Vanta app to Paragon

Under **Integrations > Connected Integrations > Vanta > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Vanta App page.
* **Client Secret:** Found under Client Secret on your Vanta App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vanta%20app%20to%20Paragon%20Connect.png?maxW=1830&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2db4a8babee3fa65487a9a375946eb29" alt="" width="1830" height="1186" data-path="assets/Connecting your Vanta app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vanta%20app%20to%20Paragon%20Connect.png?w=280&maxW=1830&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6ccb161f8b28aea77079f682f44c9bf3 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vanta%20app%20to%20Paragon%20Connect.png?w=560&maxW=1830&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d417c30a1a9118a3f76db57c072a9604 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vanta%20app%20to%20Paragon%20Connect.png?w=840&maxW=1830&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e926dadec19f6e25d6af760b4216449e 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vanta%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1830&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ac705501c3a9c12a53a9f82a35827f12 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vanta%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1830&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7092ff0499a8f71cd9424d38d0a8b7f7 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vanta%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1830&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=062ea2d3c654e146652196b4a7effe6a 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Vanta

Once your users have connected their Vanta account, you can use the Paragon SDK to access the Vanta API on behalf of connected users.

See the Vanta [REST API documentation](https://developer.vanta.com/reference) for their full API reference.

Any Vanta API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// List SecurityTask
paragon.request('vanta', 'v1/resources/security_task/list_all?resourceId=<id>', {
  method: 'GET'
});
  
```

## Building Vanta workflows

Once your Vanta account is connected, you use the [Vanta Request](/workflows/requests#making-integration-requests) step to access any of Vanta's API endpoints without the authentication piece.

When creating or updating records in Vanta, you can reference data from previous steps by typing `{{` to invoke the variable menu.e


# Vimeo
Source: https://docs.useparagon.com/resources/integrations/vimeo

Connect to your users' Vimeo accounts.

## Setup Guide

You can find your Vimeo app credentials in your [Vimeo Developer Account.](https://developer.vimeo.com/api)

You'll need the following information to set up your Vimeo App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your Vimeo app to Paragon

Under **Integrations > Connected Integrations > Vimeo > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your Vimeo App page.
* **Client Secret:** Found under Client Secret on your Vimeo App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vimeo%20app%20to%20Paragon%20Connect.png?maxW=2032&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=0c4c68b1dc54b70027495da636557df0" alt="" width="2032" height="1188" data-path="assets/Connecting your Vimeo app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vimeo%20app%20to%20Paragon%20Connect.png?w=280&maxW=2032&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=46a9944b75443178c36a03c627787d78 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vimeo%20app%20to%20Paragon%20Connect.png?w=560&maxW=2032&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=845331bea40e1b5a785c9d920d55a1d7 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vimeo%20app%20to%20Paragon%20Connect.png?w=840&maxW=2032&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ca5129dc6d8345970de4e1c8f205d393 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vimeo%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2032&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=8fd560bc9afe6fedc0289aa392515eee 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vimeo%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2032&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=5836862a19016e8096a11d326098e855 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Vimeo%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2032&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=17a29dfde4b78434dde982da4331def7 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Vimeo

Once your users have connected their Vimeo account, you can use the Paragon SDK to access the Vimeo API on behalf of connected users.

See the Vimeo [REST API documentation](https://developer.vimeo.com/api) for their full API reference.

Any Vimeo API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Search for Videos
paragon.request("vimeo", "/videos?query=[Search Query]", {
  method: "GET"
});
// Edit a Video's Metadata
paragon.request("vimeo", "/videos/[Video ID]", {
  method: "PATCH",
  body: {
    "name": "New video name"
  }
});
// Get Video Subtitles
paragon.request("vimeo", "/videos/[Video ID]/texttracks", {
  method: "GET"
});
  
```

## Building Vimeo workflows

Once your Vimeo account is connected, you use the [Vimeo Request](/workflows/requests#making-integration-requests) step to access any of Vimeo's API endpoints without the authentication piece.

When creating or updating records in Vimeo, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# WhatsApp
Source: https://docs.useparagon.com/resources/integrations/whatsapp

Connect to your users' WhatsApp accounts.

## Setup Guide

You can find your WhatsApp app credentials in your [WhatsApp Developer Account.](https://developers.facebook.com/docs/whatsapp/cloud-api/reference)

You'll need the following information to set up your WhatsApp App with Paragon Connect:

* [Permanent Access Token](https://developers.facebook.com/blog/post/2022/12/05/auth-tokens)
* Phone Number ID

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to WhatsApp

Once your users have connected their WhatsApp account, you can use the Paragon SDK to access the WhatsApp API on behalf of connected users.

See the WhatsApp [REST API documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/reference) for their full API reference.

Any WhatsApp API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Send a Message
await paragon.request('whatsapp', '/messages', {
  method: 'POST',
  body: {
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "PHONE_NUMBER",
    "type": "text",
    "text": {
      "preview_url": false,
      "body": "MESSAGE_CONTENT"
    }
  }
});

// Register a Phone
await paragon.request('whatsapp', '/register', {
  method: 'POST',
  body: {
    "messaging_product": "whatsapp",
    "pin": "6_DIGIT_PIN"
  }
});
  
```

## Building WhatsApp workflows

Once your WhatsApp account is connected, you use the [WhatsApp Request](/workflows/requests#making-integration-requests) step to access any of WhatsApp's API endpoints without the authentication piece.

When creating or updating records in WhatsApp, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# WooCommerce
Source: https://docs.useparagon.com/resources/integrations/woocommerce

Connect to your users' WooCommerce accounts.

## Setup Guide

You can find your WooCommerce app credentials in your [WooCommerce Developer Account.](https://woocommerce.github.io/woocommerce-rest-api-docs/#)

## Connecting to WooCommerce

Once your users have connected their WooCommerce account, you can use the Paragon SDK to access the WooCommerce API on behalf of connected users.

See the WooCommerce [REST API documentation](https://woocommerce.github.io/woocommerce-rest-api-docs/#) for their full API reference.

Any WooCommerce API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Get all customers
paragon.request("woocommerce", "/customers", {
  method: "GET"
});

// Get order by id
paragon.request("woocommerce", "/orders/<id>", {
  method: "GET"
});

// Create a product
paragon.request("woocommerce", "/products", {
  method: "POST",
  body: {
    name: "Premium Quality",
    type: "simple",
    regular_price: "21.99",
    description: "This is our Premium Quality offering",
  }
});
  
```

## Building WooCommerce workflows

Once your WooCommerce account is connected, you can add steps to perform the following actions:

* Create Customer
* Get Customer by ID
* Search Customers
* Update Customer
* Delete Customer
* Create Order
* Get Order by ID
* Search Orders
* Update Order
* Delete Order
* Create Product
* Get Product by ID
* Search Products
* Update Product
* Delete Product

You can also use the [WooCommerce Request](/workflows/requests#making-integration-requests) step to access any of WooCommerce's API endpoints without the authentication piece.

When creating or updating records in WooCommerce, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Wordpress.com
Source: https://docs.useparagon.com/resources/integrations/wordpress

Connect to your users' Wordpress accounts.

## Setup Guide

You can find your WordPress.com app credentials in your [WordPress.com Developer Account.](https://developer.wordpress.com/docs/api/)

You'll need the following information to set up your WordPress.com App with Paragon Connect:

* Client ID
* Client Secret

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your WordPress.com app to Paragon

Under **Integrations > Connected Integrations > Wordpress.com > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found under Client ID on your WordPress.com App page.
* **Client Secret:** Found under Client Secret on your WordPress.com App page.
* **Permissions:** Specify any additional scopes required by your integration here. [Learn more](https://developer.wordpress.com/docs/oauth2/) about the scopes supported by WordPress.

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Wordpress%20app%20to%20Paragon%20Connect.png?maxW=2044&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6fdf543e3e704c172c819eb8ed86ead6" alt="" width="2044" height="1198" data-path="assets/Connecting your Wordpress app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Wordpress%20app%20to%20Paragon%20Connect.png?w=280&maxW=2044&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6ac972a5277c2a4c629f49cce0d05017 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Wordpress%20app%20to%20Paragon%20Connect.png?w=560&maxW=2044&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=f4d7f682edceff8516280b36bb27b399 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Wordpress%20app%20to%20Paragon%20Connect.png?w=840&maxW=2044&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=bcdbd91268178245de3eb9e5c18e9f6f 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Wordpress%20app%20to%20Paragon%20Connect.png?w=1100&maxW=2044&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=3f6e220e605fea865ee3e971918baf78 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Wordpress%20app%20to%20Paragon%20Connect.png?w=1650&maxW=2044&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=3c05a8337bde84e56121ab356d227180 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Wordpress%20app%20to%20Paragon%20Connect.png?w=2500&maxW=2044&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e44956861edd1fc6a5d7b66e4d0f1888 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to WordPress.com

Once your users have connected their WordPress.com account, you can use the Paragon SDK to access the WordPress.com API on behalf of connected users.

See the WordPress.com [REST API documentation](https://developer.wordpress.com/docs/api/) for their full API reference.

Any WordPress.com API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Retrieve the connected user's WP sites
paragon.request("wordpress.com", "v1.1/me/sites", {
  method: "GET"
});

// Retrieve the number of likes on a certain WP post
paragon.request("wordpress.com", "v1.1/sites/<site_ID>/posts/<post_ID>/likes", {
  method: "GET"
});

// Create
paragon.request("wordpress.com", "sites/<site_ID>/posts/new", {
  method: "POST",
  body: {
    title: "My Post",
    content: "This is my post",
    tags: "api_posts",
    categories: "API"
  }
});
  
```

## Building WordPress.com workflows

Once your WordPress.com account is connected, you use the [WordPress.com Request](/workflows/requests#making-integration-requests) step to access any of WordPress.com's API endpoints without the authentication piece.

When creating or updating records in WordPress.com, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Workable
Source: https://docs.useparagon.com/resources/integrations/workable

Connect to your users' Workable accounts.

## Setup Guide

You can find your Workable app credentials in your [Workable Developer Account.](https://workable.readme.io/reference/generate-an-access-token)

You'll need the following information to set up your Workable App with Paragon Connect:

* Account Subdomain
* API Access Token

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

## Connecting to Workable

Once your users have connected their Workable account, you can use the Paragon SDK to access the Workable API on behalf of connected users.

See the Workable [REST API documentation](https://workable.readme.io/reference/generate-an-access-token) for their full API reference.

Any Workable API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Retrieve the members data
await paragon.request("workable", "/members", {
  method: "GET",
});

// Create a candidate at the specified job
await paragon.request("workable", "/jobs/{shortcode}/candidates", {
  method: "POST",
  body: {
    "candidate": [
      {
        "first_name": "Hashirama",
        "email": "hashirama@senju.com",
        "last_name": "Senju"
      }
    ]
  }
});
  
```

## Building Workable workflows

Once your Workable account is connected, you use the [Workable Request](/workflows/requests#making-integration-requests) step to access any of Workable's API endpoints without the authentication piece.

When creating or updating records in Workable, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Workday
Source: https://docs.useparagon.com/resources/integrations/workday

Connect to your users' Workday accounts

## Setup Guide

You'll need the following information to set up your Workday App with Paragon Connect:

* Subdomain
* Username
* Password
* Tenant Name

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Add your Workday app to Paragon

Under **Integrations > Connected Integrations > Workday > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Subdomain:** Found in your account URL address: `https://[host_name].workday.com/`
* **Username:** The username for the account connected account.
* **Password:** The password for the connected account/
* **Tenant Name:** Found in your account URL address: `https://.workday.com/[Tenant Name]/d/home/html`.

## Connecting to Workday

Once your users have connected their Workday account, you can use the Paragon SDK to access the Workday API on behalf of connected users.

See the Workday [REST API documentation](https://community.workday.com/api) for their full API reference.

Any Workday API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
await paragon.request("workday", "/Human_Resources/v40.1", { 
  method: "POST",
  body: `<soapenv:Body>
  <bsvc:Get_Workers_Request>
    <bsvc:Request_Criteria></bsvc:Request_Criteria>
    <bsvc:Response_Filter></bsvc:Response_Filter>
    <bsvc:Response_Group>
      <bsvc:Include_Reference>true</bsvc:Include_Reference>
    </bsvc:Response_Group>
  </bsvc:Get_Workers_Request>
</soapenv:Body>`
});
  
```

## Building Workday workflows

Once your Workday account is connected, you use the [Workday Request](/workflows/requests#making-integration-requests) step to access any of Workday's API endpoints without the authentication piece.

When creating or updating records in Workday, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Xero
Source: https://docs.useparagon.com/resources/integrations/xero

Connect to your users' Xero accounts.

## Setup Guide

You can find your Xero app credentials by visiting your [Xero Developer Portal](https://developer.xero.com/app/manage)

<Info>
  **Note:** You'll need to create a new Xero app if you don't already have one.
</Info>

You'll need the following information to set up your Xero App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Add the Redirect URL to your Xero app

Paragon provides a redirect URL to send information to your Xero app. To add the redirect URL to your Xero app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. Log in to your [Xero Developer Portal](https://developer.xero.com/app/manage).

3. Select your application from the developer portal.

4. Under **App details > OAuth 2.0 credentials**, press the `Add another URI` button.

5. Paste-in the redirect URL from Paragon. The redirect URL can be found in Step 1.

6. Press the `Save` button to save the Redirect URL.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20redirect%20URL%20to%20Xero.png?maxW=1884&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=9196e003a1ec9936089e40f2ef065284" alt="" width="1884" height="594" data-path="assets/Adding a redirect URL to Xero.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20redirect%20URL%20to%20Xero.png?w=280&maxW=1884&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=7db9f309eb1a4629c2298213d135587b 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20redirect%20URL%20to%20Xero.png?w=560&maxW=1884&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ada553d50cae408a96c081767e916205 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20redirect%20URL%20to%20Xero.png?w=840&maxW=1884&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ba6ef14840d2600de771729230c64859 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20redirect%20URL%20to%20Xero.png?w=1100&maxW=1884&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3fd30c8210e9361d3eefc3294b1e524c 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20redirect%20URL%20to%20Xero.png?w=1650&maxW=1884&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a051d00d6813a9af5d60409e499f8eaa 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20redirect%20URL%20to%20Xero.png?w=2500&maxW=1884&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f5d66c33a1625bfb1ddcee88f40f6a3d 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Xero app to Paragon

1. Select **Xero** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Xero > App Configuration > Configure**, fill out your credentials in their respective sections:

* **Client ID:**

  1. Log in to your [Xero Developer Portal](https://developer.xero.com/app/manage).

  2. Select your application.

  3. Navigate to **App details > OAuth 2.0 credentials**.

  4. Copy the **Client ID** from "**Client id**".

* **Client Secret:**

  1. Log in to your [Xero Developer Portal](https://developer.xero.com/app/manage).

  2. Select your application.

  3. Navigate to **App details > OAuth 2.0 credentials**.

  4. Press `Generate a secret`.

  5. Copy the **Client Secret** to use in Paragon.

* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

## Connecting to Xero

Once your users have connected their Xero account, you can use the Paragon SDK to access the Xero API on behalf of connected users.

See the Xero [REST API documentation](https://developer.xero.com/documentation/api/accounting/overview/) for their full API reference.

Any Xero API endpoints can be accessed with the Paragon SDK as shown in this example.

```js JavaScript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Query Payments
await paragon.request("xero", "payments", {
  method: "GET",
});
```

## Building Xero workflows

Once your Xero account is connected, you can add steps to perform the following actions:

* Get Accounts
* Get Contacts
* Create Customer
* Update Customer
* Get Invoices
* Create Invoice
* Update Invoice
* Send Invoice
* Get Payments
* Create Payments

You can also use the [Xero Request](/workflows/requests#making-integration-requests) step to access any of Xero's API endpoints without the authentication piece.

When creating or updating customers and invoices in Xero, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Xero%20in%20Paragon.png?maxW=2670&auto=format&n=867oBBVpxd2C3zc4&q=85&s=d5c42ec586560bb079cfa7255aa303a4" alt="" width="2670" height="1414" data-path="assets/Using Xero in Paragon.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Xero%20in%20Paragon.png?w=280&maxW=2670&auto=format&n=867oBBVpxd2C3zc4&q=85&s=26e52fee52851720e5d46b4b1d74268c 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Xero%20in%20Paragon.png?w=560&maxW=2670&auto=format&n=867oBBVpxd2C3zc4&q=85&s=236ff132b3dba42e84302a2da6a1f62c 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Xero%20in%20Paragon.png?w=840&maxW=2670&auto=format&n=867oBBVpxd2C3zc4&q=85&s=44d0eff641519f62eb2c4bb3c88dbb30 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Xero%20in%20Paragon.png?w=1100&maxW=2670&auto=format&n=867oBBVpxd2C3zc4&q=85&s=8fd73ef9545914c89d71d69fca57c0a3 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Xero%20in%20Paragon.png?w=1650&maxW=2670&auto=format&n=867oBBVpxd2C3zc4&q=85&s=065d30d821d97932e4ed5ef2ed816d03 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Xero%20in%20Paragon.png?w=2500&maxW=2670&auto=format&n=867oBBVpxd2C3zc4&q=85&s=bf72084d367c13684d6f58c3d9240852 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Xero account. For example, you might want to trigger a workflow whenever new customers are created in Xero to sync your users' Xero customers to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Xero%20webhook%20triggers%20in%20Paragon%20Connect.png?maxW=2202&auto=format&n=867oBBVpxd2C3zc4&q=85&s=cf69d3b8139c10da361c501b100aaf39" alt="" width="2202" height="1326" data-path="assets/Xero webhook triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Xero%20webhook%20triggers%20in%20Paragon%20Connect.png?w=280&maxW=2202&auto=format&n=867oBBVpxd2C3zc4&q=85&s=097434b08f33e75deec3dc97f716d902 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Xero%20webhook%20triggers%20in%20Paragon%20Connect.png?w=560&maxW=2202&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9226a389ca681080863c27e52a424f3e 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Xero%20webhook%20triggers%20in%20Paragon%20Connect.png?w=840&maxW=2202&auto=format&n=867oBBVpxd2C3zc4&q=85&s=f2c97842b8c6f72ade094167d67e6504 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Xero%20webhook%20triggers%20in%20Paragon%20Connect.png?w=1100&maxW=2202&auto=format&n=867oBBVpxd2C3zc4&q=85&s=a41fb817c4b5124031f32fa2526a9754 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Xero%20webhook%20triggers%20in%20Paragon%20Connect.png?w=1650&maxW=2202&auto=format&n=867oBBVpxd2C3zc4&q=85&s=6910d61a4d9f2e8275b64cf587b4dbd7 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Xero%20webhook%20triggers%20in%20Paragon%20Connect.png?w=2500&maxW=2202&auto=format&n=867oBBVpxd2C3zc4&q=85&s=b29e6bc0ca55f150ca0fa414f2e5648f 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Xero below:

* **New Account**
* **New Customer**
* **New Invoice**


# Zendesk
Source: https://docs.useparagon.com/resources/integrations/zendesk

Connect to your users' Zendesk accounts.

## Setup Guide

You can find your Zendesk app credentials by visiting your [Zendesk Developer App Console](https://www.zendesk.com/).

You'll need the following information to set up your Zendesk app with Paragon:

* Client ID
* Client Secret

### Add the Redirect URL to your Zendesk app

Paragon provides a redirect URL to send information to your Zendesk app. To add the redirect URL to your Zendesk app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your Zendesk dashboard, click the gear icon on the left.

3. Under **Channels > API > OAuth Clients**, click the "Add OAuth Client" button.

<Frame>
  <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=74ba6f16eba8684fab09a0d7599e1f86" alt="" width="810" height="523" data-path="assets/Accessing Zendesk OAuth Clients.gif" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?w=280&maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=fd1574924948febd4b3b387c91451172 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?w=560&maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=415109b5260ed8832e5ecfaaf4b36692 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?w=840&maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=393329fcd0a48ddccf4b060c1e3d6386 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?w=1100&maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=ff07abc939314003983402ca7871b9f4 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?w=1650&maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=f1dba1854850a672791006afb2d4d003 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?w=2500&maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=333bcb0db3a687d70df18b6c2916edab 2500w" data-optimize="true" data-opv="2" />
</Frame>

4. Fill out your **Client Name** and **Description**.

5. Under "**Redirect URLs**", paste the Redirect URL from Paragon.

6. Set the "**Client Kind"** to **Confidential**

7. Press the **Save** button.

8. Scroll down to the bottom of the page to copy your **Secret**. We'll use this in the next step.

<Warning>
  Your OAuth app created with the steps above will *only* work in your own test Zendesk account sandbox until steps to [“globalize”](/resources/integrations/zendesk#publishing-your-zendesk-application) the app are followed. Refer to the [instructions](/resources/integrations/zendesk#publishing-your-zendesk-application) for enabling the *global* app.
</Warning>

### Add your Zendesk app to Paragon

1. Select Zendesk from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Zendesk > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/zendesk#add-the-redirect-url-to-your-zendesk-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

## Using the Paragon SDK for Zendesk

Once your users have connected their Zendesk account, you can use the Paragon SDK to access the Zendesk API on behalf of connected users.

See the Zendesk [REST API documentation](https://developer.zendesk.com/rest_api/docs/support/introduction) for their full API reference.

Any Zendesk API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// List tickets
await paragon.request("zendesk", "v2/tickets", {
    method: "GET",
});
```

## Building Zendesk workflows

Once your Zendesk account is connected, you can add steps to perform the following actions:

* Create Ticket
* Update Ticket
* Add Comment to Ticket
* Search Tickets
* Get Ticket by ID
* Get Ticket Audits
* Create User
* Update User
* Search Users
* Get User by ID
* Search All Records

You can also use the [Zendesk Request](/workflows/requests#making-integration-requests) step to access any of Zendesk's API endpoints without the authentication piece.

When creating or updating tickets in Zendesk, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Zendesk account. For example, you might want to trigger a workflow whenever new tickets are created Zendesk to sync your users' Zendesk tickets to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Zendesk%20Webhook%20Triggers%20in%20Paragon%20Connect.png?maxW=1954&auto=format&n=867oBBVpxd2C3zc4&q=85&s=435c835157162be43f62e5251ea54976" alt="" width="1954" height="1138" data-path="assets/Zendesk Webhook Triggers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Zendesk%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=280&maxW=1954&auto=format&n=867oBBVpxd2C3zc4&q=85&s=ea5a8645d1eaf9b88946a0a99358abdc 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Zendesk%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=560&maxW=1954&auto=format&n=867oBBVpxd2C3zc4&q=85&s=3925f67a8eeb57a86ed2f56e4dce2ef4 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Zendesk%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=840&maxW=1954&auto=format&n=867oBBVpxd2C3zc4&q=85&s=3d6fc66f938cdcc673fe49bf69df0a10 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Zendesk%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1100&maxW=1954&auto=format&n=867oBBVpxd2C3zc4&q=85&s=4da3ce32be3a37f6ed1772a629d43d7d 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Zendesk%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=1650&maxW=1954&auto=format&n=867oBBVpxd2C3zc4&q=85&s=8a67f4d0c7b11a98fb0a513746800f95 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Zendesk%20Webhook%20Triggers%20in%20Paragon%20Connect.png?w=2500&maxW=1954&auto=format&n=867oBBVpxd2C3zc4&q=85&s=0deb8c529a3f6deb7c3e9d24ff7df16b 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of Webhook Triggers for Zendesk below:

* **New Ticket**
* **Ticket Updated**

## Publishing your Zendesk Application

A *global* OAuth application registration is required with Zendesk in order to allow connections from Zendesk users outside of your Zendesk organization. Follow the steps provided by Zendesk's developer documentation for [publishing your Zendesk Application](https://developer.zendesk.com/documentation/marketplace/building-a-marketplace-app/set-up-a-global-oauth-client/).


# Zendesk Sell
Source: https://docs.useparagon.com/resources/integrations/zendesksell

Connect to your users' Zendesk Sell accounts.

## Setup Guide

You can find your Zendesk Sell app credentials by visiting your [Zendesk Developer App Console](https://developer.zendesk.com/documentation/).

You'll need the following information to set up your Zendesk Sell app with Paragon:

* Client ID
* Client Secret

### Add the Redirect URL to your Zendesk Sell app

Paragon provides a redirect URL to send information to your Zendesk Sell app. To add the redirect URL to your Zendesk Sell app:

1. Copy the link under "**Redirect URL"** in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your Zendesk dashboard, click the gear icon on the left.

3. Under **Channels > API > OAuth Clients**, click the "Add OAuth Client" button.

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=74ba6f16eba8684fab09a0d7599e1f86" alt="" width="810" height="523" data-path="assets/Accessing Zendesk OAuth Clients.gif" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?w=280&maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=fd1574924948febd4b3b387c91451172 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?w=560&maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=415109b5260ed8832e5ecfaaf4b36692 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?w=840&maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=393329fcd0a48ddccf4b060c1e3d6386 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?w=1100&maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=ff07abc939314003983402ca7871b9f4 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?w=1650&maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=f1dba1854850a672791006afb2d4d003 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20Zendesk%20OAuth%20Clients.gif?w=2500&maxW=810&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=333bcb0db3a687d70df18b6c2916edab 2500w" data-optimize="true" data-opv="2" />
</Frame>

4. Fill out your **Client Name** and **Description**.

5. Under "**Redirect URLs**", paste the Redirect URL from Paragon.

6. Press the **Save** button.

7. Scroll down to the bottom of the page to copy your **Secret**. We'll use this in the next step.

### Add your Zendesk Sell app to Paragon

1. Select Zendesk Sell from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations > Zendesk Sell > App Configuration > Configure**, fill out your credentials from the end of [Step 1](/resources/integrations/zendesksell#add-the-redirect-url-to-your-zendesk-sell-app) in their respective sections:

* **Client ID:** Found at the end of Step 1.
* **Client Secret:** Found at the end of Step 1.

Press the purple "**Save Changes**" button to save your credentials.

<Info>
  **Note:** Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

## Connecting to Zendesk Sell

Once your users have connected their Zendesk account, you can use the Paragon SDK to access the Zendesk API on behalf of connected users.

See the Zendesk [REST API documentation](https://developer.zendesk.com/rest_api/docs/support/introduction) for their full API reference.

Any Zendesk API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Create a Contact
await paragon.request("zendesksell", "/contacts", {
    method: "POST",
    body: {
      "contact_id": 1,
      "name": "Mark Johnson",
      "first_name": "Mark",
      "last_name": "Johnson",
      "title": "CEO",
      "description": "I know him via Tom",
      "industry": "Design Services",
      "website": "http://www.designservice.com",
      "email": "mark@designservices.com",
      "phone": "508-778-6516",
      "mobile": "508-778-6516",
      "fax": "+44-208-1234567",
      "twitter": "mjohnson",
      "facebook": "mjohnson",
      "linkedin": "mjohnson",
      "skype": "mjohnson",
      "address": {
        "line1": "2726 Smith Street",
        "city": "Hyannis",
        "postal_code": "02601",
        "state": "MA",
        "country": "US"
      },
      "tags": [
        "contractor",
        "early-adopter"
      ],
      "custom_fields": {
        "referral_website": "http://www.example.com"
      }
    }
  }
});

// Create a Lead
await paragon.request("zendesksell", "/leads", {
    method: "POST",
    body: {
      "first_name": "Mark",
      "last_name": "Johnson",
      "organization_name": "Design Services Company",
      "source_id": 10,
      "title": "CEO",
      "description": "I know him via Tom",
      "industry": "Design Services",
      "website": "http://www.designservice.com",
      "email": "mark@designservices.com",
      "phone": "508-778-6516",
      "mobile": "508-778-6516",
      "fax": "+44-208-1234567",
      "twitter": "mjohnson",
      "facebook": "mjohnson",
      "linkedin": "mjohnson",
      "skype": "mjohnson",
      "address": {
        "line1": "2726 Smith Street",
        "city": "Hyannis",
        "postal_code": "02601",
        "state": "MA",
        "country": "US"
      },
      "tags": [
        "important"
      ],
      "custom_fields": {
        "known_via": "tom"
      }
    }
  });

// Get all Deals
await paragon.request("zendesksell", "/deals", {
   method: "GET"
})
```

## Building Zendesk Sell workflows

Once your Zendesk Sell account is connected, you can add steps to perform the following actions:

* Create Record
* Update Record
* Get Record by ID
* Search Records
* Delete Record

You can also use the [Zendesk Sell Request](/workflows/requests#making-integration-requests) step to access any of Zendesk Sell's API endpoints without the authentication piece.

When creating or updating records in Zendesk Sell, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Zoho CRM
Source: https://docs.useparagon.com/resources/integrations/zohocrm

Connect to your users' Zoho CRM accounts.

## Setup Guide

You can find your Zoho CRM app credentials in your [Zoho CRM Developer Account](https://accounts.zoho.com/developerconsole).

You'll need the following information to set up your Zoho CRM App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Creating a Zoho CRM app

### Add the Redirect URL to your Zoho CRM app

Paragon provides a redirect URL to send information to your Zoho CRM app. To add the redirect URL to your Zoho CRM app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

1. Visit the [Zoho API Console](https://api-console.zoho.com/).

2. Sign in with your Zoho CRM Developer Account.

3. Click "**Add Client**" in the top right:

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f5f2d7d5a76ea8c5cabbb482f855fd1e" alt="" width="2078" height="942" data-path="assets/Screen Shot 2022-11-03 at 9.10.23 PM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?w=280&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=6f37bede1a1123c5fc3596ce65826b70 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?w=560&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1a7be3a99ce3d9a2d36e51dda50f4695 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?w=840&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=689db2d79c103d2eed31c67452f20ece 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?w=1100&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f494aad3a476f641b008b095ae8663f8 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?w=1650&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=9545394e7d27c9b7ea9f0d36c8d95a7e 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?w=2500&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c91b59da2a3536670cd91da77829c540 2500w" data-optimize="true" data-opv="2" />
</Frame>

4. Select "**Server-based Applications**" as the Client Type:

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ec421633670036ae9e07a2b473213c85" alt="" width="2586" height="1120" data-path="assets/Screen Shot 2022-11-03 at 9.11.18 PM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?w=280&maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=2230abe844bfae99a9b27bb175126034 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?w=560&maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=0b61429040f6db92415cda58e9222dec 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?w=840&maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=614d73de397c69d129e305a0dc0b9061 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?w=1100&maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=00a8e457e0c6b8b6e6690b08c5867a9b 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?w=1650&maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=072aebcb4328daa643220163c5559dc7 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?w=2500&maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=56b10666693978b90189df2e44ae0b1c 2500w" data-optimize="true" data-opv="2" />
</Frame>

5. Add your website as the Homepage URL.

6. Paste-in the Redirect URL Paragon provides as an **Authorized Redirect URI**.

Zoho CRM provides you with the **Client ID** and **Client Secret** needed for the next steps after adding the redirect URL to your app.

### Add your Zoho CRM app to Paragon

Under **Integrations > Connected Integrations >** **Zoho CRM** **>** **Settings**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found at the end of [Step 1](/resources/integrations/zohocrm#add-the-redirect-url-to-your-zoho-crm-app) on your Zoho CRM App page.
* **Client Secret:** Found at the end of [Step 1](/resources/integrations/zohocrm#add-the-redirect-url-to-your-zoho-crm-app) on your Zoho CRM App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

Leaving the Client ID and Client Secret blank will use Paragon development keys.

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20to%20your%20Zoho%20CRM%20app%20%20to%20Paragon%20Connect.png?maxW=1888&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=d2fdb709fde8c5c217ee01148a4264a0" alt="" width="1888" height="1148" data-path="assets/Connecting to your Zoho CRM app  to Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20to%20your%20Zoho%20CRM%20app%20%20to%20Paragon%20Connect.png?w=280&maxW=1888&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=f8b3a743f3b67a07a80f815684d5a894 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20to%20your%20Zoho%20CRM%20app%20%20to%20Paragon%20Connect.png?w=560&maxW=1888&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b39cb51ac219ca49c5085db0fe2e9764 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20to%20your%20Zoho%20CRM%20app%20%20to%20Paragon%20Connect.png?w=840&maxW=1888&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=07bd802edfdc00a2af1cad33dcc0804d 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20to%20your%20Zoho%20CRM%20app%20%20to%20Paragon%20Connect.png?w=1100&maxW=1888&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=663f196bd1afe4561e89742576679736 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20to%20your%20Zoho%20CRM%20app%20%20to%20Paragon%20Connect.png?w=1650&maxW=1888&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3ccb8d760dc8690b77177386d7f18a68 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Connecting%20to%20your%20Zoho%20CRM%20app%20%20to%20Paragon%20Connect.png?w=2500&maxW=1888&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=41d6fedbfb8c0cad2f1e61c9612a9b2c 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Zoho CRM

Once your users have connected their Zoho CRM account, you can use the Paragon SDK to access the Zoho CRM API on behalf of connected users.

See the Zoho CRM [REST API documentation](https://www.zoho.com/crm/developer/docs/api/v3/modules-api.html) for their full API reference.

Any Zoho CRM API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Retrieve the user's data
await paragon.request("zohocrm", "users", {
  method: "GET",
});
            
// Add a user to your organization
await paragon.request("zohocrm", "users", {
  method: "POST",
  body: {
    "users": [
      {
        "role": "554023000000015969",
        "first_name": "Patricia",
        "email": "Patricia@abcl.com",
        "profile": "554023000000015975",
        "last_name": "Boyle"
      }
    ]
  }
});
```

## Building Zoho CRM workflows

Once your Zoho CRM account is connected, you can add steps to perform the following actions:

* Create Record
* Update Record
* Get Record by ID
* Search Records
* Search Records by COQL Query
* Delete Record

You can also use the [Zoho CRM Request](/workflows/requests#making-integration-requests) step to access any of Zoho CRM's API endpoints without the authentication piece.

When creating or updating records in Zoho CRM, you can reference data from previous steps by typing `{{` to invoke the variable menu.

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Zoho CRM account. For example, you might want to trigger a workflow whenever new Accounts are created in Zoho CRM to sync your users' Zoho CRM Accounts to your application in real-time.

You can find the full list of Webhook Triggers for Zoho CRM below:

* **New Record**
* **Record Updated**


# Zoho People
Source: https://docs.useparagon.com/resources/integrations/zohopeople

Connect to your users' Zoho People accounts.

## Setup Guide

You can find your Zoho People app credentials in your [Zoho People Developer Account](https://api-console.zoho.com/).

You'll need the following information to set up your Zoho People App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

<Info>
  This is an **API-only** integration - workflow actions for this integration are still in development. You can still connect user accounts, build workflows, and access the API for this integration.
</Info>

### Creating a Zoho People app

To get started, you'll need to create an app in the [Zoho API Console](https://api-console.zoho.com/).

1. Sign in with your Zoho People Developer Account.

2. Click "**Add Client**" in the top right:

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f5f2d7d5a76ea8c5cabbb482f855fd1e" alt="" width="2078" height="942" data-path="assets/Screen Shot 2022-11-03 at 9.10.23 PM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?w=280&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=6f37bede1a1123c5fc3596ce65826b70 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?w=560&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1a7be3a99ce3d9a2d36e51dda50f4695 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?w=840&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=689db2d79c103d2eed31c67452f20ece 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?w=1100&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f494aad3a476f641b008b095ae8663f8 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?w=1650&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=9545394e7d27c9b7ea9f0d36c8d95a7e 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.10.23%20PM.png?w=2500&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c91b59da2a3536670cd91da77829c540 2500w" data-optimize="true" data-opv="2" />
</Frame>

3. Select "**Server-based Applications**" as the Client Type:

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=ec421633670036ae9e07a2b473213c85" alt="" width="2586" height="1120" data-path="assets/Screen Shot 2022-11-03 at 9.11.18 PM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?w=280&maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=2230abe844bfae99a9b27bb175126034 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?w=560&maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=0b61429040f6db92415cda58e9222dec 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?w=840&maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=614d73de397c69d129e305a0dc0b9061 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?w=1100&maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=00a8e457e0c6b8b6e6690b08c5867a9b 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?w=1650&maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=072aebcb4328daa643220163c5559dc7 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202022-11-03%20at%209.11.18%20PM.png?w=2500&maxW=2586&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=56b10666693978b90189df2e44ae0b1c 2500w" data-optimize="true" data-opv="2" />
</Frame>

4. Add your website as the Homepage URL.

5. Add [https://passport.useparagon.com/oauth](https://passport.useparagon.com/oauth) as an **Authorized Redirect URI**.

### Add the Redirect URL to your Zoho People app

Paragon provides a redirect URL to send information to your Zoho CRM app. To add the redirect URL to your Zoho PeoplePeople app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Zoho People Developer Account](https://api-console.zoho.com/), select your application.

3. Under **Authorized Redirect URIs**, paste-in the Paragon Connect redirect URL found in Step 1.

4. Copy the Client ID and Client Secret provided by Zoho CRM.

### Add your Zoho People app to Paragon

Under **Integrations > Connected Integrations > Zoho People > App Configuration > Configure**, fill out your credentials from your developer app in their respective sections:

* **Client ID:** Found at the end of [Step 1](/resources/integrations/zohopeople#add-the-redirect-url-to-your-zoho-people-app) on your Zoho People App page.
* **Client Secret:** Found at the end of [Step 1](/resources/integrations/zohopeople#add-the-redirect-url-to-your-zoho-people-app) on your Zoho People App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com)

<Info>
  Leaving the Client ID and Client Secret blank will use Paragon development keys.
</Info>

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoho%20People%20app%20to%20Paragon%20Connect.png.png?maxW=997&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e569fe2dcc7ec179981033f27b949ef2" alt="" width="997" height="569" data-path="assets/Connecting your Zoho People app to Paragon Connect.png.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoho%20People%20app%20to%20Paragon%20Connect.png.png?w=280&maxW=997&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=81e5e4875f7a2b47bbe1a823091c687d 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoho%20People%20app%20to%20Paragon%20Connect.png.png?w=560&maxW=997&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6aa81d6de6cdb3e2e73167b36983a5a0 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoho%20People%20app%20to%20Paragon%20Connect.png.png?w=840&maxW=997&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=969bf2b9d6dda1678bcb35b5de88c4df 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoho%20People%20app%20to%20Paragon%20Connect.png.png?w=1100&maxW=997&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=01892011a8477184df1c3ac285db6467 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoho%20People%20app%20to%20Paragon%20Connect.png.png?w=1650&maxW=997&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=efb8c7f67b4c6828720a9659ce282b3e 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoho%20People%20app%20to%20Paragon%20Connect.png.png?w=2500&maxW=997&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7d64a1e82cb94694f20fb68cca1ed892 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Zoho People

Once your users have connected their Zoho People account, you can use the Paragon SDK to access the Zoho People API on behalf of connected users.

See the Zoho People [REST API documentation](https://www.zoho.com/crm/developer/docs/api/v3/modules-api.html) for their full API reference.

Any Zoho People API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// List of view details available in all forms
await paragon.request('zohopeople', 'views', {
    method: 'GET'
});

// List of files categories
await paragon.request('zohopeople', 'files/getCategories', {
    method: 'GET'
});
            
// List of field components available in a form with ID
await paragon.request('zohopeople', 'forms/<formLinkName>/components', {
    method: 'GET'
});
```

## Building Zoho People workflows

Once your Zoho People account is connected, you use the [Zoho People Request](/workflows/requests#making-integration-requests) step to access any of Zoho People's API endpoints without the authentication piece.

When creating or updating records in Zoho People, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Zoom
Source: https://docs.useparagon.com/resources/integrations/zoom

Connect to your users' Zoom accounts.

## Setup Guide

You can find your Zoom application credentials by visiting your [Zoom developer dashboard](https://marketplace.zoom.us/user/build).

You'll need the following information to set up your Zoom App with Paragon Connect:

* Client ID
* Client Secret
* Scopes Requested

### Prerequisites

* Zoom Developer Account. You can create one [here](https://developers.zoom.us/).
* Zoom OAuth application. Learn more about creating a Zoom OAuth application [here](https://marketplace.zoom.us/docs/guides/build/oauth-app).

### Add the Redirect URL to your Zoom app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your Zoom app:

1. Copy the link under "**Redirect URL**" in your integration settings in Paragon. The Redirect URL is:

```
https://passport.useparagon.com/oauth
```

2. In your [Zoom developer dashboard](https://marketplace.zoom.us/user/build), select your application.

3. Navigate to **App Credentials > Redirect URL for OAuth**, then paste-in Paragon Connect's redirect URL found in [Step 1](/resources/integrations/zoom#add-the-redirect-url-to-your-zoom-app).

4. Under **App Credentials > OAuth allow list > Add Whitelist URL**, paste-in Paragon Connect's redirect URL found in [Step 1](/resources/integrations/zoom#add-the-redirect-url-to-your-zoom-app).

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20Zoom%20app.png?maxW=2384&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=5eecacbd4999fef89b83edc4936d8e0b" alt="" width="2384" height="1374" data-path="assets/Adding the Redirect URL to your Zoom app.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20Zoom%20app.png?w=280&maxW=2384&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=25f649a28f469ad9e6b3a72b4d44eb1d 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20Zoom%20app.png?w=560&maxW=2384&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=5c04aca4628bb3341f8ef4d134498ead 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20Zoom%20app.png?w=840&maxW=2384&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=31af93423c89d877b14a1216f6adb053 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20Zoom%20app.png?w=1100&maxW=2384&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=dfac616120b5e9b20d903fb07827c2f4 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20Zoom%20app.png?w=1650&maxW=2384&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a7a91ac952165827bfcf8baa966c6bdc 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20the%20Redirect%20URL%20to%20your%20Zoom%20app.png?w=2500&maxW=2384&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=24fbfe81c9252a7aee15425734bb043e 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Add your Zoom app to Paragon

1. Select **Zoom** from the **Integrations Catalog**.

2. Under **Integrations > Connected Integrations >** **Zoom** **>** **Settings**, fill out your credentials from the end of [Step 1](/resources/integrations/zoom#add-the-redirect-url-to-your-zoom-app) in their respective sections:

* **Client ID:** Found under App Credentials > Client ID on your Zoom App page.
* **Client Secret:** Found under App Credentials > Client secret on your Zoom App page.
* **Permissions:** Select the scopes you've requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. [View dashboard.](https://dashboard.useparagon.com) You must add `users:read` in your Zoom and Paragon dashboard.

Press the blue "**Save Changes**" button to save your credentials.

<Info>
  **Note:** You should only indicate the scopes you have requested in your Zoom application registration to Paragon. They should match exactly.
</Info>

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoom%20app%20to%20Paragon%20Connect.png?maxW=1604&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=a6b15c4db1db339009fd723294accbf7" alt="" width="1604" height="1188" data-path="assets/Connecting your Zoom app to Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoom%20app%20to%20Paragon%20Connect.png?w=280&maxW=1604&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=a40a50bdfb9f9bf477345b5bab539689 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoom%20app%20to%20Paragon%20Connect.png?w=560&maxW=1604&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=f3f11cd9ae8e94e47020530fec58ca25 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoom%20app%20to%20Paragon%20Connect.png?w=840&maxW=1604&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=c4adfafd4aeefd092ff2ed804468fa1f 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoom%20app%20to%20Paragon%20Connect.png?w=1100&maxW=1604&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=85039f374b07908c01c567a51a4fc7cd 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoom%20app%20to%20Paragon%20Connect.png?w=1650&maxW=1604&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=657ec70a8ee37ceddcdff53e0f8e93f9 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Connecting%20your%20Zoom%20app%20to%20Paragon%20Connect.png?w=2500&maxW=1604&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=30ffef81d05eb2cf60ea663193402ff6 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Connecting to Zoom

Once your users have connected their Zoom account, you can use the Paragon SDK to access the Zoom API on behalf of connected users.

See the Zoom [REST API documentation](https://marketplace.zoom.us/docs/api-reference/zoom-api) for their full API reference.

Any Zoom API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Create a Meeting
paragon.request("zoom", "users/me/meetings", {
    method: "POST",
    body: { "topic": "Product Demo Webinar" }
});


//Get Meetings
paragon.request("zoom", "users/me/meetings", {
    method: "GET",
});
```

## Building Zoom workflows

Once your Zoom account is connected, you can add steps to perform the following actions:

* Create Meeting
* Update Meeting
* Get Meetings
* Get Meeting by ID
* Delete Meeting
* Add Meeting Registrant
* Get Meeting Registrants
* Delete Meeting Registrant
* Get Recording by Meeting ID
* Search Recordings

You can also use the [Zoom Request](/workflows/requests#making-integration-requests) step to access any of Zoom's API endpoints without the authentication piece.

When creating or updating meetings in Zoom, you can reference data from previous steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Generating%20a%20Zoom%20meeting%20from%20Paragon.png?maxW=2204&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=7f9047b83af5d605a0ccdae2c9660361" alt="" width="2204" height="1520" data-path="assets/Generating a Zoom meeting from Paragon.png" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Generating%20a%20Zoom%20meeting%20from%20Paragon.png?w=280&maxW=2204&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=ba2b7d1865cafe0d9a5d6d23eefd0b28 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Generating%20a%20Zoom%20meeting%20from%20Paragon.png?w=560&maxW=2204&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=58723a0f37dc8ec0cdb653b426b1e9dd 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Generating%20a%20Zoom%20meeting%20from%20Paragon.png?w=840&maxW=2204&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=04a04b912da87ac7127e42031d4f6096 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Generating%20a%20Zoom%20meeting%20from%20Paragon.png?w=1100&maxW=2204&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=49a67914f975e74f60abf02f52d18458 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Generating%20a%20Zoom%20meeting%20from%20Paragon.png?w=1650&maxW=2204&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=95d90d041e6faa7da8a2898eb96fa852 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Generating%20a%20Zoom%20meeting%20from%20Paragon.png?w=2500&maxW=2204&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=6d9399f401b5a2bf1da2a4a32d537e59 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users' Zoom account. Paragon provides a webhook URL to listen for updates from Zoom to send information to your app. To add the webhook URL to your Zoom app registration and complete its verification, perform the following:

2. Start in your [Zoom developer dashboard](https://marketplace.zoom.us/user/build), and select your application.

3. Navigate to **Feature > Add Feature** and turn on **Event subscriptions**.

4. Copy the **Secret Token** value provided by Zoom.

5. Navigate back to your integration settings in Paragon. Add the **Secret Token** value to the **Webhook Client Secret**.

6. Copy the link under "**Webhook URL**" in your integration settings in Paragon. The webhook URL takes the form:

```
https://hermes.useparagon.com/webhook/triggers/connect/zoom/<Integration_ID>
```

4. Return to Zoom's **Event subscriptions** page and press the `+ Add new event subscription` button.

5. Under "**Event notification endpoint URL**", paste-in the webhook URL from your integration's `Settings` in Paragon Connect.

6. Choose the event types that you look to support in **Event types**. These are listed below.

7. Validate the URL with Zoom by pressing the "Validate" button. There is no need to change the Authentication Header option.

8. Press `Save` to save your changes once verified.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-02-22%20at%2012.35.54@2x.png?maxW=1172&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=b693415b8e3ab1f3da6f10b477f82a00" alt="" width="1172" height="1594" data-path="assets/CleanShot 2024-02-22 at 12.35.54@2x.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-02-22%20at%2012.35.54@2x.png?w=280&maxW=1172&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=fbae795c85925f074c2fb030ab3e0467 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-02-22%20at%2012.35.54@2x.png?w=560&maxW=1172&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=0432f20b9d048fd557cd0ccb86204fef 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-02-22%20at%2012.35.54@2x.png?w=840&maxW=1172&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=b47f416977782e34d56c8f250e56eb1f 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-02-22%20at%2012.35.54@2x.png?w=1100&maxW=1172&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=72ff1fbfeeafd0bd2e60881bcb997be8 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-02-22%20at%2012.35.54@2x.png?w=1650&maxW=1172&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=7934dfc766c261b134c856b7d7232433 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/CleanShot%202024-02-22%20at%2012.35.54@2x.png?w=2500&maxW=1172&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=6aeb001e48c46092757511e73f9e77e3 2500w" data-optimize="true" data-opv="2" />
</Frame>

Once you've added the Event Notification Endpoint URL to your Zoom app, you can access the following triggers in Paragon:

* **New Meeting**
* **Meeting Updated**
* **Meeting Ended**
* **New Meeting Registrant**
* **Meeting Participant Joined**
* **Meeting Participant Left**
* **New Recording**
* **Complete Recording**
* **Recording Transcript Completed**


# JavaScript Libraries
Source: https://docs.useparagon.com/resources/javascript-libraries



You can find the full list of supported npm modules below. If you don't see the module that you're looking for, [let us know](mailto:team@useparagon.com) and can usually add it for you.

<Card title="Using Functions" href="/workflows/functions" horizontal />

* [archiver](https://www.npmjs.com/package/archiver)
* [aws-sdk](https://www.npmjs.com/package/aws-sdk) (`libraries["aws-sdk"]`)
* [azure/storage-blob](https://www.npmjs.com/package/@azure/storage-blob) (`libraries["azure/storage-blob"]`)
* [bluebird](https://www.npmjs.com/package/bluebird)
* [Buffer](https://nodejs.org/api/buffer.html#buffer_buffer/)
* [cheerio](https://www.npmjs.com/package/cheerio)
* [cloudflare](https://www.npmjs.com/package/cloudflare)
* [crypto](https://nodejs.org/api/crypto.html#crypto_crypto)
* [cryptr](https://www.npmjs.com/package/cryptr)
* [csv](https://www.npmjs.com/package/csv)
* [csv/lib/sync](https://www.npmjs.com/package/csv) (`libraries["csv/lib/sync"]`)
* [date-fns](https://www.npmjs.com/package/date-fns) (`libraries.dateFns`)
* [fast-xml-parser](https://www.npmjs.com/package/fast-xml-parser) (`libraries["fast-xml-parser"]`)
* [fetch](https://www.npmjs.com/package/node-fetch)
* [firebase](https://www.npmjs.com/package/firebase)
* [firebaseAdmin](https://www.npmjs.com/package/firebase-admin)
* [FormData](https://www.npmjs.com/package/form-data)
* [fuse.js](https://www.npmjs.com/package/fuse.js)
* [https](https://nodejs.org/api/https.html#https_https)
* [ioredis](https://www.npmjs.com/package/ioredis)
* [jsforce](https://www.npmjs.com/package/jsforce)
* [jsonwebtoken](https://www.npmjs.com/package/jsonwebtoken)
* [lodash](https://www.npmjs.com/package/lodash)
* [lodash/fp](https://www.npmjs.com/package/lodash) (`libraries["lodash/fp"]`)
* [luxon](https://www.npmjs.com/package/luxon)
* [libphonenumber-js](https://www.npmjs.com/package/libphonenumber-js) (`libraries.libphonenumber`)
* [mailgun.js](https://www.npmjs.com/package/mailgun.js) (`libraries.Mailgun`)
* [mercury](https://www.npmjs.com/package/@postlight/mercury-parser)
* [mime](https://www.npmjs.com/package/mime/v/3.0.0)
* [moment](https://www.npmjs.com/package/moment)
* [mongodb](https://www.npmjs.com/package/mongodb)
* [mssql](https://www.npmjs.com/package/mssql)
* [mysql2](https://www.npmjs.com/package/mysql2)
* [neo4j-driver](https://www.npmjs.com/package/neo4j-driver) (`libraries['neo4j-driver']`)
* [node-fetch](https://www.npmjs.com/package/node-fetch) (`libraries.fetch`)
* [numberToWords](https://www.npmjs.com/package/number-to-words)
* [oauth](https://www.npmjs.com/package/oauth)
* [pdf](https://www.npmjs.com/package/html-pdf)
* [pg](https://www.npmjs.com/package/pg)
* [ramda](https://www.npmjs.com/package/ramda)
* [redis](https://www.npmjs.com/package/redis)
* [s3](https://www.npmjs.com/package/s3)
* [segment](https://www.npmjs.com/package/analytics-node)
* [sendgrid](https://www.npmjs.com/package/@sendgrid/mail)
* [sendpulse](https://www.npmjs.com/package/sendpulse-api)
* [sequelize](https://www.npmjs.com/package/sequelize)
* [slack](https://www.npmjs.com/package/slack)
* [snowflake-sdk](https://www.npmjs.com/package/snowflake-sdk)
* [ssh2-sftp-client](https://www.npmjs.com/package/ssh2-sftp-client)
* [throttle](https://www.npmjs.com/package/promise-parallel-throttle)
* [twilio](https://www.npmjs.com/package/twilio)
* [underscore](https://www.npmjs.com/package/underscore)
* [underscore.string](https://www.npmjs.com/package/underscore) (`libraries['underscore.string']`)
* [unzipper](https://www.npmjs.com/package/unzipper)
* [url](https://www.npmjs.com/package/url)
* [uuid](https://www.npmjs.com/package/uuid)
* [web3](https://www.npmjs.com/package/web3)


# Paragon User Token Generator
Source: https://docs.useparagon.com/resources/user-token





# GDPR
Source: https://docs.useparagon.com/security/gdpr

GDPR at Paragon

Privacy and security are core to Paragon's approach to product development and business, and we continuously evaluate all our practices in an effort to safeguard your information as effectively as possible. In that vein, we're glad to comply with the General Data Protection Regulation ("GDPR") and to help Paragon customers comply with the GDPR.

### Data processing agreement

Paragon offers Data Processing Agreements (DPAs) to users upon request. This DPA includes standard contractual clauses (“Model Clauses”) that are the mechanism for GDPR-compliant data transfer. To request a DPA, please email [privacy@useparagon.com](mailto:privacy@useparagon.com) from the email address associated with your Paragon account or visit our [Trust Center](https://security.useparagon.com/).

### Data Protection Officer

We have appointed a Data Protection Officer. For more information, contact [privacy@useparagon.com](mailto:privacy@useparagon.com).

### Privacy Policy

We've added additional language to our privacy policy in order to reinforce our commitment to privacy, security, and confidentiality. The privacy policy can be found at [https://www.useparagon.com/privacy](https://www.useparagon.com/privacy).

### Questions?

If you have further questions, please reach out to [privacy@useparagon.com](mailto:privacy@useparagon.com).


# Security
Source: https://docs.useparagon.com/security/security

Paragon's Security and Change Management Procedures.

## Overview

This document outlines some of [Paragon's](https://www.useparagon.com/) security practices and architecture.

### Contact

* **Chief Technology Officer:**  Ishmael Samuel ([ishmael@useparagon.com](mailto:ishmael@useparagon.com))
* **Data Protection Officer:**  Ishmael Samuel ([ishmael@useparagon.com](mailto:ishmael@useparagon.com))
* **Support:**  [support@useparagon.com](mailto:support@useparagon.com)
* **Privacy:**  [privacy@useparagon.com](mailto:privacy@useparagon.com)

### Other Resources

* [Privacy Policy](https://www.useparagon.com/privacy)
* [Terms of Service](https://www.useparagon.com/terms-of-service)

## Policy Compliance

### Data Protection Agreement

We have a Data Protection Agreement (DPA) that can be requested and signed as a formal agreement between us and customers that require it. It outlines our obligations and procedures. It is reviewed once a quarter and updated as needed.

Our appointed Data Protection Officer is responsible for reviewing that it is up to date and its procedures are followed. Any customer can request a copy of the document by emailing [privacy@useparagon.com](mailto:privacy@useparagon.com). This is outlined in [our GDPR documentation](/security/gdpr).

### Policy Coverage

* Third-Party Connectivity
* Data Privacy
* Access Control
* Encryption Standards

## Security

### Physical and Environment Security

We do not manage any physical servers or data centers. Our data is stored in AWS Cloud. Logs are maintained for access to data and stored in AWS CloudWatch. AWS was selected for our cloud provider due to their large foothold in the market. All incoming traffic is logged.

### Access to Data

We have separate AWS accounts for our sandbox and live environments. The sandbox environment is available to all of our engineers (with authentication) while the live environment requires separate logins and additionally requires connecting from a whitelisted IP.

Any engineer needing to connect to the live environment must request access with a reason and their IP address to be temporarily allowed into the live environment.

### Data Storage & Encryption

Our customers' security is top priority. Third-party credentials for integrations are stored in a distributed vault with encryption keys and encrypted values stored separately. Flow logs are stored independently and secure information is redacted. Emails and password are never logged.

### Security and Staff Training

When onboarding new employees, we follow the principle of least privileged access and manually provision only the necessary logins with the least amount of access possible to conduct their job. We explain what they have access to, why, and the valid use cases to use each service.

We run through our security tools (password vaults, network security, etc) and discuss best practices for information security (storing, retrieving, and sharing secure information, 2FA, etc).

Once familiar with our tooling and procedures, they're brought up to speed on our incident response plan and their role in it in a separate session.

## Change Management

Changes to our environments are done via an automated continuous delivery system. Every change runs through a suite of thousands of unit, integration, and end-to-end tests. We do manual quality assurance, and our CTO code reviews and manually approves each outgoing deployment that goes to the production environment.

Our infrastructure is represented in code and updated through a version-controlled continuous deployment system.

All changes are logged with the author, reviewer, and date-time.

## Incident Management

### Incident Response

We have a rotating support engineer to handle or delegate issues to the necessary parties. Our CTO is responsible for overseeing disaster recovery, and all incidents are documented in our ticket management system with large incidents documented via a formal Post Mortem.

### Security Incidents

When a security incident is detected, we immediately notify the entire engineering and management team and prioritize it as a Priority 0 (meaning once assigned, a responsible engineer drops whatever they're doing and immediately begins work on resolution).

Once the engineering team is notified, an engineer claims it or is assigned it by management and becomes the responsible engineer. The response time to date from detection to assignment for all P0s to date has been \< 5 minutes.

The first step the responsible engineer takes is to determine the cause of the issue, a preliminary scope of impacted services and users, and the threat level. If one or more users are actively unable to use the service or at risk of secure information being leaked, then work continues and any other necessary parties are notified to help resolve the issue if needed.

Once the preliminary scope and severity has been assessed, a plan for containment and resolution is proposed, shared with the engineering team for any asynchronous feedback and work begins immediately. Our continuous integration & deployment system allows the responsible engineer to build, test and deploy their changes to test environments, and the CTO manually code reviews and approves all changes before they're sent to our live servers.

After resolution, a more thorough assessment of impacted services and users is conducted and a Post Mortem is written with a brief overview, the cause of the issue, impacted services and users, duration of the event, how we resolved it, and steps being taken to prevent the issue from happening again.

If one or more users are impacted by downtime or a breach, the Post Mortem is made public and sent to all parties affected within 1 business day (usually same day). All business and enterprise users share a Slack channel with us, so they're usually notified at the start of an event and updated throughout the process. Naturally, no enterprise users have had a security breach to date by nature of running Paragon in their own network.

## Whitelisting IPs

If needed, you can whitelist the following Paragon IP addresses to ensure requests to your platform are only being made from Paragon.

* `18.205.92.162`
* `18.215.215.164`
* `34.225.59.94`
* `44.210.155.28`
* `52.45.12.206`
* `54.235.127.238`


# Service Level Agreement
Source: https://docs.useparagon.com/security/sla



## Overview

Paragon provides a 99.9% uptime commitment for customers on any paid plan.

## Downtime

**Downtime** is the overall number of minutes Paragon is unavailable during a fiscal quarter (three month periods). Paragon calculates unavailability using server monitoring software to measure the server side error rate, ping test results, web server tests.

Downtime excludes the following:

* Slowness or other performance issues with individual features (task history, replay, workflow editing).
* Issues that are related to external integrations or third parties.
* Any products or features identified as pilot, alpha, beta, or similar.
* External network or equipment problems outside of our reasonable control, such as DNS issues or cloud provider downtime.
* Scheduled downtime for maintenance.

## Uptime Commitment

**Uptime** is the percentage of total minutes Paragon was available during a fiscal quarter.

**(total minutes in quarter - Downtime) / total minutes in quarter > 99.9%**

#### Scheduled Downtime

Sometimes we need to perform maintenance to keep Paragon working smoothly. If scheduled downtime is necessary, we'll do our best to give you at least 24 hours advance notice.

#### Service Credits

If we fall short of our Uptime commitment, we'll apply a credit to each affected account equal to 2 times the amount that the organization paid during the period Paragon was down (**Service Credits**) for the next billing cycle.

Service Credits are not refunds, cannot be exchanged into a cash amount, are capped at a maximum of 30 days of paid services, require you to have paid any outstanding invoices and expire upon termination of your contract or subscription. Service Credits are the sole and exclusive remedy for any failure by Paragon to meet its obligations under this SLA. Service Credits must be requested in written format during the same fiscal quarter in which the downtime occurred to be applied.

Downtime doesn't affect everyone at the same time or in the same way due to the separation of services and data. Service Credits applied to one customer don't guarantee Service Credits will be applied to another.


# Trust Center
Source: https://docs.useparagon.com/security/trust-center





# Contacting Support
Source: https://docs.useparagon.com/support/contacting-support



## Submitting a Ticket

Before submitting a ticket, please visit our [Status Page](https://status.useparagon.com/) to see if any known incidents may be related to your issue. You are also able to subscribe for alerts for status page updates.

Submit a ticket by reaching out to **[support@useparagon.com](mailto:support@useparagon.com)** or by sending a message in Slack, if your support level includes a shared Slack channel.

To help our team reach a resolution as quickly as possible, please provide:

* Approximate date/time of issue occurrence
* Links to workflow executions or errors
* Error messages appearing in browser console
* Error messages appearing in API requests
* User ID (as provided in the Paragon User Token), if related to an end-user

## Support Levels

Your support level corresponds to the Startup, Pro, or Enterprise plan of your Paragon account. If you'd like a higher support level than what is included with your plan, please [contact our sales team](mailto:sales@useparagon.com).

Response times apply during US business hours (9 AM - 5 PM in Pacific Time or America/Los\_Angeles).

Paragon’s office is closed in observance of the following holidays:

* US Federal Holidays, as defined by the Office of Personal Management of the United States
* The day after Thanksgiving
* One business day before and after Christmas
* All business days between Christmas and New Years

| Support Level            | Startup                  | Pro                                                                                                                                           | Enterprise                                                                                                                                                        |
| ------------------------ | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Documentation & SDKs** | ✔                        | ✔                                                                                                                                             | ✔                                                                                                                                                                 |
| **Support Channels**     | Email Only               | Email, Slack                                                                                                                                  | Email, Slack                                                                                                                                                      |
| **Initial Response**     | Within 24 business hours | - **Urgent**: 4 business hours <br /> - **High**: 4 business hours <br /> - **Normal**: 12 business hours <br /> - **Low**: 24 business hours | - **Urgent**: 2 hours, with Slack escalation access <br /> - **High**: 4 business hours <br /> - **Normal**: 8 business hours <br /> - **Low**: 12 business hours |

## Priority Levels

Our support team will assign a priority to your ticket based on impact. Here are the standard definitions we use to classify your ticket:

* **Urgent:** Your production system is down. Widespread impact for multiple end-users and no workaround is possible. Could cause widespread impact if not resolved.
* **High:** Your production system is impaired or degraded in a significant way, for more than 1 end-user. Examples include significant performance delays. This is also the appropriate Priority for an Urgent issue once a workaround has been identified & provided.
* **Normal:** You have issues impacting a single end-user, but your overall production system is still performing. This would also include minor performance degradation that is noticeable but not high-impact. This is also the appropriate Priority for issues in staging or development environments.
* **Low:** An issue that is not impairing normal business operations, but warrants attention. Feature requests.


# Building a BambooHR Integration
Source: https://docs.useparagon.com/tutorials/building-a-bamboohr-integration

In this tutorial, we'll build a basic BambooHR integration that syncs employees from your app to your customers' BambooHR accounts.

This guide demonstrates how to **sync data from your app to your customer's BambooHR accounts**. For demonstration purposes, we’ll build a workflow that creates a new employee in our user's BambooHR using contact data from our app. You can use the concepts covered in this tutorial in other applications as well.

### Prerequisites

1. [Connect your BambooHR application to Paragon](/resources/integrations/bamboohr).

2. Add your BambooHR app credentials to [activate your integration](/resources/integrations/bamboohr#add-your-bamboohr-app-to-paragon).

## 1. Build your workflow

#### Step 1.1: Create a new BambooHR workflow

It's important that you give your workflows a descriptive name to provide the best experience for your user.

#### Step 1.2: Create an App Event

Since we want to pass employee data from our application to our customer's BambooHR account, we'll use the [App Event](/workflows/triggers#app-events) trigger. Select the trigger step from the Workflow Editor, then click "App Event".

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=684317b4dc61d2d640e2aa1d5a339945" alt="" width="1159" height="467" data-path="assets/Choosing a Trigger in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=280&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ebbf7c9d9b9735c7b09a116a50770486 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=560&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a9b9fb3d7520cd5d687a78ea922f1ba5 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=840&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=9c4e4576f288130c2a1a27e5ebf10b9b 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=1100&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=fc0c783af0d8b1a7ee6e99561f5dd1c2 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=1650&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=5c9981566c6bfc359b17a3fb6eea72d9 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=2500&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ac35c91f1829eedaae70acb5ec2dc992 2500w" data-optimize="true" data-opv="2" />
</Frame>

Select **Choose an App Event > Create new App Event**, then add the following parameters:

* **Event Name** - the name of your App Event. (e.g. Contact Created)
* **Event Schema** - example JSON Object that will be sent from your app. JSON objects are written in key/value pairs. Keys must be `strings`, and values must be a valid JSON data type (`string`, `number`, `object`, `array`, `boolean` or `null`)

You can use the sample App Event Schema below to jumpstart your progress:

```json Employee Created
{
    "first_name": "Buddha",
    "last_name": "Samuel",
    "email": "buddha@useparagon.com",
    "company": "Paragon",
    "title": "Chief Dog Officer"
}
```

#### Step 1.3: Add a BambooHR step

Add a BambooHR step to your workflow and use the dropdown menu to select `Create Employee` as the action. You can input the fields from your App Event by typing two left curly braces `{{` to bring up the dynamic variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Employees%20to%20BambooHR%20in%20the%20Workflow%20Editor%20on%20Paragon%20Connect.gif?maxW=1110&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=bca83fb20f5dd7508284c8714a14dda8" alt="" width="1110" height="652" data-path="assets/Adding Employees to BambooHR in the Workflow Editor on Paragon Connect.gif" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Employees%20to%20BambooHR%20in%20the%20Workflow%20Editor%20on%20Paragon%20Connect.gif?w=280&maxW=1110&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=6fe34f17ded3861cd7bcf10d2c2c1bd4 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Employees%20to%20BambooHR%20in%20the%20Workflow%20Editor%20on%20Paragon%20Connect.gif?w=560&maxW=1110&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=d96ec800d7d5dbe1148faa136f921107 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Employees%20to%20BambooHR%20in%20the%20Workflow%20Editor%20on%20Paragon%20Connect.gif?w=840&maxW=1110&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=3d3d7c34a94a7aa617561a7a684e9c0f 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Employees%20to%20BambooHR%20in%20the%20Workflow%20Editor%20on%20Paragon%20Connect.gif?w=1100&maxW=1110&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=8ee7e2e8ed1e11232f46d41b309dc900 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Employees%20to%20BambooHR%20in%20the%20Workflow%20Editor%20on%20Paragon%20Connect.gif?w=1650&maxW=1110&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=49d98163e9575e27fd6a58aeb0b23c0b 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20Employees%20to%20BambooHR%20in%20the%20Workflow%20Editor%20on%20Paragon%20Connect.gif?w=2500&maxW=1110&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=fb0892eaa3d12c250a053653cd398d4f 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### Step 1.4: Deploy your workflow

Now that your workflow is all set up, deploy your workflow by clicking the "Deploy" button in the top-right of your screen.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e9496cda52b7e1f73774564c73e081c5" alt="" width="966" height="570" data-path="assets/Deploying a workflow in Paragon (1).png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=280&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e28b05ccf60dfd0e415f46b1798bc5b8 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=560&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6d87770645178a3a4e874d5b51ed8374 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=840&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=966f00558bb2e547eee5a4ba18f7e71e 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=1100&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d4d27b7001865790074a28debc2552f1 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=1650&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=542fe3fa9f84dc37bcd402ff401a0949 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=2500&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2b2f470d07a8cc6b59e4b57f342c81e2 2500w" data-optimize="true" data-opv="2" />
</Frame>

## 2. Generate a Paragon Signing Key

To generate a Signing Key, go to **Settings > Signing Keys** in your Paragon dashboard. You should store this key in an environment secrets file.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8a57c4d786bfe4b6a3b180ef39558eb2" alt="" width="2078" height="952" data-path="assets/Screen Shot 2021-01-28 at 3.00.48 PM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=280&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3822d91921a9d5464f701155831c06f3 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=560&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=740af3b3df431d0cc4f744d5bf8b6dc2 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=840&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=866c3620b33898fbf00b307caf82277c 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=1100&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=fb841d4cea86628dcde16304f3984c44 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=1650&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a874d8b9665ea8fe07b8172ec16abff8 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=2500&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c44bb6c424bf777b1e0950eb9a87aafe 2500w" data-optimize="true" data-opv="2" />
</Frame>

For security reasons, we don’t store your Private Key and cannot show it to you again, so we recommend you download the key and store it someplace secure.

## 3. Install the Paragon SDK

The Paragon SDK gives you access to the Paragon global, which you can access as `paragon`.

You can install the Paragon SDK with npm:

```bash
npm install @useparagon/connect
```

The SDK can be imported in your client-side JavaScript files as a module:

```js
import { paragon } from '@useparagon/connect';
```

<Info>
  **Don't want to install the SDK just yet?**

  Use Paragon's [Hosted Demo Environment](/demo) to start testing your integrations without embedding the SDK in your application. [Learn more](/demo).
</Info>

## 4. Authenticate your user

Next, you'll need a library in your target language to sign JWTs with RS256. You can find one in your language at [https://jwt.io/](https://jwt.io/).

If your application is a fully client-rendered single-page app, you may have to create and use an additional API endpoint to retrieve a signed JWT (or reuse an existing endpoint that handles authentication or user info).

#### Step 4.1: Sign a Paragon User Token

The Paragon User Token is a signed JWT that minimally must include the `sub`, `iat`, and `exp` claims:

```js JavaScript
{
	// Uniquely identifying key for a user
	"sub": "the-user-id",

	// Issue timestamp, should be the current time
	"iat": 1608600116

	// Expiry timestamp for token, such as 1 hour from time of signature (iat)
	"exp": 1608603716
}
```

<Info>
  **Just for testing: Generating one-off JWTs**

  Use the [Paragon JWT Generator](https://jwt.useparagon.com/) to generate test JWTs for your development purposes. In production, static tokens should never be used.
</Info>

#### Step 4.2: Call paragon.authenticate()

You'll call `paragon.authenticate` in your view with a JWT signed by your backend using the library chosen in [Step 4.1](/tutorials/building-a-hubspot-integration#step-4-1-sign-a-paragon-user-token). **This JWT is the Paragon user token.**

[`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string) should be called at the beginning of your application's lifecycle in all cases. This is to make sure that the `userToken` is always as fresh as possible, with respect to your user's existing session on your own site. You may reference [Installing the Connect SDK](/getting-started/installing-the-connect-sdk#setup) for a detailed explanation on how to use [`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string).

```js
paragon.authenticate(
	// You can find your project ID in the Overview tab of any Integration
	"38b1f170-0c43-4eae-9a04-ab85325d99f7",

	// See Setup for how to encode your user token
	"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.ey..."
);
```

## 5. Connect to your integration

Now that you've authenticated your user, you can call `paragon.connect()` to bring up the Paragon Connect Portal.

```js JavaScript
paragon.connect("bamboohr");
```

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BambooHR%20Paragon%20Connect%20Portal.png?maxW=1764&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ca71d8215a283c0f25d32cb463269e1e" alt="" width="1764" height="1166" data-path="assets/BambooHR Paragon Connect Portal.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BambooHR%20Paragon%20Connect%20Portal.png?w=280&maxW=1764&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=fb6005d203a2f9928bc331485eb0ddd1 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BambooHR%20Paragon%20Connect%20Portal.png?w=560&maxW=1764&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=83a399a6d1166e2751f096b9f0dcc82c 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BambooHR%20Paragon%20Connect%20Portal.png?w=840&maxW=1764&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ddd895c76ee4e6195e881fc2fd05d053 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BambooHR%20Paragon%20Connect%20Portal.png?w=1100&maxW=1764&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=641eb9cfc97cd74cf104d028dbf8a669 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BambooHR%20Paragon%20Connect%20Portal.png?w=1650&maxW=1764&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=1710b27abecd70148ae865e820a0505a 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/BambooHR%20Paragon%20Connect%20Portal.png?w=2500&maxW=1764&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=08ef69ed6c476600deb56e0d2b456efa 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Note>
  **Note:** Toggle your workflow from the **Configuration** tab to enable your workflow after connecting to your BambooHR account.
</Note>

## 6. Send an App Event

Lastly, we'll send an App Event whenever a lead is created in your app. App Events can be sent from your application using the Paragon SDK or REST API. In both cases, you must pass two parameters:

* **name** - the event name defined in your App Event
* **payload** - the event payload that should match the event schema defined in your App Event

See the code examples below for how to send App Events using the Paragon SDK or API.

<CodeGroup>
  ```js JavaScript SDK
  var eventName = "Employee Created";
  var eventPayload = {
      "first_name": "Buddha",
      "last_name": "Samuel",
      "email": "buddha@useparagon.com",
      "company": "Paragon",
      "title": "Chief Dog Officer"
  };

  // Trigger the "Contact Created" App Event
  paragon.event(eventName, eventPayload)
  ```

  ```bash REST API
  // Trigger the "Lead Created" App Event
  POST https://api.useparagon.com/projects/<Paragon Project ID>/sdk/events/trigger

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json

  { 
      "name": "Employee Created", 
      "payload": {
          "first_name": "Buddha",
          "last_name": "Samuel",
          "email": "buddha@useparagon.com",
          "company": "Paragon",
          "title": "Chief Dog Officer"
      }
  }
  ```
</CodeGroup>

When sending live events from your application, Paragon will not validate that your event payload matches the defined event schema.

Great work! We just built a BambooHR integration that syncs new employees from your app to our customers' BambooHR accounts.


# Building a HubSpot Integration
Source: https://docs.useparagon.com/tutorials/building-a-hubspot-integration

In this tutorial, we'll build a basic HubSpot integration that syncs contacts from your app to your customers' HubSpot accounts.

This guide demonstrates how to **sync data from your app to your customer's HubSpot accounts**. For demonstration purposes, we’ll build a workflow that creates a new contact in our user's HubSpot using contact data from our app. You can use the concepts covered in this tutorial in other applications as well.

### Prerequisites

1. [Connect your HubSpot application to Paragon](/resources/integrations/hubspot#add-the-redirect-url-to-your-hubspot-app).

2. Add your HubSpot app credentials to [activate your integration](/resources/integrations/hubspot#add-your-hubspot-app-to-paragon).

## 1. Build your workflow

#### Step 1.1: Create a new HubSpot workflow

It's important that you give your workflows a descriptive name to provide the best experience for your user.

#### Step 1.2: Create an App Event

Since we want to pass contact data from our application to our customer's HubSpot account, we'll use the [App Event](/workflows/triggers#app-events) trigger. Select the trigger step from the Workflow Editor, then click "App Event".

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=684317b4dc61d2d640e2aa1d5a339945" alt="" width="1159" height="467" data-path="assets/Choosing a Trigger in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=280&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ebbf7c9d9b9735c7b09a116a50770486 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=560&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a9b9fb3d7520cd5d687a78ea922f1ba5 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=840&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=9c4e4576f288130c2a1a27e5ebf10b9b 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=1100&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=fc0c783af0d8b1a7ee6e99561f5dd1c2 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=1650&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=5c9981566c6bfc359b17a3fb6eea72d9 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=2500&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ac35c91f1829eedaae70acb5ec2dc992 2500w" data-optimize="true" data-opv="2" />
</Frame>

Select **Choose an App Event > Create new App Event**, then add the following parameters:

* **Event Name** - the name of your App Event. (e.g. Contact Created)
* **Event Schema** - example JSON Object that will be sent from your app. JSON objects are written in key/value pairs. Keys must be `strings`, and values must be a valid JSON data type (`string`, `number`, `object`, `array`, `boolean` or `null`)

You can use the sample App Event Schema below to jumpstart your progress:

```js Contact Created
{
    "first_name": "Buddha",
    "last_name": "Samuel",
    "email": "buddha@useparagon.com",
    "company": "Paragon",
    "title": "Chief Dog Officer"
}
```

#### Step 1.3: Add a HubSpot step

Add a HubSpot step to your workflow and use the dropdown menu to select `Create Contact` as the action. You can input the fields from your App Event by typing two left curly braces `{{` to bring up the dynamic variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20contact%20through%20Paragon%20Connect.gif?maxW=1073&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=d84601115aa87e02d222fe65a4a9204c" alt="" width="1073" height="703" data-path="assets/Adding a contact through Paragon Connect.gif" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20contact%20through%20Paragon%20Connect.gif?w=280&maxW=1073&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=de1ef83227322420a5e700441d02243e 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20contact%20through%20Paragon%20Connect.gif?w=560&maxW=1073&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=eebb30f01a5ee3bc1a8bb6351904f11d 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20contact%20through%20Paragon%20Connect.gif?w=840&maxW=1073&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a5614efebe5ccfa550faf13cc0a20059 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20contact%20through%20Paragon%20Connect.gif?w=1100&maxW=1073&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=2572970c966b23d5371fa23bb3cc0c50 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20contact%20through%20Paragon%20Connect.gif?w=1650&maxW=1073&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f873297c3e5f4d83641d0c7fc9295ad6 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20contact%20through%20Paragon%20Connect.gif?w=2500&maxW=1073&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3f3ed0fb3c264471de27faeb47da6eee 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### Step 1.4: Deploy your workflow

Now that your workflow is all set up, deploy your workflow by clicking the "Deploy" button in the top-right of your screen.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e9496cda52b7e1f73774564c73e081c5" alt="" width="966" height="570" data-path="assets/Deploying a workflow in Paragon (1).png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=280&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e28b05ccf60dfd0e415f46b1798bc5b8 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=560&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6d87770645178a3a4e874d5b51ed8374 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=840&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=966f00558bb2e547eee5a4ba18f7e71e 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=1100&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d4d27b7001865790074a28debc2552f1 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=1650&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=542fe3fa9f84dc37bcd402ff401a0949 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=2500&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2b2f470d07a8cc6b59e4b57f342c81e2 2500w" data-optimize="true" data-opv="2" />
</Frame>

## 2. Generate a Paragon Signing Key

To generate a Signing Key, go to **Settings > Signing Keys** in your Paragon dashboard. You should store this key in an environment secrets file.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8a57c4d786bfe4b6a3b180ef39558eb2" alt="" width="2078" height="952" data-path="assets/Screen Shot 2021-01-28 at 3.00.48 PM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=280&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3822d91921a9d5464f701155831c06f3 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=560&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=740af3b3df431d0cc4f744d5bf8b6dc2 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=840&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=866c3620b33898fbf00b307caf82277c 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=1100&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=fb841d4cea86628dcde16304f3984c44 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=1650&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a874d8b9665ea8fe07b8172ec16abff8 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=2500&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c44bb6c424bf777b1e0950eb9a87aafe 2500w" data-optimize="true" data-opv="2" />
</Frame>

For security reasons, we don’t store your Private Key and cannot show it to you again, so we recommend you download the key and store it someplace secure.

## 3. Install the Paragon SDK

The Paragon SDK gives you access to the Paragon global, which you can access as `paragon`.

You can install the Paragon SDK with npm:

```bash
npm install @useparagon/connect
```

The SDK can be imported in your client-side JavaScript files as a module:

```js
import { paragon } from '@useparagon/connect';
```

<Info>
  **Don't want to install the SDK just yet?**

  Use Paragon's [Hosted Demo Environment](/demo) to start testing your integrations without embedding the SDK in your application. [Learn more](/demo).
</Info>

## 4. Authenticate your user

Next, you'll need a library in your target language to sign JWTs with RS256. You can find one in your language at [https://jwt.io/](https://jwt.io/).

If your application is a fully client-rendered single-page app, you may have to create and use an additional API endpoint to retrieve a signed JWT (or reuse an existing endpoint that handles authentication or user info).

#### Step 4.1: Sign a Paragon User Token

The Paragon User Token is a signed JWT that minimally must include the `sub`, `iat`, and `exp` claims:

```js JavaScript
{
	// Uniquely identifying key for a user
	"sub": "the-user-id",

	// Issue timestamp, should be the current time
	"iat": 1608600116

	// Expiry timestamp for token, such as 1 hour from time of signature (iat)
	"exp": 1608603716
}
```

<Info>
  **Just for testing: Generating one-off JWTs**

  Use the [Paragon JWT Generator](https://jwt.useparagon.com/) to generate test JWTs for your development purposes. In production, static tokens should never be used.
</Info>

#### Step 4.2: Call paragon.authenticate()

You'll call `paragon.authenticate` in your view with a JWT signed by your backend using the library chosen in [Step 4.1](/tutorials/building-a-hubspot-integration#step-4-1-sign-a-paragon-user-token). **This JWT is the Paragon user token.**

[`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string) should be called at the beginning of your application's lifecycle in all cases. This is to make sure that the `userToken` is always as fresh as possible, with respect to your user's existing session on your own site. You may reference [Installing the Connect SDK](/getting-started/installing-the-connect-sdk#setup) for a detailed explanation on how to use [`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string).

```js
paragon.authenticate(
	// You can find your project ID in the Overview tab of any Integration
	"38b1f170-0c43-4eae-9a04-ab85325d99f7",

	// See Setup for how to encode your user token
	"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.ey..."
);
```

## 5. Connect to your integration

Now that you've authenticated your user, you can call `paragon.connect()` to bring up the Paragon Connect Portal.

```js JavaScript
paragon.connect("hubspot");
```

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Paragon%20Connect%20Portal.png?maxW=1764&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0a2792b2966a8c83d1d4a3aa1a9df9f1" alt="" width="1764" height="1134" data-path="assets/HubSpot Paragon Connect Portal.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Paragon%20Connect%20Portal.png?w=280&maxW=1764&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=8dc11bab0b46f5d823e4fb04fd11a21b 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Paragon%20Connect%20Portal.png?w=560&maxW=1764&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=480357b29afae43cd74dd74d25905934 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Paragon%20Connect%20Portal.png?w=840&maxW=1764&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=f6a352451ca237a827b5f959daf601e7 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Paragon%20Connect%20Portal.png?w=1100&maxW=1764&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=79fffa9e0a1874649fc453017e06e464 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Paragon%20Connect%20Portal.png?w=1650&maxW=1764&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=e13996e02ae0f159300a0f8a8021ad25 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/HubSpot%20Paragon%20Connect%20Portal.png?w=2500&maxW=1764&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=ea1f277734e598cdbc6b1069b940e849 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Info>
  rations without embedding the SDK in your application. [Learn more](/demo).**Note:** Toggle your workflow from the **Configuration** tab to enable your workflow after connecting to your HubSpot account.
</Info>

## 6. Send an App Event

Lastly, we'll send an App Event whenever a lead is created in your app. App Events can be sent from your application using the Paragon SDK or REST API. In both cases, you must pass two parameters:

* **name** - the event name defined in your App Event
* **payload** - the event payload that should match the event schema defined in your App Event

See the code examples below for how to send App Events using the Paragon SDK or API.

<CodeGroup>
  ```js JavaScript SDK
  var eventName = "Contact Created";
  var eventPayload = {
      "first_name": "Buddha",
      "last_name": "Samuel",
      "email": "buddha@useparagon.com",
      "company": "Paragon",
      "title": "Chief Dog Officer"
  };

  // Trigger the "Contact Created" App Event
  paragon.event(eventName, eventPayload)
  ```

  ```bash REST API
  // Trigger the "Lead Created" App Event
  POST https://api.useparagon.com/projects/<Paragon Project ID>/sdk/events/trigger

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json

  { 
      "name": "Contact Created", 
      "payload": {
          "first_name": "Buddha",
          "last_name": "Samuel",
          "email": "buddha@useparagon.com",
          "company": "Paragon",
          "title": "Chief Dog Officer"
      }
  }
  ```
</CodeGroup>

When sending live events from your application, Paragon will not validate that your event payload matches the defined event schema.

Great work! We just built a HubSpot integration that syncs new contacts from your app to our customers' HubSpot accounts.


# Building a Marketo Integration
Source: https://docs.useparagon.com/tutorials/building-a-marketo-integration

In this tutorial, we'll build a basic Marketo integration that syncs leads from your app to lists in your customers' Marketo accounts.

This guide demonstrates how to **sync data from your app to your customer's Marketo accounts**. For demonstration purposes, we’ll build a workflow that creates a new lead in our user's Marketo list using lead data from our app. You can use the concepts covered in this tutorial in other applications as well.

### Prerequisites

1. [Connect your Marketo application to Paragon](/resources/integrations/marketo).

2. Add your Marketo app credentials to [activate your integration](/resources/integrations/marketo#connecting-to-marketo).

## 1. Build your workflow

#### Step 1.1: Create a new Marketo workflow

It's important that you give your workflows a descriptive name to provide the best experience for your user.

#### Step 1.2: Create an App Event

Since we want to pass lead data from our application to our customer's Marketo account, we'll use the [App Event](/workflows/triggers#app-events) trigger. Select the trigger step from the Workflow Editor, then click "App Event".

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=684317b4dc61d2d640e2aa1d5a339945" alt="" width="1159" height="467" data-path="assets/Choosing a Trigger in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=280&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ebbf7c9d9b9735c7b09a116a50770486 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=560&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a9b9fb3d7520cd5d687a78ea922f1ba5 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=840&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=9c4e4576f288130c2a1a27e5ebf10b9b 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=1100&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=fc0c783af0d8b1a7ee6e99561f5dd1c2 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=1650&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=5c9981566c6bfc359b17a3fb6eea72d9 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=2500&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ac35c91f1829eedaae70acb5ec2dc992 2500w" data-optimize="true" data-opv="2" />
</Frame>

Select **Choose an App Event > Create new App Event**, then add the following parameters:

* **Event Name** - the name of your App Event. (e.g. Lead Created)
* **Event Schema** - example JSON Object that will be sent from your app. JSON objects are written in key/value pairs. Keys must be `strings`, and values must be a valid JSON data type (`string`, `number`, `object`, `array`, `boolean` or `null`)

You can use the sample App Event Schema below to jumpstart your progress:

```js Lead Created
{
    "first_name": "Bowie",
    "last_name": "Foo",
    "email": "bowie@useparagon.com",
    "company": "Paragon",
    "title": "Chief Dog Officer"
}
```

#### Step 1.3: Add a Marketo step

Add a Marketo step to your workflow and use the dropdown menu to select `Create or Update Lead` as the action. You can input the fields from your App Event by typing two left curly braces `{{` to bring up the dynamic variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20a%20Lead%20to%20Marketo%20through%20Paragon%20Connect.gif?maxW=1174&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=40e458e71c27dc46e72da9bff7e83d83" alt="" width="1174" height="728" data-path="assets/Adding a Lead to Marketo through Paragon Connect.gif" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20a%20Lead%20to%20Marketo%20through%20Paragon%20Connect.gif?w=280&maxW=1174&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=d9455ab092be1854ced9ecc76e12ebbf 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20a%20Lead%20to%20Marketo%20through%20Paragon%20Connect.gif?w=560&maxW=1174&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=95d2b555cdc7eca13100f8d50dfa929a 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20a%20Lead%20to%20Marketo%20through%20Paragon%20Connect.gif?w=840&maxW=1174&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=2889818010e8387edd9698b769494403 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20a%20Lead%20to%20Marketo%20through%20Paragon%20Connect.gif?w=1100&maxW=1174&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=d2663b623c111abdd2c306876b75ef74 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20a%20Lead%20to%20Marketo%20through%20Paragon%20Connect.gif?w=1650&maxW=1174&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=abebec11900ae3f23e1d3e73eace0226 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Adding%20a%20Lead%20to%20Marketo%20through%20Paragon%20Connect.gif?w=2500&maxW=1174&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=b265773cb924c872c801788f451e7788 2500w" data-optimize="true" data-opv="2" />
</Frame>

**Step 1.4: Create a User Setting**

Since we want our user to select which list in Marketo we should add new leads to, we will add a [User Setting](/connect-portal/workflow-user-settings)to our workflow.

To add Workflow User Setting to Marketo, follow these steps:

1. Click **Customize Connect Portal** in the Overview page to open the Connect Portal Editor.

2. Click the **Configuration** tab in the right sidebar.

3. Click on the workflow you'd like to add User Settings to.

4. Under **User Settings** in the right sidebar, click **+ Add Settings.**

5. Enter a name for the field and choose the **List** field type from the dropdown menu.

6. Click the **Save** button to add it to your Connect Portal.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20User%20Setting%20for%20Marketo%20in%20Paragon%20Connect.png?maxW=3334&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=48066d3ca9619f95d28d9b903325f3ff" alt="" width="3334" height="1638" data-path="assets/Adding a User Setting for Marketo in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20User%20Setting%20for%20Marketo%20in%20Paragon%20Connect.png?w=280&maxW=3334&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=38b867221a49e7756c51fa36178d8811 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20User%20Setting%20for%20Marketo%20in%20Paragon%20Connect.png?w=560&maxW=3334&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=54dcbd142b5d9f52a7b6d75b4721c198 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20User%20Setting%20for%20Marketo%20in%20Paragon%20Connect.png?w=840&maxW=3334&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=d02c5cbe896ae3f63c1d2c5ea12ebbec 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20User%20Setting%20for%20Marketo%20in%20Paragon%20Connect.png?w=1100&maxW=3334&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=9be51912bb478e7e60fcd7cdfab08337 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20User%20Setting%20for%20Marketo%20in%20Paragon%20Connect.png?w=1650&maxW=3334&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=0e8bf23264baf5d1cb507c9f4ce28c3f 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Adding%20a%20User%20Setting%20for%20Marketo%20in%20Paragon%20Connect.png?w=2500&maxW=3334&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=7a1d8aea877e94fe093babca41eca211 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### Step 1.5: Add the lead to a list

Navigate back to your workflow once you have added the User Setting. Add another Marketo step to your workflow and use the dropdown menu to select `Add Leads to List`as the action. You can input the fields from your App Event by typing two left curly braces `{{` to bring up the dynamic variable menu.

#### Step 1.6: Deploy your workflow

Now that your workflow is all set up, deploy your workflow by clicking the "Deploy" button in the top-right of your screen.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e9496cda52b7e1f73774564c73e081c5" alt="" width="966" height="570" data-path="assets/Deploying a workflow in Paragon (1).png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=280&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e28b05ccf60dfd0e415f46b1798bc5b8 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=560&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6d87770645178a3a4e874d5b51ed8374 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=840&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=966f00558bb2e547eee5a4ba18f7e71e 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=1100&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d4d27b7001865790074a28debc2552f1 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=1650&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=542fe3fa9f84dc37bcd402ff401a0949 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=2500&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2b2f470d07a8cc6b59e4b57f342c81e2 2500w" data-optimize="true" data-opv="2" />
</Frame>

## 2. Generate a Paragon Signing Key

To generate a Signing Key, go to **Settings > Signing Keys** in your Paragon dashboard. You should store this key in an environment secrets file.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8a57c4d786bfe4b6a3b180ef39558eb2" alt="" width="2078" height="952" data-path="assets/Screen Shot 2021-01-28 at 3.00.48 PM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=280&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3822d91921a9d5464f701155831c06f3 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=560&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=740af3b3df431d0cc4f744d5bf8b6dc2 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=840&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=866c3620b33898fbf00b307caf82277c 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=1100&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=fb841d4cea86628dcde16304f3984c44 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=1650&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a874d8b9665ea8fe07b8172ec16abff8 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=2500&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c44bb6c424bf777b1e0950eb9a87aafe 2500w" data-optimize="true" data-opv="2" />
</Frame>

For security reasons, we don’t store your Private Key and cannot show it to you again, so we recommend you download the key and store it someplace secure.

## 3. Install the Paragon SDK

The Paragon SDK gives you access to the Paragon global, which you can access as `paragon`.

You can install the Paragon SDK with npm:

```bash
npm install @useparagon/connect
```

The SDK can be imported in your client-side JavaScript files as a module:

```js
import { paragon } from '@useparagon/connect';
```

<Info>
  **Don't want to install the SDK just yet?**

  Use Paragon's [Hosted Demo Environment](/demo) to start testing your integrations without embedding the SDK in your application. [Learn more](/demo).
</Info>

## 4. Authenticate your user

Next, you'll need a library in your target language to sign JWTs with RS256. You can find one in your language at [https://jwt.io/](https://jwt.io/).

If your application is a fully client-rendered single-page app, you may have to create and use an additional API endpoint to retrieve a signed JWT (or reuse an existing endpoint that handles authentication or user info).

#### Step 4.1: Sign a Paragon User Token

The Paragon User Token is a signed JWT that minimally must include the `sub`, `iat`, and `exp` claims:

```js JavaScript
{
	// Uniquely identifying key for a user
	"sub": "the-user-id",

	// Issue timestamp, should be the current time
	"iat": 1608600116

	// Expiry timestamp for token, such as 1 hour from time of signature (iat)
	"exp": 1608603716
}
```

<Info>
  **Just for testing: Generating one-off JWTs**

  Use the [Paragon JWT Generator](https://jwt.useparagon.com/) to generate test JWTs for your development purposes. In production, static tokens should never be used.
</Info>

#### Step 4.2: Call paragon.authenticate()

You'll call `paragon.authenticate` in your view with a JWT signed by your backend using the library chosen in [Step 4.1](/tutorials/building-a-salesforce-integration#1-sign-a-jwt). **This JWT is the Paragon user token.**

[`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string) should be called at the beginning of your application's lifecycle in all cases. This is to make sure that the `userToken` is always as fresh as possible, with respect to your user's existing session on your own site. You may reference [Installing the Connect SDK](/getting-started/installing-the-connect-sdk#setup) for a detailed explanation on how to use [`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string).

```js
paragon.authenticate(
	// You can find your project ID in the Overview tab of any Integration
	"38b1f170-0c43-4eae-9a04-ab85325d99f7",

	// See Setup for how to encode your user token
	"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.ey..."
);
```

## 5. Connect to your integration

Now that you've authenticated your user, you can call `paragon.connect()` to bring up the Paragon Connect Portal.

```js JavaScript
paragon.connect("marketo");
```

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20for%20Marketo.png?maxW=1748&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a57386609896a737eb8828dacd96d5c2" alt="" width="1748" height="1106" data-path="assets/Paragon Connect Portal for Marketo.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20for%20Marketo.png?w=280&maxW=1748&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=879e210587d9dc5442dae75a3b5d8c45 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20for%20Marketo.png?w=560&maxW=1748&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=549eac283aa7c72c9ba41246282ddc32 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20for%20Marketo.png?w=840&maxW=1748&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=9bf6b352cd8eb4a8e3af4953b0950dc3 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20for%20Marketo.png?w=1100&maxW=1748&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=9d0f37006657b9f5e796aae8de96d91a 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20for%20Marketo.png?w=1650&maxW=1748&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=09eece5c72a570d29ebd28ef9cb3312d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Paragon%20Connect%20Portal%20for%20Marketo.png?w=2500&maxW=1748&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=13106c20a1ad60ff8d4a01884861d343 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Note>
  **Note:** Toggle your workflow from the **Configuration** tab to enable your workflow after connecting to your Marketo account.
</Note>

## 6. Send an App Event

Lastly, we'll send an App Event whenever a lead is created in your app. App Events can be sent from your application using the Paragon SDK or REST API. In both cases, you must pass two parameters:

* **name** - the event name defined in your App Event
* **payload** - the event payload that should match the event schema defined in your App Event

See the code examples below for how to send App Events using the Paragon SDK or API.

<CodeGroup>
  ```js JavaScript SDK
  var eventName = "Lead Created";
  var eventPayload = {
      "first_name": "Bowie",
      "last_name": "Foo",
      "email": "bowie@useparagon.com",
      "company": "Paragon",
      "title": "Chief Dog Officer"
  };

  // Trigger the "Lead Created" App Event
  paragon.event(eventName, eventPayload)
  ```

  ```bash REST API
  // Trigger the "Lead Created" App Event
  POST https://api.useparagon.com/projects/<Paragon Project ID>/sdk/events/trigger

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json

  { 
      "name": "Lead Created", 
      "payload": {
          "first_name": "Bowie",
          "last_name": "Foo",
          "email": "bowie@useparagon.com",
          "company": "Paragon",
          "title": "Chief Dog Officer"
      }
  }
  ```
</CodeGroup>

When sending live events from your application, Paragon will not validate that your event payload matches the defined event schema.

Great work! We just built a Marketo integration that adds new leads from your app to lists in our customers' Marketo accounts.


# Building a Salesforce Integration
Source: https://docs.useparagon.com/tutorials/building-a-salesforce-integration

In this tutorial, we'll build a basic Salesforce integration that syncs leads from your app to your customers' Salesforce accounts.

This guide demonstrates how to **sync data from your app to your customer's Salesforce accounts**. For demonstration purposes, we’ll build a workflow that creates a new lead in our user's Salesforce using lead data from our app. You can use the concepts covered in this tutorial in other applications as well.

### Prerequisites

1. [Connect your Salesforce application to Paragon.](/resources/integrations/salesforce#add-the-redirect-url-to-your-salesforce-app)

2. Add your Salesforce app credentials to [activate your integration.](/resources/integrations/salesforce#add-your-salesforce-app-to-paragon)

## 1. Build your workflow

#### Step 1.1: Create a new Salesforce workflow

It's important that you give your workflows a descriptive name to provide the best experience for your user.

#### Step 1.2: Create an App Event

Since we want to pass lead data from our application to our customer's Salesforce account, we'll use the [App Event](/workflows/triggers#app-events) trigger. Select the trigger step from the Workflow Editor, then click "App Event".

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=684317b4dc61d2d640e2aa1d5a339945" alt="" width="1159" height="467" data-path="assets/Choosing a Trigger in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=280&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ebbf7c9d9b9735c7b09a116a50770486 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=560&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a9b9fb3d7520cd5d687a78ea922f1ba5 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=840&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=9c4e4576f288130c2a1a27e5ebf10b9b 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=1100&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=fc0c783af0d8b1a7ee6e99561f5dd1c2 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=1650&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=5c9981566c6bfc359b17a3fb6eea72d9 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=2500&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ac35c91f1829eedaae70acb5ec2dc992 2500w" data-optimize="true" data-opv="2" />
</Frame>

Select **Choose an App Event > Create new App Event**, then add the following parameters:

* **Event Name** - the name of your App Event. (e.g. Lead Created)
* **Event Schema** - example JSON Object that will be sent from your app. JSON objects are written in key/value pairs. Keys must be `strings`, and values must be a valid JSON data type (`string`, `number`, `object`, `array`, `boolean` or `null`)

You can use the sample App Event Schema below to jumpstart your progress:

```js Lead Created
{
    "first_name": "Bowie",
    "last_name": "Foo",
    "email": "bowie@useparagon.com",
    "company": "Paragon",
    "title": "Chief Dog Officer"
}
```

#### Step 1.3: Add a Salesforce step

Add a Salesforce step to your workflow and use the dropdown menu to select `Create record` as the action and `Lead` as the record type. You can input the fields from your App Event by typing two left curly braces `{{` to bring up the dynamic variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20leads%20in%20Salesforce%20from%20Paragon%20COnnect.gif?maxW=1236&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=4132d3bdc027b5d1e84f232de7549bf4" alt="" width="1236" height="867" data-path="assets/Creating leads in Salesforce from Paragon COnnect.gif" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20leads%20in%20Salesforce%20from%20Paragon%20COnnect.gif?w=280&maxW=1236&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=7cc488fc5736e3166507238597f18fee 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20leads%20in%20Salesforce%20from%20Paragon%20COnnect.gif?w=560&maxW=1236&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=f08e3490698de9c890a16e2355daef56 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20leads%20in%20Salesforce%20from%20Paragon%20COnnect.gif?w=840&maxW=1236&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=faad9f8cc4029e050c17f485626a0f96 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20leads%20in%20Salesforce%20from%20Paragon%20COnnect.gif?w=1100&maxW=1236&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=c478a503a0c12dfb90c5dd78741704cb 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20leads%20in%20Salesforce%20from%20Paragon%20COnnect.gif?w=1650&maxW=1236&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=53b394f11d935b3e2f552419c85076bb 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20leads%20in%20Salesforce%20from%20Paragon%20COnnect.gif?w=2500&maxW=1236&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=eef0af94957aa2ada361a95d7be58899 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### Step 1.4: Deploy your workflow

Now that your workflow is all set up, deploy your workflow by clicking the "Deploy" button in the top-right of your screen.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e9496cda52b7e1f73774564c73e081c5" alt="" width="966" height="570" data-path="assets/Deploying a workflow in Paragon (1).png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=280&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e28b05ccf60dfd0e415f46b1798bc5b8 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=560&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6d87770645178a3a4e874d5b51ed8374 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=840&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=966f00558bb2e547eee5a4ba18f7e71e 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=1100&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d4d27b7001865790074a28debc2552f1 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=1650&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=542fe3fa9f84dc37bcd402ff401a0949 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=2500&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2b2f470d07a8cc6b59e4b57f342c81e2 2500w" data-optimize="true" data-opv="2" />
</Frame>

## 2. Generate a Paragon Signing Key

To generate a Signing Key, go to **Settings > Signing Keys** in your Paragon dashboard. You should store this key in an environment secrets file.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8a57c4d786bfe4b6a3b180ef39558eb2" alt="" width="2078" height="952" data-path="assets/Screen Shot 2021-01-28 at 3.00.48 PM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=280&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3822d91921a9d5464f701155831c06f3 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=560&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=740af3b3df431d0cc4f744d5bf8b6dc2 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=840&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=866c3620b33898fbf00b307caf82277c 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=1100&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=fb841d4cea86628dcde16304f3984c44 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=1650&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a874d8b9665ea8fe07b8172ec16abff8 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=2500&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c44bb6c424bf777b1e0950eb9a87aafe 2500w" data-optimize="true" data-opv="2" />
</Frame>

For security reasons, we don’t store your Private Key and cannot show it to you again, so we recommend you download the key and store it someplace secure.

## 3. Install the Paragon SDK

The Paragon SDK gives you access to the Paragon global, which you can access as `paragon`.

You can install the Paragon SDK with npm:

```bash
npm install @useparagon/connect
```

The SDK can be imported in your client-side JavaScript files as a module:

```js
import { paragon } from '@useparagon/connect';
```

<Info>
  **Don't want to install the SDK just yet?**

  Use Paragon's [Hosted Demo Environment](/demo) to start testing your integrations without embedding the SDK in your application. [Learn more](/demo).
</Info>

## 4. Authenticate your user

Next, you'll need a library in your target language to sign JWTs with RS256. You can find one in your language at [https://jwt.io/](https://jwt.io/).

If your application is a fully client-rendered single-page app, you may have to create and use an additional API endpoint to retrieve a signed JWT (or reuse an existing endpoint that handles authentication or user info).

#### Step 4.1: Sign a Paragon User Token

The Paragon User Token is a signed JWT that minimally must include the `sub`, `iat`, and `exp` claims:

```js JavaScript
{
	// Uniquely identifying key for a user
	"sub": "the-user-id",

	// Issue timestamp, should be the current time
	"iat": 1608600116

	// Expiry timestamp for token, such as 1 hour from time of signature (iat)
	"exp": 1608603716
}
```

<Info>
  **Just for testing: Generating one-off JWTs**

  Use the [Paragon JWT Generator](https://jwt.useparagon.com/) to generate test JWTs for your development purposes. In production, static tokens should never be used.
</Info>

#### Step 4.2: Call paragon.authenticate()

You'll call `paragon.authenticate` in your view with a JWT signed by your backend using the library chosen in [Step 4.1](/tutorials/building-a-salesforce-integration#1-sign-a-jwt). **This JWT is the Paragon user token.**

[`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string) should be called at the beginning of your application's lifecycle in all cases. This is to make sure that the `userToken` is always as fresh as possible, with respect to your user's existing session on your own site. You may reference [Installing the Connect SDK](/getting-started/installing-the-connect-sdk#setup) for a detailed explanation on how to use [`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string).

```js
paragon.authenticate(
	// You can find your project ID in the Overview tab of any Integration
	"38b1f170-0c43-4eae-9a04-ab85325d99f7",

	// See Setup for how to encode your user token
	"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.ey..."
);
```

## 5. Connect to your integration

Now that you've authenticated your user, you can call `paragon.connect()` to bring up the Paragon Connect Portal.

```js JavaScript
paragon.connect("salesforce");
```

<Frame>
  ![](https://gblobscdn.gitbook.com/assets%2F-MCJwlyhqtCdBfCLUO0d%2F-MR14Lp-nu7f4a2xbdN3%2F-MR162ccpCy5B2eOsE7A%2FConnect%20Portal%20in%20an%20application.png?alt=media\&token=e90f3e42-fbf2-4ff8-a892-3ed500daa2ca)
</Frame>

<Note>
  **Note:** Toggle your workflow from the **Configuration** tab to enable your workflow after connecting to your Salesforce account.
</Note>

## 6. Send an App Event

Lastly, we'll send an App Event whenever a lead is created in your app. App Events can be sent from your application using the Paragon SDK or REST API. In both cases, you must pass two parameters:

* **name** - the event name defined in your App Event
* **payload** - the event payload that should match the event schema defined in your App Event

See the code examples below for how to send App Events using the Paragon SDK or API.

<CodeGroup>
  ```js JavaScript SDK
  var eventName = "Lead Created";
  var eventPayload = {
      "first_name": "Bowie",
      "last_name": "Foo",
      "email": "bowie@useparagon.com",
      "company": "Paragon",
      "title": "Chief Dog Officer"
  };

  // Trigger the "Lead Created" App Event
  paragon.event(eventName, eventPayload)
  ```

  ```bash REST API
  // Trigger the "Lead Created" App Event
  POST https://api.useparagon.com/projects/<Paragon Project ID>/sdk/events/trigger

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json

  { 
      "name": "Lead Created", 
      "payload": {
          "first_name": "Bowie",
          "last_name": "Foo",
          "email": "bowie@useparagon.com",
          "company": "Paragon",
          "title": "Chief Dog Officer"
      }
  }
  ```
</CodeGroup>

When sending live events from your application, Paragon will not validate that your event payload matches the defined event schema.

Great work! We just built a Salesforce integration that syncs new leads from your app to our customers' Salesforce accounts.


# Building a Slack Integration
Source: https://docs.useparagon.com/tutorials/building-a-slack-integration

In this tutorial, we'll build a basic Slack integration that sends notifications from your app to your customers' Slack accounts.

This guide demonstrates how to **sync data from your app to your customer's Slack accounts**. For demonstration purposes, we’ll build a workflow that sends a notification to our user's Slack using event data from our app. You can use the concepts covered in this tutorial in other applications as well.

### Prerequisites

1. [Connect your Slack application to Paragon.](/resources/integrations/slack#setup-guide)

2. Add your Slack app credentials to [activate your integration](/resources/integrations/slack#add-your-slack-app-to-paragon).

## 1. Build your workflow

#### Step 1.1: Create a new Slack workflow

It's important that you give your workflows a descriptive name to provide the best experience for your user.

#### Step 1.2: Create an App Event

Since we want to pass event data from our application to our customer's Slack account, we'll use the [App Event](/workflows/triggers#app-events) trigger. Select the trigger step from the Workflow Editor, then click "App Event".

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=684317b4dc61d2d640e2aa1d5a339945" alt="" width="1159" height="467" data-path="assets/Choosing a Trigger in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=280&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ebbf7c9d9b9735c7b09a116a50770486 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=560&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a9b9fb3d7520cd5d687a78ea922f1ba5 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=840&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=9c4e4576f288130c2a1a27e5ebf10b9b 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=1100&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=fc0c783af0d8b1a7ee6e99561f5dd1c2 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=1650&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=5c9981566c6bfc359b17a3fb6eea72d9 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Trigger%20in%20Paragon%20Connect.png?w=2500&maxW=1159&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ac35c91f1829eedaae70acb5ec2dc992 2500w" data-optimize="true" data-opv="2" />
</Frame>

Select **Choose an App Event > Create new App Event**, then add the following parameters:

* **Event Name** - the name of your App Event. (e.g. Lead Created)
* **Event Schema** - example JSON Object that will be sent from your app. JSON objects are written in key/value pairs. Keys must be `strings`, and values must be a valid JSON data type (`string`, `number`, `object`, `array`, `boolean` or `null`)

You can use the sample App Event Schema below to jumpstart your progress:

```js Task Created
{
    "creator": "Ethan Lee",
    "summary": "Connect the Paragon SDK to my application",
    "priority": "P1",
    "status": "Not Started"
}
```

#### Step 1.3: Add a Slack step

Add a Slack step to your workflow and use the dropdown menu to select `Send message in channel` as the action. When composing your message, you can input the fields from your App Event by typing two left curly braces `{{` to bring up the dynamic variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=6e3c512cc37b6b5ff055eba5a0afaded" alt="" width="974" height="774" data-path="assets/Sending notifications to Slack from Paragon Connect.gif" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?w=280&maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=2c2eaba1586c0bd53f45866ac251d2cd 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?w=560&maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=7662962ec193e304c5b08c3e2b0409c9 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?w=840&maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=5801f6ade7a60ccd4a13676a820b4a49 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?w=1100&maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=1d1017f5d950c0d23f539e99dabda773 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?w=1650&maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=c5e2acdd24b9f13cc8bb13cf82856abd 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?w=2500&maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=13ea8a9587a8b55c7c4c7d13a0ae0b05 2500w" data-optimize="true" data-opv="2" />
</Frame>

**Step 1.4: Create a User Setting**

Since we want our user to select which channel in Slack we should send new notifications to, we will add a [User Setting](/connect-portal/workflow-user-settings)to our workflow.

To add Workflow User Setting to Slack, follow these steps:

1. Click **Customize Connect Portal** in the Overview page to open the Connect Portal Editor.

2. Click the **Configuration** tab in the right sidebar.

3. Click on the workflow you'd like to add User Settings to.

4. Under **User Settings** in the right sidebar, click **+ Add Settings.**

5. Enter a name for the field and choose the **Channel** field type from the dropdown menu.

6. Click the **Save** button to add it to your Connect Portal.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customizing%20your%20Slack%20integration%20in%20Paragon%20Connect.png?maxW=3258&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=89586cac89508e9e95f0ec54cb855798" alt="" width="3258" height="1742" data-path="assets/Customizing your Slack integration in Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customizing%20your%20Slack%20integration%20in%20Paragon%20Connect.png?w=280&maxW=3258&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=a0d4e3b5cfb2b6adb3b500a7a26f342d 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customizing%20your%20Slack%20integration%20in%20Paragon%20Connect.png?w=560&maxW=3258&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d0e44013b7418765d070a66c8c0c48ed 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customizing%20your%20Slack%20integration%20in%20Paragon%20Connect.png?w=840&maxW=3258&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=9978a0d25c3ffe3ae29af577b84f568c 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customizing%20your%20Slack%20integration%20in%20Paragon%20Connect.png?w=1100&maxW=3258&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=0a51e78e30de177b11fae12b75c67bec 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customizing%20your%20Slack%20integration%20in%20Paragon%20Connect.png?w=1650&maxW=3258&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=009ac6795bb39144967189608ff68ca7 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Customizing%20your%20Slack%20integration%20in%20Paragon%20Connect.png?w=2500&maxW=3258&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=466ab9ea2dc10bebbc11ee73b503934b 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### Step 1.5: Choose a channel to send notifications

Navigate back to your workflow once you have added the User Setting. Click into the Slack step and input the fields from your App Event by typing two left curly braces `{{` to bring up the dynamic variable menu.

#### Step 1.6: Deploy your workflow

Now that your workflow is all set up, deploy your workflow by clicking the "Deploy" button in the top-right of your screen.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e9496cda52b7e1f73774564c73e081c5" alt="" width="966" height="570" data-path="assets/Deploying a workflow in Paragon (1).png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=280&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e28b05ccf60dfd0e415f46b1798bc5b8 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=560&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6d87770645178a3a4e874d5b51ed8374 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=840&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=966f00558bb2e547eee5a4ba18f7e71e 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=1100&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d4d27b7001865790074a28debc2552f1 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=1650&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=542fe3fa9f84dc37bcd402ff401a0949 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=2500&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2b2f470d07a8cc6b59e4b57f342c81e2 2500w" data-optimize="true" data-opv="2" />
</Frame>

## 2. Generate a Paragon Signing Key

To generate a Signing Key, go to **Settings > Signing Keys** in your Paragon dashboard. You should store this key in an environment secrets file.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8a57c4d786bfe4b6a3b180ef39558eb2" alt="" width="2078" height="952" data-path="assets/Screen Shot 2021-01-28 at 3.00.48 PM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=280&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3822d91921a9d5464f701155831c06f3 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=560&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=740af3b3df431d0cc4f744d5bf8b6dc2 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=840&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=866c3620b33898fbf00b307caf82277c 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=1100&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=fb841d4cea86628dcde16304f3984c44 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=1650&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a874d8b9665ea8fe07b8172ec16abff8 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-01-28%20at%203.00.48%20PM.png?w=2500&maxW=2078&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c44bb6c424bf777b1e0950eb9a87aafe 2500w" data-optimize="true" data-opv="2" />
</Frame>

For security reasons, we don’t store your Private Key and cannot show it to you again, so we recommend you download the key and store it someplace secure.

## 3. Install the Paragon SDK

The Paragon SDK gives you access to the Paragon global, which you can access as `paragon`.

You can install the Paragon SDK with npm:

```bash
npm install @useparagon/connect
```

The SDK can be imported in your client-side JavaScript files as a module:

```js
import { paragon } from '@useparagon/connect';
```

<Info>
  **Don't want to install the SDK just yet?**

  Use Paragon's [Hosted Demo Environment](/demo) to start testing your integrations without embedding the SDK in your application. [Learn more](/demo).
</Info>

## 4. Authenticate your user

Next, you'll need a library in your target language to sign JWTs with RS256. You can find one in your language at [https://jwt.io/](https://jwt.io/).

If your application is a fully client-rendered single-page app, you may have to create and use an additional API endpoint to retrieve a signed JWT (or reuse an existing endpoint that handles authentication or user info).

#### Step 4.1: Sign a Paragon User Token

The Paragon User Token is a signed JWT that minimally must include the `sub`, `iat`, and `exp` claims:

```js JavaScript
{
	// Uniquely identifying key for a user
	"sub": "the-user-id",

	// Issue timestamp, should be the current time
	"iat": 1608600116

	// Expiry timestamp for token, such as 1 hour from time of signature (iat)
	"exp": 1608603716
}
```

<Info>
  **Just for testing: Generating one-off JWTs**

  Use the [Paragon JWT Generator](https://jwt.useparagon.com/) to generate test JWTs for your development purposes. In production, static tokens should never be used.
</Info>

#### Step 4.2: Call paragon.authenticate()

You'll call `paragon.authenticate` in your view with a JWT signed by your backend using the library chosen in [Step 4.1](/tutorials/building-a-slack-integration#4.-authenticate-your-user). **This JWT is the Paragon user token.**

[`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string) should be called at the beginning of your application's lifecycle in all cases. This is to make sure that the `userToken` is always as fresh as possible, with respect to your user's existing session on your own site. You may reference [Installing the Connect SDK](/getting-started/installing-the-connect-sdk#setup) for a detailed explanation on how to use [`.authenticate`](/apis/api-reference#authenticate-projectid-string-usertoken-string).

```js
paragon.authenticate(
	// You can find your project ID in the Overview tab of any Integration
	"38b1f170-0c43-4eae-9a04-ab85325d99f7",

	// See Setup for how to encode your user token
	"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.ey..."
);
```

## 5. Connect to your integration

Now that you've authenticated your user, you can call `paragon.connect()` to bring up the Paragon Connect Portal.

```js JavaScript
paragon.connect("slack");
```

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Integration%20Portal%20for%20Slack%20in%20Paragon%20Connect.png?maxW=1832&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=e63f51efa873fc308e64df9deb027c40" alt="" width="1832" height="1176" data-path="assets/Integration Portal for Slack in Paragon Connect.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Integration%20Portal%20for%20Slack%20in%20Paragon%20Connect.png?w=280&maxW=1832&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=b59db0160f15114a252b228f6ebc452a 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Integration%20Portal%20for%20Slack%20in%20Paragon%20Connect.png?w=560&maxW=1832&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=5b1e60f18c1fe811480e8822451583b5 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Integration%20Portal%20for%20Slack%20in%20Paragon%20Connect.png?w=840&maxW=1832&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0a15e218fdae5fb4668ec722619bab7f 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Integration%20Portal%20for%20Slack%20in%20Paragon%20Connect.png?w=1100&maxW=1832&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=855ef8d2176b442b5d6755ed11bccc42 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Integration%20Portal%20for%20Slack%20in%20Paragon%20Connect.png?w=1650&maxW=1832&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=a1b0893b63a4956030a2404c7760f913 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Integration%20Portal%20for%20Slack%20in%20Paragon%20Connect.png?w=2500&maxW=1832&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=639ad14cc33b27412a754464469fbe75 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Note>
  **Note:** Toggle your workflow from the **Configuration** tab to enable your workflow after connecting to your Slack account.
</Note>

## 6. Send an App Event

Lastly, we'll send an App Event whenever a lead is created in your app. App Events can be sent from your application using the Paragon SDK or REST API. In both cases, you must pass two parameters:

* **name** - the event name defined in your App Event
* **payload** - the event payload that should match the event schema defined in your App Event

See the code examples below for how to send App Events using the Paragon SDK or API.

<CodeGroup>
  ```js JavaScript SDK
  var eventName = "Task Created";
  var eventPayload = {
      "creator": "Ethan Lee",
      "summary": "Connect the Paragon SDK to my application",
      "priority": "P1",
      "status": "Not Started",
  };

  // Trigger the "Task Created" App Event
  paragon.event(eventName, eventPayload)
  ```

  ```bash REST API
  // Trigger the "Task Created" App Event
  POST https://api.useparagon.com/projects/<Paragon Project ID>/sdk/events/trigger

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json

  { 
      "name": "Task Created", 
      "payload": {
          "creator": "Ethan Lee",
          "summary": "Connect the Paragon SDK to my application",
          "priority": "P1",
          "status": "Not Started"
      }
  }
  ```
</CodeGroup>

When sending live events from your application, Paragon will not validate that your event payload matches the defined event schema.

Great work! We just built a Slack integration that sends new notifications from your app to our customers' Slack accounts.


# Building an In-App Integrations Catalog
Source: https://docs.useparagon.com/tutorials/building-an-in-app-integrations-catalog

In this tutorial, we'll use the Paragon SDK to build an integrations catalog into your app.

This guide provides an example implementation of building an integrations catalog **into your React app, using TypeScript.** The completed code is available in [this GitHub repository](https://github.com/useparagon/paragon-integrations-catalog-tutorial).

<Info>
  The tutorial repository signs Paragon User Tokens in the frontend application, which should NOT be used in production. Replace `getParagonUserToken` with your own app's Paragon User Token generation, which should be performed on your server only.
</Info>

Alternatively, for a production-ready implementation of the SDK embedded in a Next.js app, see our [Example App](https://github.com/useparagon/paragon-connect-nextjs-example) repository.

### Demo

In this tutorial, we'll build the user interface to display a list of Paragon integrations embedded in your application:

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=5e2808c725b3d3ad2b0d3573da8e87ce" alt="" width="720" height="553" data-path="assets/Screen Recording.gif" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?w=280&maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=0fb1c900c1a9abc8f5e114935fc32587 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?w=560&maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=26c0e41e78ba113b34a84741ab60bee5 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?w=840&maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=817b0a70704731b4d086355a4dbaf10c 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?w=1100&maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=75c2a2ce66185fa4c75df76e1281020e 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?w=1650&maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=da8a13056e31f732b59a4a1df341827c 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?w=2500&maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=5d5af4b647467fae1ff06a6d261276e0 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Prerequisites

* This guide embeds the Integration Catalog in a React.js app. React is not a requirement for using the SDK, but the tutorial steps will use React-specific functions to dynamically update the Catalog UI.
* This guide assumes that you've already [installed the SDK and configured User Authentication](/getting-started/installing-the-connect-sdk). We will change your implementation slightly so that your React app can listen for the SDK events for loading and authenticating.

## 1. Add hooks for authenticating the Paragon User

First, define a hook used for SDK authentication. We'll call this `useParagonAuth.ts`. Copy the following contents to this file:

```js
import { useEffect, useState } from "react";
import { paragon, AuthenticatedConnectUser } from "@useparagon/connect";

async function getParagonUserToken(): Promise<string> {
  // Replace this with the logic that your app uses for
  // fetching the Paragon User Token.
}

export default function useParagonAuth(): { user?: AuthenticatedConnectUser; error?: Error } {
  const [token, setToken] = useState<string | null>(null);
  const [user, setUser] = useState<ConnectUser | undefined>();
  const [error, setError] = useState<Error | undefined>();

  useEffect(() => {
    getParagonUserToken().then(setToken).catch(setError);
  }, []);

  useEffect(() => {
    if (token && !error) {
      paragon
        .authenticate(PARAGON_PROJECT_ID, token)
        .then(() => setUser(paragon.getUser()))
        .catch(setError);
    }
  }, [token, error]);

  return { user, error };
}
```

<Info>
  Replace `PARAGON_PROJECT_ID` with your Project ID in Paragon. You can find your Project ID in the Overview tab of any Integration within the dashboard.
</Info>

This hook can then be consumed from a component that will render your integrations catalog as follows:

```js
// IntegrationsCatalog.tsx
import useParagonAuth from "../hooks/useParagonAuth";

function IntegrationsCatalog() {
    const { user } = useParagonAuth();
    
    return (<div className="catalog">
        <h1>Integrations Catalog</h1>
    </div>);
}

export default IntegrationsCatalog;
```

## 2. Displaying integrations

Next, we'll show the list of integrations loaded from your project. The `paragon` global is loaded as a stateful value, so when the SDK loads, the component will update accordingly:

```js
// IntegrationsCatalog.tsx
import { paragon } from "@useparagon/connect";

function IntegrationsCatalog() {
    const { user } = useParagonAuth();
    
    return (<div className="catalog">
        <h1>Integrations Catalog</h1>
        {paragon.getIntegrationMetadata().map((integration) => {
             return <div
                 key={integration.type}
                 onClick={() => paragon.connect(integration.type)}
             >
                 <img src={integration.icon} width={20} height={20} />
                 <p>{integration.name}</p>
             </div>;
         })}
    </div>);
}

export default IntegrationsCatalog;
```

This snippet calls [`.getIntegrationMetadata`](/apis/api-reference#.getintegrationmetadata) to get all active integrations in your project, along with their names and icon URLs.

For every integration, we display their icons and names. We also set up an event handler to call [`.connect`](/apis/api-reference#.connect-integrationtype-string) with the `integration.type` when the element is clicked. This will display the Connect Portal over your app, prompting the user to connect an account to the specified integration.

**Result:**

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Recording%202022-11-07%20at%2009.08.22.gif?maxW=1158&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=3f5f715cc157e53d84d59a18b6ed1e28" alt="" width="1158" height="840" data-path="assets/Recording 2022-11-07 at 09.08.22.gif" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Recording%202022-11-07%20at%2009.08.22.gif?w=280&maxW=1158&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e6b1798ce4a903b5e1988fd5b221b35b 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Recording%202022-11-07%20at%2009.08.22.gif?w=560&maxW=1158&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=0b07b0cbffe70a2ed145b7fc73a75529 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Recording%202022-11-07%20at%2009.08.22.gif?w=840&maxW=1158&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f899368e9a8e6cd36f7c582b2fa94a16 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Recording%202022-11-07%20at%2009.08.22.gif?w=1100&maxW=1158&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=196411db84112316205d1db39a520100 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Recording%202022-11-07%20at%2009.08.22.gif?w=1650&maxW=1158&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=1a20dcd0eb10b2d494b1da71c955129d 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Recording%202022-11-07%20at%2009.08.22.gif?w=2500&maxW=1158&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d2313e2b23ce1c8fff3e36d41a0156af 2500w" data-optimize="true" data-opv="2" />
</Frame>

When you click on any one of the integrations, the Connect Portal overlay appears over your app.

## 3. Displaying account status

Next, we'll update your integrations catalog to display your user's account status for each integration within the element that shows the icon and name.

We can get the account status using [`.getUser`](/apis/api-reference#.getuser-paragonuser), which returns the current state of the authenticated user from the SDK, including their connected integrations and enabled workflows.

```js
// IntegrationsCatalog.tsx
import { paragon } from "@useparagon/connect";

function IntegrationsCatalog() {
    const { user } = useParagonAuth();
    
    return (<div className="catalog">
        <h1>Integrations Catalog</h1>
        {paragon &&
         paragon.getIntegrationMetadata().map((integration) => {
             const integrationEnabled = user?.integrations?.[integration.type]?.enabled;
             return <div
                 key={integration.type}
                 onClick={() => paragon.connect(integration.type)}
             >
                 <img src={integration.icon} width={20} height={20} />
                 <p>{integration.name}</p>
                 <p>{integrationEnabled ? "Connected" : "Not connected"}</p>
             </div>
         })}
    </div>);
}

export default IntegrationsCatalog;
```

**Result:**

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(20).png?maxW=805&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=0fb985955be1c87d7bdb1ec561a1ec91" alt="" width="805" height="289" data-path="assets/image (20).png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(20).png?w=280&maxW=805&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=9e2763ad53477fc3467d6ea0a0e96b91 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(20).png?w=560&maxW=805&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=f16ec9cf16703d33a067fb68e6788efa 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(20).png?w=840&maxW=805&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=c2830de2fe7115abbd4e8a36b6ae396f 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(20).png?w=1100&maxW=805&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=8538bda6094415153cd51e5def64acda 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(20).png?w=1650&maxW=805&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=36184212e2bf0925ac8ee82dd81b1d0b 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(20).png?w=2500&maxW=805&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=6fa895922d63143d7a33abc46a881d55 2500w" data-optimize="true" data-opv="2" />
</Frame>

Each integration will show the "Connected" or "Not connected" status for the current user.

## 4. Adding subscriptions for account status changes

Finally, we want to make sure that the catalog components that we've created update automatically when the SDK handles a state change with one of our user's integrations. Specifically, when a user connects or disconnects their account, we want the account status to reflect that immediately.

To do this, we can use [`.subscribe`](/apis/api-reference#subscribe), which allows us to listen for global SDK events. We will listen for the events `"onIntegrationInstall"` and `"onIntegrationUninstall"` to detect when a user has connected or disconnected an account.

```js
// useParagonAuth.ts
import { paragon, AuthenticatedConnectUser, SDK_EVENT } from '@useparagon/connect';

export default function useParagonAuth(): { user?: AuthenticatedConnectUser; error?: Error } {
  const [token, setToken] = useState<string | null>(null);
  const [user, setUser] = useState<ConnectUser | undefined>();
  const [error, setError] = useState<Error | undefined>();

  useEffect(() => {
    getParagonUserToken().then(setToken).catch(setError);
  }, []);
  
  // Listen for account state changes
  useEffect(() => {
    const listener = () => {
        const authedUser = paragon.getUser();
        if (authedUser.authenticated) {
          setUser({ ...authedUser });
        }
    };
    paragon.subscribe(SDK_EVENT.ON_INTEGRATION_INSTALL, listener);
    paragon.subscribe(SDK_EVENT.ON_INTEGRATION_UNINSTALL, listener);
    return () => {
      paragon.unsubscribe(SDK_EVENT.ON_INTEGRATION_INSTALL, listener);
      paragon.unsubscribe(SDK_EVENT.ON_INTEGRATION_UNINSTALL, listener);
    };
  }, []);

  useEffect(() => {
    if (token && !error) {
      paragon
        .authenticate(PARAGON_PROJECT_ID, token)
        .then(() => setUser(paragon.getUser()))
        .catch(setError);
    }
  }, [token, error]);

  return { user, error };
}
```

Our integrations catalog will now re-render with the most up-to-date information when account state changes.

**Result**: You've completed a basic Integrations Catalog with the Connect SDK!

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=5e2808c725b3d3ad2b0d3573da8e87ce" alt="" width="720" height="553" data-path="assets/Screen Recording.gif" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?w=280&maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=0fb1c900c1a9abc8f5e114935fc32587 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?w=560&maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=26c0e41e78ba113b34a84741ab60bee5 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?w=840&maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=817b0a70704731b4d086355a4dbaf10c 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?w=1100&maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=75c2a2ce66185fa4c75df76e1281020e 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?w=1650&maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=da8a13056e31f732b59a4a1df341827c 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Recording.gif?w=2500&maxW=720&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=5d5af4b647467fae1ff06a6d261276e0 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Recap

In this guide, you built an integrations catalog that you can embed in your app.

* You defined 2 hooks: [`useParagonGlobal`](https://github.com/useparagon/paragon-integrations-catalog-tutorial/blob/master/src/hooks/useParagonGlobal.ts) (for mounting the Paragon SDK) and [`useParagonAuth`](https://github.com/useparagon/paragon-integrations-catalog-tutorial/blob/master/src/hooks/useParagonAuth.ts) (for authenticating a user).
* You used [`.getIntegrationMetadata`](/apis/api-reference#.getintegrationmetadata) to get all available integrations in the project with name and icon information.
* You used [`.getUser`](/apis/api-reference#.getuser-paragonuser) to get the user's account status.
* You used [`.subscribe`](/apis/api-reference#subscribe) to listen for user account status changes to sync updates to your catalog UI.


# Advanced Techniques
Source: https://docs.useparagon.com/workflows/advanced-techniques



You can use the following advanced techniques to create comprehensive workflows on Paragon:

<CardGroup columns={2}>
  <Card title="Polling-Based Workflows" href="/workflows/advanced-techniques/polling-based-workflows" icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-clock-fading-icon lucide-clock-fading"><path d="M12 2a10 10 0 0 1 7.38 16.75"/><path d="M12 6v6l4 2"/><path d="M2.5 8.875a10 10 0 0 0-.5 3"/><path d="M2.83 16a10 10 0 0 0 2.43 3.4"/><path d="M4.636 5.235a10 10 0 0 1 .891-.857"/><path d="M8.644 21.42a10 10 0 0 0 7.631-.38"/></svg>}>
    Learn how to implement polling-based workflows to check for updates at regular intervals.
  </Card>

  <Card title="Implementing Custom Field Mapping" href="/workflows/advanced-techniques/implementing-custom-field-mapping" icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-text-cursor-input-icon lucide-text-cursor-input"><path d="M12 20h-1a2 2 0 0 1-2-2 2 2 0 0 1-2 2H6"/><path d="M13 8h7a2 2 0 0 1 2 2v4a2 2 0 0 1-2 2h-7"/><path d="M5 16H4a2 2 0 0 1-2-2v-4a2 2 0 0 1 2-2h1"/><path d="M6 4h1a2 2 0 0 1 2 2 2 2 0 0 1 2-2h1"/><path d="M9 6v12"/></svg>}>
    Create field mappings between your app and the integration provider.
  </Card>

  <Card title="Triggering Workflows in Workflows" href="/workflows/advanced-techniques/triggering-workflows-in-workflows" icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-workflow-icon lucide-workflow"><rect width="8" height="8" x="3" y="3" rx="2"/><path d="M7 11v4a2 2 0 0 0 2 2h4"/><rect width="8" height="8" x="13" y="13" rx="2"/></svg>}>
    Build complex integration chains by triggering workflows from within other workflows.
  </Card>
</CardGroup>


# Implementing Custom Field Mapping
Source: https://docs.useparagon.com/workflows/advanced-techniques/implementing-custom-field-mapping



In the event that the integration provider does not have a native Field Mapping [User Setting](/connect-portal/workflow-user-settings), you can map the data in pulled from your application in a Paragon workflow.

#### In your application

1. Use the [Proxy API](/apis/proxy) to make a request to the integration provider to get the schema for a given object in your application.

2. Save the mapping to your [Connected User](/billing/connected-users) using [User Metadata](/apis/users).

#### In your Paragon workflow

1. Add an integration step to retrieve the schema for the given record type. This can also be done by querying the record type for a single existing record.

2. Use a [Function](/workflows/functions) step to map the data from User Metadata to the data retrieved in the previous step.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Custom%20Field%20Mapping%20in%20a%20workflow%20on%20Paragon%20Connect.png?maxW=2220&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=5b40d51ed4e846d42fe5c3bc12eda96c" alt="" width="2220" height="1538" data-path="assets/Using Custom Field Mapping in a workflow on Paragon Connect.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Custom%20Field%20Mapping%20in%20a%20workflow%20on%20Paragon%20Connect.png?w=280&maxW=2220&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=c3f94be35e5aed6653c167ec40e17268 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Custom%20Field%20Mapping%20in%20a%20workflow%20on%20Paragon%20Connect.png?w=560&maxW=2220&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=5bef2a2787c1ee5d172f9e5ed602d0a7 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Custom%20Field%20Mapping%20in%20a%20workflow%20on%20Paragon%20Connect.png?w=840&maxW=2220&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=f2c5acf21dfbaa8e22619b7e957c7f3d 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Custom%20Field%20Mapping%20in%20a%20workflow%20on%20Paragon%20Connect.png?w=1100&maxW=2220&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=289241bf00c3f7091b9a58633fc4cada 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Custom%20Field%20Mapping%20in%20a%20workflow%20on%20Paragon%20Connect.png?w=1650&maxW=2220&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=92121017f3fe2839ba1e087653f7d853 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Custom%20Field%20Mapping%20in%20a%20workflow%20on%20Paragon%20Connect.png?w=2500&maxW=2220&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=c03d790d1a8df1a7e3d03c5a0284d477 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Polling Based Workflows
Source: https://docs.useparagon.com/workflows/advanced-techniques/polling-based-workflows



In the event that the integration provider does not have webhooks, you can build polling-based workflows that essentially work as real-time triggers for your users.

1. Create a workflow with the [Scheduler](/workflows/triggers/scheduler-trigger) trigger

2. Use a Function step to create a timestamp from the last sync time. For example, if the workflow is configured to run every ten minutes, create a timestamp from ten minutes ago.

3. Use the timestamp to filter items from the integration provider.

4. Use a [Fan Out](/workflows/using-fan-out) to iterate through every item in the array returned from the integration provider.

5. Use a [Request](/workflows/triggers/request-trigger)[](/workflows/requests)or [API Resource](/workflows/api-resources) step to send data back to your application.

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20time%20deltas%20for%20workflows%20in%20Paragon%20Connect.png?maxW=1339&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=4a78f2ad39c53a840d72af978346a4ae" alt="" width="1339" height="934" data-path="assets/Creating time deltas for workflows in Paragon Connect.png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20time%20deltas%20for%20workflows%20in%20Paragon%20Connect.png?w=280&maxW=1339&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=8bd512144fa60563238244600011a495 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20time%20deltas%20for%20workflows%20in%20Paragon%20Connect.png?w=560&maxW=1339&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=bcf88dd3085998dd8f91d9a26b48bac4 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20time%20deltas%20for%20workflows%20in%20Paragon%20Connect.png?w=840&maxW=1339&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=917010e9762907e3e9af12fa589897ac 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20time%20deltas%20for%20workflows%20in%20Paragon%20Connect.png?w=1100&maxW=1339&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=07f3c84efdce64efefa200f5fe7128bf 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20time%20deltas%20for%20workflows%20in%20Paragon%20Connect.png?w=1650&maxW=1339&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=c326fcd0e0a3aa06523dfe165e3035c6 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20time%20deltas%20for%20workflows%20in%20Paragon%20Connect.png?w=2500&maxW=1339&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=32c0a413cdeae1628fd386ea70196a69 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Triggering Workflows in Workflows
Source: https://docs.useparagon.com/workflows/advanced-techniques/triggering-workflows-in-workflows



In the event that you need to trigger integration logic between different workflows, you can build a [Function](/workflows/functions) step that generates a [Paragon User Token](/getting-started/installing-the-connect-sdk#id-2.-generate-a-paragon-user-token) in order to trigger workflows via a subsequent [Request](/workflows/triggers/request-trigger) step.

1. Add your Paragon Signing Key as an [Environment Secret](/workflows/environment-secrets) in Paragon.

<Note>
  When adding your signing key as an Environment Secret, make sure to use the single-line "string" format instead of the multi-line "file" format. The key should be a single string with newlines represented as `\n`.
</Note>

2. In the first workflow, add a Function step with the following code:

```js
function yourFunction(parameters, libraries) {

  // Import the jsonwebtoken library
  const { jsonwebtoken } = libraries;

  // Your Connected User's ID, taken from settings.userId
  const userId = parameters.userId;

  // Your Paragon Signing Key
  const key = parameters.signingKey.replaceAll("\\n", "\n");

  // Generate current timestamp
  const currentTime = Math.floor(Date.now() / 1000);

  // Generate your Paragon User Token
  return jsonwebtoken.sign(
      {
        sub: userId,
        iat: currentTime,
        exp: currentTime + (60 * 60), // 1 hour from now
      },
      key,
      {
        algorithm: "RS256",
      }
    )
}
```

The function takes in the following parameters: `userId` and `signingKey`, which can be retrieved by using the [Dynamic Variable Menu](/workflows/using-dynamic-variables).

3. Add a Request step configured for the API Endpoint provided for your specific trigger type. You can more about Triggers and their endpoints [here](/workflows/triggers).

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Calling%20workflows%20in%20workflows%20on%20Paragon%20Connect.png?maxW=2348&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=c52d1692f39b71060853f4450821078a" alt="" width="2348" height="1504" data-path="assets/Calling workflows in workflows on Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Calling%20workflows%20in%20workflows%20on%20Paragon%20Connect.png?w=280&maxW=2348&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3952656931cfa16f1e79501294fe98c8 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Calling%20workflows%20in%20workflows%20on%20Paragon%20Connect.png?w=560&maxW=2348&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=22ef71b1c9316c3338bf6b35c6b45b08 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Calling%20workflows%20in%20workflows%20on%20Paragon%20Connect.png?w=840&maxW=2348&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=807ffea24c3bf79359d1e65da373f1d7 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Calling%20workflows%20in%20workflows%20on%20Paragon%20Connect.png?w=1100&maxW=2348&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=286111fed5ddb92ffa91867ceb11fdcb 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Calling%20workflows%20in%20workflows%20on%20Paragon%20Connect.png?w=1650&maxW=2348&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=7ebd5a52564e774ce85f7b3a8ab5bf66 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Calling%20workflows%20in%20workflows%20on%20Paragon%20Connect.png?w=2500&maxW=2348&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=7b05cd8eb8ae7cfc7304f95767304f99 2500w" data-optimize="true" data-opv="2" />
</Frame>


# API Resources
Source: https://docs.useparagon.com/workflows/api-resources

Add API Resources to your project to build reusable Triggers and Steps for your API in Workflows.

## Overview

API Resources are reusable connections to your internal API endpoints that can be used to define Requests and Triggers for Workflows.

With API Resources, you can:

* Connect Workflows to existing webhooks in your API
* Define your API configuration once (including authentication and basic API details) and reuse it across requests made in Workflows

<Info>
  **API Resources are currently in beta.**

  Resources are stable in Workflows and in the API, but the Setup and Configuration experience in the dashboard is subject to change. If you have feedback or questions, please reach out to our [support team](mailto:support@useparagon.com).
</Info>

## Getting Started

To start creating an API Resource, navigate to the **Resources** page in your dashboard sidebar and click **Create Resource**.

You will be prompted to name your Resource, which will be used to reference your API in Triggers and Requests. For example, if your Resource is named "TaskLab", you will see "TaskLab Request" Steps and "TaskLab Triggers" appear as options for your Workflows.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20API%20Resources%20in%20Paragon%20Connect.png?maxW=2016&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=6033d31787eb101b07e2c31c92d4b3a2" alt="Setting up an API Resource in Paragon Connect" width="2016" height="1114" data-path="assets/Setting up API Resources in Paragon Connect.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20API%20Resources%20in%20Paragon%20Connect.png?w=280&maxW=2016&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=6df2695ac3953211887abaf7784793b2 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20API%20Resources%20in%20Paragon%20Connect.png?w=560&maxW=2016&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=95b6309e0bd167ac80c434f41bf09b92 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20API%20Resources%20in%20Paragon%20Connect.png?w=840&maxW=2016&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=3a5823034904261f9f083cdd150dedd9 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20API%20Resources%20in%20Paragon%20Connect.png?w=1100&maxW=2016&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=f59e0dcfdfad22922d5413cd8a6b0e1f 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20API%20Resources%20in%20Paragon%20Connect.png?w=1650&maxW=2016&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=13fc2597ebb41031296313a8cd05b61a 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20API%20Resources%20in%20Paragon%20Connect.png?w=2500&maxW=2016&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=142396a7ea423d4a79fd9173d5664833 2500w" data-optimize="true" data-opv="2" />
</Frame>

### API Info

Next, you'll configure your API Resource with details on how your API authenticates and sends requests.

1. **Choose between a User-Level and an App-Level Resource.** **User-Level Resources** require you to use the SDK/API to save separate API credentials for each of your Connected Users. Choose this option if each of your users will have separate OAuth tokens or API keys. **App-Level Resources** use one set of API credentials to authenticate for all of your Connected Users. Choose this option if one set of API keys/service account credentials will be used to authenticate to your API from Paragon.

2. **Select an authentication type.** Resources support the most common API authentication types, including OAuth 2.0 (Refresh Token or Client Credentials) and API Keys.

<Frame>
  <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20Authorization%20Methods%20for%20API%20Resources%20in%20Paragon%20Connect.png?maxW=1670&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=82efc5ae9f29222f8fb77d80b0d3c3d1" alt="Choosing Authorization Methods for API Resources in Paragon Connect" width="1670" height="1626" data-path="assets/Choosing Authorization Methods for API Resources in Paragon Connect.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20Authorization%20Methods%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=280&maxW=1670&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=a8ede4b6f8e951cf1d656c7d82edaa27 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20Authorization%20Methods%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=560&maxW=1670&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=d1e571d8960658d74b0e70ee5eb6fd67 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20Authorization%20Methods%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=840&maxW=1670&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ee1d602317044dba2d36ad59e42d0d4a 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20Authorization%20Methods%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=1100&maxW=1670&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3e4244be05d75d94159f325752299bff 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20Authorization%20Methods%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=1650&maxW=1670&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=fd425b5e0f8669ecf02874cdf1f6ba34 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20Authorization%20Methods%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=2500&maxW=1670&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=daa3aeb3c103b68177933642ad3b414d 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Authorization

**Note**: The next steps may vary depending on which options you select above. If you selected App-Level Resource, proceed directly to [Request Details](/workflows/api-resources#request-details).

#### OAuth 2.0

If you selected OAuth 2.0 authentication, you'll need to provide the following details:

* **Access Token URL**: URL that Paragon will use to refresh OAuth tokens for your API.
* **Client ID and Client Secret**: The `client_id` and `client_secret` parameters that will be used for the OAuth refresh request to the preconfigured URL.
* Optionally, you can configure additional settings under Advanced Options:

  * **Required Inputs**: Add an input to this list if you need to parameterize values like the Access Token URL or API Base URL.

  * **Include Client ID and Secret**: You can disable this setting if your integration does not use a Basic Authorization header to pass your Client ID and Secret into the token request.

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20OAuth%202.0%20for%20API%20Resources%20in%20Paragon%20Connect.png?maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=21ee0a8936016aa52398e59f53e808f7" alt="Configuring OAuth 2.0 for API Resources in Paragon Connect" width="1860" height="1320" data-path="assets/Configuring OAuth 2.0 for API Resources in Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20OAuth%202.0%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=280&maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=1f99435d52d1863c747060bc28edf2c1 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20OAuth%202.0%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=560&maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b161efc425f4bf104cdc5874712e92ab 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20OAuth%202.0%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=840&maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=17146012cb8df80df5d82ac91e3642ec 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20OAuth%202.0%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=1100&maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=6bcba9cbf7b1083362a6415742ff6da0 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20OAuth%202.0%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=1650&maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=309a63eb2d5b4e2f5b928a3bc2b826bd 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20OAuth%202.0%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=2500&maxW=1860&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=fcc4f2c6a10d8d2d89f06e6ad7e5fb16 2500w" data-optimize="true" data-opv="2" />
</Frame>

#### API Keys

If you selected API Key authentication, you'll need to provide the names of any values that are required as a part of a user's credentials to your API.

For example, if your API requires a username and password to authenticate, add `username` and `password` as API Key names.

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20API%20Keys%20for%20API%20Resources%20in%20Paragon%20Connect.png?maxW=1862&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=b0196cf8ea4f39eebfe273fbea8903f0" alt="Configuring API Keys for API Resources in Paragon Connect" width="1862" height="1130" data-path="assets/Configuring API Keys for API Resources in Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20API%20Keys%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=280&maxW=1862&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5d49321eb5255599af9ce5ed57ad7740 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20API%20Keys%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=560&maxW=1862&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=a67fbe952d93a6b685cac10b207180b2 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20API%20Keys%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=840&maxW=1862&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=7826e944b372bff6e1db7e6e66fe9977 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20API%20Keys%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=1100&maxW=1862&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c71d25ea6281bf137f8d446bfbaf09e7 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20API%20Keys%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=1650&maxW=1862&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=eeecc6c1cc9a0045129f0af2a84e170e 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20API%20Keys%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=2500&maxW=1862&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=c7884a02627cc33255589b8ea6aed717 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Request Details

Next, define a template for how requests are sent to your API.

* **API Base URL**: URL that should be used to send requests.

  * If you are using a User-Level Resource and added Required Inputs in the **Authorization** step, you can use the variable menu (type `{{` to open) to parameterize this value with a user-specific input.

* **API Authentication:** Define how tokens or other values are used to authenticate requests sent to your API.

* Optionally, if you are using a User-Level Resource, you can configure a User Profile.

  * User Profiles are retrieved from your API at the time of first authentication and can be used to store persistent information about the user's Resource Connection.

  * You can configure a Request or use a field from a JWT-encoded access token to save the User Profile.

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Request%20Details%20for%20API%20Resources%20in%20Paragon%20Connect.png?maxW=1842&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=5fcb736a00996723d2e8a33f9b163d0e" alt="Configuring Request Details for API Resources in Paragon Connect" width="1842" height="1188" data-path="assets/Configuring Request Details for API Resources in Paragon Connect.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Request%20Details%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=280&maxW=1842&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=39f14c5c23592915d435dddd41a45d0a 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Request%20Details%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=560&maxW=1842&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=d90829c58b5bab0236c27b2829bcd9ee 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Request%20Details%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=840&maxW=1842&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=3e317a305d80fe996d9a56a9a2f60b38 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Request%20Details%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=1100&maxW=1842&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=e3b342c942a61aa525cc3ad3dcc49279 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Request%20Details%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=1650&maxW=1842&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=fc0be98eb019192a2ef0a2ee3a3291c8 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/Configuring%20Request%20Details%20for%20API%20Resources%20in%20Paragon%20Connect.png?w=2500&maxW=1842&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=6b154ebebd7774ab98fd4b117f0bf0e9 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Test and Publish

Finally, you can send a test request to your API Resource to verify that you can connect to your API.

If you are using a User-Level Resource, you will be prompted to enter test credentials using your Required Fields (and an access/refresh token, for OAuth). *This step must be completed to test your Resource in the Workflow Editor and Webhook Setup pages.*

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20and%20Finishing%20API%20Resources%20in%20Paragon%20Connect.png?maxW=1842&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=255824e061032a7dd350f75a6a02070f" alt="Testing and Finishing API Resources in Paragon Connect" width="1842" height="1696" data-path="assets/Testing and Finishing API Resources in Paragon Connect.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20and%20Finishing%20API%20Resources%20in%20Paragon%20Connect.png?w=280&maxW=1842&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=9e52eff0fb41c862d4bc5b1e9d51ea88 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20and%20Finishing%20API%20Resources%20in%20Paragon%20Connect.png?w=560&maxW=1842&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=383094df7acd5d249bf5b67c1bc44f35 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20and%20Finishing%20API%20Resources%20in%20Paragon%20Connect.png?w=840&maxW=1842&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=76a4b59efd4909f8a108a584ac786cd4 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20and%20Finishing%20API%20Resources%20in%20Paragon%20Connect.png?w=1100&maxW=1842&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=9ccdf98389b04a2c513770af827dadf7 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20and%20Finishing%20API%20Resources%20in%20Paragon%20Connect.png?w=1650&maxW=1842&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=b0a8434ba15d2b01a1c7648f1283b544 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20and%20Finishing%20API%20Resources%20in%20Paragon%20Connect.png?w=2500&maxW=1842&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=41a5d9a83c5f0121fe292f3f2fec2ba6 2500w" data-optimize="true" data-opv="2" />
</Frame>

Once you are finished verifying that your API Resource can send requests successfully, click **Finish** to save your Resource configuration.

## Connecting Resources

If you are using User-Level Resources, you will need to connect your users' credentials to ensure that Resource Requests and Triggers can run as expected.

<Tabs>
  <Tab title="JavaScript SDK">
    To connect your users' credentials via your frontend application, you can use the SDK's `connectAction` method to pass through the Required Keys for your User-Level Resource.

    **Example OAuth 2.0 connectAction call:**

    ```js
    await paragon.connectAction({
        access_token: "eyJ....",
        refresh_token: "ref_123..."
    });
    ```

    <Tip>
      You can visit **Resource Setup** > **Test and Publish** to see a code example of your specific Resource, with all required keys.
    </Tip>
  </Tab>

  <Tab title="REST API">
    To connect your users' credentials via the REST API, perform the following request:

    ```http
    POST https://zeus.useparagon.com/projects/[Project ID]/sdk/resources/[Resource ID]/connect
    Authorization: Bearer [Paragon User Token]
    Content-Type: application/json

    { 
      "access_token": "eyJ...",
      "refresh_token": "ref_123..." 
    }
    ```

    * **Project ID**: Your Paragon Project ID

    * **Resource ID**: You can find your Resource ID in your dashboard, in the URL of your Resource page. It is a UUID which follows the `/resources/` path of the URL.

      <Frame>
        <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-12%20at%2003.54.57%20PM@2x.png?maxW=2848&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=5de42080dbcf86ab438d324fd8259fee" alt="" width="2848" height="736" data-path="assets/[Paragon] 2024-09-12 at 03.54.57 PM@2x.png" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-12%20at%2003.54.57%20PM@2x.png?w=280&maxW=2848&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=de878c63a1bb49daa4a43c04db6e8e60 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-12%20at%2003.54.57%20PM@2x.png?w=560&maxW=2848&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=9eaae93585cb3e08e37b8617e39095ec 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-12%20at%2003.54.57%20PM@2x.png?w=840&maxW=2848&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d39399e1498153a0f803e6f8cf13f5d5 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-12%20at%2003.54.57%20PM@2x.png?w=1100&maxW=2848&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d720cb4579a1f61efd8a80733bb9b8bb 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-12%20at%2003.54.57%20PM@2x.png?w=1650&maxW=2848&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=a0cd7dab3d0d790941d75cb0e6190d6f 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-12%20at%2003.54.57%20PM@2x.png?w=2500&maxW=2848&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=f28dc348dd4b7784d9872fbc90a5b9e6 2500w" data-optimize="true" data-opv="2" />
      </Frame>

    * **Paragon User Token:** The User Token which authenticates the Connected User you are trying to connect a Resource for.
  </Tab>
</Tabs>


# Auto Retries
Source: https://docs.useparagon.com/workflows/auto-retries

Automatically retry failed step executions.

## Overview

When auto-retry is enabled on a step, the step automatically retries if the step execution fails. This is useful for ensuring your workflows run successfully when encountering intermittent errors, such as API rate limits.

Auto-retry is available on the following step types:

* [Integrations](/resources/integrations) (e.g. Salesforce, Slack, Jira)
* [Request](/workflows/requests#overview)
* [Function](/workflows/functions)

If a step with auto-retry enabled fails, Paragon will perform several retries, waiting after each failed execution before performing the next attempt. All attempts will only count as [one task](/billing/tasks) used.

The timing of retry attempts is as follows:

* **1st retry:** around `10 seconds` after initial attempt
* **2nd retry:** around `20 seconds` after 1st retry
* **3rd retry:** around `30 seconds` after 2nd retry
* **4th retry:** around `50 seconds` after 3rd retry
* **5th retry:** around `80 seconds` after 4th retry

### Enabling Auto-Retry

To enable auto-retry for a step, click on the step, scroll to the bottom of the sidebar, and toggle auto-retry.

<Frame>
    <img src="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Auto%20Retries%20in%20a%20Paragon%20workflow%20(1).gif?maxW=856&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=163cf54af05c2cae3d0155deff4a963f" alt="" width="856" height="376" data-path="assets/Enabling Auto Retries in a Paragon workflow (1).gif" srcset="https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Auto%20Retries%20in%20a%20Paragon%20workflow%20(1).gif?w=280&maxW=856&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=47a996175447c94c9b9d25a5ad0f4d37 280w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Auto%20Retries%20in%20a%20Paragon%20workflow%20(1).gif?w=560&maxW=856&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=a516f0b3d18aba8a144ba3a5ca556e97 560w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Auto%20Retries%20in%20a%20Paragon%20workflow%20(1).gif?w=840&maxW=856&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=6fc147040fe4311d5ad8b7d84b1f0593 840w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Auto%20Retries%20in%20a%20Paragon%20workflow%20(1).gif?w=1100&maxW=856&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=d59b6045978ddde90a1e820e89ae7626 1100w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Auto%20Retries%20in%20a%20Paragon%20workflow%20(1).gif?w=1650&maxW=856&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=ff384675d0ee2e2c17e0c87d5845b2d7 1650w, https://mintcdn.com/paragon/jCM_Y_j0HttScr1R/assets/Enabling%20Auto%20Retries%20in%20a%20Paragon%20workflow%20(1).gif?w=2500&maxW=856&auto=format&n=jCM_Y_j0HttScr1R&q=85&s=e8f7b14d5a3d2862f974e08f657ed33a 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Note>
  **Note:** Enabling auto-retry only retries the **specific step**, not your entire workflow.
</Note>

## How Auto-Retry works

**Deployed Workflows:** Paragon attempts to run your step **up to five times** with an exponential back-off. Retried steps appear as "Running" in [Task History](/monitoring/viewing-task-history#overview).

**Test Workflow** or **Test Step:** Paragon does not retry step executions.

While auto-retry is enabled, no error emails for the workflow will be sent during the auto-retry window. If Paragon fails to retry the step after the last attempt, we will send you an email indicating the error, and workflow execution in your [Task History](/monitoring/viewing-task-history#editing-and-replaying).


# Building Workflows
Source: https://docs.useparagon.com/workflows/building-workflows

Workflows connect data between your users' apps and your application

## Introduction

Once your users have connected their third-party app accounts in the Connect Portal, you can build workflows that connect data between your application and your users' apps. Paragon's visual workflow builder allows you to create custom integrations that your users can activate in their integrations.

Workflows are durable, retriable jobs that can be [triggered](/workflows/triggers) by your application or by events in your user's connected accounts. Workflows can be used to build out logic for your integration in Paragon's scalable, high-availability runtime.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20workflow%20editor%20in%20Paragon.png?maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=27ea817ce346f5c1793ff781d8aeb62f" alt="" width="2398" height="1680" data-path="assets/Using the workflow editor in Paragon.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20workflow%20editor%20in%20Paragon.png?w=280&maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=956478068fd525ad10bde24e74ed5a17 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20workflow%20editor%20in%20Paragon.png?w=560&maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=3f8b9fcda73fa395ce1a30428d41db15 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20workflow%20editor%20in%20Paragon.png?w=840&maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=cb0e771cc79da6a36f1fa1255a7f31b8 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20workflow%20editor%20in%20Paragon.png?w=1100&maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9e39bf0b832aa90719975e7ac22c4027 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20workflow%20editor%20in%20Paragon.png?w=1650&maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=eb0707c281a7823dd771d1137a9d00a6 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20workflow%20editor%20in%20Paragon.png?w=2500&maxW=2398&auto=format&n=867oBBVpxd2C3zc4&q=85&s=065e45a4e77083c7c69838db1cfab36e 2500w" data-optimize="true" data-opv="2" />
</Frame>

Here are some common step types that can get you started building workflows:

* [Integration Actions](/workflows/integration-actions)**:** Perform an action in your users' connected app account, like sending a Slack message or querying contacts from Salesforce
* [Requests](/workflows/requests): Make a request to any API, such as sending data to your application
* [Functions](/workflows/functions): Write custom JavaScript to transform data or perform custom business logic, using [npm libraries](/resources/javascript-libraries) as supported
* [Conditionals](/workflows/using-conditionals): Add conditional branching logic
* [Fan Out](/workflows/using-fan-out)**:** Iterate in parallel over a list of data and reduce results in downstream steps

Along with the [Proxy API](/apis/proxy), Workflows are one of two primary ways to build integrations with Paragon.

## When to use Workflows

In general, Workflows are the way that most integrations are built with Paragon. When deciding when to use Workflows or the [Proxy API](/apis/proxy), Workflows are often best suited for common use cases including:

* Pushing data from your application to your users' apps
* Receiving new or updated data from your users' apps (Webhooks)
* Allowing your users to configure integration options with custom fields
* Enabling non-engineering teams (e.g. Product or Client Services teams) to configure integrations without writing code

Here are examples of Workflows for a few common integrations:

* **Slack:** Send notifications from your application to Slack
* **Salesforce:** Sync contacts from your application to Salesforce
* **HubSpot:** Sync contacts HubSpot to your application
* **Google Calendar:** Create Google Calendar events from events in your application

## Creating Workflows

You can create a Workflow by selecting an integration and clicking **Create Workflow.**

<Frame>
  <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.03.05%20AM@2x.png?maxW=2822&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=64a6895d40c463ad10672d763090d79b" alt="" width="2822" height="1322" data-path="assets/[Paragon] 2025-02-18 at 08.03.05 AM@2x.png" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.03.05%20AM@2x.png?w=280&maxW=2822&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=396bdef8ac2c4b25e7dc684b6a660af5 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.03.05%20AM@2x.png?w=560&maxW=2822&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=af49644b012f4b8712146b5b056468ed 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.03.05%20AM@2x.png?w=840&maxW=2822&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=228d5d0c849396c70c50acffc39b75e9 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.03.05%20AM@2x.png?w=1100&maxW=2822&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=4c15e60f430e1fea3dd7fc09755d85ff 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.03.05%20AM@2x.png?w=1650&maxW=2822&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=e0e980de63fe9c2f1c45b1fae1a2d8ff 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202025-02-18%20at%2008.03.05%20AM@2x.png?w=2500&maxW=2822&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=6f8d33c98f6762ece1544e38dde5b288 2500w" data-optimize="true" data-opv="2" />
</Frame>

**Naming your workflow**

The Workflow Editor will appear and allow you to name your new workflow (click in the workflow title "New Workflow" and type to rename).

<Frame>
  > <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Editor%20Navbar%20-%20Rename%20(1).png?maxW=2464&auto=format&n=867oBBVpxd2C3zc4&q=85&s=965f1d9a8eaf2ab095892efb120fa3af" alt="" width="2464" height="98" data-path="assets/Workflow Editor Navbar - Rename (1).png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Editor%20Navbar%20-%20Rename%20(1).png?w=280&maxW=2464&auto=format&n=867oBBVpxd2C3zc4&q=85&s=cb5ed942a62cca0c2e6c80006f07cddc 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Editor%20Navbar%20-%20Rename%20(1).png?w=560&maxW=2464&auto=format&n=867oBBVpxd2C3zc4&q=85&s=ef84ec4c76cfa2a0bcd4427626359084 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Editor%20Navbar%20-%20Rename%20(1).png?w=840&maxW=2464&auto=format&n=867oBBVpxd2C3zc4&q=85&s=f0b594940fd43d5d09a3f31e4671d513 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Editor%20Navbar%20-%20Rename%20(1).png?w=1100&maxW=2464&auto=format&n=867oBBVpxd2C3zc4&q=85&s=408fc7818a871023838b509ad8498419 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Editor%20Navbar%20-%20Rename%20(1).png?w=1650&maxW=2464&auto=format&n=867oBBVpxd2C3zc4&q=85&s=d398c448b83c0a4eeb085e74b1db0766 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflow%20Editor%20Navbar%20-%20Rename%20(1).png?w=2500&maxW=2464&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7a65d0ce96065fecae1dbdbb48404344 2500w" data-optimize="true" data-opv="2" />
</Frame>

**Selecting a trigger**

Every workflow begins with a trigger. Select a trigger that matches how this workflow should begin its execution.

Workflows can only have one type of trigger. If you need to create a two-way sync between an integration and your application, you would create two workflows: one workflow to push updates from Integration -> Your App and another workflow to push updates from Your App -> Integration.

See the page below for full information on defining and using triggers:

<Card title="Triggering Workflows" href="/workflows/triggers" horizontal />

**Adding steps**

Beneath a trigger, you can build out your workflow logic as a series of steps. Steps can represent [Integration Actions](/workflows/integration-actions), [API requests](/workflows/requests), [custom functions](/workflows/functions), or other control flow elements in your workflow.

Click the "**+**" button underneath any step to add a new step. You can also right-click any step to add a step immediately downstream of the step, duplicate the step, or remove the step from the workflow.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Editor%20context%20menu.png?maxW=1420&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=4a7a92ebd6efc13719163ee5427c0898" alt="" width="1420" height="544" data-path="assets/Step Editor context menu.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Editor%20context%20menu.png?w=280&maxW=1420&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=283e3b587ad4db80b5ba9324cef4d0f8 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Editor%20context%20menu.png?w=560&maxW=1420&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=bc17109e7814787881be514142127801 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Editor%20context%20menu.png?w=840&maxW=1420&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=2c63c2e4015d945c666b75072b688603 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Editor%20context%20menu.png?w=1100&maxW=1420&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=097ca0b1bffc4a2656d942ff81872d46 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Editor%20context%20menu.png?w=1650&maxW=1420&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=25ac279f4d7cdd5855affd83bc5efa18 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Step%20Editor%20context%20menu.png?w=2500&maxW=1420&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=c51bfa3ca552207c529ca753d9807b8e 2500w" data-optimize="true" data-opv="2" />
</Frame>

Requests, Integration Actions, and Function Steps can be configured to "Continue workflow if step fails" or to use [Auto-Retries](/workflows/auto-retries).

#### Using Dynamic Data

You can insert data from any upstream step in the Workflow Editor with the [Dynamic Variable Menu](/workflows/using-dynamic-variables). To access the Dynamic Variable Menu, click into any text input box, type two left curly braces `{{`, then select the desired step and specific reference to pull data from.

<Frame>
    <img src="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.gif?maxW=974&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=8eb46bf7e9bb22b9ec76707a989f77b8" alt="" width="974" height="774" data-path="assets/Accessing the Dynamic Variable Menu in Paragon Connect.gif" srcset="https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.gif?w=280&maxW=974&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=6e2faa3fbad06c9bc3a06bc68d5ecd83 280w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.gif?w=560&maxW=974&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=f59fa2c4175bafc95c951714b2954697 560w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.gif?w=840&maxW=974&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=879a4151b892c83d85d7839018438d6f 840w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.gif?w=1100&maxW=974&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=42d8579e5b165fc2c2431c488ceb279d 1100w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.gif?w=1650&maxW=974&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=ce9c7ea51f3fe39aa3e4213528cd3112 1650w, https://mintcdn.com/paragon/PqlWbzgmbhNFByFv/assets/Accessing%20the%20Dynamic%20Variable%20Menu%20in%20Paragon%20Connect.gif?w=2500&maxW=974&auto=format&n=PqlWbzgmbhNFByFv&q=85&s=9a8847911c754394b88ce4eb27046367 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Testing Workflows

Individual steps in a workflow can be tested as you build them. Each step has a Test Step button in the sidebar that executes the step as the Preview User (the user connected in the Preview page of your integration).

You can use the Test Workflow button when you want to test a workflow with all steps to completion.

<Note>
  **Note:** When testing steps or workflows from the Workflow Editor, the data output returned is partial.

  Here are some limitations to the test data displayed in the Workflow Editor:

  * Arrays are truncated to 20 items maximum
  * Paginated requests will only send 3 requests maximum
</Note>

The above limitations improve the performance of the Workflow Editor as you build your workflow and reference variables between steps.

To test the workflow without these limitations, use a live Connected User to [connect an integration in the Connect Portal](/getting-started/displaying-the-connect-portal) and enable the workflow. Once you trigger the workflow for this user, the execution will appear in [Task History](/monitoring/viewing-task-history), where you can monitor the results and view the full input and output data.

## Deploying Workflows

You can push workflows live to your customers by pressing the purple Deploy button in the top-right corner of the Workflow Editor.

<Frame>
  <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e9496cda52b7e1f73774564c73e081c5" alt="" width="966" height="570" data-path="assets/Deploying a workflow in Paragon (1).png" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=280&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=e28b05ccf60dfd0e415f46b1798bc5b8 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=560&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6d87770645178a3a4e874d5b51ed8374 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=840&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=966f00558bb2e547eee5a4ba18f7e71e 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=1100&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=d4d27b7001865790074a28debc2552f1 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=1650&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=542fe3fa9f84dc37bcd402ff401a0949 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deploying%20a%20workflow%20in%20Paragon%20(1).png?w=2500&maxW=966&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=2b2f470d07a8cc6b59e4b57f342c81e2 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Editing Workflows

You can edit deployed workflows by making changes directly to the Workflow Editor. The changes will not affect the live workflow changes until you redeploy the workflow.

## Undeploying Workflows

To pull deployed workflows from your customers, click the purple “Deploy” button in the top-right corner of the Workflow Editor, then select “Undeploy”.

## Workflows and the Connect Portal

Workflows that you've deployed for an integration will appear in that integration's Connect Portal under the Configuration tab.

There, your users can choose which workflows they want to activate for that integration. You can also provide options for your users to configure their workflow settings. For example, if you have a Slack workflow that sends notifications to your users' workspaces, you may want to provide them the option of which Slack channel they want to send notifications to.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-11%20at%2011.37.03%20AM.png?maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=eac3facdbeb6f871c8ccb6c00c9ca5f8" alt="" width="1366" height="1126" data-path="assets/Screen Shot 2021-02-11 at 11.37.03 AM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-11%20at%2011.37.03%20AM.png?w=280&maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=803d4b6c810dced7610fa145a8eb53b7 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-11%20at%2011.37.03%20AM.png?w=560&maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f1ef1156b86ee7b8fa6300f559e07eaf 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-11%20at%2011.37.03%20AM.png?w=840&maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=de54327aef187c8efafcec761fa72625 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-11%20at%2011.37.03%20AM.png?w=1100&maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=e9a3df5833c7fc7bdfcb81f1454ace73 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-11%20at%2011.37.03%20AM.png?w=1650&maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=54a74fbb833d69667a23f9e83d77e9a5 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-11%20at%2011.37.03%20AM.png?w=2500&maxW=1366&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=57987b8cb1385857fc76c9de2eb05117 2500w" data-optimize="true" data-opv="2" />
</Frame>

See [Workflow User Settings](/connect-portal/workflow-user-settings) for an overview of how to provide user-facing options for your users to configure their workflow settings.

## What's Next

Throughout the articles in this section, we'll provide a detailed overview of how to start building your own Workflows in Paragon.


# Environment Secrets
Source: https://docs.useparagon.com/workflows/environment-secrets

Securely store and access credentials across your workflows.

## Overview

Environment Secrets are global variables used for securely storing and accessing secure values across your workflows. For example, you can store a global authorization token for your API to use in all Request steps that send a request to your API.

<Note>
  **Note:** You must be an account Admin to manage Environment Secrets.
</Note>

To set up Environment Secrets:

**1. Click on "Settings" in the sidebar, then click on "Environment Secrets".**

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20settings%20in%20Paragon.gif?maxW=470&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=671930e5eabe7c4ccb73e732d3a2aa9c" alt="" width="470" height="298" data-path="assets/Going to settings in Paragon.gif" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20settings%20in%20Paragon.gif?w=280&maxW=470&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=79c883e0134181dfcfd18ea180b52e60 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20settings%20in%20Paragon.gif?w=560&maxW=470&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=072561f95c43ab588002519cd47ce13c 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20settings%20in%20Paragon.gif?w=840&maxW=470&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=47f65347f53ae1784e127e99d23f8ce7 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20settings%20in%20Paragon.gif?w=1100&maxW=470&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c18327e7aa75a9c00c3b4077b0e3d3a7 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20settings%20in%20Paragon.gif?w=1650&maxW=470&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7557e6fc9314f606ef291cb9bbdbd5d4 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Going%20to%20settings%20in%20Paragon.gif?w=2500&maxW=470&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=df2a7211f8fe878cf802e1114ba5336c 2500w" data-optimize="true" data-opv="2" />
</Frame>

**2. Enter details for your new Environment Secret.**

Set **Key** to a descriptive and recognizable name. This easily identifies it in the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20environment%20secrets%20in%20Paragon.gif?maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=39406836fe361b36faf46cd949866243" alt="" width="1426" height="658" data-path="assets/Creating environment secrets in Paragon.gif" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20environment%20secrets%20in%20Paragon.gif?w=280&maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=fcb674d5e5ea62475020eeeb525c7d63 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20environment%20secrets%20in%20Paragon.gif?w=560&maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=6685f6444ba5a20652e98710512d11d7 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20environment%20secrets%20in%20Paragon.gif?w=840&maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=64043b65a4d108a3932ee04fc0069ed2 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20environment%20secrets%20in%20Paragon.gif?w=1100&maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=759c783cc0a3e0902a3f54353bbe6b4f 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20environment%20secrets%20in%20Paragon.gif?w=1650&maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ed55ade6aa07bffc59c4ba4061baaa39 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Creating%20environment%20secrets%20in%20Paragon.gif?w=2500&maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=ba9ccd6bb1258f34c41b8c64e05a70f3 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using Environment Secrets

Environment Secrets appear at the bottom of the variable menu. Selecting one uses the `Value` stored in the Environment Secret.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20environment%20secrets%20in%20Paragon.gif?maxW=842&auto=format&n=867oBBVpxd2C3zc4&q=85&s=3806b773f2f0064ff9fd19f93878bb09" alt="" width="842" height="686" data-path="assets/Using environment secrets in Paragon.gif" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20environment%20secrets%20in%20Paragon.gif?w=280&maxW=842&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7772a6bea46aae3404f9320812e06a3d 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20environment%20secrets%20in%20Paragon.gif?w=560&maxW=842&auto=format&n=867oBBVpxd2C3zc4&q=85&s=d08977ea2df04b9206caf8224fb924e8 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20environment%20secrets%20in%20Paragon.gif?w=840&maxW=842&auto=format&n=867oBBVpxd2C3zc4&q=85&s=6e6a89c8f794b2dfbcbb415bb030a2ab 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20environment%20secrets%20in%20Paragon.gif?w=1100&maxW=842&auto=format&n=867oBBVpxd2C3zc4&q=85&s=ace54321232d36e82d4da199e9426520 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20environment%20secrets%20in%20Paragon.gif?w=1650&maxW=842&auto=format&n=867oBBVpxd2C3zc4&q=85&s=d4b297f30df60fed28012ed88f2ec6bf 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20environment%20secrets%20in%20Paragon.gif?w=2500&maxW=842&auto=format&n=867oBBVpxd2C3zc4&q=85&s=995af95286fc1571eb06d31bf3faf433 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Updating an Environment Secret

Click on the triple-dot menu to the right of the Environment Secret you'd like to update. After confirming the update, the Environment Secret will update in any workflows it's used in.

<Frame>
    <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Updating%20environment%20secrets%20in%20Paragon.gif?maxW=1466&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=97db5da0872ce8fbf62934c23eb01286" alt="" width="1466" height="658" data-path="assets/Updating environment secrets in Paragon.gif" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Updating%20environment%20secrets%20in%20Paragon.gif?w=280&maxW=1466&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=67b1fee9a620af9fb2fc8f5bf073d783 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Updating%20environment%20secrets%20in%20Paragon.gif?w=560&maxW=1466&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=63549c1011b5c54859dbb68498c65877 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Updating%20environment%20secrets%20in%20Paragon.gif?w=840&maxW=1466&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=91d677b4acbb52f6792b884d485707aa 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Updating%20environment%20secrets%20in%20Paragon.gif?w=1100&maxW=1466&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=338947b3c96f83e31bae21c05bd041b7 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Updating%20environment%20secrets%20in%20Paragon.gif?w=1650&maxW=1466&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=9b692e273a24ec651e7a6cdfcef09fc5 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Updating%20environment%20secrets%20in%20Paragon.gif?w=2500&maxW=1466&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=1bf936af0c72217372b01c2be9210a9b 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Deleting an Environment Secret

Click on the triple-dot menu to the right of the environment secret you'd like to delete. After confirming the deletion, the Environment Secret will get removed from any workflows.

<Frame>
    <img src="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20environment%20secrets%20in%20Paragon.gif?maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=5e828e59c5047a3a85924df77be93210" alt="" width="1426" height="658" data-path="assets/Deleting environment secrets in Paragon.gif" srcset="https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20environment%20secrets%20in%20Paragon.gif?w=280&maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=995c5a5256f7c29eaaf8b1a4365158fa 280w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20environment%20secrets%20in%20Paragon.gif?w=560&maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=69f4cd569886e242cf2a784916e426bd 560w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20environment%20secrets%20in%20Paragon.gif?w=840&maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=8f432b7c8e108cf4b0e3806789dbdb3f 840w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20environment%20secrets%20in%20Paragon.gif?w=1100&maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=4f8acc90ccc773f5f662aeef75497d75 1100w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20environment%20secrets%20in%20Paragon.gif?w=1650&maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=fc38a8d2252fdf24d3d95a606b2420e2 1650w, https://mintcdn.com/paragon/EuLlf5VxgsSnEq57/assets/Deleting%20environment%20secrets%20in%20Paragon.gif?w=2500&maxW=1426&auto=format&n=EuLlf5VxgsSnEq57&q=85&s=9f5ec824fd8605a49c6044936839ffbe 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Using Functions
Source: https://docs.useparagon.com/workflows/functions



## Overview

Paragon's Functions are built-in cloud functions that provide a powerful way to add custom logic to your workflows. You can use functions to transform or compute data, or even to perform more complex operations within workflows that you might otherwise need to write server-side code for. Paragon functions support Javascript (ES7) and provide access to select npm modules.

<Card title="JavaScript Libraries" href="/resources/javascript-libraries" horizontal />

To add a function to your workflow, click the "+" button in the workflow canvas and choose the Function step from the sidebar.

<Frame>
    <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(79).png?maxW=1126&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=18d67a536e031360c8ecd5482beecb58" alt="" width="1126" height="810" data-path="assets/image (79).png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(79).png?w=280&maxW=1126&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=30f07add6b7c2b5014bfda2dceaeb279 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(79).png?w=560&maxW=1126&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=ca23fd761239804164e2bfd6890a582f 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(79).png?w=840&maxW=1126&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=9d2e54a97aeddda56bc02b0695e65492 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(79).png?w=1100&maxW=1126&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=d22a65f57e6f5b01ac5383f1bc4416bc 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(79).png?w=1650&maxW=1126&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=0bf4f6ad2529c9b009164b931b8424dd 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image%20(79).png?w=2500&maxW=1126&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=9d4c34d64d0621d2c9c9f378349cada2 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Defining function parameters

You can pass any data from upstream steps into your Function as parameters using the key-value table under "What data should be passed in as parameters?". Under "Key", you can give your variable a name and under "Value" you can insert a variable from the variable menu by clicking the dropdown button.

## Writing function code

You can write your custom code in the `yourFunction()` function, which accepts any valid Javascript (ES7). Any data that you `return` from this function can then accessed by downstream steps in your workflow.

You can access parameters defined in the key-value table above by referencing `parameters.<parameter_name>` within `yourFunction()`. For example, a parameter whose key is `email` can be accessed in the function by referencing `parameters.email`.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Writing%20function%20code%20in%20Paragon.gif?maxW=1126&auto=format&n=867oBBVpxd2C3zc4&q=85&s=b538c22893a8f07b5d6fd04953509665" alt="" width="1126" height="690" data-path="assets/Writing function code in Paragon.gif" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Writing%20function%20code%20in%20Paragon.gif?w=280&maxW=1126&auto=format&n=867oBBVpxd2C3zc4&q=85&s=953146e46e731e530a283bf10b4d8c6d 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Writing%20function%20code%20in%20Paragon.gif?w=560&maxW=1126&auto=format&n=867oBBVpxd2C3zc4&q=85&s=0a5ce01e3898bfb518f3008cafa17f50 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Writing%20function%20code%20in%20Paragon.gif?w=840&maxW=1126&auto=format&n=867oBBVpxd2C3zc4&q=85&s=4e9bc7c5c419f8f6c7bda768750b7ace 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Writing%20function%20code%20in%20Paragon.gif?w=1100&maxW=1126&auto=format&n=867oBBVpxd2C3zc4&q=85&s=f59d0363ce10fc1e2b502dfbd7b876eb 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Writing%20function%20code%20in%20Paragon.gif?w=1650&maxW=1126&auto=format&n=867oBBVpxd2C3zc4&q=85&s=190aab02539ad4b95690547a78e151ad 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Writing%20function%20code%20in%20Paragon.gif?w=2500&maxW=1126&auto=format&n=867oBBVpxd2C3zc4&q=85&s=30bf175bf4db09dc8af4087264355703 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Using NPM modules in functions

Paragon provides access to [certain npm modules](/resources/javascript-libraries) that can be used within functions. Here's an example of how you can access the `uuid` npm module within a function.

```js JavaScript
function yourFunction(parameters, libraries) {
  // Generate a uuid with the uuid Javascript library
  const uuid = libraries.uuid;
  const id = uuid.v4();
  return id;
}
```

Note that you'll need to add the `libraries` parameter to `yourFunction()`. If your function needs to work asynchronously, you can declare it `async`.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20npm%20modules%20in%20functions%20in%20Paragon.gif?maxW=1200&auto=format&n=867oBBVpxd2C3zc4&q=85&s=5c3bf9582d545d89d7be427fdba9d10d" alt="" width="1200" height="920" data-path="assets/Using npm modules in functions in Paragon.gif" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20npm%20modules%20in%20functions%20in%20Paragon.gif?w=280&maxW=1200&auto=format&n=867oBBVpxd2C3zc4&q=85&s=e55da03470ca6189085ae39b504f880b 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20npm%20modules%20in%20functions%20in%20Paragon.gif?w=560&maxW=1200&auto=format&n=867oBBVpxd2C3zc4&q=85&s=90cd5cc37fe57afb456a9f876eb587b5 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20npm%20modules%20in%20functions%20in%20Paragon.gif?w=840&maxW=1200&auto=format&n=867oBBVpxd2C3zc4&q=85&s=451a0acb4b94c100c2407d0dc6a90e46 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20npm%20modules%20in%20functions%20in%20Paragon.gif?w=1100&maxW=1200&auto=format&n=867oBBVpxd2C3zc4&q=85&s=56b291669463b73f86e47bd790f2cd86 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20npm%20modules%20in%20functions%20in%20Paragon.gif?w=1650&maxW=1200&auto=format&n=867oBBVpxd2C3zc4&q=85&s=187972169cf44224cda3bf3f4660c32b 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20npm%20modules%20in%20functions%20in%20Paragon.gif?w=2500&maxW=1200&auto=format&n=867oBBVpxd2C3zc4&q=85&s=81d3ec6abb1bf70da316e44aca98e0f5 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can find the full list of supported npm modules in our [Javascript Libraries Catalog](/resources/javascript-libraries). If you don't see the module that you're looking for, [let us know](mailto:team@useparagon.com) and can usually add it for you.

## Considerations

When using Functions, there are a few things to keep in mind:

### Memory Constraints

At the system level, the container that processes workloads is limited by its available resources. Paragon limits step input and output sizes based on your billing plan:

* **Trial**: 50 MB
* **Basic**: 50 MB
* **Pro**: 100 MB
* **Enterprise**: 1 GB

### Time Constraints

Paragon sets time limits for how long Functions can execute based on your billing plan to ensure your workflows run smoothly. If a Function takes longer than allowed, the workflow step will fail.

Here are the maximum execution times by billing plan:

* **Trial**: 1 minute
* **Basic**: 1 minute
* **Pro**: 1 minute
* **Enterprise**: 1 hour


# Smart Rate Limits
Source: https://docs.useparagon.com/workflows/handling-rate-limits

Learn how Workflows automatically recover from integration API rate limits.

## Overview

While building integration logic, you may encounter rate limit errors from upstream APIs if you consume requests faster than the integration provider supports.

Rate limits can be enforced by integration providers for either the requesting user or the requesting application (or both). They can be applied with different schedules (requests per minute, per hour, or per day).

Paragon provides automatic protection from rate limit errors in the form of Smart Rate Limits, adapting to known rate limits from supported providers or rate limiting errors encountered during Workflow executions.

**Example: HubSpot rate limit**

```json 429 Too Many Requests
{
  "status": "error",
  "message": "You have reached your daily limit.",
  "errorType": "RATE_LIMIT"
}
```

## Usage

All Workflows for [supported integrations](/workflows/handling-rate-limits#supported-integrations) will automatically use Smart Rate Limits. No action is required to enable Smart Rate Limits on your account or Workflows.

## How it works

Smart Rate Limits automatically limit the pressure of all requests sent to an API by your Workflows, backing off and retrying when a rate limit is exceeded.

When a Smart Rate Limit is enforced, your workflow will be paused until it is safe to proceed with additional requests.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Task%20History_%20Execution%20View%20(1).png?maxW=2400&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=4d401b90a69b3c108c651e303c0fb902" alt="" width="2400" height="1800" data-path="assets/Task History_ Execution View (1).png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Task%20History_%20Execution%20View%20(1).png?w=280&maxW=2400&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=faf87dd1cb980ef501fb20a770d29b53 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Task%20History_%20Execution%20View%20(1).png?w=560&maxW=2400&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=10b48dc45606d7d0d58a4d62d1449cd2 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Task%20History_%20Execution%20View%20(1).png?w=840&maxW=2400&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=1b0fcd079d981dbaec19f87630789872 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Task%20History_%20Execution%20View%20(1).png?w=1100&maxW=2400&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=2361c7974507b4836c339ded9bdf92b3 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Task%20History_%20Execution%20View%20(1).png?w=1650&maxW=2400&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=fd5c52b0c505296ed7e5e1e2c8bb6eab 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Task%20History_%20Execution%20View%20(1).png?w=2500&maxW=2400&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=117120137f8dd55ac00676c729b88a03 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can see the status of your paused workflow in Task History, along with the scheduled resumption time. When the workflow resumes, it will retry the last request that was suspended or failed.

### Supported integrations

The following integrations have Smart Rate Limits built-in and will respect known rate limits for their APIs. We are actively expanding support for Smart Rate Limits across our complete integrations catalog.

* Gmail
* Google Drive
* Google Sheets
* HubSpot (currently not available for `Search Records` or `Get All Records` actions)
* Jira
* NetSuite
* Notion
* OneDrive
* Outlook
* Salesforce
* Zendesk


# Integration Actions
Source: https://docs.useparagon.com/workflows/integration-actions



**Integration Actions, or just Actions, are the main building blocks of Paragon Workflows.** Paragon's workflow builder provides Actions for each integration provider that allow you to perform operations in your users' apps.

For example, common Actions include:

* Create a Salesforce contact
* Send a Slack message
* Update a Hubspot account
* List Google Calendar events

Paragon provides a simple-to-use UI for configuring and mapping data into each Action - making it easy to use Actions without any prior knowledge of an integration provider's API.

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Slack%20Workflow%20in%20Paragon%20Connect.png?maxW=2094&auto=format&n=867oBBVpxd2C3zc4&q=85&s=39b327561862151335725b19b80863d8" alt="" width="2094" height="1362" data-path="assets/Viewing a Slack Workflow in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Slack%20Workflow%20in%20Paragon%20Connect.png?w=280&maxW=2094&auto=format&n=867oBBVpxd2C3zc4&q=85&s=723e6347949fdf3a9cc7ffb4a34e9eaf 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Slack%20Workflow%20in%20Paragon%20Connect.png?w=560&maxW=2094&auto=format&n=867oBBVpxd2C3zc4&q=85&s=26103ada3256911ea48bc13b1a3da865 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Slack%20Workflow%20in%20Paragon%20Connect.png?w=840&maxW=2094&auto=format&n=867oBBVpxd2C3zc4&q=85&s=0a8030f697145c2f7f7a40b26ff16de2 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Slack%20Workflow%20in%20Paragon%20Connect.png?w=1100&maxW=2094&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7a2cafc503b5c56ce64f32b2c2b8aaa1 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Slack%20Workflow%20in%20Paragon%20Connect.png?w=1650&maxW=2094&auto=format&n=867oBBVpxd2C3zc4&q=85&s=95580e20fccbb962da465e1f98157dfd 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Viewing%20a%20Slack%20Workflow%20in%20Paragon%20Connect.png?w=2500&maxW=2094&auto=format&n=867oBBVpxd2C3zc4&q=85&s=d2d2344d6dd37e443dce54e4ffb02b4a 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Workflow User Settings

In some cases, you may want to provide your users the option to configure certain workflow settings. For example, if you have a Slack workflow that sends notifications to your users' workspaces, you may want to provide them the option of which Slack channel they want to send notifications to.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20in%20your%20Paragon%20Connect%20Portal.png?maxW=1362&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f7c2da777af2644d41ba8b52fe5bfe55" alt="" width="1362" height="1220" data-path="assets/Choosing a Slack channel in your Paragon Connect Portal.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20in%20your%20Paragon%20Connect%20Portal.png?w=280&maxW=1362&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=36215c7ba3c0a3cd04fd77220d2afa71 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20in%20your%20Paragon%20Connect%20Portal.png?w=560&maxW=1362&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=cbb6650ca03e8648e8d1c508ebd17584 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20in%20your%20Paragon%20Connect%20Portal.png?w=840&maxW=1362&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=c4e0486ee098fdcaf1abfc04e19ffbfb 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20in%20your%20Paragon%20Connect%20Portal.png?w=1100&maxW=1362&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f1f27c4110ceb8a7bcbcdf057c2afde5 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20in%20your%20Paragon%20Connect%20Portal.png?w=1650&maxW=1362&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=6334581be4c9176e18623f9ed1aa4423 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20in%20your%20Paragon%20Connect%20Portal.png?w=2500&maxW=1362&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=14aec88a34a402ca4a525400e763078c 2500w" data-optimize="true" data-opv="2" />
</Frame>

Actions in Paragon will indicate when they accept User Settings as an input parameter. In these cases, you should add the respective User Settings in the Connect Portal Editor, then use the **variable menu** by typing two left curly braces `{{` to reference that User Setting in the Action sidebar.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20to%20send%20notifications%20to%20in%20Paragon.gif?maxW=901&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=1e09c61fe162663223b6b2917778dad4" alt="" width="901" height="484" data-path="assets/Choosing a Slack channel to send notifications to in Paragon.gif" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20to%20send%20notifications%20to%20in%20Paragon.gif?w=280&maxW=901&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=3a99bc7a0ce170caa589411bc2cf0cdd 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20to%20send%20notifications%20to%20in%20Paragon.gif?w=560&maxW=901&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=623bd3b7cbc874cda5f7f1b5cb13ae6a 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20to%20send%20notifications%20to%20in%20Paragon.gif?w=840&maxW=901&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=81c313a8c46a9181927d3c03f9e3a4a8 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20to%20send%20notifications%20to%20in%20Paragon.gif?w=1100&maxW=901&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=5aef906cf715db3dd3cbbf3802e5c6a8 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20to%20send%20notifications%20to%20in%20Paragon.gif?w=1650&maxW=901&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=c24625c6c6260e67346ccad534c28497 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Choosing%20a%20Slack%20channel%20to%20send%20notifications%20to%20in%20Paragon.gif?w=2500&maxW=901&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ead575555f6be9347c496b4fff304009 2500w" data-optimize="true" data-opv="2" />
</Frame>

See [Workflow User Settings](/connect-portal/workflow-user-settings) for an in-depth overview of how to configure User Settings and use them in tandem with Actions.

<Card title="User Settings" href="/connect-portal/workflow-user-settings" horizontal />

## Using Actions

For a complete list of all Actions supported by each Integration Provider, see our [Integrations Provider section](/resources/integrations).

<Card title="Integration Providers" href="/resources/integrations" horizontal />


# Workflows
Source: https://docs.useparagon.com/workflows/overview

Workflows allow you to build and automate complex integration logic across your SaaS stack—without managing infrastructure or writing custom code.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflows%20Header.png?maxW=2798&auto=format&n=867oBBVpxd2C3zc4&q=85&s=62c3ea63bec6fa48fe5c3ae91061f493" alt="Page cover image" width="2798" height="874" data-path="assets/Workflows Header.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflows%20Header.png?w=280&maxW=2798&auto=format&n=867oBBVpxd2C3zc4&q=85&s=51b5fdd7dbd6f3a40c69943b3063ee02 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflows%20Header.png?w=560&maxW=2798&auto=format&n=867oBBVpxd2C3zc4&q=85&s=26dd169cecff1772128729c0ff6911e3 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflows%20Header.png?w=840&maxW=2798&auto=format&n=867oBBVpxd2C3zc4&q=85&s=807662f33e7f1f0d3bfcfa9ff0ccf2c5 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflows%20Header.png?w=1100&maxW=2798&auto=format&n=867oBBVpxd2C3zc4&q=85&s=ef0dbde998d4c943bb3a1b963afeedae 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflows%20Header.png?w=1650&maxW=2798&auto=format&n=867oBBVpxd2C3zc4&q=85&s=52dca0bc23ae079983582586db514058 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Workflows%20Header.png?w=2500&maxW=2798&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9dd1d0c4e54b4e76fade292ae27239a2 2500w" data-optimize="true" data-opv="2" />
</Frame>

**Workflows** allow you to automate and orchestrate complex integration logic across your SaaS stack—without managing infrastructure or writing custom code. With Workflows, you can design multi-step automations that connect your app to the tools your users rely on, all through an intuitive builder.

## Build Your Way

Paragon Workflows are designed for ultimate flexibility. You can build and manage workflows in two fully interchangeable ways:

### Workflow Builder (UI)

Use our intuitive drag-and-drop [Workflow Builder](/workflows/building-workflows) to visually create, edit, and manage your automations—no code required.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20the%20Workflow%20Builder.png?maxW=1758&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=2b907f3e3363745101ca5c9512594f1e" alt="Workflow Builder" width="1758" height="1194" data-path="assets/Building Workflows in the Workflow Builder.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20the%20Workflow%20Builder.png?w=280&maxW=1758&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=aa1ff75f3f6ac5c7aa0348bc00adcaaf 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20the%20Workflow%20Builder.png?w=560&maxW=1758&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=ff9ae30354b47f0abc6c06b60f96b8e3 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20the%20Workflow%20Builder.png?w=840&maxW=1758&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=d7ab8a1e176c36c17d7ae1f261946a38 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20the%20Workflow%20Builder.png?w=1100&maxW=1758&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=99a6ffe804f574ff1da8c6129ab6de43 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20the%20Workflow%20Builder.png?w=1650&maxW=1758&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=2d6802e85ff8b92e1eb4e43a8e2d8ed4 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20the%20Workflow%20Builder.png?w=2500&maxW=1758&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=26cea18e51342d41b9d692fc408caad1 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Card title="Explore the Workflow Builder" href="/workflows/building-workflows" horizontal icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right-icon lucide-arrow-right"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg>}>
  Learn more about building workflows in the Workflow Builder.
</Card>

### Paragraph (Code)

Prefer code? Harness the full power of our TypeScript framework, [Paragraph](/paragraph/getting-started), to define workflows programmatically with complete control and flexibility.

<Frame>
    <img src="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20Paragraph.png?maxW=2586&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=55995765fa88261e80f8759259daa679" alt="Paragraph" width="2586" height="1546" data-path="assets/Building Workflows in Paragraph.png" srcset="https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20Paragraph.png?w=280&maxW=2586&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=f8a77645f0b05c3787d72f083b2ced2e 280w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20Paragraph.png?w=560&maxW=2586&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=813eb78c2a6bd5e095eac7277173d10e 560w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20Paragraph.png?w=840&maxW=2586&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=db9a43b82dcb1a0b703a564768b6c3d9 840w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20Paragraph.png?w=1100&maxW=2586&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=9cceae7eeeeacd095fbeaf43cb6567f2 1100w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20Paragraph.png?w=1650&maxW=2586&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=c891ab20c419ec2667ce0ca55ddaaa1e 1650w, https://mintcdn.com/paragon/DkcdqxlytLXlO_-w/assets/Building%20Workflows%20in%20Paragraph.png?w=2500&maxW=2586&auto=format&n=DkcdqxlytLXlO_-w&q=85&s=e19faaaf6f7add36376ac2fcd51d9efe 2500w" data-optimize="true" data-opv="2" />
</Frame>

<Card title="Explore Paragraph" href="/paragraph/getting-started" horizontal icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right-icon lucide-arrow-right"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg>}>
  Learn more about building workflows in Paragraph.
</Card>

You can **switch between the UI and code at any time**. Changes made in one are reflected in the other, so you're never locked into a single approach. Choose the method that fits your workflow, your team, and your preferences.


# Making API Requests
Source: https://docs.useparagon.com/workflows/requests

Making HTTP requests with Paragon

## Overview

You can make requests to any HTTP API using Paragon's Request steps. This is useful for connecting workflows to your application's internal API, the integration's API, or to any REST APIs in general.

## Types of Requests

<CardGroup>
  <Card title="Integration Requests" icon="plug" href="/workflows/requests#making-integration-requests" cta="Learn more" img="/assets/An Integration Request in Paragon.png">
    Make authenticated requests directly to integration providers' APIs using pre-configured connections.
  </Card>

  <Card title="API Requests" icon="globe" href="/workflows/requests#making-api-requests" cta="Learn more" img="/assets/An API Request in Paragon.png">
    Make HTTP requests to any external API or your own application's API. Perfect for external calls and connecting to internal services.
  </Card>
</CardGroup>

## Making Integration Requests

The **Integration Request** is a per-integration step that allows you to make HTTP calls to any endpoint the integration supports. This means you can access actions that aren't yet supported natively by Paragon.

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Integration%20Request%20step%20for%20Slack%20in%20Paragon%20Connect.png?maxW=1934&auto=format&n=867oBBVpxd2C3zc4&q=85&s=a54d6ba036de03b3accb303d8cd0acc7" alt="" width="1934" height="1198" data-path="assets/Using the Integration Request step for Slack in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Integration%20Request%20step%20for%20Slack%20in%20Paragon%20Connect.png?w=280&maxW=1934&auto=format&n=867oBBVpxd2C3zc4&q=85&s=4faf240e1015b2b80766a3068e0c2faf 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Integration%20Request%20step%20for%20Slack%20in%20Paragon%20Connect.png?w=560&maxW=1934&auto=format&n=867oBBVpxd2C3zc4&q=85&s=355cf64343007337e40b771ab40edc38 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Integration%20Request%20step%20for%20Slack%20in%20Paragon%20Connect.png?w=840&maxW=1934&auto=format&n=867oBBVpxd2C3zc4&q=85&s=382ab07fcd17cf2473ec3059a10ed48b 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Integration%20Request%20step%20for%20Slack%20in%20Paragon%20Connect.png?w=1100&maxW=1934&auto=format&n=867oBBVpxd2C3zc4&q=85&s=8938d709a4014d312a9572cb5b4c197b 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Integration%20Request%20step%20for%20Slack%20in%20Paragon%20Connect.png?w=1650&maxW=1934&auto=format&n=867oBBVpxd2C3zc4&q=85&s=4776d7651a909cc61944b83d1ed742c3 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Integration%20Request%20step%20for%20Slack%20in%20Paragon%20Connect.png?w=2500&maxW=1934&auto=format&n=867oBBVpxd2C3zc4&q=85&s=581a2174caf3dffca800d95bf2f9b1b6 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Configuring the Authentication

We've got you covered! You can leave out the authentication piece to connect to your integration's API since you've connected using Paragon. We prefix the URL of each integration, so you only have to enter the API endpoint and any parameters.

### Replacing the Base URL

If you need to overwrite the default base URL Paragon provides for any request you make to the integration provider, you can do so by typing `https://` in the input followed by the rest of the URL.

<Frame>
  <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Replacing%20the%20Base%20URL%20for%20an%20integration%20in%20Paragon%20Connect.gif?maxW=1082&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c0e0441c2f1cc66fc1072f133f439e17" alt="" width="1082" height="598" data-path="assets/Replacing the Base URL for an integration in Paragon Connect.gif" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Replacing%20the%20Base%20URL%20for%20an%20integration%20in%20Paragon%20Connect.gif?w=280&maxW=1082&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8d0125212da6d9b15b1ddb67f35290b3 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Replacing%20the%20Base%20URL%20for%20an%20integration%20in%20Paragon%20Connect.gif?w=560&maxW=1082&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8cb54dd567fe6feb732ef51f29fd51ed 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Replacing%20the%20Base%20URL%20for%20an%20integration%20in%20Paragon%20Connect.gif?w=840&maxW=1082&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=f1e4bd9af1301e12aa252feab69128ba 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Replacing%20the%20Base%20URL%20for%20an%20integration%20in%20Paragon%20Connect.gif?w=1100&maxW=1082&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=d4618f04b429745096622f03d03e93e8 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Replacing%20the%20Base%20URL%20for%20an%20integration%20in%20Paragon%20Connect.gif?w=1650&maxW=1082&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=b1a940f9f4bbd7b8dc21387ea9de2d51 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Replacing%20the%20Base%20URL%20for%20an%20integration%20in%20Paragon%20Connect.gif?w=2500&maxW=1082&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=16c1f8570e465132fbea4b8c6775b53f 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Making API Requests

To add a request to your workflow, click the "+" button in the workflow canvas and choose the Request step from the sidebar. You can follow familiar specifications to setup requests in Paragon:

* URL
* Request type
  * `POST`
  * `GET`
  * `PATCH`
  * `PUT`
  * `DELETE`
* Request data
  * Query parameters
  * Headers
  * Body parameters
    * `JSON`
    * `multipart/form-data`
    * `x-www-form-urlencoded`
    * `GraphQL`
    * `XML`
    * `Raw`
  * Authorization
    * `Bearer Token`
    * `Basic Auth`
    * `Query Params`
    * `Auth Header`
    * `OAuth 2.0 Client Credentials`
    * `OAuth 2.0 Refresh Token`
    * `ROPC Access Token`

### Configuring your Request URL

You can enter the request URL in the input under "**Request URL"**. You can also include parameters as part of the URL by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Including%20parameters%20in%20a%20URL%20request%20in%20Paragon.png?maxW=2250&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=f753f8f9faacd1becc99b16a2df4816f" alt="" width="2250" height="558" data-path="assets/Including parameters in a URL request in Paragon.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Including%20parameters%20in%20a%20URL%20request%20in%20Paragon.png?w=280&maxW=2250&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7fffb78c0d7a2f9747dd3d20db112f83 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Including%20parameters%20in%20a%20URL%20request%20in%20Paragon.png?w=560&maxW=2250&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=f7cca596adf682f423ff35179fde0e22 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Including%20parameters%20in%20a%20URL%20request%20in%20Paragon.png?w=840&maxW=2250&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=8a8f1c1de44f5389eac924a130c20c5c 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Including%20parameters%20in%20a%20URL%20request%20in%20Paragon.png?w=1100&maxW=2250&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=20d8fba2dc79bba8dbc332dcb2f2a660 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Including%20parameters%20in%20a%20URL%20request%20in%20Paragon.png?w=1650&maxW=2250&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=03e4ccc965f6ebabb581cbaae0b9bba2 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Including%20parameters%20in%20a%20URL%20request%20in%20Paragon.png?w=2500&maxW=2250&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1d283a8648b9ff611ae3a5c12d8b531a 2500w" data-optimize="true" data-opv="2" />
</Frame>

The **variable menu** allows you to reference data from upstream steps in your request URL. For example, we can pass a `userId` from the Trigger into the request URL, which is represented as: `/users/{{1.event.userId}}`

### Sending data in a request

Query parameters, headers, and body parameters can be included in the request by adding them in the key-value table under their respective heading.

<Frame>
    <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20a%20JSON%20request%20in%20Paragon.gif?maxW=964&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=4fbb4b25c6e6c672f2def0e8e633dd5b" alt="" width="964" height="487" data-path="assets/Sending a JSON request in Paragon.gif" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20a%20JSON%20request%20in%20Paragon.gif?w=280&maxW=964&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=c0acc9330e0d9dd081f8c04d1ad941bc 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20a%20JSON%20request%20in%20Paragon.gif?w=560&maxW=964&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=abf5b5c6646a4f368efb1f256ea362ec 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20a%20JSON%20request%20in%20Paragon.gif?w=840&maxW=964&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=760a6252e64d09122212b67a5851ed57 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20a%20JSON%20request%20in%20Paragon.gif?w=1100&maxW=964&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=554f1ce53481c24ab9691bad6f4f1242 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20a%20JSON%20request%20in%20Paragon.gif?w=1650&maxW=964&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=c7ed77244b6b353fc5446713aa982a4e 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20a%20JSON%20request%20in%20Paragon.gif?w=2500&maxW=964&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=8c29c920e7bb317d1d984ddca30ef2de 2500w" data-optimize="true" data-opv="2" />
</Frame>

When using the key-value table, you can type in **static values** or **reference variables** from upstream steps by invoking the variable menu using the dropdown button.

### Sending JSON in a request

You can easily send JSON in a request by choosing `Raw` in the dropdown to the right of Body. When creating the raw JSON body, you can type in **static values** or **reference variables** from upstream steps by typing `{{` to invoke the variable menu.

<Frame>
    <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20nested%20JSON%20through%20a%20Request%20step%20in%20Paragon.png?maxW=1938&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=807fc1151bf32a0d6e9da7bef7edb720" alt="" width="1938" height="736" data-path="assets/Sending nested JSON through a Request step in Paragon.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20nested%20JSON%20through%20a%20Request%20step%20in%20Paragon.png?w=280&maxW=1938&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=d9d240e1271e9c00306c655afcdee24e 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20nested%20JSON%20through%20a%20Request%20step%20in%20Paragon.png?w=560&maxW=1938&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=cbbe7d1902775432b822bb202b48d2c6 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20nested%20JSON%20through%20a%20Request%20step%20in%20Paragon.png?w=840&maxW=1938&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=909580c00099af83e74c838d53ad9ec3 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20nested%20JSON%20through%20a%20Request%20step%20in%20Paragon.png?w=1100&maxW=1938&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=fc57242c102ba078bf3bab19f46227a8 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20nested%20JSON%20through%20a%20Request%20step%20in%20Paragon.png?w=1650&maxW=1938&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=fc2f38cbb6464b5389cb115702d63923 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20nested%20JSON%20through%20a%20Request%20step%20in%20Paragon.png?w=2500&maxW=1938&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=f7f32c11f714c0ed03d18aebd54db65a 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Sending File Data in a request

You can send file data in a request by adding a `X-Paragon-Encoding` header. The encoding should be set to encoding used in the file, like `hex`.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20files%20to%20your%20application%20in%20Paragon%20Connect.png?maxW=2198&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=90bed1a344b4e23a67795f7986f4830b" alt="" width="2198" height="1210" data-path="assets/Sending files to your application in Paragon Connect.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20files%20to%20your%20application%20in%20Paragon%20Connect.png?w=280&maxW=2198&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=6504b0724c0de316200a1ff147da6c3b 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20files%20to%20your%20application%20in%20Paragon%20Connect.png?w=560&maxW=2198&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=6bd8e1e9a0c0e2f7ccb7d9d0f76f383b 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20files%20to%20your%20application%20in%20Paragon%20Connect.png?w=840&maxW=2198&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=f2b61662cc8fe682ec087ebc70451422 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20files%20to%20your%20application%20in%20Paragon%20Connect.png?w=1100&maxW=2198&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=cb248910138230a46a2d7a133dbd24a3 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20files%20to%20your%20application%20in%20Paragon%20Connect.png?w=1650&maxW=2198&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=88c0d6fa9baeb52de35be8f23e694221 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20files%20to%20your%20application%20in%20Paragon%20Connect.png?w=2500&maxW=2198&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=26ae49fb625c24e1d09778b3bfbb0b74 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Handling request failures

You can choose whether or not the workflow should continue to the next step if the request fails under "Continue workflow if request fails". This option is useful if you want to conditionally handle request failures. You can do this by adding a Conditional step after the Request step, then referencing the request's response status code in the Conditional.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20request%20failures%20with%20a%20conditional%20step%20in%20Paragon.png?maxW=2736&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=58fe9c62b67230b602f3e5c0804d278a" alt="" width="2736" height="952" data-path="assets/Handling request failures with a conditional step in Paragon.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20request%20failures%20with%20a%20conditional%20step%20in%20Paragon.png?w=280&maxW=2736&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=6bdfed3e26d98f9c3fab46003d717f4b 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20request%20failures%20with%20a%20conditional%20step%20in%20Paragon.png?w=560&maxW=2736&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=07cf3a5c5fa220467acae5c5b6b59ec7 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20request%20failures%20with%20a%20conditional%20step%20in%20Paragon.png?w=840&maxW=2736&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=16f4b24e91e12cc5703ae8c3e331a581 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20request%20failures%20with%20a%20conditional%20step%20in%20Paragon.png?w=1100&maxW=2736&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0f1947694d4bdb8aa1e3b6fb78ec930b 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20request%20failures%20with%20a%20conditional%20step%20in%20Paragon.png?w=1650&maxW=2736&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=b4abf9300b08489e3b6a60b3e9d486a1 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Handling%20request%20failures%20with%20a%20conditional%20step%20in%20Paragon.png?w=2500&maxW=2736&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7bb872a8601c6647c9b948a23cf86f18 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Request Pagination
Source: https://docs.useparagon.com/workflows/requests/request-pagination

Configuring requests for data that span multiple pages.

Integration APIs commonly enforce limits for how many results can be returned in a single request. When you need to access more results, the API will provide a value in the response to use in your next request to get the next page of results.

Our native [Integration Actions](/workflows/integration-actions) use pagination automatically, but Request and Integration Request steps can also be configured to page across multiple requests.

Request steps with Pagination will wait until all requests for data have been completed before proceeding in the workflow.

## Configuring Pagination

[Some native Paragon integrations](/workflows/requests/request-pagination#integrations-supporting-pre-configured-pagination) include pre-configured pagination. For these integrations, toggling **Pagination** will enable the pre-configured strategy, and you can optionally configure the Limit, Skip, and Previous Page options.

* **Limit:** Specify a numerical record limit of records to fetch.
* **Skip:** Specify a numerical record offset indicating where to start request pagination.
* **Previous Page:** Specify a page token indicating where to start request pagination.

<Frame>
  <img src="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-31%20at%2010.12.56.png?maxW=1281&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=a383614d0efbf1ada23f24270f3d7d80" alt="" width="1281" height="911" data-path="assets/CleanShot 2024-10-31 at 10.12.56.png" srcset="https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-31%20at%2010.12.56.png?w=280&maxW=1281&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=aa299f2c9f10cf4235a2658144b854c0 280w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-31%20at%2010.12.56.png?w=560&maxW=1281&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=a5938f7f0cdc381d864616a296b2fdf4 560w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-31%20at%2010.12.56.png?w=840&maxW=1281&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=8371cf00870d189a036553960a6158b9 840w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-31%20at%2010.12.56.png?w=1100&maxW=1281&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=472d3ccead6f749f24728b775744952b 1100w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-31%20at%2010.12.56.png?w=1650&maxW=1281&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=ed1e2e77c9888792570e6be970185b96 1650w, https://mintcdn.com/paragon/XNDe-bFT_2yOxy1A/assets/CleanShot%202024-10-31%20at%2010.12.56.png?w=2500&maxW=1281&auto=format&n=XNDe-bFT_2yOxy1A&q=85&s=2dde75c01d5f07cc55f6bb6fb2569624 2500w" data-optimize="true" data-opv="2" />
</Frame>

For integrations that do not support pre-configured pagination, you can still configure your request with [Custom Pagination](/workflows/requests/request-pagination#custom-pagination).

### Custom Pagination

Before configuring Custom Pagination, press Test Step in your Request to make sure that you have Test Data to work with. This will be required to select fields from the output to configure subsequent, paginated requests.

After confirming that this step has Test Data, turn on the **Pagination** switch (below Authorization) for the Request step.

Custom Pagination requires you to configure 3 values:

* **Output**: Select the field from Test Data that represents a single page of results. Output must be an Array-type value, which will be aggregated across the paginated requests.
* **Page Token**: Select a field from Test Data to use as a parameter for subsequent requests.
* **Stop When**: Specify a condition for when request pagination should end. For example, "`.nextPageToken` Is `null`".

Finally, you'll need to use the **Page Token** value in the Request step configuration to make paginated requests fetch the next page of available data.

For example, if the API expects you to pass the Page Token as a query parameter called `cursor`, you can add this parameter to your request with the value `{{self.pageToken}}`.

<Frame>
  <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Pagination%20Example.png?maxW=2218&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=12c14ae030e8785257f9e6a9324cc35d" alt="" width="2218" height="1706" data-path="assets/Pagination Example.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Pagination%20Example.png?w=280&maxW=2218&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1196676c78524184abc9aafabe80f4a2 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Pagination%20Example.png?w=560&maxW=2218&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=e583187ab3f08a626b2c31acd04db8bf 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Pagination%20Example.png?w=840&maxW=2218&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=a19a35f55bef55fa240d61afd2d893a6 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Pagination%20Example.png?w=1100&maxW=2218&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=3121fd95e20bb85978ead85b48e1e74b 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Pagination%20Example.png?w=1650&maxW=2218&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=9a48074160caa62d960754775833fe2f 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Pagination%20Example.png?w=2500&maxW=2218&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c60b5ebf37c2e9eb05937beb2f64844d 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Testing

You can test your Request Pagination by clicking Test Step after configuring the above options.

In test mode, Request steps will only attempt to page once after the initial request. Verify that your request is paging correctly by checking the output array.

## Auto-Retry and Errors

Requests that use Pagination will automatically attempt to retry requests that fail due to rate limits with an exponential backoff strategy.

If pagination cannot continue, then the step will provide the partial set of results that it successfully requested alongside the final error that occurred before the Request step.

**Example output:**

```json
{
    "response": {
        "results": [...],
        "error": {
            "message": "401 - Unauthorized"
        }
    }
}
```

To handle errors from Request steps using Pagination, you can use a Conditional step to check for the presence of the `error` field before continuing the workflow.

## Task Usage

Each page fetched in a Request step with Pagination configured will consume 1 task. For example, a Request that uses 150 requests to fully page through your user's data will consume 150 tasks.

You can configure your request to use larger page sizes (as allowed by the integration) to reduce the number of tasks that your Request step consumes.

## Tutorial: Using Pagination for Slack channels

As an example of configuring Request Pagination, we'll implement a workflow that uses Slack's API to get all channels from a Slack workspace.

The API endpoint we will use is `conversations.list` ([see Slack documentation](https://api.slack.com/methods/conversations.list)).

Slack allows for a maximum of 1000 channels to be retrieved at a time, but recommends no more than 200:

> This method uses cursor-based pagination to make it easier to incrementally collect information. To begin pagination, specify a `limit` value under `1000`. We recommend no more than `200` results at a time.
>
> Responses will include a top-level `response_metadata` attribute containing a `next_cursor` value. By using this value as a `cursor` parameter in a subsequent request, along with `limit`, you may navigate through the collection page by virtual page.

1. Start by creating a Slack Request step in a workflow and configuring it to use `conversations.list` in the URL.

   <Frame>
     <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Screen%201.png?maxW=2214&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=1434eacafa01e7d0f77a531c787f138f" alt="" width="2214" height="1664" data-path="assets/Slack Pagination Tutorial - Screen 1.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Screen%201.png?w=280&maxW=2214&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=2e27d2a544f1266cc1db282325f25796 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Screen%201.png?w=560&maxW=2214&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=327d598f2df2b2d6281d8f5d366827a7 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Screen%201.png?w=840&maxW=2214&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=58671191c175efefe7d2f97d8467ec74 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Screen%201.png?w=1100&maxW=2214&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=a82dec2b8f9200f24528a1835f2885cb 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Screen%201.png?w=1650&maxW=2214&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=dd41251c830e08884590d48d66d224e0 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Screen%201.png?w=2500&maxW=2214&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=449cbe87853ffd830f359f37bc96db90 2500w" data-optimize="true" data-opv="2" />
   </Frame>

   Click **Test Step** to see the output of this step and confirm that you see Slack channels from your connected Preview account.

2. Next, turn on Pagination. You will see 3 new fields appear to configure: Output, Page Token, and Stop When.

   1. Set **Output** to the array of channel results by clicking on the Output field and using `{{` to open the variable menu. Select the `response.body.channels` field from Test Data.

      <Frame>
        <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Select%20Output.png?maxW=1342&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=6a72e83e91fe0e7383cf6086d42d368b" alt="" width="1342" height="912" data-path="assets/Slack Pagination Tutorial - Select Output.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Select%20Output.png?w=280&maxW=1342&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=426eb76dea0558d1037a8cec043dd5e2 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Select%20Output.png?w=560&maxW=1342&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=b3ae90a617750dfa5ddd673e11646b1c 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Select%20Output.png?w=840&maxW=1342&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=f6274bbf185dd5c29672fd30c667542c 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Select%20Output.png?w=1100&maxW=1342&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=1da8228dc360d0c4e50299e37f307a51 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Select%20Output.png?w=1650&maxW=1342&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=dfa29bff8d1dde9d676e846f5f893f66 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Select%20Output.png?w=2500&maxW=1342&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=577194258d1a1fa54d28ad012fe2477d 2500w" data-optimize="true" data-opv="2" />
      </Frame>

   2. Set **Page Token** to the field that will be used as the "cursor" field of the request. Slack returns the result in `response.body.response_metadata.next_cursor`, as mentioned in their documentation quoted above.

   3. Set **Stop When** to "`response.body.response_metadata.next_cursor` does not exist". This means that we will stop paging for additional results when Slack does not send us a `next_cursor` value in the last response.

3. According to the Slack documentation quoted above, we can request the next page with the `cursor` query parameter. Add `cursor` to the **URL Parameters** and use `{{` to open the variable menu and set the value to **Page Token**.

   <Frame>
     <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Page%20Token.png?maxW=1226&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=40049411de6ee26fe6dcf1412bd4790e" alt="" width="1226" height="950" data-path="assets/Slack Pagination Tutorial - Page Token.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Page%20Token.png?w=280&maxW=1226&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=5172eb41a42bc8fc4654dd4ff9fb01f2 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Page%20Token.png?w=560&maxW=1226&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=ac9ba5b8e69f103d00c3b7fb4abd227b 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Page%20Token.png?w=840&maxW=1226&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=8216bb82f9e4650cc93d928263cdfa43 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Page%20Token.png?w=1100&maxW=1226&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=14071ee5cc4a0f70ee28970702e9f946 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Page%20Token.png?w=1650&maxW=1226&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=9981827af8c7f2c1335e5af29875701a 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Slack%20Pagination%20Tutorial%20-%20Page%20Token.png?w=2500&maxW=1226&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=86d0b3d57a4b9bfbd8de88127b6efab7 2500w" data-optimize="true" data-opv="2" />
   </Frame>

4. Test the step again to verify that pagination is working as intended. Any errors that occur during pagination will appear in Test Data.

## Integrations Supporting Pre-configured Pagination

* Asana
* Salesforce
* SharePoint
* Dynamics Business Central
* Dynamics 365 Finance
* Dynamics 365 Sales
* Microsoft Teams
* Outlook
* OneDrive
* Azure DevOps
* Jira


# Triggering Workflows
Source: https://docs.useparagon.com/workflows/triggers

Triggering workflows in Paragon

**All Paragon workflows start with a trigger**, which determines when the workflow will run and how data is passed into the workflow.

Click into any of the triggers below to learn more about the trigger type and how to configure it for your workflow.

<CardGroup cols={2}>
  <Card title="App Event" href="/workflows/triggers/app-events">
    Use one event from your app to trigger workflow(s) across any integrations.

    <br />**Example**: "Contact Created" event from your app routes to Salesforce, HubSpot, or Pipedrive (depending on what integrations are connected)
  </Card>

  <Card title="Request" href="/workflows/triggers/request-trigger">
    Send an HTTP request from your app to a specific integration and workflow, optionally receiving a synchronous response.

    <br />**Example**: Expose an HTTP endpoint to a workflow that searches Google Drive documents and returns results to your app.
  </Card>

  <Card title="Integration Trigger" href="/workflows/triggers/integration-trigger">
    Listen for events from your users' integrations, using our prebuilt triggers or [Custom Webhooks](/resources/custom-webhooks).

    <br />**Example**: Listen for new contacts that are created in your user's Salesforce account.
  </Card>

  <Card title="Integration Enabled" href="/workflows/triggers/integration-enabled-trigger">
    Trigger a workflow when an integration is initially connected and set up by your user.

    <br />**Example**: Create custom fields in your user's HubSpot account after they have connected the integration.
  </Card>

  <Card title="Scheduler" href="/workflows/triggers/scheduler-trigger">
    Trigger a workflow on a recurring schedule.

    <br />**Example**: Every day at 12:00 AM, export all Pipedrive activities that were created in the last 24 hours and send them to your app.
  </Card>

  <Card title="API Resource Trigger" href="/workflows/triggers/api-resource-trigger">
    Listen for webhooks from your configured [Resources](/workflows/api-resources), such as your internal API.

    <br />**Example**: Listen for a User Created webhook to fire from your app.
  </Card>
</CardGroup>


# API Resource Trigger
Source: https://docs.useparagon.com/workflows/triggers/api-resource-trigger

Trigger workflows with your existing webhooks API

API Resource Triggers are triggers configured to use your API's webhooks to start workflows. To use this trigger, you must have an API Resource configured: [API Resources](/workflows/api-resources).

## Defining an API Resource Trigger

To start creating an API Resource Trigger, open your Resource in the dashboard and click **Create Trigger**.

<Frame>
  <img src="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image.png?maxW=3337&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=954e1ea2a751613b8b8e9683bff1d67b" alt="" width="3337" height="1480" data-path="assets/image.png" srcset="https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image.png?w=280&maxW=3337&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=88fa874ec3ab600b9ed0362426dc4983 280w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image.png?w=560&maxW=3337&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=2b9bb18c94ae44b28ad64aaee8f4c8a6 560w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image.png?w=840&maxW=3337&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=c048e0d80ea1f0d232ecc1dd02701a21 840w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image.png?w=1100&maxW=3337&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=4c888ef48e372be3ec8d56e7cf540c14 1100w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image.png?w=1650&maxW=3337&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=754ca99ac323a4901a1dafc478c18d89 1650w, https://mintcdn.com/paragon/VPMcg_H0p5RWAFJc/assets/image.png?w=2500&maxW=3337&auto=format&n=VPMcg_H0p5RWAFJc&q=85&s=6efef27bf85ff6a78480b5914faa1b0a 2500w" data-optimize="true" data-opv="2" />
</Frame>

The Custom Webhook setup page will open and prompt you to define the trigger setup details. See more about how to use the Custom Webhook setup here: [Custom Webhooks](/resources/custom-webhooks)

## Using an API Resource Trigger

To use an API Resource Trigger in a workflow, click your Resource name in the trigger types and select the trigger that you defined.

<Note>
  **Note:** Only fully-configured triggers that have completed the Custom Webhook setup will appear in this menu.
</Note>

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(1).png?maxW=3133&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=89f50723df757ccd4465a785e03b7bba" alt="" width="3133" height="1946" data-path="assets/image (1).png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(1).png?w=280&maxW=3133&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=a9daf6752ee164c800e3ec8c767e2dc8 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(1).png?w=560&maxW=3133&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ed98699a4cd77fdbffbeadc9bb19e763 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(1).png?w=840&maxW=3133&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=898f22bad9cdb3d97040103a5acfb9da 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(1).png?w=1100&maxW=3133&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=83972f3a7f3b2f7ea178b0d6d9db07bb 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(1).png?w=1650&maxW=3133&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=e03c2b34b391053e455dad231f098596 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/image%20(1).png?w=2500&maxW=3133&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=8380710330ce93492095b6f3970bfbf0 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Webhook Subscriptions

For user-level API Resource triggers, the webhook will subscribe when a Connected User has successfully established a Resource Connection via [`connectAction`](/workflows/api-resources#connecting-resources) in the SDK and has enabled at least one workflow which is triggered by an API Resource trigger.

The webhook subscription will only be created once per unique API Resource trigger type. However, one webhook event can trigger multiple workflows connected to the same trigger type.


# App Events
Source: https://docs.useparagon.com/workflows/triggers/app-events



App Events are custom events that are sent programmatically from your application via the Paragon SDK or API to trigger Workflows. In general, App Events are useful for triggering workflows that map data from your application to your users' apps.

For example, you might send a "Contact Created" App Event from your application to trigger a Workflow that creates a matching contact in your users' Salesforce CRM.

**Once defined, an App Event can be used to trigger multiple workflows.** This is useful in cases where you may want the same event to trigger similar workflows across different integrations.

For example, the same "Contact Created" event in the above example could trigger one workflow that creates a contact in Salesforce, and another workflow that creates a contact in HubSpot. This allows you to easily provide the same integration functionality across different providers without any additional engineering.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20an%20App%20Event%20for%20multiple%20workflows%20in%20Paragon.png?maxW=2118&auto=format&n=867oBBVpxd2C3zc4&q=85&s=25a62a003a43be2bf856b4bb981ae50f" alt="" width="2118" height="1634" data-path="assets/Using an App Event for multiple workflows in Paragon.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20an%20App%20Event%20for%20multiple%20workflows%20in%20Paragon.png?w=280&maxW=2118&auto=format&n=867oBBVpxd2C3zc4&q=85&s=a02e906ed22c3d9afd98732b30f26162 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20an%20App%20Event%20for%20multiple%20workflows%20in%20Paragon.png?w=560&maxW=2118&auto=format&n=867oBBVpxd2C3zc4&q=85&s=ab88ba07bb1423a99c6fc0d56317a28f 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20an%20App%20Event%20for%20multiple%20workflows%20in%20Paragon.png?w=840&maxW=2118&auto=format&n=867oBBVpxd2C3zc4&q=85&s=124d3aba44cb7db84d867fa58b39d716 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20an%20App%20Event%20for%20multiple%20workflows%20in%20Paragon.png?w=1100&maxW=2118&auto=format&n=867oBBVpxd2C3zc4&q=85&s=30a2d028ef2a2adc83f2a50e2c011c94 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20an%20App%20Event%20for%20multiple%20workflows%20in%20Paragon.png?w=1650&maxW=2118&auto=format&n=867oBBVpxd2C3zc4&q=85&s=213597cbbe8efd44cee4723b7b4af5c4 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20an%20App%20Event%20for%20multiple%20workflows%20in%20Paragon.png?w=2500&maxW=2118&auto=format&n=867oBBVpxd2C3zc4&q=85&s=8400a7f55d3c504cabe9bb9932279639 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Creating an App Event

To create an App event, select the **App Event** trigger type in the Workflow editor and choose "Create new app event" in the menu under **Choose an App Event**.

Next, enter the name and event schema of your App Event. The **event schema** that you enter here should be an example payload sent from your application to Paragon. The event schema defined here will be used as test data for any workflows triggered by this App Event.

<Note>
  The **event schema** must be a valid JSON object, and can contain <u>any arbitrary JSON</u>.
</Note>

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-15%20at%2012.51.29%20PM.png?maxW=1208&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=8ba49b5c01b197e8e8c5e1dad068cf15" alt="" width="1208" height="1012" data-path="assets/Screen Shot 2021-02-15 at 12.51.29 PM.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-15%20at%2012.51.29%20PM.png?w=280&maxW=1208&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=616829253b3a50cf7b6caba46dec5905 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-15%20at%2012.51.29%20PM.png?w=560&maxW=1208&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=076768840c491fc56ffd307b3a8b6bf3 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-15%20at%2012.51.29%20PM.png?w=840&maxW=1208&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a639e3ba48dfb2ded275790f8b458ac6 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-15%20at%2012.51.29%20PM.png?w=1100&maxW=1208&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=7fe1c2e45cea787adedbeaa1f0039af3 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-15%20at%2012.51.29%20PM.png?w=1650&maxW=1208&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=512e682693429669be6dd98e0b9802dd 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Screen%20Shot%202021-02-15%20at%2012.51.29%20PM.png?w=2500&maxW=1208&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=fe19e3efca3a6d90bc9706271e8e8548 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Sending an App Event

App Events can be sent from your application using the Paragon SDK or REST API. In both cases, you must pass two parameters:

* **name** - the event name defined in your App Event
* **payload** - the event payload that should match the event schema defined in your App Event

See the code examples below for how to send App Events using the Paragon SDK or API.

<Tabs>
  <Tab title="JavaScript SDK">
    ```js
    var eventName = "Contact Created";
    var eventPayload = { "name": "Brandon", "email": "b@useparagon.com" };

    // Called once during your user's session 
    paragon.authenticate("project-id", <Paragon User Token>)

    // Trigger the "Contact Created" App Event
    paragon.event(eventName, eventPayload)
    ```
  </Tab>

  <Tab title="REST API">
    ```bash
    // Trigger the "Contact Created" App Event
    POST https://api.useparagon.com/projects/<Paragon Project ID>/sdk/events/trigger

    Authorization: Bearer <Paragon User Token>
    Content-Type: application/json

    // Body
    { 
        "name": "Contact Created", 
        "payload": { 
            "name": "Brandon", 
            "email": "b@useparagon.com" 
        } 
    }
    ```

    <Note>
      **Note:** You'll receive a `201` response code as confirmation that your event has been successfully received. This is due to the one-to-many nature of these triggers, which means Paragon cannot simultaneously provide all potential responses from the various workflows your event may initiate.
    </Note>
  </Tab>
</Tabs>

Paragon sends a `201` response and does not validate event payloads against the defined schema when your application sends live events, regardless of whether they trigger any workflows.

### Managing App Events

If you need to edit your App Events' name or event schema, you can visit the App Events tab in your Paragon dashboard to view and manage your app events.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20App%20Events%20in%20Paragon.png?maxW=2122&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1603dda3753a303ade1fea5341796d81" alt="" width="2122" height="1344" data-path="assets/Managing App Events in Paragon.png" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20App%20Events%20in%20Paragon.png?w=280&maxW=2122&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=590abddef8e20d06c4a83ae57607248b 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20App%20Events%20in%20Paragon.png?w=560&maxW=2122&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=18204c821429fe0b707e93f2f2d7feef 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20App%20Events%20in%20Paragon.png?w=840&maxW=2122&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=c790b600d583f5f2318acb998e71045e 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20App%20Events%20in%20Paragon.png?w=1100&maxW=2122&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0572096558ba6c6bf8f5c4f0749deefa 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20App%20Events%20in%20Paragon.png?w=1650&maxW=2122&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=4e381c07ab899f1541bb984c3f1e6d5d 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Managing%20App%20Events%20in%20Paragon.png?w=2500&maxW=2122&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=7c13a86552001452ef92a3aad6c32263 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Integration Enabled Trigger
Source: https://docs.useparagon.com/workflows/triggers/integration-enabled-trigger



Integration Enabled triggers can be used to run workflows when a user initially activates your integration. For example, you might want to trigger a workflow that syncs all leads from your customer's CRM to your application once they've enabled the integration.

<Frame>
    <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Triggering%20a%20Paragon%20Connect%20workflow%20once%20the%20integration%20is%20enabled.png?maxW=2256&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=f12ab779f072cc354cf2402d30b20838" alt="" width="2256" height="1422" data-path="assets/Triggering a Paragon Connect workflow once the integration is enabled.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Triggering%20a%20Paragon%20Connect%20workflow%20once%20the%20integration%20is%20enabled.png?w=280&maxW=2256&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=a5e208f2fb970220aac6bb8952e3ff92 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Triggering%20a%20Paragon%20Connect%20workflow%20once%20the%20integration%20is%20enabled.png?w=560&maxW=2256&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=cecae447d13f8b6bc64fe6d7ea7ccc56 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Triggering%20a%20Paragon%20Connect%20workflow%20once%20the%20integration%20is%20enabled.png?w=840&maxW=2256&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=ad0a9cd9b524683bddee7dc8ba33a31d 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Triggering%20a%20Paragon%20Connect%20workflow%20once%20the%20integration%20is%20enabled.png?w=1100&maxW=2256&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=4ac99380ee972394a971b8e8d7614dbf 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Triggering%20a%20Paragon%20Connect%20workflow%20once%20the%20integration%20is%20enabled.png?w=1650&maxW=2256&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=79f84598754320c570b194fef294bd32 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Triggering%20a%20Paragon%20Connect%20workflow%20once%20the%20integration%20is%20enabled.png?w=2500&maxW=2256&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=9fb2c1650c5d164106d3342bbfbe3960 2500w" data-optimize="true" data-opv="2" />
</Frame>

The Integration Enabled trigger will fire when your user connects their integration to an account and they have completed any required [User Settings](/connect-portal/workflow-user-settings) in the Connect Portal.

<Note>
  **Note:** Integration-enabled trigger workflows are displayed as **"Not Enabled"** when viewing users' integrations in the Connected Users Dashboard.

  This status does not affect functionality; the workflow will trigger and execute successfully once activated by the Connected User. You can confirm the workflow’s execution via the [Task History](/monitoring/viewing-task-history) page, though these workflows cannot be replayed.
</Note>


# Integration Trigger
Source: https://docs.useparagon.com/workflows/triggers/integration-trigger



Integration Triggers can be used to run workflows based on events in your users' apps. For example, you might want to trigger a workflow whenever new contacts are created in your users' Salesforce account to sync your users' Salesforce contacts to your application in real-time.

<Frame>
    <img src="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Webhook%20Trigger%20in%20Paragon%20Connect.png?maxW=2134&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=9b47148a15426d6018e4706028afd750" alt="" width="2134" height="1324" data-path="assets/Salesforce Webhook Trigger in Paragon Connect.png" srcset="https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Webhook%20Trigger%20in%20Paragon%20Connect.png?w=280&maxW=2134&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=c9f1bd9d3686d1e1c6467fdb6122da28 280w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Webhook%20Trigger%20in%20Paragon%20Connect.png?w=560&maxW=2134&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=a8bd26c75e138ab1d94012fef6c3da12 560w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Webhook%20Trigger%20in%20Paragon%20Connect.png?w=840&maxW=2134&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=99a3597776f287da9120ea0c660ebac1 840w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Webhook%20Trigger%20in%20Paragon%20Connect.png?w=1100&maxW=2134&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=91a0974b26482f2b4cbd9ee419c88e88 1100w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Webhook%20Trigger%20in%20Paragon%20Connect.png?w=1650&maxW=2134&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=19adff16b037547630400bcc2641a830 1650w, https://mintcdn.com/paragon/cqJFSKyZXJDp3p3z/assets/Salesforce%20Webhook%20Trigger%20in%20Paragon%20Connect.png?w=2500&maxW=2134&auto=format&n=cqJFSKyZXJDp3p3z&q=85&s=47314a5d3a37f0e59c5b547d3bb9e45e 2500w" data-optimize="true" data-opv="2" />
</Frame>

Paragon supports a webhook builder for any integration provider, allowing you to extend your application into any natively supported trigger for any integration.

<Card title="Discover the Webhook Builder" href="/resources/custom-webhooks" horizontal icon={<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="#6747e7" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right-icon lucide-arrow-right"><path d="M5 12h14"/><path d="m12 5 7 7-7 7"/></svg>}>
  Learn more about creating native webhook triggers for any integration.
</Card>

## Pre-Built Integration Triggers

The Paragon team has already created powerful abstractions over the most commonly used triggers for popular integrations, making it easy to get started with the integrations listed below.

<Note>
  **Note**: When webhooks are not supported by an integration, Paragon may use a polling process to detect updates for Integration Triggers. Polling triggers send one request per minute to an account to check on created / updated records.

  Integrations which use polling triggers are marked with ⁺ below.
</Note>

* [Asana](/resources/integrations/asana#using-webhook-triggers)
* [Calendly](/resources/integrations/calendly#using-webhook-triggers)
* [ClickUp](/resources/integrations/clickup#using-webhook-triggers)
* [Close](/resources/integrations/close#using-webhook-triggers)
* [DocuSign](/resources/integrations/docusign#using-webhook-triggers)
* [Dropbox](/resources/integrations/dropbox#using-webhook-triggers)⁺
* [Dynamics 365 CRM](/resources/integrations/microsoft-dynamics-365#using-webhook-triggers)⁺
* [Dynamics 365 Business Central](/resources/integrations/dynamicsbusinesscentral#using-webhook-triggers)
* [GitHub](/resources/integrations/github#using-webhook-triggers)
* [Gmail](/resources/integrations/gmail#using-webhook-triggers)
* [Google Calendar](/resources/integrations/google-calendar#using-webhook-triggers)⁺
* [Google Drive](/resources/integrations/google-drive#using-webhook-triggers)⁺
* [Google Sheets](/resources/integrations/google-sheets#using-webhook-triggers)⁺
* [Greenhouse](/resources/integrations/greenhouse#using-webhook-triggers)
* [HubSpot](/resources/integrations/hubspot#using-webhook-triggers)
* [Intercom](/resources/integrations/intercom#using-webhook-triggers)
* [Jira](/resources/integrations/jira#using-webhook-triggers)⁺
* [Lever](/resources/integrations/lever#using-webhook-triggers)⁺
* [Linear](/resources/integrations/linear#using-webhook-triggers)
* [Mailchimp](/resources/integrations/mailchimp#using-webhook-triggers)
* [Marketo](/resources/integrations/marketo#using-webhook-triggers)⁺
* [Microsoft Outlook](/resources/integrations/outlook#using-webhook-triggers)⁺
* [Microsoft Teams](/resources/integrations/microsoft-teams#using-webhook-triggers)⁺
* [Monday.com](/resources/integrations/monday#using-webhook-triggers)
* [Notion](/resources/integrations/notion#using-webhook-triggers)⁺
* [OneDrive](/resources/integrations/onedrive#using-webhook-triggers)
* [Outreach](/resources/integrations/outreach#using-webhook-triggers)⁺
* [Pardot](/resources/integrations/pardot#using-webhook-triggers)⁺
* [Pipedrive](/resources/integrations/pipedrive#using-pipedrive-triggers)⁺for Lead Created trigger
* [QuickBooks](/resources/integrations/quickbooks#using-webhook-triggers)⁺
* [Sage Intacct](/resources/integrations/sage-intacct#using-webhook-triggers)⁺
* [Salesforce](/resources/integrations/salesforce#using-webhook-triggers)⁺
* [Salesloft](/resources/integrations/salesloft#using-webhook-triggers)
* [Sharepoint](/resources/integrations/sharepoint#using-webhook-triggers)⁺
* [Shopify](/resources/integrations/shopify#using-webhook-triggers)
* [Slack](/resources/integrations/slack#using-webhook-triggers)
* [Trello](/resources/integrations/trello#using-webhook-triggers)
* [Xero](/resources/integrations/xero#using-webhook-triggers)⁺
* [Zendesk](/resources/integrations/zendesk#using-webhook-triggers)
* [Zoho CRM](/resources/integrations/zohocrm#using-webhook-triggers)⁺
* [Zoom](/resources/integrations/zoom#using-webhook-triggers)


# Request Trigger
Source: https://docs.useparagon.com/workflows/triggers/request-trigger



The Request trigger can be used to run workflows by sending it an **HTTP request or webhook**. Request triggers allow passing data from the incoming HTTP request into the workflow.

* **Example:** when a lead is created in your app, send lead data to your customer's CRM and provide a custom response upon success.

Request triggers can also be used to create API Endpoints that send synchronous results back to your app. For more about sending results, see [Sending a Response](/workflows/triggers/request-trigger#sending-a-response).

* **Example:** expose an endpoint that gets called by your app to pull contacts from their CRM.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Request%20Trigger%20in%20Paragon%20Connect.png?maxW=1680&auto=format&n=867oBBVpxd2C3zc4&q=85&s=b3508279c33fa8664893fd38d207b8ba" alt="" width="1680" height="1644" data-path="assets/Using the Request Trigger in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Request%20Trigger%20in%20Paragon%20Connect.png?w=280&maxW=1680&auto=format&n=867oBBVpxd2C3zc4&q=85&s=8c1de20bc03fc6d9f0da4310392c0986 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Request%20Trigger%20in%20Paragon%20Connect.png?w=560&maxW=1680&auto=format&n=867oBBVpxd2C3zc4&q=85&s=1c341ee781daafe830e4bb233f03c16b 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Request%20Trigger%20in%20Paragon%20Connect.png?w=840&maxW=1680&auto=format&n=867oBBVpxd2C3zc4&q=85&s=4d802d8480f4b522aa4247ae8eeadf77 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Request%20Trigger%20in%20Paragon%20Connect.png?w=1100&maxW=1680&auto=format&n=867oBBVpxd2C3zc4&q=85&s=4c8c53691292b5e8ce41a92adec4ce33 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Request%20Trigger%20in%20Paragon%20Connect.png?w=1650&maxW=1680&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9f935983a445a1a0844f4af09af4c38b 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20the%20Request%20Trigger%20in%20Paragon%20Connect.png?w=2500&maxW=1680&auto=format&n=867oBBVpxd2C3zc4&q=85&s=c4ff36069741622688b7d25982a8a454 2500w" data-optimize="true" data-opv="2" />
</Frame>

Request-triggered workflows can be triggered by sending an HTTP `POST` request to their unique URL. You can manually enter the expected query parameters (Params), headers (Headers), and body parameters (Body) to use as variables by other steps in the workflow.

<Tabs>
  <Tab title="JavaScript SDK">
    ```js
    // Called once during your user's session 
    paragon.authenticate("project-id", <Paragon User Token>)

    // Trigger the "Lead Created" workflow
    await paragon.workflow("<workflow_id>", {
      "query": {
        },
      "headers": {
        "Content-Type": "application/json"
      },
      "body": {
        "email": "bowie@useparagon.com",
        "first_name": "Bowie",
        "last_name": "Foo"
      }
    });
    ```
  </Tab>

  <Tab title="REST API">
    ```bash
    // Trigger the "Lead Created" Workflow
    POST https://zeus.useparagon.com/projects/<Paragon Project ID>/sdk/triggers/<Workflow ID>

    Authorization: Bearer <Paragon User Token>
    Content-Type: application/json

    // Body
    {
      "email": "bowie@useparagon.com",
      "first_name": "Bowie",
      "last_name": "Foo
    }
    ```
  </Tab>
</Tabs>

### Defining Test Data

There are two ways to define what data you expect to be sent by incoming requests to the workflow:

* **Manually entering the expected request data**
* **Automatically detecting data by sending a test request**

**Manually entering request data** is usually the best option if you know what data will be sent by the incoming request (e.g. you're sending it from your own app). This option allows you to manually enter the expected query parameters (Params), headers (Headers), and body parameters (Body). Any data entered here can be used as variables by other steps in the workflow.

<Frame>
    <img src="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Manually%20Entering%20Request%20Data%20in%20Paragon.gif?maxW=970&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=b9540a4002763d73f82eb35f22293eda" alt="" width="970" height="832" data-path="assets/Manually Entering Request Data in Paragon.gif" srcset="https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Manually%20Entering%20Request%20Data%20in%20Paragon.gif?w=280&maxW=970&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=acc65e4dfea6ff8879e24c4867566bce 280w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Manually%20Entering%20Request%20Data%20in%20Paragon.gif?w=560&maxW=970&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=1b157e545ca2503f1ad47715c2d976c3 560w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Manually%20Entering%20Request%20Data%20in%20Paragon.gif?w=840&maxW=970&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=a8e48202d87d0e17c3c3a072f72e2ba0 840w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Manually%20Entering%20Request%20Data%20in%20Paragon.gif?w=1100&maxW=970&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=71b73a36eaa20548dc96619aa44c641b 1100w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Manually%20Entering%20Request%20Data%20in%20Paragon.gif?w=1650&maxW=970&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=0ce6f7dd3b19b1616c5f070ebc00fe38 1650w, https://mintcdn.com/paragon/7RZyQGncIlY8Xl4A/assets/Manually%20Entering%20Request%20Data%20in%20Paragon.gif?w=2500&maxW=970&auto=format&n=7RZyQGncIlY8Xl4A&q=85&s=54e14d31adea233438b8c87da02b8b91 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can also choose to validate the incoming request data. For example, you can enforce that query parameters should be required, that headers should match an expected value, or that body parameters should match an expected type. If the incoming request doesn't meet your workflow's validation rules, the workflow will automatically return an error response.

**Automatically detecting data from a test request** is usually the best option if you have a large amount of data to pass through. When you choose this option, the test shelf will appear and display a test URL at the bottom of the step sidebar. By sending a request to the test URL, Paragon will automatically detect data from the request and display it in the test shelf. Here, it'll be saved as test data that can be used as variables by other steps in the workflow.

<Frame>
    <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20a%20trigger%20in%20Paragon.gif?maxW=850&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=119f59b6eb02886e79fa7c8dcb1c94ed" alt="" width="850" height="800" data-path="assets/Testing a trigger in Paragon.gif" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20a%20trigger%20in%20Paragon.gif?w=280&maxW=850&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=24140230861925aa609b93d1e733a852 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20a%20trigger%20in%20Paragon.gif?w=560&maxW=850&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=de3162652d2c40b684b07d78d553b76b 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20a%20trigger%20in%20Paragon.gif?w=840&maxW=850&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=8ee72b08441170960d92721694eb6007 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20a%20trigger%20in%20Paragon.gif?w=1100&maxW=850&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=b8d1ede63371d5788fb31dc42e66c3e1 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20a%20trigger%20in%20Paragon.gif?w=1650&maxW=850&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=ecfe5b5bb9cf7de719d1d672fdb9e897 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Testing%20a%20trigger%20in%20Paragon.gif?w=2500&maxW=850&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=f748bbe9d06db9b5da42441968d1bcb3 2500w" data-optimize="true" data-opv="2" />
</Frame>

Once you're ready to start using a Request workflow in production, click the "Deploy" button in the top-right of the screen to deploy the workflow. This will set the workflow's endpoint URL live and make it available for requests to be sent to.

### Triggering with Files

Paragon offers multiple ways to manage files within your workflows, enabling features like sending email attachments and retrieving files from storage providers such as OneDrive.

#### Hex-encoded file

You can pass in hex-encoded data in a Paragon file object to either an [App Event](/workflows/triggers/app-events) or Request Trigger to be handled in the workflow. Here’s an example file object structure:

```json
{
	"name": "test.txt", // File name
	"data": "5468697320697320612073616d706c6520746578742e", // hex encoded data string
	"mimeType": "text/plain", // File type and subtype
	"dataType": "FILE" // Paragon specific property
}
```

#### multipart/form-data

[multipart/form-data](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) is a MIME encoding type used for sending binary data, like files, and text data in a single HTTP request.

```bash
POST /projects/<Your Project ID>/sdk/triggers/<Workflow ID> HTTP/1.1
Host: zeus.useparagon.com

Authorization: Bearer <Paragon User Token>
Content-Length: <Length>
Content-Type: multipart/form-data; boundary=----12345

------12345
Content-Disposition: form-data; name="paragon-file"; filename="1efc9f67-5758-4ab0-9b0e-2484e5900ae4"
Content-Type: <Content-Type header here>

(data)
------12345--
```

## Sending a Response

Request-triggered workflows support sending a custom response to the original HTTP request that triggered the workflow.

<Note>
  **Note**:

  * If your Request-triggered workflow does not require a custom response, your workflow will respond immediately upon request with 202 Accepted.
  * When using a custom response, your workflow will have a limit of 55 seconds to reach the Response step. If your workflow may potentially run longer, you will need to handle timeout errors. See [Response time limitations](/workflows/triggers/request-trigger#response-time-limitations) below for more details.
</Note>

To add a response to your workflow, click the "+" button in the workflow canvas and choose the Response step in the sidebar.

<Frame>
    <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Responses%20in%20Paragon%20Connect.png?maxW=1942&auto=format&n=867oBBVpxd2C3zc4&q=85&s=89a3bac1d2408bf37a0a0ca242b89010" alt="" width="1942" height="1726" data-path="assets/Using Responses in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Responses%20in%20Paragon%20Connect.png?w=280&maxW=1942&auto=format&n=867oBBVpxd2C3zc4&q=85&s=aeaa64ae28c15c5c4fbbb442d231449a 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Responses%20in%20Paragon%20Connect.png?w=560&maxW=1942&auto=format&n=867oBBVpxd2C3zc4&q=85&s=1ebbd5028f8f37a6909c3f48e7863bb6 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Responses%20in%20Paragon%20Connect.png?w=840&maxW=1942&auto=format&n=867oBBVpxd2C3zc4&q=85&s=2931fbd97043a831ce131ae2d2eff226 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Responses%20in%20Paragon%20Connect.png?w=1100&maxW=1942&auto=format&n=867oBBVpxd2C3zc4&q=85&s=4c7a2d9075ea0a55407708809ed14fc0 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Responses%20in%20Paragon%20Connect.png?w=1650&maxW=1942&auto=format&n=867oBBVpxd2C3zc4&q=85&s=82f3b6ae3adcb321ecce7d2b6053d72e 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Responses%20in%20Paragon%20Connect.png?w=2500&maxW=1942&auto=format&n=867oBBVpxd2C3zc4&q=85&s=84ba6f84de82ee97332e19427c3e2c40 2500w" data-optimize="true" data-opv="2" />
</Frame>

### Defining response data

There are two components to a Response: its status code and its data.

In general, you should send the `200: OK` status code if the workflow ran successfully, you can choose from other commonly used status codes for more specific cases (e.g. if a Request failed, send an error response).

You can choose what data to send the response body using the key-value table to reference data from previous steps in the workflow.

### Sending files in responses

You can use the Response step to send files to your application. To do so, select "File" as the Response Type and reference a File object from a previous step.

File objects are returned from file-related Integration Actions and Request steps which include a file in the response.

<Frame>
  <img src="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-24%20at%2011.58.04%20AM@2x.png?maxW=2790&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=61b0b250b24f9cedfbfab492a785a287" alt="" width="2790" height="1912" data-path="assets/[Paragon] 2024-09-24 at 11.58.04 AM@2x.png" srcset="https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-24%20at%2011.58.04%20AM@2x.png?w=280&maxW=2790&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=304f0fb5748a3bead44bf15a090e1ce7 280w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-24%20at%2011.58.04%20AM@2x.png?w=560&maxW=2790&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=6031f38222f4e84b245415b3a5bdc1f2 560w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-24%20at%2011.58.04%20AM@2x.png?w=840&maxW=2790&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=2f0b468c799e183b8d1ebeed8a99f488 840w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-24%20at%2011.58.04%20AM@2x.png?w=1100&maxW=2790&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=3add2429577c205dce3a2d9a100121ca 1100w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-24%20at%2011.58.04%20AM@2x.png?w=1650&maxW=2790&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=6761bda8d56561d4454d265ee0dd5357 1650w, https://mintcdn.com/paragon/LX9pU-rN1rqQwuP1/assets/%5BParagon%5D%202024-09-24%20at%2011.58.04%20AM@2x.png?w=2500&maxW=2790&auto=format&n=LX9pU-rN1rqQwuP1&q=85&s=d933a52b242ba79f73bab9c76207cef9 2500w" data-optimize="true" data-opv="2" />
</Frame>

A File Response will be returned to the original HTTP request with the `Content-Type` of the file's MIME type and the raw bytes of the underlying file.

### Response time limitations

When using a custom response, your workflow will have a limit of 55 seconds to reach the Response step. If your workflow does not reach the Response step in that time, the HTTP request will respond with a **542 status code** to indicate a response timeout.

A 542 status code *does not indicate* that your workflow was unsuccessful; your workflow may still be running, but the results were not processed in time to provide a synchronous response. The timeout response will be returned as a JSON body which includes the workflow execution ID for your reference.

You can use this ID to retrieve results using the [Task History API](/apis/task-history) or to view results in the dashboard's [Task History view](/monitoring/viewing-task-history).

* Link to view execution in Task History: `https://dashboard.useparagon.com/connect/projects/[Project ID]/history/workflows/[Workflow ID]/executions/[Workflow Execution ID]`

**Example timeout response**

```json
{
    "message": "Workflow has been enqueued but has not completed.",
    "dateSubmitted": "2024-09-24T01:07:13.658Z",
    "projectId": "...",
    "workflowId": "...",
    "executionId": "..."
}
```


# Scheduler Trigger
Source: https://docs.useparagon.com/workflows/triggers/scheduler-trigger



The Scheduler trigger is used for workflows that should run automatically at a **scheduled time or interval**.

<Frame>
  ![](https://gblobscdn.gitbook.com/assets%2F-MCJwlyhqtCdBfCLUO0d%2F-MCK3fVEMwn-wSf2u0rs%2F-MCK480bq-rDimZiDVII%2FScheduler%20Trigger.png?alt=media\&token=7f87f73a-c62b-4f56-bee5-d540a05d2e17)
</Frame>

The Scheduler trigger provides the following scheduling options:

* **Seconds** (e.g. every 5 seconds)
* **Minutes** (e.g. every 30 minutes)
* **Hourly** (e.g. every hour at 15 minutes past the hour)
* **Daily** (e.g. every 2 days at 9:00 am)
* **Weekly** (e.g. every Monday at 12:00 pm)

Once deployed, the workflow will run automatically at the designated time for all users who have activated the workflow in their Connect Portal.

### Configuring Variable Time Zones

You can configure the Scheduler such that workflows run at a specific time in the user's time zone by using [User Metadata](/apis/users).

Paragon uses IANA-formatted time zones. For example, you would use `America/Los_Angeles` for users in the Pacific Time Zone. You can view a full list of time zone identifiers [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20Variable%20Timezones%20for%20Schedulers%20in%20Paragon%20Connect.png?maxW=1154&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=43bd87c99081ce73603978f3a2d23306" alt="" width="1154" height="648" data-path="assets/Setting up Variable Timezones for Schedulers in Paragon Connect.png" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20Variable%20Timezones%20for%20Schedulers%20in%20Paragon%20Connect.png?w=280&maxW=1154&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=5a36bb07f2b18380005290462a6cd9fb 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20Variable%20Timezones%20for%20Schedulers%20in%20Paragon%20Connect.png?w=560&maxW=1154&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=61baa7922a3d792ba5066c97b22ec785 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20Variable%20Timezones%20for%20Schedulers%20in%20Paragon%20Connect.png?w=840&maxW=1154&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=50ce2bd574eb301c33a609713761209d 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20Variable%20Timezones%20for%20Schedulers%20in%20Paragon%20Connect.png?w=1100&maxW=1154&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=86e93820032d627864705ddda07354ec 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20Variable%20Timezones%20for%20Schedulers%20in%20Paragon%20Connect.png?w=1650&maxW=1154&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=23af58c087f6e4257880c10d20a46975 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Setting%20up%20Variable%20Timezones%20for%20Schedulers%20in%20Paragon%20Connect.png?w=2500&maxW=1154&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=03cb61aa117d5be9993d618559cc36fe 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Using Conditionals
Source: https://docs.useparagon.com/workflows/using-conditionals

Add conditional branching logic to your workflows

## Overview

You can add conditional logic to workflows in Paragon using our Conditional step. Conditionals allow you to define rules to determine which of two paths your workflow should execute.

To add a conditional to your workflow, click the "+" button in the workflow canvas and choose the Conditional step from the sidebar.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Conditionals%20in%20a%20Paragon%20Connect%20workflow.gif?maxW=1543&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=7a6207427ccb9e4d37645b83be0cf11a" alt="" width="1543" height="739" data-path="assets/Using Conditionals in a Paragon Connect workflow.gif" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Conditionals%20in%20a%20Paragon%20Connect%20workflow.gif?w=280&maxW=1543&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=ade39b1845bd0c7aa01ae95c72e1127e 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Conditionals%20in%20a%20Paragon%20Connect%20workflow.gif?w=560&maxW=1543&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=8b115b47ea1ed327f4530c7d69ddea14 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Conditionals%20in%20a%20Paragon%20Connect%20workflow.gif?w=840&maxW=1543&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=61b42d3323f1c7fd55c504e7446040ac 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Conditionals%20in%20a%20Paragon%20Connect%20workflow.gif?w=1100&maxW=1543&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=e02de01e4fecb46bd9a923efbefe399e 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Conditionals%20in%20a%20Paragon%20Connect%20workflow.gif?w=1650&maxW=1543&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=9ba356c542b7b2e17327d623e63c8fca 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Using%20Conditionals%20in%20a%20Paragon%20Connect%20workflow.gif?w=2500&maxW=1543&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=77fd63245cce6391d2b09a3b616953e5 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Conditional rules

To add a rule to your conditional, click the dropdown menu in the 'select from step' input to choose a value that you want to evaluate. In the input to the right, you can choose a conditional operator (e.g. is true, equals, greater than).

<Note>
  **Note:** Operators depend on the value's type - for example, "greater than" only works for numbers, "exactly matches" only works for strings, etc.
</Note>

### Conditional operators

* Contains: `string`
* Does not contain: `string`
* Exactly matches: `string`
* Does not exactly match: `string`
* Is in: `string`
* Is not in: `string`
* Starts with: `string`
* Does not start with: `string`
* Ends with: `string`
* Does not end with: `string`
* Greater than: `integer`
* Less than: `integer`
* Equals: `integer`
* Does not equal: `integer`
* After: `date/time`
* Before: `date/time`
* Equals: `date/time`
* Is true: `boolean`
* Is false: `boolean`
* Is Not Null
* Is Null
* Exists
* Does not exist
* Is empty: `Array`
* Is not empty: `Array`

If you choose a relational operator, another input will appear where you can type or choose or a second value to compare to.

You can combine multiple rules using **"and"** and **"or"** operators.


# Using Dynamic Variables
Source: https://docs.useparagon.com/workflows/using-dynamic-variables

Pass data from your application, the Connect Portal, and previous steps.

## Overview

The Dynamic Variable Menu allows you to select data from your application, the Connect Portal, or previous steps. For example, you might want to dynamically reference data from your application's actions when creating new messages in Slack.

## Accessing Dynamic Variables

To access the Dynamic Variable Menu:

1. Click into any text input box.
2. Type two left curly braces `{{` .
3. Select the step you want to pull data from.
4. Select the specific reference you want to use.

<Frame>
  <img src="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=6e3c512cc37b6b5ff055eba5a0afaded" alt="" width="974" height="774" data-path="assets/Sending notifications to Slack from Paragon Connect.gif" srcset="https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?w=280&maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=2c2eaba1586c0bd53f45866ac251d2cd 280w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?w=560&maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=7662962ec193e304c5b08c3e2b0409c9 560w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?w=840&maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=5801f6ade7a60ccd4a13676a820b4a49 840w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?w=1100&maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=1d1017f5d950c0d23f539e99dabda773 1100w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?w=1650&maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=c5e2acdd24b9f13cc8bb13cf82856abd 1650w, https://mintcdn.com/paragon/HSp5hB8tE4Z6e44m/assets/Sending%20notifications%20to%20Slack%20from%20Paragon%20Connect.gif?w=2500&maxW=974&auto=format&n=HSp5hB8tE4Z6e44m&q=85&s=13ea8a9587a8b55c7c4c7d13a0ae0b05 2500w" data-optimize="true" data-opv="2" />
</Frame>


# Using Fan Out
Source: https://docs.useparagon.com/workflows/using-fan-out

Run a sequence of steps over each object in an array.

## Overview

Fan Out allows you to run the same sequence of steps over each object in an array (or list) of objects. For example, you might want to query a segment of users from your database and send each user a message.

To add a Fan Out to your workflow, click the "+" button in the Workflow Editor and choose Fan Out from the sidebar. Then, click the dropdown button under "Fan out which array?" to invoke the dynamic variable menu and choose the array you want to fan out.

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20a%20Fan%20Out%20in%20Paragon%20Connect.gif?maxW=1067&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9507a6ca0c6a2cb85dbc5d7999d4e0e8" alt="" width="1067" height="735" data-path="assets/Using a Fan Out in Paragon Connect.gif" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20a%20Fan%20Out%20in%20Paragon%20Connect.gif?w=280&maxW=1067&auto=format&n=867oBBVpxd2C3zc4&q=85&s=26dfc32f057f4421369f7ecfa61ca8d7 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20a%20Fan%20Out%20in%20Paragon%20Connect.gif?w=560&maxW=1067&auto=format&n=867oBBVpxd2C3zc4&q=85&s=77afa36cac24afa108a88d6e600dc1a0 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20a%20Fan%20Out%20in%20Paragon%20Connect.gif?w=840&maxW=1067&auto=format&n=867oBBVpxd2C3zc4&q=85&s=fdf5413392aa0271e93376a2cf11301d 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20a%20Fan%20Out%20in%20Paragon%20Connect.gif?w=1100&maxW=1067&auto=format&n=867oBBVpxd2C3zc4&q=85&s=523376be450997be9fd8d51b60e98d6b 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20a%20Fan%20Out%20in%20Paragon%20Connect.gif?w=1650&maxW=1067&auto=format&n=867oBBVpxd2C3zc4&q=85&s=4cc4c7387ffb8ddce04e13f19470c463 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20a%20Fan%20Out%20in%20Paragon%20Connect.gif?w=2500&maxW=1067&auto=format&n=867oBBVpxd2C3zc4&q=85&s=e77abf31c0ce81d231c39301c3978b24 2500w" data-optimize="true" data-opv="2" />
</Frame>

## Referencing data within a Fan Out

Any steps you add within a Fan Out will run for each object in the array passed into the Fan Out. To reference the object in the array from within a Fan Out, you can reference the Fan Out's `instance` object from the variable menu.

<Note>
  **Note:** Iterations within a Fan Out are executed in parallel, although your workflow will wait for all iterations to finish before proceeding to steps after the Fan Out.
</Note>


# Version History
Source: https://docs.useparagon.com/workflows/version-history

Review and restore previous versions of your workflow. Check or revert to earlier workflow versions.

<Info>
  If [Git Sync](/paragraph/setting-up-git-sync) is enabled, saving a version within Paragon also saves the changes to your connected Git repo.
</Info>

## Overview

Version History keeps track of the important changes to your workflow.

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Version%20History%20in%20Paragon%20Connect.png?maxW=2504&auto=format&n=867oBBVpxd2C3zc4&q=85&s=851d19bf7f367d3f02f04d7a634fedec" alt="" width="2504" height="1640" data-path="assets/Version History in Paragon Connect.png" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Version%20History%20in%20Paragon%20Connect.png?w=280&maxW=2504&auto=format&n=867oBBVpxd2C3zc4&q=85&s=9b03004eb1684f1ae5157a5f04e36515 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Version%20History%20in%20Paragon%20Connect.png?w=560&maxW=2504&auto=format&n=867oBBVpxd2C3zc4&q=85&s=3e6c453a79cb52ee71fb9876412ac8b9 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Version%20History%20in%20Paragon%20Connect.png?w=840&maxW=2504&auto=format&n=867oBBVpxd2C3zc4&q=85&s=2a10de24298e7da6b842bca3fceaa2c6 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Version%20History%20in%20Paragon%20Connect.png?w=1100&maxW=2504&auto=format&n=867oBBVpxd2C3zc4&q=85&s=542e5ee89ae489e9fc6bfa66099077e0 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Version%20History%20in%20Paragon%20Connect.png?w=1650&maxW=2504&auto=format&n=867oBBVpxd2C3zc4&q=85&s=e3e3544c22fbed1bc2496540b6036bc7 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Version%20History%20in%20Paragon%20Connect.png?w=2500&maxW=2504&auto=format&n=867oBBVpxd2C3zc4&q=85&s=5abf31dce753c5c2514fa35a6d86bdf6 2500w" data-optimize="true" data-opv="2" />
</Frame>

You can filter the list of versions by:

* All Versions
* Named versions
* Saved versions
* Deployed versions

## Saving a new version of your workflow

Versions will be made whenever you perform one of the following actions:

* Deploy the workflow
* Press ⌘⇧S on macOS or `CTRL` + `Shift` + `S` on Windows
* Restore to a previous version
* Manually click "Save Version" in the triple-dot menu
* Every 10th update or edit to your workflow

## Viewing or reverting to earlier versions of workflows

1. In [Paragon](https://app.useparagon.com/), open your workflow.

2. Click the **Horizontal three dots > Manage Versions**

3. Click a timestamp to see a previous version of the workflow. Below the timestamp, you'll see the name of the person who saved or deployed the workflow.

4. (Optional) To revert to this version, click **Restore this version.**

<Frame>
  <img src="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Version%20History%20in%20Paragon%20Connect.gif?maxW=1484&auto=format&n=867oBBVpxd2C3zc4&q=85&s=47c33f11dd888025915becbd831e7aad" alt="" width="1484" height="798" data-path="assets/Using Version History in Paragon Connect.gif" srcset="https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Version%20History%20in%20Paragon%20Connect.gif?w=280&maxW=1484&auto=format&n=867oBBVpxd2C3zc4&q=85&s=7416219efd10d0eafafee321d7d55bfa 280w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Version%20History%20in%20Paragon%20Connect.gif?w=560&maxW=1484&auto=format&n=867oBBVpxd2C3zc4&q=85&s=d23013b1c8fe3eb3e058ab2f09c9f63f 560w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Version%20History%20in%20Paragon%20Connect.gif?w=840&maxW=1484&auto=format&n=867oBBVpxd2C3zc4&q=85&s=3ec21f93cafbcaa9581c1fafd6f9442c 840w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Version%20History%20in%20Paragon%20Connect.gif?w=1100&maxW=1484&auto=format&n=867oBBVpxd2C3zc4&q=85&s=85b41b7fd6dad960482da4fcdcff0c23 1100w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Version%20History%20in%20Paragon%20Connect.gif?w=1650&maxW=1484&auto=format&n=867oBBVpxd2C3zc4&q=85&s=1173751e31edeb1cd60b95d258dad414 1650w, https://mintcdn.com/paragon/867oBBVpxd2C3zc4/assets/Using%20Version%20History%20in%20Paragon%20Connect.gif?w=2500&maxW=1484&auto=format&n=867oBBVpxd2C3zc4&q=85&s=405a0a56688ac479189b66da86efbd34 2500w" data-optimize="true" data-opv="2" />
</Frame>

## How long versions are saved

The number of days versions will be saved depends on your plan.

* **Trial:** 45 days
* **Pro:** 90 days
* **Enterprise:** Unlimited

<Note>
  **Note:** Versions older than your history limit are accessible upon upgrading.
</Note>


# Working with Files
Source: https://docs.useparagon.com/workflows/working-with-files



## Overview

Paragon offers multiple ways to manage files within your workflows, enabling features like sending email attachments and retrieving or uploading files from storage providers such as Google Drive.

## Sending Files to Paragon

#### Hex Encoded Data

You can pass in **hex encoded** data in as a Paragon File Object to either an [App Event](/workflows/triggers/app-events) or [Request](/workflows/triggers/request-trigger) Trigger to be handled in the workflow. Here’s an example file object structure:

```http
// Trigger the "File Upload" Workflow
POST https://zeus.useparagon.com/projects/<Paragon Project ID>/sdk/triggers/<Workflow ID>

Authorization: Bearer <Paragon User Token>
Content-Type: application/json

// Body

{
	"name": "test.txt", // File name
	"data": "5468697320697320612073616d706c6520746578742e", // hex encoded data string
	"mimeType": "text/plain", // File type and subtype
	"dataType": "FILE" // Paragon specific property
}
```

#### multipart/form-data

[multipart/form-data](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) is a MIME encoding type used for sending binary data, like files, and text data in a single HTTP request. It can also be submitted as a POST request to a Request Trigger

```http
POST /projects/<Your Project ID>/sdk/triggers/<Workflow ID> HTTP/1.1
Host: zeus.useparagon.com

Authorization: Bearer <Paragon User Token>
Content-Length: <Length>
Content-Type: multipart/form-data; boundary=----12345

------12345
Content-Disposition: form-data; name="paragon-file"; filename="1efc9f67-5758-4ab0-9b0e-2484e5900ae4"
Content-Type: <Content-Type header here>

(data)
------12345--
```

## Usage

### Workflows

You can send files to a workflow [App Event](/workflows/triggers/app-events) or [Request Triggers](/workflows/triggers/request-trigger). Set up your Request Trigger with [test data](/workflows/building-workflows#testing-workflows) by defining the parameters or sending a test request to the provided test endpoint:

<Frame caption="Paragon File Object used as test data">
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example.png?maxW=2160&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=632625d6e7850f4f347110628a71fc08" alt="" width="2160" height="1196" data-path="assets/file-upload-example.png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example.png?w=280&maxW=2160&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=5910070e4debbe1e676d2a93a758f19e 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example.png?w=560&maxW=2160&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=975e6e6a3576de43ff9ba4d2ec163bf6 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example.png?w=840&maxW=2160&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=fcf90ab3be36a10862dc94b1730fb6cc 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example.png?w=1100&maxW=2160&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=ce2fe7ce22a315317e1ff53d2ace3554 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example.png?w=1650&maxW=2160&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=4c14b4df4635c90f0e1248e237f79ab0 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example.png?w=2500&maxW=2160&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=816e6e0e651d842cd72735912c80f40b 2500w" data-optimize="true" data-opv="2" />
</Frame>

After you've received the file object in the test data, you can reference the object in any of your workflow steps to be uploaded using a dropdown like the Google Drive File Upload action shown here:

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example3.png?maxW=2084&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=3677494d439f98d812396787c8625cd6" alt="" width="2084" height="612" data-path="assets/file-upload-example3.png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example3.png?w=280&maxW=2084&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=10573d6c8133cc522a3bbbdf1c5e2168 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example3.png?w=560&maxW=2084&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=2eab3cd7161c546e5eb804fd455b5aa6 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example3.png?w=840&maxW=2084&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=c7391daa0b928ef8eac7ff0a7f1c35f0 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example3.png?w=1100&maxW=2084&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=e5af980db8cc600b0cdcb00b7ad4823a 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example3.png?w=1650&maxW=2084&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=4545f327557157921414278ef037534b 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example3.png?w=2500&maxW=2084&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=596cbaf89ed2c8800c5f1f15777e9580 2500w" data-optimize="true" data-opv="2" />
</Frame>

Or use our [Dynamic Variables](/workflows/using-dynamic-variables) to reference the file to POST to an upload endpoint of your choosing!

<Frame>
  <img src="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example4.png?maxW=2230&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=fd90dbc8868a3b31a09cae1d830f2fa6" alt="" width="2230" height="1236" data-path="assets/file-upload-example4.png" srcset="https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example4.png?w=280&maxW=2230&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=28092f766605f9bf87d55b396853a1a0 280w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example4.png?w=560&maxW=2230&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=22e55e4e28a1344cedcc0bd917d904e3 560w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example4.png?w=840&maxW=2230&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=bc3a17a95d158579de9bd48bc6da652e 840w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example4.png?w=1100&maxW=2230&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=32383bb2a0f0d3f78aacb1fa6d8b4ded 1100w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example4.png?w=1650&maxW=2230&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=925668ce79787bed12a3a34b9e04ea99 1650w, https://mintcdn.com/paragon/p_CuCy_equ6Xxvlm/assets/file-upload-example4.png?w=2500&maxW=2230&auto=format&n=p_CuCy_equ6Xxvlm&q=85&s=6600c2df31931fef69612e258cf61e54 2500w" data-optimize="true" data-opv="2" />
</Frame>