# 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 Tools.

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 theme={null}
import { generateText, jsonSchema, tool } from "ai";
import { openai } from "@ai-sdk/openai";

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

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

if (errors.length === 0) {
  await generateText({
    model: openai("gpt-4o"),
    tools: Object.fromEntries(
      tools.map((tool) => [
        tool.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>/tools`,
                {
                  method: "POST",
                  body: JSON.stringify({
                    tool: 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 theme={null}
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
    tool_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}/tools",
                headers={
                    "Authorization": f"Bearer {self.paragon_token}",
                    "Content-Type": "application/json",
                },
                json={
                    "tool": self.tool_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}/tools"
    headers = {"Authorization": f"Bearer {PARAGON_USER_TOKEN}"}
    
    resp = requests.get(url, headers=headers)
    json_resp = resp.json()
    tools = json_resp.get("tools", [])
    errors = json_resp.get("errors", [])

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

    tools_list = []
    for integration in tools:
        integration_tools = tools.get(integration)
        for tool in integration_tools:
            func_def = tool["function"]
            tool_name = func_def["name"]
            tool_description = func_def["description"]

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

    llm = ChatOpenAI(
        openai_api_key=OPENAI_API_KEY,
        model_name="o1"
    )
    
    def chatbot(state: State):
        return {"messages": [llm.bind_tools(tools_list).invoke(state["messages"])]}
    
    graph_builder.add_node("chatbot", chatbot)
    tools_node = ToolNode(tools=tools_list)
    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 theme={null}
import requests
from openai import OpenAI
client = OpenAI()

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

response = requests.get(actions_url, params=get_tools_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["tools"],
  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 theme={null}
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["tools"]):
        run_tools_body = {
            "tool": function_name,
            "parameters": arguments
        }

        # Run Tool
        response = requests.post(actions_url, body=run_tools_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 and trigger events.

## Overview

Quickly search, view, and trace through logs of your ActionKit calls on the **Monitoring** page of your Paragon dashboard. There are two tabs in Monitoring for ActionKit:

* The **Tools** tab provides a timeline of all ActionKit Tool usage, including all List and Run Tool requests.
* The **Triggers** tab provides a timeline of all subscribed ActionKit Triggers, including the full lifecycle of subscribing to triggers, detecting new data, and delivering events to your webhook.

<Frame>
  <img alt="" />
</Frame>

## Tool Logs

Visit the **Tools** Tab in Monitoring to find a list of your historical Tool calls. You can use this tab to:

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

### Filtering

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

* **User ID**

* **Integration name**

* **Status**

* **Tool 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 Sample ActionKit error response with a requestId highlight={6} theme={null}
  {
    "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.

### Tool Log Trace

Clicking into a Tool call row opens a Log Trace view, which shows all logs associated with a single Tool call.

<Frame>
  <img alt="" />
</Frame>

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.

Expanding the log shows additional metadata, such as API response data, error messages, and HTTP status codes.

<Info>
  **Note**: The response body of API requests are only displayed for Error-level logs. All other logs do not include the contents of the body.
</Info>

## Trigger Logs

The **Triggers** tab in Monitoring displays a table of all trigger events for your project. You can click on any trigger event row to open a detail panel that shows the full context of that event, including its deliveries and event logs.

### Trigger Event Detail

The top of the detail panel shows key information about the trigger event:

* **Event ID**: the unique identifier for the trigger event.
* **Integration**: the integration that produced the event.
* **Time Received**: when the event was received by Paragon.
* **Status**: the current processing status of the event (Success, Delivery Failures, Processing Failure, or Queued).

#### Deliveries

The deliveries section shows how the trigger event was delivered to your subscribed users. Each delivery includes:

* **Status**: whether the delivery succeeded, failed, or is still pending.
* **User**: the end user ID the delivery was sent to.
* **Timestamp**: when the delivery was created.

When there is a single delivery, the panel shows additional details including the **Trigger ID**, **Webhook URL**, and delivery timing.

#### Event Logs

The event logs section shows a timeline of logs associated with the trigger event. You can expand any log entry to view its full payload, including the Trace ID and log context.

This is useful for debugging trigger processing issues and understanding how an event moved through Paragon.

You will see logs for:

* Attempts or failures to deliver a received trigger event to your webhook URL
* Triggers with a `POLLING` subscription model:
  * New or updated records detected by the trigger's polling job
* Triggers with a `WEBHOOK` subscription model:
  * The original webhook events received by Paragon
  * Attempts or failures to create a webhook in a specific integration on behalf of your user

#### Filtering Trigger Events

You can filter the Triggers table by:

* **User ID**
* **Integration**
* **Status** (Success, Delivery Failures, Processing Failure, Queued)
* **Date range**

## Log Retention

ActionKit Logs are rotated automatically based on limits to your Paragon plan's retention and storage policy.

When you reach the maximum lifetime or number of logs that your plan supports, Paragon will automatically drop the oldest logs from the system.

<Info>
  Interested in forwarding logs to your own system? [Contact us](mailto:support@useparagon.com) for more details.
</Info>

| Plan       | Log Retention                                           |
| ---------- | ------------------------------------------------------- |
| Trial      | 7 days or 50k maximum logs (whichever is reached first) |
| Pro        | 30 days or 1M maximum logs                              |
| Enterprise | Configurable                                            |


# 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 alt="" />
</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 alt="" />
  </Frame>
</Accordion>

Start by cloning the source of Playground locally:

```bash theme={null}
git clone git@github.com:useparagon/actionkit-playground.git && cd actionkit-playground
```

Install the dependencies with pnpm:

```bash theme={null}
pnpm install
```

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

```bash theme={null}
pnpm migrate
```

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

```bash theme={null}
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 theme={null}
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 Tools to the chat

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

In your app, you can control what Tools 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>


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

Give your AI agent or app access to thousands of tools from your users' integrations, from our catalog of pre-built Tools.

ActionKit **Tools API** provides our complete library of pre-built tools (actions in third-party systems) to expose as capabilities for AI agents, workflow builders, or other front-end functions that require integration data.

## API Usage

**Base URL**

```js theme={null}
https://actionkit.useparagon.com/projects/[Project ID]
```

<Accordion title="For on-premise instances">
  ```js theme={null}
  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 theme={null}
Authorization: Bearer [Paragon User Token]
```

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

<Info>
  If you are using [JWT Permissions](/apis/api-reference/jwt-permissions) to control access, your Paragon User Token must include the `actionkit` permission to make ActionKit API requests.
</Info>

## Pagination

Many list and search actions in ActionKit accept a `paginationParameters` object as part of the request `parameters`. When the result set exceeds a single page, the response includes a `pageCursor` (or equivalent token) that you pass in the next request to retrieve the following page.

A typical pagination flow looks like this:

1. Call an action without any pagination parameters to get the first page.
2. Check the response for a pagination cursor or token (e.g. `nextPageCursor`).
3. If a cursor is present, call the action again with the cursor in `paginationParameters`.
4. Repeat until no cursor is returned.

```js Example: Paginating Asana projects expandable theme={null}
// First request: no pagination parameters
const firstPage = await fetch(
  `https://actionkit.useparagon.com/projects/${projectId}/actions`,
  {
    method: "POST",
    headers: {
      "Authorization": `Bearer ${userToken}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      action: "ASANA_GET_PROJECTS",
      parameters: {},
    }),
  }
);

const firstResult = await firstPage.json();
// Use firstResult.pageCursor for the next request

// Subsequent request: pass the page cursor
const nextPage = await fetch(
  `https://actionkit.useparagon.com/projects/${projectId}/actions`,
  {
    method: "POST",
    headers: {
      "Authorization": `Bearer ${userToken}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      action: "ASANA_GET_PROJECTS",
      parameters: {
        paginationParameters: {
          pageCursor: firstResult.pageCursor,
        },
      },
    }),
  }
);
```

Paragon standardizes vendor-specific pagination mechanics into a few patterns:

| Parameter type | Description                                                                                                                                  | Fields                                          | Example integrations                                                                                                                                                                                                                       |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Cursor-based   | Receive `nextPageCursor` or `nextPageToken` and pass that field to `paginationParameters` in the next call.                                  | `pageCursor` or `pageToken`                     | [Asana](/actionkit/integrations/asana/ASANA_GET_PROJECTS), [Confluence](/actionkit/integrations/confluence/CONFLUENCE_SEARCH_PAGES), [Slack](/actionkit/integrations/slack/SLACK_LIST_CHANNELS)                                            |
| Offset-based   | Count the number of records received in a page and add it to a running `offset` parameter passed to `paginationParameters` in the next call. | `offset` or `skip`                              | [Mailchimp](/actionkit/integrations/mailchimp/MAILCHIMP_GET_CONTACTS_FROM_LIST), [Sage Intacct](/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_ACCOUNTS), [Zoho CRM](/actionkit/integrations/zohocrm/ZOHO_CRM_SEARCH_RECORDS_ANY) |
| Page number    | For each page, add 1 to a running `pageOffset` parameter passed to `paginationParameters` in the next call.                                  | `page`, `pageNo`, `pageNumber`, or `pageOffset` | [Dropbox Sign](/actionkit/integrations/dropboxsign/DROPBOX_SIGN_SEARCH_SIGNATURE_REQUESTS), [ServiceNow](/actionkit/integrations/servicenow/SERVICENOW_GET_TICKETS), [Xero](/actionkit/integrations/xero/XERO_GET_ACCOUNTS)                |

You can find the specific pagination parameters available for each action in the [Actions Reference](/actionkit/supported-integrations). Actions that support pagination include `paginationParameters` in their input schema.

## File Uploads

Actions that accept a `file` input to upload a file to an integration (for example, [Google Drive: Save File](/actionkit/integrations/googledrive/GOOGLE_DRIVE_SAVE_FILE) and [Box: Save File](/actionkit/integrations/box/BOX_SAVE_FILE)) will need to be encoded as part of the JSON payload provided when the Action is run.

1. **Hex-encode the file**

   With the file contents you want to upload, hex-encode of the bytes file that you intend to upload.

2. **Construct a File object**

   A File object is a JSON object that represents a File to upload. You must provide three standard fields:

   ```json File object theme={null}
   {
       "dataType": "FILE", // Always set to "FILE"
       "mimeType": "text/plain", // Set to the file's known MIME type
       "data": "..." // Use the hex-encoded file data
   }
   ```

#### Examples

Here are some end-to-end examples of uploading a file with ActionKit in a few different client languages:

<CodeGroup>
  ```javascript Node.js expandable theme={null}
  import fs from 'node:fs';
  const filePath = './report.pdf';
  const fileBuffer = fs.readFileSync(filePath);

  const body = {
      action: "GOOGLE_DRIVE_SAVE_FILE",
      parameters: {
          filename: "report.pdf",
          file: {
              mimeType: "application/pdf",
              dataType: "FILE",
              data: fileBuffer.toString('hex'),
          },
      },
  };

  const res = await fetch(
      `https://actionkit.useparagon.com/projects/${PROJECT_ID}/actions`,
      {
          method: "POST",
          headers: {
              "Content-Type": "application/json",
              Authorization: `Bearer ${PARAGON_USER_TOKEN}`,
          },
          body: JSON.stringify(body),
      },
  );
  ```

  ```python Python expandable theme={null}
  from pathlib import Path
  import json
  import requests

  file_path = Path("./report.pdf")
  file_bytes = file_path.read_bytes()

  body = {
      "action": "GOOGLE_DRIVE_SAVE_FILE",
      "parameters": {
          "filename": "report.pdf",
          "file": {
              "mimeType": "application/pdf",
              "dataType": "FILE",
              "data": file_bytes.hex(),
          },
      },
  }

  res = requests.post(
      f"https://actionkit.useparagon.com/projects/{PROJECT_ID}/actions",
      headers={
          "Content-Type": "application/json",
          "Authorization": f"Bearer {PARAGON_USER_TOKEN}",
      },
      data=json.dumps(body),
  )
  ```

  ```bash Bash theme={null}
  FILE_HEX="$(xxd -p -c 1000000 "./report.pdf" | tr -d '\n')"

  curl "https://actionkit.useparagon.com/projects/${PROJECT_ID}/actions" \
      -X POST \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer ${PARAGON_USER_TOKEN}" \
      --data "$(jq -n \
          --arg data "$FILE_HEX" \
          '{
          action: "GOOGLE_DRIVE_SAVE_FILE",
          parameters: {
              filename: "report.pdf",
              file: {
              mimeType: "application/pdf",
              dataType: "FILE",
              data: $data
              }
          }
          }'
      )"
  ```
</CodeGroup>

#### Limitations

ActionKit limits incoming request body payloads to **10 MB**. Because of the required hex encoding, uploaded files are effectively limited to 5 MB.

For larger file sizes, use the [Proxy API](/apis/proxy) to upload to the integration directly.

## Using Multi-Account Authorization

[Multi-Account Authorization](/apis/api-reference/multi-account-authorization#getting-started) is a set of SDK options that enables you to connect multiple accounts of the same integration type for a [Connected User](/billing/connected-users).

You can use Multi-Account Authorization with ActionKit by specifying a credential with a header of `X-Paragon-Credential`.

```http REST API theme={null}
POST https://actionkit.useparagon.com/projects/<Project ID>/tools

Authorization: Bearer <Paragon User Token>
X-Paragon-Credential: <Credential ID>

// Body
{
    "tool": "SLACK_SEND_MESSAGE",
    "parameters": {
        "channel": "#general",
        "message": "Hello world!"
    }
}
```


# List Tools
Source: https://docs.useparagon.com/actionkit/api-reference/list-tools

actionkit/openapi-standard.json GET /projects/{project_id}/tools
List all Tools available for a user.

Every Connected User will have the ability to run different Tools, depending on what accounts they have connected.

Use this endpoint to list those Tools and discover the schemas of their input parameters.

<Check>
  **Paragon automatically loads user-specific fields to Tool schemas for users where applicable.**

  For example, if the user has custom fields defined for Salesforce Opportunities, those custom fields will appear in their response for the `SALESFORCE_CREATE_RECORD_OPPORTUNITY` Tool schema.
</Check>

<Info>
  This endpoint was previously available at `GET /projects/{project_id}/actions`. The `/actions` path is preserved for backward compatibility; both paths work identically.
</Info>


# Run Tool
Source: https://docs.useparagon.com/actionkit/api-reference/run-tool

actionkit/openapi-standard.json POST /projects/{project_id}/tools
Run a Tool on behalf of your user.

This endpoint can be used to call any ActionKit Tool on behalf of your user.

You can find specific input parameters for a Tool you want to call in the Tools Reference, for example:

* [Slack: Send Message](/actionkit/integrations/slack/SLACK_SEND_MESSAGE)
* [Google: Drive Download File](/actionkit/integrations/googledrive/GOOGLE_DRIVE_DOWNLOAD_FILE)
* [Gmail: Search Emails](/actionkit/integrations/gmail/GMAIL_SEARCH_FOR_EMAIL)

Each Tool in the Reference is an example call to this endpoint.

<Info>
  This endpoint was previously available at `POST /projects/{project_id}/actions`. The `/actions` path is preserved for backward compatibility; both paths work identically.
</Info>


# Custom Tools
Source: https://docs.useparagon.com/actionkit/custom-tools

Use the Proxy API to create Custom Tools for any API or integration.

To send requests to integrations or APIs that aren't yet supported by our catalog of tools available in ActionKit, you can use the [Proxy API](/apis/proxy) to create a Custom Tool for any use case.

## Usage

To send a custom request to any API for an integration in your Paragon project, use the following base URL with a [Paragon User Token](/getting-started/installing-the-connect-sdk#setup) (JWT) as a Bearer token in the Authorization header.

**Base URL**

```
https://proxy.useparagon.com/projects/[Project ID]/sdk/proxy/[integration]
```

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

Then, specify the path or full URL of a custom integration request to send on behalf of your user as the header `X-Paragon-Proxy-Url` (or directly appended to the base URL).

For example, if you are trying to reach the `comments.list` endpoint of Google Drive, which has the URL:

```
GET https://www.googleapis.com/drive/v3/files/{fileId}/comments
```

...the custom request would be structured as:

```http theme={null}
GET https://proxy.useparagon.com/projects/[Project ID]/sdk/proxy/googledrive

Authorization: Bearer [Paragon User Token]
X-Paragon-Proxy-Url: https://www.googleapis.com/drive/v3/files/{fileId}/comments
```

Proxy API requests can be sent for any of the 130+ integrations available in [our catalog](/resources/integrations) or with [Custom Integrations](/resources/custom-integrations), so you can add Custom Tools for any API.

<Info>
  Custom Tool definitions will not appear in the [List Tools](/actionkit/api-reference/list-tools) endpoint, which only includes Paragon-defined Tools.

  See below for examples of defining Custom Tools within your application or our MCP to drive Proxy API requests.
</Info>

## Examples

### Custom Tool for Tool Calling

A Custom Tool can be defined in your system as one or many Proxy API calls that are made for a given set of input parameters.

A basic implementation of a Custom Tool would look like the following:

```js expandable theme={null}
// Create JSON Schema of a Get Comments tool:
const getFileCommentsTool = {
  "type": "function",
  "name": "get_file_comments",
  "description": "Get comments for a specific file in Google Drive",
  "parameters": {
    "type": "object",
    "properties": {
      "fileId": {
        "type": "string",
        "description": "The ID of the file to get comments for"
      }
    },
    "required": ["fileId"]
  }
}

// When receiving this tool call, make the proxy request:
if (outputItem.type === "function_call" && outputItem.name === getFileCommentsTool.name) {
  const { fileId } = item.arguments;
  const response = await fetch(
    `https://proxy.useparagon.com/projects/${PROJECT_ID}/sdk/proxy/googledrive`,
    {
      method: 'GET',
      headers: {
        'Authorization': `Bearer ${getUserToken()}`,
        'X-Paragon-Proxy-Url': `https://www.googleapis.com/drive/v3/files/${fileId}/comments`
      }
    }
  );

  // Make additional requests or transformations...
  let output = await response.text();

  // Return to the model:
  input.push({
    type: "function_call_output",
    call_id: outputItem.call_id,
    output,
  });

  await responses.create(...);
};
```

The 2 key components to implement:

1. Define a JSON Schema for your Custom Tool that you will pass to the model as a tool definition (in addition to the native ActionKit definitions).
2. When your Custom Tool is called, call the Proxy API with the input and return the output to the model (or make additional requests / transformations).

### OpenAPI as Custom Tools

If you have an OpenAPI spec defining a list of endpoints that you want to add as available tools, you can transform those automatically into Custom Tools as described above that send requests to the Proxy API.

Our open-source MCP does this out-of-the-box by accepting OpenAPI specs in the `openapi/` folder of your server:

<Card href="https://github.com/useparagon/paragon-mcp" title="useparagon/paragon-mcp" icon="github" />

You can also adapt the implementation yourself for use outside of MCP. The key areas to adapt from are:

1. Transforming OpenAPI fields to JSON Schemas that can be used as tool definitions. [(Source)](https://github.com/useparagon/paragon-mcp/blob/main/src/openapi.ts#L78-L165)
2. Calling the Proxy API with the input (and path parameters resolved in the URL) given a tool call request from an LLM. [(Source)](https://github.com/useparagon/paragon-mcp/blob/main/src/utils.ts#L73-L115)


# 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">
  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).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#ADOBE_EXPERIENCE_MANAGER_CREATE_FOLDER



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

actionkit/openapi.json POST /projects/{project_id}/tools/#ADOBE_EXPERIENCE_MANAGER_DELETE_ASSET



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

actionkit/openapi.json POST /projects/{project_id}/tools/#ADOBE_EXPERIENCE_MANAGER_DELETE_FOLDER



# Get Asset By ID
Source: https://docs.useparagon.com/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_GET_ASSET_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#ADOBE_EXPERIENCE_MANAGER_GET_ASSET_BY_ID



# Get Folder By ID
Source: https://docs.useparagon.com/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_GET_FOLDER_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#ADOBE_EXPERIENCE_MANAGER_GET_FOLDER_BY_ID



# List Folders
Source: https://docs.useparagon.com/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_LIST_FOLDERS

actionkit/openapi.json POST /projects/{project_id}/tools/#ADOBE_EXPERIENCE_MANAGER_LIST_FOLDERS



# Adobe Experience Manager
Source: https://docs.useparagon.com/actionkit/integrations/adobeexperiencemanager/overview

Browse the tools available for Adobe Experience Manager in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_LIST_FOLDERS" title="List Folders" />

  <Card href="/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_GET_FOLDER_BY_ID" title="Get Folder By ID" />

  <Card href="/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_CREATE_FOLDER" title="Create Folder" />

  <Card href="/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_DELETE_FOLDER" title="Delete Folder" />

  <Card href="/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_GET_ASSET_BY_ID" title="Get Asset By ID" />

  <Card href="/actionkit/integrations/adobeexperiencemanager/ADOBE_EXPERIENCE_MANAGER_DELETE_ASSET" title="Delete Asset" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Adobe Experience Manager. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Create Record
Source: https://docs.useparagon.com/actionkit/integrations/airtable/AIRTABLE_CREATE_RECORD

actionkit/openapi.json POST /projects/{project_id}/tools/#AIRTABLE_CREATE_RECORD



# Fetch Records
Source: https://docs.useparagon.com/actionkit/integrations/airtable/AIRTABLE_FETCH_RECORDS

actionkit/openapi.json POST /projects/{project_id}/tools/#AIRTABLE_FETCH_RECORDS



# Update Record
Source: https://docs.useparagon.com/actionkit/integrations/airtable/AIRTABLE_UPDATE_RECORD

actionkit/openapi.json POST /projects/{project_id}/tools/#AIRTABLE_UPDATE_RECORD



# Airtable
Source: https://docs.useparagon.com/actionkit/integrations/airtable/overview

Browse the tools available for Airtable in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/airtable/AIRTABLE_FETCH_RECORDS" title="Fetch Records" />

  <Card href="/actionkit/integrations/airtable/AIRTABLE_CREATE_RECORD" title="Create Record" />

  <Card href="/actionkit/integrations/airtable/AIRTABLE_UPDATE_RECORD" title="Update Record" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Airtable. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Create Folder
Source: https://docs.useparagon.com/actionkit/integrations/amazons3/AMAZON_S3_CREATE_FOLDER

actionkit/openapi.json POST /projects/{project_id}/tools/#AMAZON_S3_CREATE_FOLDER



# Delete Folder
Source: https://docs.useparagon.com/actionkit/integrations/amazons3/AMAZON_S3_DELETE_FOLDER

actionkit/openapi.json POST /projects/{project_id}/tools/#AMAZON_S3_DELETE_FOLDER



# Download File
Source: https://docs.useparagon.com/actionkit/integrations/amazons3/AMAZON_S3_DOWNLOAD_FILE

actionkit/openapi.json POST /projects/{project_id}/tools/#AMAZON_S3_DOWNLOAD_FILE

This Tool will respond with a temporary signed download URL from the Amazon S3 API. Send a request to this URL to get a response with a byte stream of the file data.


# List Files
Source: https://docs.useparagon.com/actionkit/integrations/amazons3/AMAZON_S3_LIST_FILES

actionkit/openapi.json POST /projects/{project_id}/tools/#AMAZON_S3_LIST_FILES



# Upload File
Source: https://docs.useparagon.com/actionkit/integrations/amazons3/AMAZON_S3_UPLOAD_FILE

actionkit/openapi.json POST /projects/{project_id}/tools/#AMAZON_S3_UPLOAD_FILE



# Amazon S3
Source: https://docs.useparagon.com/actionkit/integrations/amazons3/overview

Browse the tools available for Amazon S3 in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/amazons3/AMAZON_S3_CREATE_FOLDER" title="Create Folder" />

  <Card href="/actionkit/integrations/amazons3/AMAZON_S3_DELETE_FOLDER" title="Delete Folder" />

  <Card href="/actionkit/integrations/amazons3/AMAZON_S3_UPLOAD_FILE" title="Upload File" />

  <Card href="/actionkit/integrations/amazons3/AMAZON_S3_DOWNLOAD_FILE" title="Download File" />

  <Card href="/actionkit/integrations/amazons3/AMAZON_S3_LIST_FILES" title="List Files" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Amazon S3. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#ASANA_CREATE_COMMENT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#ASANA_CREATE_PROJECT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#ASANA_CREATE_TASK



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#ASANA_GET_PROJECT_BY_ID



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

actionkit/openapi.json POST /projects/{project_id}/tools/#ASANA_GET_TASKS_BY_ID



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

actionkit/openapi.json POST /projects/{project_id}/tools/#ASANA_GET_TASKS_V2



# 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}/tools/#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}/tools/#ASANA_GET_TEAMS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#ASANA_GET_WORKSPACES



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

actionkit/openapi.json POST /projects/{project_id}/tools/#ASANA_UPDATE_TASK



# Asana
Source: https://docs.useparagon.com/actionkit/integrations/asana/overview

Browse the tools and triggers available for Asana in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/asana/ASANA_CREATE_COMMENT" title="Create Comment" />

  <Card href="/actionkit/integrations/asana/ASANA_CREATE_PROJECT" title="Create Project" />

  <Card href="/actionkit/integrations/asana/ASANA_GET_PROJECTS" title="Get Projects" />

  <Card href="/actionkit/integrations/asana/ASANA_GET_PROJECT_BY_ID" title="Get Project By ID" />

  <Card href="/actionkit/integrations/asana/ASANA_CREATE_TASK" title="Create Task" />

  <Card href="/actionkit/integrations/asana/ASANA_UPDATE_TASK" title="Update Task" />

  <Card href="/actionkit/integrations/asana/ASANA_GET_TASKS_V2" title="Get Tasks" />

  <Card href="/actionkit/integrations/asana/ASANA_GET_TASKS_BY_ID" title="Get Tasks By ID" />

  <Card href="/actionkit/integrations/asana/ASANA_GET_TASK_BY_EXTERNAL_ID" title="Get Task By External ID" />

  <Card href="/actionkit/integrations/asana/ASANA_ADD_TASK_TO_SECTION" title="Add Task To Section" />

  <Card href="/actionkit/integrations/asana/ASANA_GET_TEAMS" title="Get Teams" />

  <Card href="/actionkit/integrations/asana/ASANA_GET_WORKSPACES" title="Get Workspaces" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/asana/triggers/ASANA_TRIGGER_TASK_CREATED" title="New Task" />

  <Card href="/actionkit/integrations/asana/triggers/ASANA_TRIGGER_TASK_UPDATED" title="Task Updated" />

  <Card href="/actionkit/integrations/asana/triggers/ASANA_TRIGGER_TASK_COMPLETED" title="Task Completed" />

  <Card href="/actionkit/integrations/asana/triggers/ASANA_TRIGGER_TASK_DELETED" title="Task Deleted" />

  <Card href="/actionkit/integrations/asana/triggers/ASANA_TRIGGER_TAG_ADDED" title="Tag Added" />

  <Card href="/actionkit/integrations/asana/triggers/ASANA_TRIGGER_PROJECT_CREATED" title="New Project" />

  <Card href="/actionkit/integrations/asana/triggers/ASANA_TRIGGER_COMMENT_CREATED" title="New Comment" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Comment
Source: https://docs.useparagon.com/actionkit/integrations/asana/triggers/ASANA_TRIGGER_COMMENT_CREATED

Trigger when a new comment is created in Asana

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "asana",
  "type": "ASANA_TRIGGER_COMMENT_CREATED",
  "parameters": {
    "projectId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Select a Project to watch for comments. Use Connect Portal Workflow Settings to allow users to select an Asana Project.

  * Options can be loaded by using the `projects` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# New Project
Source: https://docs.useparagon.com/actionkit/integrations/asana/triggers/ASANA_TRIGGER_PROJECT_CREATED

Trigger when a new project is created in Asana

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "asana",
  "type": "ASANA_TRIGGER_PROJECT_CREATED",
  "parameters": {
    "workspaceId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Workspace ID

  * Options can be loaded by using the `workspaces` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# Tag Added
Source: https://docs.useparagon.com/actionkit/integrations/asana/triggers/ASANA_TRIGGER_TAG_ADDED

Trigger when a tag is added in Asana

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "asana",
  "type": "ASANA_TRIGGER_TAG_ADDED",
  "parameters": {
    "tagId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Tag ID

  * Options can be loaded by using the `tags` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# Task Completed
Source: https://docs.useparagon.com/actionkit/integrations/asana/triggers/ASANA_TRIGGER_TASK_COMPLETED

Trigger when a task is completed in Asana

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "asana",
  "type": "ASANA_TRIGGER_TASK_COMPLETED",
  "parameters": {
    "projectId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Project ID

  * Options can be loaded by using the `projects` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# New Task
Source: https://docs.useparagon.com/actionkit/integrations/asana/triggers/ASANA_TRIGGER_TASK_CREATED

Trigger when a new task is created in Asana

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "asana",
  "type": "ASANA_TRIGGER_TASK_CREATED",
  "parameters": {
    "projectId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Project ID

  * Options can be loaded by using the `projects` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# Task Deleted
Source: https://docs.useparagon.com/actionkit/integrations/asana/triggers/ASANA_TRIGGER_TASK_DELETED

Trigger when a task is deleted in Asana

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "asana",
  "type": "ASANA_TRIGGER_TASK_DELETED",
  "parameters": {
    "projectId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Project ID

  * Options can be loaded by using the `projects` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# Task Updated
Source: https://docs.useparagon.com/actionkit/integrations/asana/triggers/ASANA_TRIGGER_TASK_UPDATED

Trigger when a task is updated in Asana

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "asana",
  "type": "ASANA_TRIGGER_TASK_UPDATED",
  "parameters": {
    "projectId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Project ID

  * Options can be loaded by using the `projects` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


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

actionkit/openapi.json POST /projects/{project_id}/tools/#AZURE_DEVOPS_CREATE_WORKITEM



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

actionkit/openapi.json POST /projects/{project_id}/tools/#AZURE_DEVOPS_DELETE_WORKITEM



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

actionkit/openapi.json POST /projects/{project_id}/tools/#AZURE_DEVOPS_SEARCH_WORKITEMS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#AZURE_DEVOPS_UPDATE_WORKITEM



# Azure DevOps
Source: https://docs.useparagon.com/actionkit/integrations/azuredevops/overview

Browse the tools available for Azure DevOps in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/azuredevops/AZURE_DEVOPS_SEARCH_WORKITEMS" title="Search Workitems" />

  <Card href="/actionkit/integrations/azuredevops/AZURE_DEVOPS_CREATE_WORKITEM" title="Create Workitem" />

  <Card href="/actionkit/integrations/azuredevops/AZURE_DEVOPS_UPDATE_WORKITEM" title="Update Workitem" />

  <Card href="/actionkit/integrations/azuredevops/AZURE_DEVOPS_DELETE_WORKITEM" title="Delete Workitem" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Azure DevOps. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# 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}/tools/#BAMBOO_HR_ADD_LIST_FIELD_VALUE



# 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}/tools/#BAMBOO_HR_ADJUST_TIME_OFF_BALANCE_FOR_EMPLOYEE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#BAMBOO_HR_CHANGE_REQUEST_STATUS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#BAMBOO_HR_CREATE_EMPLOYEE



# 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}/tools/#BAMBOO_HR_CREATE_TIME_OFF_REQUEST



# 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}/tools/#BAMBOO_HR_GET_EMPLOYEE_BY_ID



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

actionkit/openapi.json POST /projects/{project_id}/tools/#BAMBOO_HR_GET_EMPLOYEE_DIRECTORY



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

actionkit/openapi.json POST /projects/{project_id}/tools/#BAMBOO_HR_GET_FIELD_LIST



# 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}/tools/#BAMBOO_HR_GET_TIME_OFF_REQUESTS_FOR_EMPLOYEE



# 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}/tools/#BAMBOO_HR_GET_TIME_OFF_TYPES



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

actionkit/openapi.json POST /projects/{project_id}/tools/#BAMBOO_HR_UPDATE_EMPLOYEE



# BambooHR
Source: https://docs.useparagon.com/actionkit/integrations/bamboohr/overview

Browse the tools available for BambooHR in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/bamboohr/BAMBOO_HR_CREATE_EMPLOYEE" title="Create Employee" />

  <Card href="/actionkit/integrations/bamboohr/BAMBOO_HR_UPDATE_EMPLOYEE" title="Update Employee" />

  <Card href="/actionkit/integrations/bamboohr/BAMBOO_HR_GET_EMPLOYEE_BY_ID" title="Get Employee By ID" />

  <Card href="/actionkit/integrations/bamboohr/BAMBOO_HR_GET_EMPLOYEE_DIRECTORY" title="Get Employee Directory" />

  <Card href="/actionkit/integrations/bamboohr/BAMBOO_HR_CREATE_TIME_OFF_REQUEST" title="Create Time Off Request" />

  <Card href="/actionkit/integrations/bamboohr/BAMBOO_HR_CHANGE_REQUEST_STATUS" title="Change Request Status" />

  <Card href="/actionkit/integrations/bamboohr/BAMBOO_HR_ADJUST_TIME_OFF_BALANCE_FOR_EMPLOYEE" title="Adjust Time Off Balance For Employee" />

  <Card href="/actionkit/integrations/bamboohr/BAMBOO_HR_GET_TIME_OFF_REQUESTS_FOR_EMPLOYEE" title="Get Time Off Requests For Employee" />

  <Card href="/actionkit/integrations/bamboohr/BAMBOO_HR_GET_TIME_OFF_TYPES" title="Get Time Off Types" />

  <Card href="/actionkit/integrations/bamboohr/BAMBOO_HR_GET_FIELD_LIST" title="Get Field List" />

  <Card href="/actionkit/integrations/bamboohr/BAMBOO_HR_ADD_LIST_FIELD_VALUE" title="Add List Field Value" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for BambooHR. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#BOX_CREATE_FOLDER



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

actionkit/openapi.json POST /projects/{project_id}/tools/#BOX_DELETE_FOLDER



# Download File
Source: https://docs.useparagon.com/actionkit/integrations/box/BOX_DOWNLOAD_FILE

actionkit/openapi.json POST /projects/{project_id}/tools/#BOX_DOWNLOAD_FILE

This Tool will respond with a temporary signed download URL from the Box API. Send a request to this URL to get a response with a byte stream of the file data.


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#BOX_LIST_FILES



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

actionkit/openapi.json POST /projects/{project_id}/tools/#BOX_MOVE_FOLDER



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#BOX_SEARCH_FOLDERS



# Box
Source: https://docs.useparagon.com/actionkit/integrations/box/overview

Browse the tools available for Box in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/box/BOX_SAVE_FILE" title="Save File" />

  <Card href="/actionkit/integrations/box/BOX_SAVE_FILE_FROM_OBJECT" title="Save File From Object" />

  <Card href="/actionkit/integrations/box/BOX_GET_FILE_BY_ID" title="Get File By ID" />

  <Card href="/actionkit/integrations/box/BOX_LIST_FILES" title="List Files" />

  <Card href="/actionkit/integrations/box/BOX_CREATE_FOLDER" title="Create Folder" />

  <Card href="/actionkit/integrations/box/BOX_MOVE_FOLDER" title="Move Folder" />

  <Card href="/actionkit/integrations/box/BOX_GET_FOLDER_BY_ID" title="Get Folder By ID" />

  <Card href="/actionkit/integrations/box/BOX_SEARCH_FOLDERS" title="Search Folders" />

  <Card href="/actionkit/integrations/box/BOX_DELETE_FOLDER" title="Delete Folder" />

  <Card href="/actionkit/integrations/box/BOX_DOWNLOAD_FILE" title="Download File" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Box. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#CALENDLY_GET_EVENT_TYPES



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

actionkit/openapi.json POST /projects/{project_id}/tools/#CALENDLY_SEARCH_EVENTS



# Calendly
Source: https://docs.useparagon.com/actionkit/integrations/calendly/overview

Browse the tools and triggers available for Calendly in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/calendly/CALENDLY_GET_EVENT_TYPES" title="Get Event Types" />

  <Card href="/actionkit/integrations/calendly/CALENDLY_GET_AVAILABLE_TIMES_FOR_EVENT_TYPE" title="Get Available Times For Event Type" />

  <Card href="/actionkit/integrations/calendly/CALENDLY_SEARCH_EVENTS" title="Search Events" />

  <Card href="/actionkit/integrations/calendly/CALENDLY_GET_EVENT_BY_ID" title="Get Event By ID" />

  <Card href="/actionkit/integrations/calendly/CALENDLY_GET_EVENT_INVITEES" title="Get Event Invitees" />

  <Card href="/actionkit/integrations/calendly/CALENDLY_CANCEL_EVENT" title="Cancel Event" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/calendly/triggers/CALENDLY_TRIGGER_INVITEE_CREATED" title="Invitee Created" />

  <Card href="/actionkit/integrations/calendly/triggers/CALENDLY_TRIGGER_INVITEE_CANCELED" title="Invitee Canceled" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Invitee Canceled
Source: https://docs.useparagon.com/actionkit/integrations/calendly/triggers/CALENDLY_TRIGGER_INVITEE_CANCELED

Trigger when a new Calendly invitee is cancelled.

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "calendly",
  "type": "CALENDLY_TRIGGER_INVITEE_CANCELED",
  "parameters": {
    "scope": "user"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Specify whether to only trigger for newly created invitees for all events that are associated with this user or for all newly scheduled events in the organization.

  * Default: `user`
  * Allowed values: `organization`, `user`
</ParamField>


# Invitee Created
Source: https://docs.useparagon.com/actionkit/integrations/calendly/triggers/CALENDLY_TRIGGER_INVITEE_CREATED

Trigger when a new Calendly invitee is created.

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "calendly",
  "type": "CALENDLY_TRIGGER_INVITEE_CREATED",
  "parameters": {
    "scope": "user"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Specify whether to only trigger for newly created invitees for all events that are associated with this user or for all newly scheduled events in the organization.

  * Default: `user`
  * Allowed values: `organization`, `user`
</ParamField>


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

actionkit/openapi.json POST /projects/{project_id}/tools/#CLICKUP_CREATE_TASK



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#CLICKUP_GET_FOLDERS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#CLICKUP_GET_LIST



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

actionkit/openapi.json POST /projects/{project_id}/tools/#CLICKUP_GET_MEMBER



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#CLICKUP_SEARCH_TASKS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#CLICKUP_UPDATE_TASK



# ClickUp
Source: https://docs.useparagon.com/actionkit/integrations/clickup/overview

Browse the tools and triggers available for ClickUp in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/clickup/CLICKUP_SEARCH_TASKS" title="Search Tasks" />

  <Card href="/actionkit/integrations/clickup/CLICKUP_GET_TASK_IN_LIST" title="Get Task In List" />

  <Card href="/actionkit/integrations/clickup/CLICKUP_CREATE_TASK" title="Create Task" />

  <Card href="/actionkit/integrations/clickup/CLICKUP_UPDATE_TASK" title="Update Task" />

  <Card href="/actionkit/integrations/clickup/CLICKUP_DELETE_TASK" title="Delete Task" />

  <Card href="/actionkit/integrations/clickup/CLICKUP_GET_LIST" title="Get List" />

  <Card href="/actionkit/integrations/clickup/CLICKUP_GET_CUSTOM_FIELDS_IN_LIST" title="Get Custom Fields In List" />

  <Card href="/actionkit/integrations/clickup/CLICKUP_GET_ALL_FIELDS_IN_LIST" title="Get All Fields In List" />

  <Card href="/actionkit/integrations/clickup/CLICKUP_GET_SPACE" title="Get Space" />

  <Card href="/actionkit/integrations/clickup/CLICKUP_GET_FOLDERS" title="Get Folders" />

  <Card href="/actionkit/integrations/clickup/CLICKUP_GET_MEMBER" title="Get Member" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_FOLDER_CREATED" title="New Folder Created" />

  <Card href="/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_FOLDER_UPDATED" title="Folder Updated" />

  <Card href="/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_LIST_CREATED" title="New List Created" />

  <Card href="/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_LIST_UPDATED" title="List Updated" />

  <Card href="/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_SPACE_CREATED" title="New Space Created" />

  <Card href="/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_SPACE_UPDATED" title="Space Updated" />

  <Card href="/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_TASK_CREATED" title="New Task Created" />

  <Card href="/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_TASK_UPDATED" title="Task Updated" />

  <Card href="/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_TASK_NEW_COMMENT_ADDED" title="New Comment on Task" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Folder Created
Source: https://docs.useparagon.com/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_FOLDER_CREATED

Trigger when a Folder is created in ClickUp

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "clickup",
  "type": "CLICKUP_TRIGGER_FOLDER_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Folder Updated
Source: https://docs.useparagon.com/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_FOLDER_UPDATED

Trigger when a Folder is updated in ClickUp

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "clickup",
  "type": "CLICKUP_TRIGGER_FOLDER_UPDATED",
  "parameters": {
    "spaceId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Trigger when a Folder is created within the provided Space. Use Connect Portal Workflow Settings to allow users to select a ClickUp Space. Defaults to watching all Spaces.

  * Options can be loaded by using the `spaceCacheKey` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# New List Created
Source: https://docs.useparagon.com/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_LIST_CREATED

Trigger when a List is created in ClickUp

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "clickup",
  "type": "CLICKUP_TRIGGER_LIST_CREATED",
  "parameters": {
    "spaceId": "example-value",
    "folderId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Trigger when a List is created within this Space. Use Connect Portal Workflow Settings to allow users to select a ClickUp Space. Defaults to all Spaces.

  * Options can be loaded by using the `spaceCacheKey` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="TEXTAREA">
  Trigger when a List is created within this Folder. Use Connect Portal Workflow Settings to allow users to select a ClickUp Space. Defaults to provided Space.

  * Options can be loaded by using the `folderCacheKey` key after selecting `spaceId`. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# List Updated
Source: https://docs.useparagon.com/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_LIST_UPDATED

Trigger when a List is updated in ClickUp

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "clickup",
  "type": "CLICKUP_TRIGGER_LIST_UPDATED",
  "parameters": {
    "spaceId": "example-value",
    "folderId": "example-value",
    "listId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Trigger when a List is updated within this Space. Use Connect Portal Workflow Settings to allow users to select a ClickUp Space. Defaults to all Spaces.

  * Options can be loaded by using the `spaceCacheKey` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="TEXTAREA">
  Trigger when a List is updated within this Folder. Use Connect Portal Workflow Settings to allow users to select a ClickUp Folder. Defaults to provided Folder.

  * Options can be loaded by using the `folderCacheKey` key after selecting `spaceId`. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="TEXTAREA">
  Provide a List to watch for updates. Use Connect Portal Workflow Settings to allow users to select a ClickUp List. Defaults to provided Folder.

  * Options can be loaded by using the `listCacheKey` key after selecting `spaceId`. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# New Space Created
Source: https://docs.useparagon.com/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_SPACE_CREATED

Trigger when a Space is created in ClickUp

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "clickup",
  "type": "CLICKUP_TRIGGER_SPACE_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Space Updated
Source: https://docs.useparagon.com/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_SPACE_UPDATED

Trigger when a Space is updated in ClickUp

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "clickup",
  "type": "CLICKUP_TRIGGER_SPACE_UPDATED",
  "parameters": {
    "spaceId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Provide a Space to watch for updates. Use Connect Portal Workflow Settings to allow users to select a ClickUp Space. Defaults to all Spaces.

  * Options can be loaded by using the `spaceCacheKey` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# New Task Created
Source: https://docs.useparagon.com/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_TASK_CREATED

Trigger when a Task is created in ClickUp

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "clickup",
  "type": "CLICKUP_TRIGGER_TASK_CREATED",
  "parameters": {
    "listId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Select a List to create this task in. Use Connect Portal User Settings to allow users to select a ClickUp List.

  * Options can be loaded by using the `listCacheKey` key after selecting `spaceId`. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# New Comment on Task
Source: https://docs.useparagon.com/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_TASK_NEW_COMMENT_ADDED

Trigger when a comment is added to a Task in ClickUp

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "clickup",
  "type": "CLICKUP_TRIGGER_TASK_NEW_COMMENT_ADDED",
  "parameters": {
    "listId": "example-value",
    "taskId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Trigger when a comment is added to a Task within the provided List. Use Connect Portal Workflow Settings to allow users to select a ClickUp List.

  * Options can be loaded by using the `listCacheKey` key after selecting `spaceId`. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="TEXTAREA">
  Trigger when a comment is added to the provided Task. Defaults to subscribing to all Tasks within the List.
</ParamField>


# Task Updated
Source: https://docs.useparagon.com/actionkit/integrations/clickup/triggers/CLICKUP_TRIGGER_TASK_UPDATED

Trigger when a Task is updated in ClickUp

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "clickup",
  "type": "CLICKUP_TRIGGER_TASK_UPDATED",
  "parameters": {
    "listId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Select a List to create this task in. Use Connect Portal User Settings to allow users to select a ClickUp List.

  * Options can be loaded by using the `listCacheKey` key after selecting `spaceId`. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# Advanced Filtering
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_ADVANCED_FILTERING

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_ADVANCED_FILTERING



# Create Record Contact
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_CREATE_RECORD_CONTACT

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_CREATE_RECORD_CONTACT



# Create Record Lead
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_CREATE_RECORD_LEAD

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_CREATE_RECORD_LEAD



# Create Record Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_CREATE_RECORD_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_CREATE_RECORD_OPPORTUNITY



# Create Record Task
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_CREATE_RECORD_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_CREATE_RECORD_TASK



# Delete Record Contact
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_DELETE_RECORD_CONTACT

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_DELETE_RECORD_CONTACT



# Delete Record Lead
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_DELETE_RECORD_LEAD

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_DELETE_RECORD_LEAD



# Delete Record Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_DELETE_RECORD_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_DELETE_RECORD_OPPORTUNITY



# Delete Record Task
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_DELETE_RECORD_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_DELETE_RECORD_TASK



# Get Custom Fields
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_GET_CUSTOM_FIELDS

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_GET_CUSTOM_FIELDS



# Get Record By ID Contact
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_GET_RECORD_BY_ID_CONTACT

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_GET_RECORD_BY_ID_CONTACT



# Get Record By ID Lead
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_GET_RECORD_BY_ID_LEAD

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_GET_RECORD_BY_ID_LEAD



# Get Record By ID Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_GET_RECORD_BY_ID_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_GET_RECORD_BY_ID_OPPORTUNITY



# Get Record By ID Task
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_GET_RECORD_BY_ID_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_GET_RECORD_BY_ID_TASK



# Search Record Contact
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_SEARCH_RECORD_CONTACT

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_SEARCH_RECORD_CONTACT



# Search Record Lead
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_SEARCH_RECORD_LEAD

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_SEARCH_RECORD_LEAD



# Search Record Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_SEARCH_RECORD_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_SEARCH_RECORD_OPPORTUNITY



# Search Record Task
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_SEARCH_RECORD_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_SEARCH_RECORD_TASK



# Update Record Contact
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_UPDATE_RECORD_CONTACT

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_UPDATE_RECORD_CONTACT



# Update Record Lead
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_UPDATE_RECORD_LEAD

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_UPDATE_RECORD_LEAD



# Update Record Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_UPDATE_RECORD_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_UPDATE_RECORD_OPPORTUNITY



# Update Record Task
Source: https://docs.useparagon.com/actionkit/integrations/close/CLOSE_UPDATE_RECORD_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#CLOSE_UPDATE_RECORD_TASK



# Close
Source: https://docs.useparagon.com/actionkit/integrations/close/overview

Browse the tools available for Close in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/close/CLOSE_CREATE_RECORD_LEAD" title="Create Record Lead" />

  <Card href="/actionkit/integrations/close/CLOSE_CREATE_RECORD_OPPORTUNITY" title="Create Record Opportunity" />

  <Card href="/actionkit/integrations/close/CLOSE_CREATE_RECORD_CONTACT" title="Create Record Contact" />

  <Card href="/actionkit/integrations/close/CLOSE_CREATE_RECORD_TASK" title="Create Record Task" />

  <Card href="/actionkit/integrations/close/CLOSE_UPDATE_RECORD_TASK" title="Update Record Task" />

  <Card href="/actionkit/integrations/close/CLOSE_UPDATE_RECORD_OPPORTUNITY" title="Update Record Opportunity" />

  <Card href="/actionkit/integrations/close/CLOSE_UPDATE_RECORD_CONTACT" title="Update Record Contact" />

  <Card href="/actionkit/integrations/close/CLOSE_UPDATE_RECORD_LEAD" title="Update Record Lead" />

  <Card href="/actionkit/integrations/close/CLOSE_GET_RECORD_BY_ID_LEAD" title="Get Record By ID Lead" />

  <Card href="/actionkit/integrations/close/CLOSE_GET_RECORD_BY_ID_OPPORTUNITY" title="Get Record By ID Opportunity" />

  <Card href="/actionkit/integrations/close/CLOSE_GET_RECORD_BY_ID_CONTACT" title="Get Record By ID Contact" />

  <Card href="/actionkit/integrations/close/CLOSE_GET_RECORD_BY_ID_TASK" title="Get Record By ID Task" />

  <Card href="/actionkit/integrations/close/CLOSE_SEARCH_RECORD_LEAD" title="Search Record Lead" />

  <Card href="/actionkit/integrations/close/CLOSE_SEARCH_RECORD_OPPORTUNITY" title="Search Record Opportunity" />

  <Card href="/actionkit/integrations/close/CLOSE_SEARCH_RECORD_CONTACT" title="Search Record Contact" />

  <Card href="/actionkit/integrations/close/CLOSE_SEARCH_RECORD_TASK" title="Search Record Task" />

  <Card href="/actionkit/integrations/close/CLOSE_DELETE_RECORD_LEAD" title="Delete Record Lead" />

  <Card href="/actionkit/integrations/close/CLOSE_DELETE_RECORD_OPPORTUNITY" title="Delete Record Opportunity" />

  <Card href="/actionkit/integrations/close/CLOSE_DELETE_RECORD_CONTACT" title="Delete Record Contact" />

  <Card href="/actionkit/integrations/close/CLOSE_DELETE_RECORD_TASK" title="Delete Record Task" />

  <Card href="/actionkit/integrations/close/CLOSE_ADVANCED_FILTERING" title="Advanced Filtering" />

  <Card href="/actionkit/integrations/close/CLOSE_GET_CUSTOM_FIELDS" title="Get Custom Fields" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Close. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#CODA_CREATE_DOCUMENT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#CODA_SEARCH_DOCUMENTS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#CODA_SEARCH_TABLES



# Coda
Source: https://docs.useparagon.com/actionkit/integrations/coda/overview

Browse the tools available for Coda in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/coda/CODA_CREATE_DOCUMENT" title="Create Document" />

  <Card href="/actionkit/integrations/coda/CODA_SEARCH_DOCUMENTS" title="Search Documents" />

  <Card href="/actionkit/integrations/coda/CODA_GET_DOCUMENT_BY_ID" title="Get Document By ID" />

  <Card href="/actionkit/integrations/coda/CODA_DELETE_DOCUMENT" title="Delete Document" />

  <Card href="/actionkit/integrations/coda/CODA_SEARCH_TABLES" title="Search Tables" />

  <Card href="/actionkit/integrations/coda/CODA_GET_TABLE_BY_ID" title="Get Table By ID" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Coda. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#CONFLUENCE_CREATE_PAGE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#CONFLUENCE_SEARCH_PAGES



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

actionkit/openapi.json POST /projects/{project_id}/tools/#CONFLUENCE_SEARCH_SPACES



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

actionkit/openapi.json POST /projects/{project_id}/tools/#CONFLUENCE_UPDATE_PAGE



# Confluence
Source: https://docs.useparagon.com/actionkit/integrations/confluence/overview

Browse the tools available for Confluence in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/confluence/CONFLUENCE_CREATE_PAGE" title="Create Page" />

  <Card href="/actionkit/integrations/confluence/CONFLUENCE_UPDATE_PAGE" title="Update Page" />

  <Card href="/actionkit/integrations/confluence/CONFLUENCE_GET_PAGE_BY_ID" title="Get Page By ID" />

  <Card href="/actionkit/integrations/confluence/CONFLUENCE_GET_PAGES_IN_SPACE" title="Get Pages In Space" />

  <Card href="/actionkit/integrations/confluence/CONFLUENCE_GET_PAGES_BY_LABEL" title="Get Pages By Label" />

  <Card href="/actionkit/integrations/confluence/CONFLUENCE_SEARCH_PAGES" title="Search Pages" />

  <Card href="/actionkit/integrations/confluence/CONFLUENCE_DELETE_PAGE" title="Delete Page" />

  <Card href="/actionkit/integrations/confluence/CONFLUENCE_GET_SPACE_BY_ID" title="Get Space By ID" />

  <Card href="/actionkit/integrations/confluence/CONFLUENCE_SEARCH_SPACES" title="Search Spaces" />

  <Card href="/actionkit/integrations/confluence/CONFLUENCE_GET_BLOG_POSTS" title="Get Blog Posts" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Confluence. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#DOCUSIGN_SEND_AN_ENVELOPE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DOCUSIGN_UPDATE_ENVELOPE



# DocuSign
Source: https://docs.useparagon.com/actionkit/integrations/docusign/overview

Browse the tools available for DocuSign in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/docusign/DOCUSIGN_CREATE_AN_ENVELOPE" title="Create An Envelope" />

  <Card href="/actionkit/integrations/docusign/DOCUSIGN_UPDATE_ENVELOPE" title="Update Envelope" />

  <Card href="/actionkit/integrations/docusign/DOCUSIGN_GET_ENVELOPE_BY_ID" title="Get Envelope By ID" />

  <Card href="/actionkit/integrations/docusign/DOCUSIGN_SEND_AN_ENVELOPE" title="Send An Envelope" />

  <Card href="/actionkit/integrations/docusign/DOCUSIGN_SEARCH_ENVELOPES" title="Search Envelopes" />

  <Card href="/actionkit/integrations/docusign/DOCUSIGN_ENVELOPE_CUSTOM_FIELD" title="Envelope Custom Field" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for DocuSign. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#DROPBOX_CREATE_FOLDER



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DROPBOX_DELETE_FOLDER



# Download File
Source: https://docs.useparagon.com/actionkit/integrations/dropbox/DROPBOX_DOWNLOAD_FILE

actionkit/openapi.json POST /projects/{project_id}/tools/#DROPBOX_DOWNLOAD_FILE

This Tool will respond with a temporary signed download URL from the Dropbox API. Send a request to this URL to get a response with a byte stream of the file data.


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#DROPBOX_LIST_FILES



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DROPBOX_MOVE_FOLDER



# Save File
Source: https://docs.useparagon.com/actionkit/integrations/dropbox/DROPBOX_SAVE_FILE

actionkit/openapi.json POST /projects/{project_id}/tools/#DROPBOX_SAVE_FILE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DROPBOX_SEARCH_FOLDERS



# Dropbox
Source: https://docs.useparagon.com/actionkit/integrations/dropbox/overview

Browse the tools and triggers available for Dropbox in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/dropbox/DROPBOX_SAVE_FILE" title="Save File" />

  <Card href="/actionkit/integrations/dropbox/DROPBOX_LIST_FILES" title="List Files" />

  <Card href="/actionkit/integrations/dropbox/DROPBOX_SEARCH_FOLDERS" title="Search Folders" />

  <Card href="/actionkit/integrations/dropbox/DROPBOX_CREATE_FOLDER" title="Create Folder" />

  <Card href="/actionkit/integrations/dropbox/DROPBOX_MOVE_FOLDER" title="Move Folder" />

  <Card href="/actionkit/integrations/dropbox/DROPBOX_GET_FOLDER_BY_ID" title="Get Folder By ID" />

  <Card href="/actionkit/integrations/dropbox/DROPBOX_DELETE_FOLDER" title="Delete Folder" />

  <Card href="/actionkit/integrations/dropbox/DROPBOX_DOWNLOAD_FILE" title="Download File" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/dropbox/triggers/TRIGGER_DROPBOX_FILE_CREATED" title="File Created" />

  <Card href="/actionkit/integrations/dropbox/triggers/TRIGGER_DROPBOX_FILE_DELETED" title="File Deleted" />

  <Card href="/actionkit/integrations/dropbox/triggers/TRIGGER_DROPBOX_FILE_UPDATED" title="File Updated" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# File Created
Source: https://docs.useparagon.com/actionkit/integrations/dropbox/triggers/TRIGGER_DROPBOX_FILE_CREATED

Trigger when a file is created in dropbox

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "dropbox",
  "type": "TRIGGER_DROPBOX_FILE_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# File Deleted
Source: https://docs.useparagon.com/actionkit/integrations/dropbox/triggers/TRIGGER_DROPBOX_FILE_DELETED

Trigger when a file is deleted in dropbox

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "dropbox",
  "type": "TRIGGER_DROPBOX_FILE_DELETED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# File Updated
Source: https://docs.useparagon.com/actionkit/integrations/dropbox/triggers/TRIGGER_DROPBOX_FILE_UPDATED

Trigger when a file is updated in dropbox

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "dropbox",
  "type": "TRIGGER_DROPBOX_FILE_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# 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}/tools/#DROPBOX_SIGN_CANCEL_INCOMPLETE_SIGNATURE_REQUEST



# 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}/tools/#DROPBOX_SIGN_CREATE_AND_SEND_SIGNATURE_REQUEST



# Download Files
Source: https://docs.useparagon.com/actionkit/integrations/dropboxsign/DROPBOX_SIGN_DOWNLOAD_FILES

actionkit/openapi.json POST /projects/{project_id}/tools/#DROPBOX_SIGN_DOWNLOAD_FILES

This Tool will respond with a temporary signed download URL from the Dropbox Sign API. Send a request to this URL to get a response with a byte stream of the file data.


# 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}/tools/#DROPBOX_SIGN_GET_SIGNATURE_REQUEST_BY_ID



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DROPBOX_SIGN_SEARCH_SIGNATURE_REQUESTS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DROPBOX_SIGN_UPDATE_SIGNATURE_REQUEST



# Dropbox Sign
Source: https://docs.useparagon.com/actionkit/integrations/dropboxsign/overview

Browse the tools available for Dropbox Sign in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/dropboxsign/DROPBOX_SIGN_CREATE_AND_SEND_SIGNATURE_REQUEST" title="Create And Send Signature Request" />

  <Card href="/actionkit/integrations/dropboxsign/DROPBOX_SIGN_UPDATE_SIGNATURE_REQUEST" title="Update Signature Request" />

  <Card href="/actionkit/integrations/dropboxsign/DROPBOX_SIGN_GET_SIGNATURE_REQUEST_BY_ID" title="Get Signature Request By ID" />

  <Card href="/actionkit/integrations/dropboxsign/DROPBOX_SIGN_SEARCH_SIGNATURE_REQUESTS" title="Search Signature Requests" />

  <Card href="/actionkit/integrations/dropboxsign/DROPBOX_SIGN_CANCEL_INCOMPLETE_SIGNATURE_REQUEST" title="Cancel Incomplete Signature Request" />

  <Card href="/actionkit/integrations/dropboxsign/DROPBOX_SIGN_DOWNLOAD_FILES" title="Download Files" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Dropbox Sign. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_CREATE_PAYMENT_TERM



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_CREATE_PURCHASE_INVOICE



# 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}/tools/#DYNAMICS_BUSINESS_CENTRAL_CREATE_PURCHASE_INVOICE_LINE_ITEM



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_CREATE_TAX_GROUP



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_CREATE_VENDOR



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_DELETE_PAYMENT_TERM



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_DELETE_PURCHASE_INVOICE



# 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}/tools/#DYNAMICS_BUSINESS_CENTRAL_DELETE_PURCHASE_INVOICE_LINE_ITEM



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_DELETE_TAX_GROUP



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_DELETE_VENDOR



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_ACCOUNTS



# 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}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_ACCOUNT_BY_ID



# 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}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_PAYMENT_TERM_BY_ID



# 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}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_BY_ID



# 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}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_LINES



# 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}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_LINE_ITEM_BY_ID



# 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}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_TAX_GROUP_BY_ID



# 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}/tools/#DYNAMICS_BUSINESS_CENTRAL_GET_VENDOR_BY_ID



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_POST_PURCHASE_INVOICE



# 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}/tools/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_FOR_PURCHASE_INVOICE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_PAYMENT_TERM



# 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}/tools/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_PURCHASE_INVOICE_LINE_ITEM



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_TAX_GROUP



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_SEARCH_VENDOR



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_PAYMENT_TERM



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_PURCHASE_INVOICE



# 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}/tools/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_PURCHASE_INVOICE_LINE_ITEM



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_TAX_GROUP



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

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_BUSINESS_CENTRAL_UPDATE_VENDOR



# Dynamics 365 Business Central
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/overview

Browse the tools and triggers available for Dynamics 365 Business Central in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_CREATE_VENDOR" title="Create Vendor" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_UPDATE_VENDOR" title="Update Vendor" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_VENDOR_BY_ID" title="Get Vendor By ID" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_SEARCH_VENDOR" title="Search Vendor" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_DELETE_VENDOR" title="Delete Vendor" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_CREATE_PURCHASE_INVOICE" title="Create Purchase Invoice" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_UPDATE_PURCHASE_INVOICE" title="Update Purchase Invoice" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_POST_PURCHASE_INVOICE" title="Post Purchase Invoice" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_BY_ID" title="Get Purchase Invoice By ID" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_SEARCH_FOR_PURCHASE_INVOICE" title="Search For Purchase Invoice" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_DELETE_PURCHASE_INVOICE" title="Delete Purchase Invoice" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_CREATE_PURCHASE_INVOICE_LINE_ITEM" title="Create Purchase Invoice Line Item" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_UPDATE_PURCHASE_INVOICE_LINE_ITEM" title="Update Purchase Invoice Line Item" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_LINES" title="Get Purchase Invoice Lines" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_PURCHASE_INVOICE_LINE_ITEM_BY_ID" title="Get Purchase Invoice Line Item By ID" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_SEARCH_PURCHASE_INVOICE_LINE_ITEM" title="Search Purchase Invoice Line Item" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_DELETE_PURCHASE_INVOICE_LINE_ITEM" title="Delete Purchase Invoice Line Item" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_ACCOUNTS" title="Get Accounts" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_ACCOUNT_BY_ID" title="Get Account By ID" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_CREATE_TAX_GROUP" title="Create Tax Group" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_UPDATE_TAX_GROUP" title="Update Tax Group" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_TAX_GROUP_BY_ID" title="Get Tax Group By ID" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_SEARCH_TAX_GROUP" title="Search Tax Group" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_DELETE_TAX_GROUP" title="Delete Tax Group" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_CREATE_PAYMENT_TERM" title="Create Payment Term" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_UPDATE_PAYMENT_TERM" title="Update Payment Term" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_GET_PAYMENT_TERM_BY_ID" title="Get Payment Term By ID" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_SEARCH_PAYMENT_TERM" title="Search Payment Term" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/DYNAMICS_BUSINESS_CENTRAL_DELETE_PAYMENT_TERM" title="Delete Payment Term" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/dynamicsbusinesscentral/triggers/DYNAMICS_BUSINESS_CENTRAL_TRIGGER_RECORD_CREATED" title="Record Created">
    Trigger when a new Dynamics Business Central record is created.
  </Card>

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/triggers/DYNAMICS_BUSINESS_CENTRAL_TRIGGER_RECORD_UPDATED" title="Record Updated" />

  <Card href="/actionkit/integrations/dynamicsbusinesscentral/triggers/DYNAMICS_BUSINESS_CENTRAL_TRIGGER_RECORD_DELETED" title="Record Deleted" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Record Created
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/triggers/DYNAMICS_BUSINESS_CENTRAL_TRIGGER_RECORD_CREATED

Trigger when a new Dynamics Business Central record is created.

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "dynamicsbusinesscentral",
  "type": "DYNAMICS_BUSINESS_CENTRAL_TRIGGER_RECORD_CREATED",
  "parameters": {
    "recordType": "purchaseInvoices",
    "businessCentralFilterFormula": "Field"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record Type

  * Allowed values: Purchase Invoice (`purchaseInvoices`), Vendors (`vendors`)
  * Options can be loaded by using the `recordType` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<Accordion title="When Purchase Invoice is selected">
  Additional options when this parameter is set to `purchaseInvoices`.

  <ParamField type="CONDITIONAL">
    Only trigger on records that match these filters.

    * Example value: `Field`
    * Supported filter fields: `id`, `vendorName`, `vendorInvoiceNumber`, `dueDate`, `postingDate`, `status`
    * Supported filter fields are loaded from `getFields` after selecting `recordType`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$numberEquals`, `$numberGreaterThan`, `$numberLessThan`, `$numberGreaterThanOrEqualTo`, `$numberDoesNotEqual`, `$dateTimeEquals`, `$dateTimeBefore`, `$dateTimeAfter`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Vendors is selected">
  Additional options when this parameter is set to `vendors`.

  <ParamField type="CONDITIONAL">
    Only trigger on records that match these filters.

    * Example value: `Field`
    * Supported filter fields: `id`, `displayName`, `number`, `email`, `taxRegistrationNumber`, `paymentTermsId`
    * Supported filter fields are loaded from `getFields` after selecting `recordType`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$numberEquals`, `$numberGreaterThan`, `$numberLessThan`, `$numberGreaterThanOrEqualTo`, `$numberDoesNotEqual`, `$dateTimeEquals`, `$dateTimeBefore`, `$dateTimeAfter`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>


# Record Deleted
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/triggers/DYNAMICS_BUSINESS_CENTRAL_TRIGGER_RECORD_DELETED

Trigger when a Dynamics Business Central record is deleted.

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "dynamicsbusinesscentral",
  "type": "DYNAMICS_BUSINESS_CENTRAL_TRIGGER_RECORD_DELETED",
  "parameters": {
    "recordType": "purchaseInvoices"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record Type

  * Allowed values: `purchaseInvoices`, `vendors`
  * Options can be loaded by using the `recordType` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# Record Updated
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsbusinesscentral/triggers/DYNAMICS_BUSINESS_CENTRAL_TRIGGER_RECORD_UPDATED

Trigger when a Dynamics Business Central record is updated.

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "dynamicsbusinesscentral",
  "type": "DYNAMICS_BUSINESS_CENTRAL_TRIGGER_RECORD_UPDATED",
  "parameters": {
    "recordType": "purchaseInvoices",
    "businessCentralFilterFormula": "Field"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record Type

  * Allowed values: Purchase Invoice (`purchaseInvoices`), Vendors (`vendors`)
  * Options can be loaded by using the `recordType` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<Accordion title="When Purchase Invoice is selected">
  Additional options when this parameter is set to `purchaseInvoices`.

  <ParamField type="CONDITIONAL">
    Only trigger on records that match these filters.

    * Example value: `Field`
    * Supported filter fields: `id`, `vendorName`, `vendorInvoiceNumber`, `dueDate`, `postingDate`, `status`
    * Supported filter fields are loaded from `getFields` after selecting `recordType`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$numberEquals`, `$numberGreaterThan`, `$numberLessThan`, `$numberGreaterThanOrEqualTo`, `$numberDoesNotEqual`, `$dateTimeEquals`, `$dateTimeBefore`, `$dateTimeAfter`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Vendors is selected">
  Additional options when this parameter is set to `vendors`.

  <ParamField type="CONDITIONAL">
    Only trigger on records that match these filters.

    * Example value: `Field`
    * Supported filter fields: `id`, `displayName`, `number`, `email`, `taxRegistrationNumber`, `paymentTermsId`
    * Supported filter fields are loaded from `getFields` after selecting `recordType`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$numberEquals`, `$numberGreaterThan`, `$numberLessThan`, `$numberGreaterThanOrEqualTo`, `$numberDoesNotEqual`, `$dateTimeEquals`, `$dateTimeBefore`, `$dateTimeAfter`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>


# Create Bill
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_BILL

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_BILL



# Create Bill Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_BILL_LINE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_BILL_LINE_ITEM



# Create Customer
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_CUSTOMER

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_CUSTOMER



# Create Invoice
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_INVOICE

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_INVOICE



# Create Invoice Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_INVOICE_LINE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_INVOICE_LINE_ITEM



# Create Payment Journal
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_PAYMENT_JOURNAL

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_PAYMENT_JOURNAL



# Create Payment Journal Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_PAYMENT_JOURNAL_LINE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_PAYMENT_JOURNAL_LINE_ITEM



# Create Vendor
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_VENDOR

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_CREATE_VENDOR



# Delete Bill
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_BILL

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_BILL



# Delete Bill Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_BILL_LINE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_BILL_LINE_ITEM



# Delete Customer
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_CUSTOMER

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_CUSTOMER



# Delete Invoice
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_INVOICE

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_INVOICE



# Delete Invoice Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_INVOICE_LINE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_INVOICE_LINE_ITEM



# Delete Payment Journal
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_PAYMENT_JOURNAL

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_PAYMENT_JOURNAL



# Delete Payment Journal Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_PAYMENT_JOURNAL_LINE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_DELETE_PAYMENT_JOURNAL_LINE_ITEM



# Get Accounts
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_ACCOUNTS

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_ACCOUNTS



# Get Bill By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_BILL_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_BILL_BY_ID



# Get Bill Line Item By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_BILL_LINE_ITEM_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_BILL_LINE_ITEM_BY_ID



# Get Customer By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_CUSTOMER_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_CUSTOMER_BY_ID



# Get Invoice By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_INVOICE_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_INVOICE_BY_ID



# Get Invoice Line Item By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_INVOICE_LINE_ITEM_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_INVOICE_LINE_ITEM_BY_ID



# Get Payment Journal By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_PAYMENT_JOURNAL_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_PAYMENT_JOURNAL_BY_ID



# Get Payment Journal Line Item By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_PAYMENT_JOURNAL_LINE_ITEM_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_PAYMENT_JOURNAL_LINE_ITEM_BY_ID



# Get Vendor By ID
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_VENDOR_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_GET_VENDOR_BY_ID



# Search Bills
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_BILLS

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_BILLS



# Search Bill Line Items
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_BILL_LINE_ITEMS

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_BILL_LINE_ITEMS



# Search Customers
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_CUSTOMERS

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_CUSTOMERS



# Search Invoices
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_INVOICES

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_INVOICES



# Search Invoice Line Items
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_INVOICE_LINE_ITEMS

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_INVOICE_LINE_ITEMS



# Search Payment Journals
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_PAYMENT_JOURNALS

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_PAYMENT_JOURNALS



# Search Payment Journal Line Items
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_PAYMENT_JOURNAL_LINE_ITEMS

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_PAYMENT_JOURNAL_LINE_ITEMS



# Search Vendors
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_VENDORS

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_SEARCH_VENDORS



# Update Bill
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_BILL

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_BILL



# Update Bill Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_BILL_LINE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_BILL_LINE_ITEM



# Update Customer
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_CUSTOMER

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_CUSTOMER



# Update Invoice
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_INVOICE

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_INVOICE



# Update Invoice Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_INVOICE_LINE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_INVOICE_LINE_ITEM



# Update Payment Journal
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_PAYMENT_JOURNAL

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_PAYMENT_JOURNAL



# Update Payment Journal Line Item
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_PAYMENT_JOURNAL_LINE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_PAYMENT_JOURNAL_LINE_ITEM



# Update Vendor
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_VENDOR

actionkit/openapi.json POST /projects/{project_id}/tools/#DYNAMICS_365_FINANCE_UPDATE_VENDOR



# Dynamics 365 Finance
Source: https://docs.useparagon.com/actionkit/integrations/dynamicsfinance/overview

Browse the tools available for Dynamics 365 Finance in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_ACCOUNTS" title="Get Accounts" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_VENDOR" title="Create Vendor" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_VENDOR" title="Update Vendor" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_VENDOR_BY_ID" title="Get Vendor By ID" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_VENDORS" title="Search Vendors" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_BILL" title="Create Bill" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_BILL" title="Update Bill" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_BILL_BY_ID" title="Get Bill By ID" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_BILL" title="Delete Bill" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_BILLS" title="Search Bills" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_BILL_LINE_ITEM" title="Create Bill Line Item" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_BILL_LINE_ITEM" title="Update Bill Line Item" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_BILL_LINE_ITEM_BY_ID" title="Get Bill Line Item By ID" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_BILL_LINE_ITEMS" title="Search Bill Line Items" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_BILL_LINE_ITEM" title="Delete Bill Line Item" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_CUSTOMER" title="Create Customer" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_CUSTOMER" title="Update Customer" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_CUSTOMER_BY_ID" title="Get Customer By ID" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_CUSTOMERS" title="Search Customers" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_CUSTOMER" title="Delete Customer" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_INVOICE" title="Create Invoice" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_INVOICE" title="Update Invoice" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_INVOICE_BY_ID" title="Get Invoice By ID" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_INVOICES" title="Search Invoices" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_INVOICE" title="Delete Invoice" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_INVOICE_LINE_ITEM" title="Create Invoice Line Item" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_INVOICE_LINE_ITEM" title="Update Invoice Line Item" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_INVOICE_LINE_ITEM_BY_ID" title="Get Invoice Line Item By ID" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_INVOICE_LINE_ITEMS" title="Search Invoice Line Items" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_INVOICE_LINE_ITEM" title="Delete Invoice Line Item" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_PAYMENT_JOURNAL" title="Create Payment Journal" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_PAYMENT_JOURNAL" title="Update Payment Journal" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_PAYMENT_JOURNAL_BY_ID" title="Get Payment Journal By ID" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_PAYMENT_JOURNALS" title="Search Payment Journals" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_PAYMENT_JOURNAL" title="Delete Payment Journal" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_CREATE_PAYMENT_JOURNAL_LINE_ITEM" title="Create Payment Journal Line Item" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_UPDATE_PAYMENT_JOURNAL_LINE_ITEM" title="Update Payment Journal Line Item" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_GET_PAYMENT_JOURNAL_LINE_ITEM_BY_ID" title="Get Payment Journal Line Item By ID" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_SEARCH_PAYMENT_JOURNAL_LINE_ITEMS" title="Search Payment Journal Line Items" />

  <Card href="/actionkit/integrations/dynamicsfinance/DYNAMICS_365_FINANCE_DELETE_PAYMENT_JOURNAL_LINE_ITEM" title="Delete Payment Journal Line Item" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Dynamics 365 Finance. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# 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}/tools/#FACEBOOK_ADS_BUILD_AD_CREATIVE_OBJECT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FACEBOOK_ADS_CREATE_AD



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FACEBOOK_ADS_CREATE_AD_CREATIVE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FACEBOOK_ADS_CREATE_AD_SET



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FACEBOOK_ADS_CREATE_CAMPAIGN



# 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}/tools/#FACEBOOK_ADS_CREATE_LEAD_GEN_FORM



# 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}/tools/#FACEBOOK_ADS_GET_AD_BY_ID



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FACEBOOK_ADS_GET_AD_SETS



# 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}/tools/#FACEBOOK_ADS_GET_AD_SET_BY_ID



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FACEBOOK_ADS_GET_CAMPAIGNS



# 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}/tools/#FACEBOOK_ADS_GET_CAMPAIGN_BY_ID



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FACEBOOK_ADS_SEND_FUNNEL_EVENT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FACEBOOK_ADS_SEND_LEAD_EVENT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FACEBOOK_ADS_SEND_PURCHASE_EVENT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FACEBOOK_ADS_UPDATE_AD



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FACEBOOK_ADS_UPDATE_AD_SET



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FACEBOOK_ADS_UPDATE_CAMPAIGN



# Facebook Ads
Source: https://docs.useparagon.com/actionkit/integrations/facebookAds/overview

Browse the tools available for Facebook Ads in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_CREATE_CAMPAIGN" title="Create Campaign" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_UPDATE_CAMPAIGN" title="Update Campaign" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_GET_CAMPAIGN_BY_ID" title="Get Campaign By ID" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_GET_CAMPAIGNS" title="Get Campaigns" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_CREATE_AD_SET" title="Create Ad Set" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_UPDATE_AD_SET" title="Update Ad Set" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_GET_AD_SET_BY_ID" title="Get Ad Set By ID" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_GET_AD_SETS" title="Get Ad Sets" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_CREATE_AD" title="Create Ad" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_UPDATE_AD" title="Update Ad" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_GET_AD_BY_ID" title="Get Ad By ID" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_BUILD_AD_CREATIVE_OBJECT" title="Build Ad Creative Object" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_CREATE_AD_CREATIVE" title="Create Ad Creative" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_CREATE_LEAD_GEN_FORM" title="Create Lead Gen Form" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_SEND_PURCHASE_EVENT" title="Send Purchase Event" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_SEND_LEAD_EVENT" title="Send Lead Event" />

  <Card href="/actionkit/integrations/facebookAds/FACEBOOK_ADS_SEND_FUNNEL_EVENT" title="Send Funnel Event" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Facebook Ads. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#FIGMA_CREATE_COMMENT_REACTION



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#FIGMA_GET_FILE_NODES



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#FIGMA_GET_RENDERED_IMAGE



# Figma
Source: https://docs.useparagon.com/actionkit/integrations/figma/overview

Browse the tools available for Figma in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/figma/FIGMA_GET_FILE_BY_ID" title="Get File By ID" />

  <Card href="/actionkit/integrations/figma/FIGMA_GET_FILE_NODES" title="Get File Nodes" />

  <Card href="/actionkit/integrations/figma/FIGMA_GET_RENDERED_IMAGE" title="Get Rendered Image" />

  <Card href="/actionkit/integrations/figma/FIGMA_GET_PROJECT" title="Get Project" />

  <Card href="/actionkit/integrations/figma/FIGMA_GET_PROJECT_FILES" title="Get Project Files" />

  <Card href="/actionkit/integrations/figma/FIGMA_CREATE_COMMENT" title="Create Comment" />

  <Card href="/actionkit/integrations/figma/FIGMA_GET_COMMENTS_BY_FILE" title="Get Comments By File" />

  <Card href="/actionkit/integrations/figma/FIGMA_DELETE_COMMENTS" title="Delete Comments" />

  <Card href="/actionkit/integrations/figma/FIGMA_CREATE_COMMENT_REACTION" title="Create Comment Reaction" />

  <Card href="/actionkit/integrations/figma/FIGMA_GET_COMMENT_REACTION" title="Get Comment Reaction" />

  <Card href="/actionkit/integrations/figma/FIGMA_DELETE_COMMENT_REACTION" title="Delete Comment Reaction" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Figma. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#FRESHDESK_CREATE_TICKET



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#FRESHDESK_UPDATE_TICKET



# Freshdesk
Source: https://docs.useparagon.com/actionkit/integrations/freshdesk/overview

Browse the tools available for Freshdesk in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/freshdesk/FRESHDESK_CREATE_TICKET" title="Create Ticket" />

  <Card href="/actionkit/integrations/freshdesk/FRESHDESK_UPDATE_TICKET" title="Update Ticket" />

  <Card href="/actionkit/integrations/freshdesk/FRESHDESK_GET_TICKET_BY_ID" title="Get Ticket By ID" />

  <Card href="/actionkit/integrations/freshdesk/FRESHDESK_DELETE_TICKET" title="Delete Ticket" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Freshdesk. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#FRONT_CREATE_ACCOUNT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FRONT_CREATE_CONTACT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FRONT_DELETE_ACCOUNT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#FRONT_SEARCH_ACCOUNTS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FRONT_SEARCH_CONTACTS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FRONT_UPDATE_ACCOUNT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#FRONT_UPDATE_CONTACT



# Front
Source: https://docs.useparagon.com/actionkit/integrations/front/overview

Browse the tools available for Front in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/front/FRONT_CREATE_ACCOUNT" title="Create Account" />

  <Card href="/actionkit/integrations/front/FRONT_UPDATE_ACCOUNT" title="Update Account" />

  <Card href="/actionkit/integrations/front/FRONT_GET_ACCOUNT_BY_ID" title="Get Account By ID" />

  <Card href="/actionkit/integrations/front/FRONT_SEARCH_ACCOUNTS" title="Search Accounts" />

  <Card href="/actionkit/integrations/front/FRONT_DELETE_ACCOUNT" title="Delete Account" />

  <Card href="/actionkit/integrations/front/FRONT_CREATE_CONTACT" title="Create Contact" />

  <Card href="/actionkit/integrations/front/FRONT_UPDATE_CONTACT" title="Update Contact" />

  <Card href="/actionkit/integrations/front/FRONT_GET_CONTACT_BY_ID" title="Get Contact By ID" />

  <Card href="/actionkit/integrations/front/FRONT_SEARCH_CONTACTS" title="Search Contacts" />

  <Card href="/actionkit/integrations/front/FRONT_DELETE_CONTACT" title="Delete Contact" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Front. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#GITHUB_CREATE_ISSUE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GITHUB_CREATE_RELEASE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GITHUB_DELETE_RELEASE



# Get File
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_GET_FILE

actionkit/openapi.json POST /projects/{project_id}/tools/#GITHUB_GET_FILE



# Get Files Changed In Pr
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_GET_FILES_CHANGED_IN_PR

actionkit/openapi.json POST /projects/{project_id}/tools/#GITHUB_GET_FILES_CHANGED_IN_PR



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GITHUB_GET_ISSUE_BY_NUMBER



# Get Pull Request By Number
Source: https://docs.useparagon.com/actionkit/integrations/github/GITHUB_GET_PULL_REQUEST_BY_NUMBER

actionkit/openapi.json POST /projects/{project_id}/tools/#GITHUB_GET_PULL_REQUEST_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}/tools/#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}/tools/#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}/tools/#GITHUB_LOCK_ISSUE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GITHUB_SEARCH_ISSUE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GITHUB_UPDATE_ISSUE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GITHUB_UPDATE_RELEASE



# GitHub
Source: https://docs.useparagon.com/actionkit/integrations/github/overview

Browse the tools and triggers available for GitHub in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/github/GITHUB_CREATE_ISSUE" title="Create Issue" />

  <Card href="/actionkit/integrations/github/GITHUB_UPDATE_ISSUE" title="Update Issue" />

  <Card href="/actionkit/integrations/github/GITHUB_GET_ISSUE_BY_NUMBER" title="Get Issue By Number" />

  <Card href="/actionkit/integrations/github/GITHUB_LOCK_ISSUE" title="Lock Issue" />

  <Card href="/actionkit/integrations/github/GITHUB_SEARCH_ISSUE" title="Search Issue" />

  <Card href="/actionkit/integrations/github/GITHUB_CREATE_RELEASE" title="Create Release" />

  <Card href="/actionkit/integrations/github/GITHUB_UPDATE_RELEASE" title="Update Release" />

  <Card href="/actionkit/integrations/github/GITHUB_GET_RELEASE_BY_ID" title="Get Release By ID" />

  <Card href="/actionkit/integrations/github/GITHUB_GET_RELEASE_BY_TAG_NAME" title="Get Release By Tag Name" />

  <Card href="/actionkit/integrations/github/GITHUB_DELETE_RELEASE" title="Delete Release" />

  <Card href="/actionkit/integrations/github/GITHUB_GET_FILES_CHANGED_IN_PR" title="Get Files Changed In Pr" />

  <Card href="/actionkit/integrations/github/GITHUB_GET_PULL_REQUEST_BY_NUMBER" title="Get Pull Request By Number" />

  <Card href="/actionkit/integrations/github/GITHUB_GET_FILE" title="Get File" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/github/triggers/GITHUB_TRIGGER_ISSUE_CREATED" title="Issue Created" />

  <Card href="/actionkit/integrations/github/triggers/GITHUB_TRIGGER_ISSUE_UPDATED" title="Issue Updated" />

  <Card href="/actionkit/integrations/github/triggers/GITHUB_TRIGGER_PULL_REQUEST_CREATED" title="PR Created" />

  <Card href="/actionkit/integrations/github/triggers/GITHUB_TRIGGER_PULL_REQUEST_UPDATED" title="PR Updated" />

  <Card href="/actionkit/integrations/github/triggers/GITHUB_TRIGGER_PROJECT_CREATED" title="Project Created" />

  <Card href="/actionkit/integrations/github/triggers/GITHUB_TRIGGER_PROJECT_UPDATED" title="Project Updated" />

  <Card href="/actionkit/integrations/github/triggers/GITHUB_TRIGGER_CLASSIC_PROJECT_CREATED" title="Project Created (Classic)" />

  <Card href="/actionkit/integrations/github/triggers/GITHUB_TRIGGER_CLASSIC_PROJECT_UPDATED" title="Project Updated (Classic)" />

  <Card href="/actionkit/integrations/github/triggers/GITHUB_TRIGGER_PROJECT_ITEM_CREATED" title="Project Item Created" />

  <Card href="/actionkit/integrations/github/triggers/GITHUB_TRIGGER_PROJECT_ITEM_UPDATED" title="Project Item Updated" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Project Created (Classic)
Source: https://docs.useparagon.com/actionkit/integrations/github/triggers/GITHUB_TRIGGER_CLASSIC_PROJECT_CREATED

Trigger when a classic Project is created in GitHub

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "github",
  "type": "GITHUB_TRIGGER_CLASSIC_PROJECT_CREATED",
  "parameters": {
    "apiType": "githubApp"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Select the type for Repository, Organization, and GitHub App triggers. see the [docs](https://docs.github.com/en/webhooks-and-events/webhooks/creating-webhooks).

  * Allowed values: `githubApp`, Organization (`organization`), Repository (`repository`)
</ParamField>

<Accordion title="When Organization is selected">
  Additional options when this parameter is set to `organization`.

  <ParamField type="TEXTAREA">
    Specify the Organization name. The name is not case sensitive.

    * Example value: `Paragon`
  </ParamField>
</Accordion>

<Accordion title="When Repository is selected">
  Additional options when this parameter is set to `repository`.

  <ParamField type="TEXTAREA">
    Specify the name of the account owner of the associated repository for this Project (Classic).

    * Example value: `abc`
  </ParamField>

  <ParamField type="TEXTAREA">
    Specify the name of the associated repository for this Project (Classic).
  </ParamField>
</Accordion>


# Project Updated (Classic)
Source: https://docs.useparagon.com/actionkit/integrations/github/triggers/GITHUB_TRIGGER_CLASSIC_PROJECT_UPDATED

Trigger when a classic Project is updated in GitHub

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "github",
  "type": "GITHUB_TRIGGER_CLASSIC_PROJECT_UPDATED",
  "parameters": {
    "apiType": "githubApp"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Select the type for Repository, Organization, and GitHub App triggers. see the [docs](https://docs.github.com/en/webhooks-and-events/webhooks/creating-webhooks).

  * Allowed values: `githubApp`, Organization (`organization`), Repository (`repository`)
</ParamField>

<Accordion title="When Organization is selected">
  Additional options when this parameter is set to `organization`.

  <ParamField type="TEXTAREA">
    Specify the Organization name. The name is not case sensitive.

    * Example value: `Paragon`
  </ParamField>
</Accordion>

<Accordion title="When Repository is selected">
  Additional options when this parameter is set to `repository`.

  <ParamField type="TEXTAREA">
    Specify the name of the account owner of the associated repository for this Project (Classic).

    * Example value: `abc`
  </ParamField>

  <ParamField type="TEXTAREA">
    Specify the name of the associated repository for this Project (Classic).
  </ParamField>
</Accordion>


# Issue Created
Source: https://docs.useparagon.com/actionkit/integrations/github/triggers/GITHUB_TRIGGER_ISSUE_CREATED

Trigger when an Issue is created in GitHub

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "github",
  "type": "GITHUB_TRIGGER_ISSUE_CREATED",
  "parameters": {
    "apiType": "githubApp"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Select the type for Repository, Organization, and GitHub App triggers. see the [docs](https://docs.github.com/en/webhooks-and-events/webhooks/creating-webhooks).

  * Allowed values: `githubApp`, Organization (`organization`), Repository (`repository`)
</ParamField>

<Accordion title="When Organization is selected">
  Additional options when this parameter is set to `organization`.

  <ParamField type="TEXTAREA">
    Specify the Organization name. The name is not case sensitive.

    * Example value: `Paragon`
  </ParamField>
</Accordion>

<Accordion title="When Repository is selected">
  Additional options when this parameter is set to `repository`.

  <ParamField type="TEXTAREA">
    Specify the name of the account owner of the associated repository for this Issue.

    * Example value: `abc`
  </ParamField>

  <ParamField type="TEXTAREA">
    Specify the name of the associated repository for this Issue.
  </ParamField>
</Accordion>


# Issue Updated
Source: https://docs.useparagon.com/actionkit/integrations/github/triggers/GITHUB_TRIGGER_ISSUE_UPDATED

Trigger when an Issue is updated in GitHub

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "github",
  "type": "GITHUB_TRIGGER_ISSUE_UPDATED",
  "parameters": {
    "apiType": "githubApp"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Select the type for Repository, Organization, and GitHub App triggers. see the [docs](https://docs.github.com/en/webhooks-and-events/webhooks/creating-webhooks).

  * Allowed values: `githubApp`, Organization (`organization`), Repository (`repository`)
</ParamField>

<Accordion title="When Organization is selected">
  Additional options when this parameter is set to `organization`.

  <ParamField type="TEXTAREA">
    Specify the Organization name. The name is not case sensitive.

    * Example value: `Paragon`
  </ParamField>
</Accordion>

<Accordion title="When Repository is selected">
  Additional options when this parameter is set to `repository`.

  <ParamField type="TEXTAREA">
    Specify the name of the account owner of the associated repository for this Issue.

    * Example value: `abc`
  </ParamField>

  <ParamField type="TEXTAREA">
    Specify the name of the associated repository for this Issue.
  </ParamField>
</Accordion>


# Project Created
Source: https://docs.useparagon.com/actionkit/integrations/github/triggers/GITHUB_TRIGGER_PROJECT_CREATED

Trigger when a Project is created in GitHub through OAuth

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "github",
  "type": "GITHUB_TRIGGER_PROJECT_CREATED",
  "parameters": {
    "apiType": "organization",
    "organization": "Paragon"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Select the type for Organization triggers. see the [docs](https://docs.github.com/en/webhooks-and-events/webhooks/creating-webhooks).

  * Allowed values: Organization (`organization`)
</ParamField>

<Accordion title="When Organization is selected">
  Additional options when this parameter is set to `organization`.

  <ParamField type="TEXTAREA">
    Specify the Organization name. The name is not case sensitive.

    * Example value: `Paragon`
  </ParamField>
</Accordion>


# Project Item Created
Source: https://docs.useparagon.com/actionkit/integrations/github/triggers/GITHUB_TRIGGER_PROJECT_ITEM_CREATED

Trigger when a Project Item is created in GitHub

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "github",
  "type": "GITHUB_TRIGGER_PROJECT_ITEM_CREATED",
  "parameters": {
    "apiType": "githubApp"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Select the type for Organization and GitHub App triggers. see the [docs](https://docs.github.com/en/webhooks-and-events/webhooks/creating-webhooks).

  * Allowed values: `githubApp`, Organization (`organization`)
</ParamField>

<Accordion title="When Organization is selected">
  Additional options when this parameter is set to `organization`.

  <ParamField type="TEXTAREA">
    Specify the Organization name. The name is not case sensitive.

    * Example value: `Paragon`
  </ParamField>
</Accordion>


# Project Item Updated
Source: https://docs.useparagon.com/actionkit/integrations/github/triggers/GITHUB_TRIGGER_PROJECT_ITEM_UPDATED

Trigger when a Project Item is updated in GitHub

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "github",
  "type": "GITHUB_TRIGGER_PROJECT_ITEM_UPDATED",
  "parameters": {
    "apiType": "githubApp"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Select the type for Organization and GitHub App triggers. see the [docs](https://docs.github.com/en/webhooks-and-events/webhooks/creating-webhooks).

  * Allowed values: `githubApp`, Organization (`organization`)
</ParamField>

<Accordion title="When Organization is selected">
  Additional options when this parameter is set to `organization`.

  <ParamField type="TEXTAREA">
    Specify the Organization name. The name is not case sensitive.

    * Example value: `Paragon`
  </ParamField>
</Accordion>


# Project Updated
Source: https://docs.useparagon.com/actionkit/integrations/github/triggers/GITHUB_TRIGGER_PROJECT_UPDATED

Trigger when a Project is updated in GitHub through OAuth

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "github",
  "type": "GITHUB_TRIGGER_PROJECT_UPDATED",
  "parameters": {
    "apiType": "organization",
    "organization": "Paragon"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Select the type for Organization triggers. see the [docs](https://docs.github.com/en/webhooks-and-events/webhooks/creating-webhooks).

  * Allowed values: Organization (`organization`)
</ParamField>

<Accordion title="When Organization is selected">
  Additional options when this parameter is set to `organization`.

  <ParamField type="TEXTAREA">
    Specify the Organization name. The name is not case sensitive.

    * Example value: `Paragon`
  </ParamField>
</Accordion>


# PR Created
Source: https://docs.useparagon.com/actionkit/integrations/github/triggers/GITHUB_TRIGGER_PULL_REQUEST_CREATED

Trigger when a PR is created in GitHub

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "github",
  "type": "GITHUB_TRIGGER_PULL_REQUEST_CREATED",
  "parameters": {
    "apiType": "githubApp"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Select the type for Repository, Organization, and GitHub App triggers. see the [docs](https://docs.github.com/en/webhooks-and-events/webhooks/creating-webhooks).

  * Allowed values: `githubApp`, Organization (`organization`), Repository (`repository`)
</ParamField>

<Accordion title="When Organization is selected">
  Additional options when this parameter is set to `organization`.

  <ParamField type="TEXTAREA">
    Specify the Organization name. The name is not case sensitive.

    * Example value: `Paragon`
  </ParamField>
</Accordion>

<Accordion title="When Repository is selected">
  Additional options when this parameter is set to `repository`.

  <ParamField type="TEXTAREA">
    Specify the name of the account owner of the associated repository for this Pull Request.

    * Example value: `abc`
  </ParamField>

  <ParamField type="TEXTAREA">
    Specify the name of the associated repository for this Pull Request.
  </ParamField>
</Accordion>


# PR Updated
Source: https://docs.useparagon.com/actionkit/integrations/github/triggers/GITHUB_TRIGGER_PULL_REQUEST_UPDATED

Trigger when a PR is updated in GitHub

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "github",
  "type": "GITHUB_TRIGGER_PULL_REQUEST_UPDATED",
  "parameters": {
    "apiType": "githubApp"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Select the type for Repository, Organization, and GitHub App triggers. see the [docs](https://docs.github.com/en/webhooks-and-events/webhooks/creating-webhooks).

  * Allowed values: `githubApp`, Organization (`organization`), Repository (`repository`)
</ParamField>

<Accordion title="When Organization is selected">
  Additional options when this parameter is set to `organization`.

  <ParamField type="TEXTAREA">
    Specify the Organization name. The name is not case sensitive.

    * Example value: `Paragon`
  </ParamField>
</Accordion>

<Accordion title="When Repository is selected">
  Additional options when this parameter is set to `repository`.

  <ParamField type="TEXTAREA">
    Specify the name of the account owner of the associated repository for this Pull Request.

    * Example value: `abc`
  </ParamField>

  <ParamField type="TEXTAREA">
    Specify the name of the associated repository for this Pull Request.
  </ParamField>
</Accordion>


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

actionkit/openapi.json POST /projects/{project_id}/tools/#GMAIL_CREATE_A_CONTACT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GMAIL_CREATE_DRAFT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GMAIL_DELETE_CONTACT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#GMAIL_SEARCH_FOR_EMAIL



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GMAIL_SEND_EMAIL



# Gmail
Source: https://docs.useparagon.com/actionkit/integrations/gmail/overview

Browse the tools and triggers available for Gmail in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/gmail/GMAIL_SEND_EMAIL" title="Send Email" />

  <Card href="/actionkit/integrations/gmail/GMAIL_GET_EMAIL_BY_ID" title="Get Email By ID" />

  <Card href="/actionkit/integrations/gmail/GMAIL_SEARCH_FOR_EMAIL" title="Search For Email" />

  <Card href="/actionkit/integrations/gmail/GMAIL_DELETE_EMAIL" title="Delete Email" />

  <Card href="/actionkit/integrations/gmail/GMAIL_CREATE_A_CONTACT" title="Create A Contact" />

  <Card href="/actionkit/integrations/gmail/GMAIL_GET_CONTACT_BY_RESOURCE_NAME" title="Get Contact By Resource Name" />

  <Card href="/actionkit/integrations/gmail/GMAIL_SEARCH_FOR_CONTACT" title="Search For Contact" />

  <Card href="/actionkit/integrations/gmail/GMAIL_DELETE_CONTACT" title="Delete Contact" />

  <Card href="/actionkit/integrations/gmail/GMAIL_CREATE_DRAFT" title="Create Draft" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/gmail/triggers/GMAIL_TRIGGER_THREAD_CREATED" title="Thread Created" />

  <Card href="/actionkit/integrations/gmail/triggers/GMAIL_TRIGGER_THREAD_UPDATED" title="Thread Updated" />

  <Card href="/actionkit/integrations/gmail/triggers/GMAIL_TRIGGER_THREAD_MODIFIED" title="Thread Modified">
    Trigger when an email thread is either created or updated in Gmail. Returned payload contains thread reference IDs.
  </Card>
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Thread Created
Source: https://docs.useparagon.com/actionkit/integrations/gmail/triggers/GMAIL_TRIGGER_THREAD_CREATED

Trigger when an email thread is created in Gmail

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "gmail",
  "type": "GMAIL_TRIGGER_THREAD_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Thread Modified
Source: https://docs.useparagon.com/actionkit/integrations/gmail/triggers/GMAIL_TRIGGER_THREAD_MODIFIED

Trigger when an email thread is either created or updated in Gmail. Returned payload contains thread reference IDs.

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "gmail",
  "type": "GMAIL_TRIGGER_THREAD_MODIFIED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Thread Updated
Source: https://docs.useparagon.com/actionkit/integrations/gmail/triggers/GMAIL_TRIGGER_THREAD_UPDATED

Trigger when an email thread is updated in Gmail

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "gmail",
  "type": "GMAIL_TRIGGER_THREAD_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#GONG_SEARCH_CALL



# Gong
Source: https://docs.useparagon.com/actionkit/integrations/gong/overview

Browse the tools available for Gong in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/gong/GONG_ADD_CALL" title="Add Call" />

  <Card href="/actionkit/integrations/gong/GONG_GET_CALL_BY_ID" title="Get Call By ID" />

  <Card href="/actionkit/integrations/gong/GONG_SEARCH_CALL" title="Search Call" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Gong. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_CALENDAR_CREATE_EVENT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_CALENDAR_DELETE_EVENT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_CALENDAR_GET_AVAILABILITY



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_CALENDAR_GET_CONTACTS



# 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}/tools/#GOOGLE_CALENDAR_GET_EVENT_BY_ID



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_CALENDAR_LIST_DIRECTORY_PEOPLE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_CALENDAR_LIST_EVENTS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_CALENDAR_LIST_OTHER_CONTACTS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_CALENDAR_SEARCH_CONTACTS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_CALENDAR_SEARCH_DIRECTORY_PEOPLE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_CALENDAR_SEARCH_OTHER_CONTACTS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_CALENDAR_UPDATE_EVENT



# Google Calendar
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/overview

Browse the tools and triggers available for Google Calendar in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_CREATE_EVENT" title="Create Event" />

  <Card href="/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_UPDATE_EVENT" title="Update Event" />

  <Card href="/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_LIST_EVENTS" title="List Events" />

  <Card href="/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_GET_EVENT_BY_ID" title="Get Event By ID" />

  <Card href="/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_DELETE_EVENT" title="Delete Event" />

  <Card href="/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_GET_CONTACTS" title="Get Contacts" />

  <Card href="/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_SEARCH_CONTACTS" title="Search Contacts" />

  <Card href="/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_LIST_DIRECTORY_PEOPLE" title="List Directory People" />

  <Card href="/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_SEARCH_DIRECTORY_PEOPLE" title="Search Directory People" />

  <Card href="/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_LIST_OTHER_CONTACTS" title="List Other Contacts" />

  <Card href="/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_SEARCH_OTHER_CONTACTS" title="Search Other Contacts" />

  <Card href="/actionkit/integrations/googleCalendar/GOOGLE_CALENDAR_GET_AVAILABILITY" title="Get Availability" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_TRIGGER_EVENT_CREATED" title="New Event (Legacy)" />

  <Card href="/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_TRIGGER_EVENT_UPDATED" title="Event Updated (Legacy)" />

  <Card href="/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_TRIGGER_EVENT_CANCELLED" title="Event Cancelled (Legacy)" />

  <Card href="/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_TRIGGER_EVENT_STARTED" title="Event Started" />

  <Card href="/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_TRIGGER_EVENT_ENDED" title="Event Ended" />

  <Card href="/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_WEBHOOK_TRIGGER_EVENT_CREATED" title="New Event" />

  <Card href="/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_WEBHOOK_TRIGGER_EVENT_UPDATED" title="Event Updated" />

  <Card href="/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_WEBHOOK_TRIGGER_EVENT_CANCELLED" title="Event Cancelled" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Event Cancelled (Legacy)
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_TRIGGER_EVENT_CANCELLED

Trigger when a Google Calendar Event is cancelled

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googleCalendar",
  "type": "GOOGLE_CALENDAR_TRIGGER_EVENT_CANCELLED",
  "parameters": {
    "calendarId": "{{settings.calendar}}",
    "collapseRecurringEventUpdates": true,
    "shouldTriggerOnPastEventUpdates": false
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Use Connect Portal Workflow Settings to allow users to select a calendar. Defaults to the user’s primary calendar if left blank.

  * Example value: `{{settings.calendar}}`
  * Options can be loaded by using the `calendars` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="BOOLEAN_INPUT">
  If on, recurring event updates will not be expanded into multiple instances of the event.

  * Default: `true`
</ParamField>

<ParamField type="BOOLEAN_INPUT">
  If on, this workflow will trigger when events that have already passed are cancelled. This can add significant event volume to this workflow.

  * Default: `false`
</ParamField>


# New Event (Legacy)
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_TRIGGER_EVENT_CREATED

Trigger when a new Google Calendar Event is created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googleCalendar",
  "type": "GOOGLE_CALENDAR_TRIGGER_EVENT_CREATED",
  "parameters": {
    "calendarId": "{{settings.calendar}}",
    "collapseRecurringEventUpdates": true
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Use Connect Portal Workflow Settings to allow users to select a calendar. Defaults to the user’s primary calendar if left blank.

  * Example value: `{{settings.calendar}}`
  * Options can be loaded by using the `calendars` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="BOOLEAN_INPUT">
  If on, recurring event updates will not be expanded into multiple instances of the event.

  * Default: `true`
</ParamField>


# Event Ended
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_TRIGGER_EVENT_ENDED

Trigger when a Google Calendar Event ends

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googleCalendar",
  "type": "GOOGLE_CALENDAR_TRIGGER_EVENT_ENDED",
  "parameters": {
    "calendarId": "{{settings.calendar}}"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Use Connect Portal Workflow Settings to allow users to select a calendar. Defaults to the user’s primary calendar if left blank.

  * Example value: `{{settings.calendar}}`
  * Options can be loaded by using the `calendars` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# Event Started
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_TRIGGER_EVENT_STARTED

Trigger when a Google Calendar Event is started

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googleCalendar",
  "type": "GOOGLE_CALENDAR_TRIGGER_EVENT_STARTED",
  "parameters": {
    "calendarId": "{{settings.calendar}}",
    "timeBefore": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Use Connect Portal Workflow Settings to allow users to select a calendar. Defaults to the user’s primary calendar if left blank.

  * Example value: `{{settings.calendar}}`
  * Options can be loaded by using the `calendars` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="TIME_CONSTRAINT_INPUT">
  How long before an event starts this should be triggered.
</ParamField>


# Event Updated (Legacy)
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_TRIGGER_EVENT_UPDATED

Trigger when a Google Calendar Event is updated

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googleCalendar",
  "type": "GOOGLE_CALENDAR_TRIGGER_EVENT_UPDATED",
  "parameters": {
    "calendarId": "{{settings.calendar}}",
    "collapseRecurringEventUpdates": true,
    "shouldTriggerOnPastEventUpdates": false
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Use Connect Portal Workflow Settings to allow users to select a calendar. Defaults to the user’s primary calendar if left blank.

  * Example value: `{{settings.calendar}}`
  * Options can be loaded by using the `calendars` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="BOOLEAN_INPUT">
  If on, recurring event updates will not be expanded into multiple instances of the event.

  * Default: `true`
</ParamField>

<ParamField type="BOOLEAN_INPUT">
  If on, this workflow will trigger when events that have already passed are updated. This can add significant event volume to this workflow.

  * Default: `false`
</ParamField>


# Event Cancelled
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_WEBHOOK_TRIGGER_EVENT_CANCELLED

Trigger when a Google Calendar Event is cancelled

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googleCalendar",
  "type": "GOOGLE_CALENDAR_WEBHOOK_TRIGGER_EVENT_CANCELLED",
  "parameters": {
    "calendarId": "{{settings.calendar}}",
    "collapseRecurringEventUpdates": true,
    "shouldTriggerOnPastEventUpdates": false
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Use Connect Portal Workflow Settings to allow users to select a calendar. Defaults to the user’s primary calendar if left blank.

  * Example value: `{{settings.calendar}}`
  * Options can be loaded by using the `calendars` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="BOOLEAN_INPUT">
  If on, recurring event updates will not be expanded into multiple instances of the event.

  * Default: `true`
</ParamField>

<ParamField type="BOOLEAN_INPUT">
  If on, this workflow will trigger when events that have already passed are cancelled. This can add significant event volume to this workflow.

  * Default: `false`
</ParamField>


# New Event
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_WEBHOOK_TRIGGER_EVENT_CREATED

Trigger when a new Google Calendar Event is created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googleCalendar",
  "type": "GOOGLE_CALENDAR_WEBHOOK_TRIGGER_EVENT_CREATED",
  "parameters": {
    "calendarId": "{{settings.calendar}}",
    "collapseRecurringEventUpdates": true
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Use Connect Portal Workflow Settings to allow users to select a calendar. Defaults to the user’s primary calendar if left blank.

  * Example value: `{{settings.calendar}}`
  * Options can be loaded by using the `calendars` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="BOOLEAN_INPUT">
  If on, recurring event updates will not be expanded into multiple instances of the event.

  * Default: `true`
</ParamField>


# Event Updated
Source: https://docs.useparagon.com/actionkit/integrations/googleCalendar/triggers/GOOGLE_CALENDAR_WEBHOOK_TRIGGER_EVENT_UPDATED

Trigger when a Google Calendar Event is updated

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googleCalendar",
  "type": "GOOGLE_CALENDAR_WEBHOOK_TRIGGER_EVENT_UPDATED",
  "parameters": {
    "calendarId": "{{settings.calendar}}",
    "collapseRecurringEventUpdates": true,
    "shouldTriggerOnPastEventUpdates": false
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Use Connect Portal Workflow Settings to allow users to select a calendar. Defaults to the user’s primary calendar if left blank.

  * Example value: `{{settings.calendar}}`
  * Options can be loaded by using the `calendars` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="BOOLEAN_INPUT">
  If on, recurring event updates will not be expanded into multiple instances of the event.

  * Default: `true`
</ParamField>

<ParamField type="BOOLEAN_INPUT">
  If on, this workflow will trigger when events that have already passed are updated. This can add significant event volume to this workflow.

  * Default: `false`
</ParamField>


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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_DRIVE_CREATE_FOLDER



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_DRIVE_DELETE_FOLDER



# Download File
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/GOOGLE_DRIVE_DOWNLOAD_FILE

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_DRIVE_DOWNLOAD_FILE

This Tool will respond with a byte stream of the file data from the Google Drive API.

The `Content-Type` response header will vary based on the MIME type of the file.

Google Workspace files, e.g. Google Docs, Slides, Sheets, will be exported to equivalent formats by default (if `mimeType` is not specified):

* **Docs**: PDF file
* **Sheets**: XLSX file
* **Slides**: PPTX file
* **Drawings**: PDF file


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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_DRIVE_EXPORT_DOC



# 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}/tools/#GOOGLE_DRIVE_GET_FILE_BY_ID



# 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}/tools/#GOOGLE_DRIVE_GET_FOLDER_BY_ID



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_DRIVE_LIST_FILES



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_DRIVE_MOVE_FOLDER



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_DRIVE_SAVE_FILE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_DRIVE_SEARCH_FOLDERS



# Google Drive
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/overview

Browse the tools and triggers available for Google Drive in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/googledrive/GOOGLE_DRIVE_GET_FILE_BY_ID" title="Get File By ID" />

  <Card href="/actionkit/integrations/googledrive/GOOGLE_DRIVE_SAVE_FILE" title="Save File" />

  <Card href="/actionkit/integrations/googledrive/GOOGLE_DRIVE_EXPORT_DOC" title="Export Doc" />

  <Card href="/actionkit/integrations/googledrive/GOOGLE_DRIVE_CREATE_FOLDER" title="Create Folder" />

  <Card href="/actionkit/integrations/googledrive/GOOGLE_DRIVE_DELETE_FOLDER" title="Delete Folder" />

  <Card href="/actionkit/integrations/googledrive/GOOGLE_DRIVE_GET_FOLDER_BY_ID" title="Get Folder By ID" />

  <Card href="/actionkit/integrations/googledrive/GOOGLE_DRIVE_MOVE_FOLDER" title="Move Folder" />

  <Card href="/actionkit/integrations/googledrive/GOOGLE_DRIVE_LIST_FILES" title="List Files" />

  <Card href="/actionkit/integrations/googledrive/GOOGLE_DRIVE_SEARCH_FOLDERS" title="Search Folders" />

  <Card href="/actionkit/integrations/googledrive/GOOGLE_DRIVE_DOWNLOAD_FILE" title="Download File" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/googledrive/triggers/GOOGLE_DRIVE_TRIGGER_FILE_CREATED" title="File Created" />

  <Card href="/actionkit/integrations/googledrive/triggers/GOOGLE_DRIVE_TRIGGER_FILE_UPDATED" title="File Updated" />

  <Card href="/actionkit/integrations/googledrive/triggers/GOOGLE_DRIVE_TRIGGER_FILE_DELETED" title="File Deleted" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# File Created
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/triggers/GOOGLE_DRIVE_TRIGGER_FILE_CREATED

Trigger when a new file is created in Google Drive

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googledrive",
  "type": "GOOGLE_DRIVE_TRIGGER_FILE_CREATED",
  "parameters": {
    "supportsAllDrives": false
  }
}
```

**Configuration options:**

<ParamField type="BOOLEAN_INPUT">
  Watch for events from files in Shared Drives. Defaults to false.

  * Default: `false`
</ParamField>


# File Deleted
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/triggers/GOOGLE_DRIVE_TRIGGER_FILE_DELETED

Trigger when a file is deleted in Google Drive

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googledrive",
  "type": "GOOGLE_DRIVE_TRIGGER_FILE_DELETED",
  "parameters": {
    "triggerOnPermanentDeletionOnly": true
  }
}
```

**Configuration options:**

<ParamField type="BOOLEAN_INPUT">
  Triggers only when a file is permanently deleted. If disabled, the workflow will trigger when a file is moved to the trash.

  * Default: `true`
</ParamField>


# File Updated
Source: https://docs.useparagon.com/actionkit/integrations/googledrive/triggers/GOOGLE_DRIVE_TRIGGER_FILE_UPDATED

Trigger when a file is updated in Google Drive

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googledrive",
  "type": "GOOGLE_DRIVE_TRIGGER_FILE_UPDATED",
  "parameters": {
    "supportsAllDrives": false,
    "parentId": "folder1,folder2"
  }
}
```

**Configuration options:**

<ParamField type="BOOLEAN_INPUT">
  Watch for events from files in Shared Drives. Defaults to false.

  * Default: `false`
</ParamField>

<ParamField type="TEXTAREA">
  Specify the Folder ID to search for updated files within the folders. Defaults to the user’s root folder if left blank.

  * Example value: `folder1,folder2`
  * Options can be loaded by using the `folders` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_SHEETS_CREATE_ROW



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_SHEETS_GET_ROW



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GOOGLE_SHEETS_UPDATE_ROW



# Google Sheets
Source: https://docs.useparagon.com/actionkit/integrations/googlesheets/overview

Browse the tools and triggers available for Google Sheets in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/googlesheets/GOOGLE_SHEETS_GET_ROW" title="Get Row" />

  <Card href="/actionkit/integrations/googlesheets/GOOGLE_SHEETS_CREATE_ROW" title="Create Row" />

  <Card href="/actionkit/integrations/googlesheets/GOOGLE_SHEETS_UPDATE_ROW" title="Update Row" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/googlesheets/triggers/GOOGLE_SHEETS_TRIGGER_FILE_CREATED" title="File Created" />

  <Card href="/actionkit/integrations/googlesheets/triggers/GOOGLE_SHEETS_TRIGGER_FILE_UPDATED" title="File Updated" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# File Created
Source: https://docs.useparagon.com/actionkit/integrations/googlesheets/triggers/GOOGLE_SHEETS_TRIGGER_FILE_CREATED

Trigger when a file is created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googlesheets",
  "type": "GOOGLE_SHEETS_TRIGGER_FILE_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# File Updated
Source: https://docs.useparagon.com/actionkit/integrations/googlesheets/triggers/GOOGLE_SHEETS_TRIGGER_FILE_UPDATED

Trigger when a file is updated

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "googlesheets",
  "type": "GOOGLE_SHEETS_TRIGGER_FILE_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Create Application
Source: https://docs.useparagon.com/actionkit/integrations/greenhouse/GREENHOUSE_CREATE_APPLICATION

actionkit/openapi.json POST /projects/{project_id}/tools/#GREENHOUSE_CREATE_APPLICATION



# Create Candidate
Source: https://docs.useparagon.com/actionkit/integrations/greenhouse/GREENHOUSE_CREATE_CANDIDATE

actionkit/openapi.json POST /projects/{project_id}/tools/#GREENHOUSE_CREATE_CANDIDATE



# Create Job Opening
Source: https://docs.useparagon.com/actionkit/integrations/greenhouse/GREENHOUSE_CREATE_JOB_OPENING

actionkit/openapi.json POST /projects/{project_id}/tools/#GREENHOUSE_CREATE_JOB_OPENING



# Delete Application
Source: https://docs.useparagon.com/actionkit/integrations/greenhouse/GREENHOUSE_DELETE_APPLICATION

actionkit/openapi.json POST /projects/{project_id}/tools/#GREENHOUSE_DELETE_APPLICATION



# Delete Candidate
Source: https://docs.useparagon.com/actionkit/integrations/greenhouse/GREENHOUSE_DELETE_CANDIDATE

actionkit/openapi.json POST /projects/{project_id}/tools/#GREENHOUSE_DELETE_CANDIDATE



# Get Application By ID
Source: https://docs.useparagon.com/actionkit/integrations/greenhouse/GREENHOUSE_GET_APPLICATION_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#GREENHOUSE_GET_APPLICATION_BY_ID



# Get Candididate By ID
Source: https://docs.useparagon.com/actionkit/integrations/greenhouse/GREENHOUSE_GET_CANDIDIDATE_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#GREENHOUSE_GET_CANDIDIDATE_BY_ID



# Get Job Opening By ID
Source: https://docs.useparagon.com/actionkit/integrations/greenhouse/GREENHOUSE_GET_JOB_OPENING_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#GREENHOUSE_GET_JOB_OPENING_BY_ID



# Update Application
Source: https://docs.useparagon.com/actionkit/integrations/greenhouse/GREENHOUSE_UPDATE_APPLICATION

actionkit/openapi.json POST /projects/{project_id}/tools/#GREENHOUSE_UPDATE_APPLICATION



# Update Candidate
Source: https://docs.useparagon.com/actionkit/integrations/greenhouse/GREENHOUSE_UPDATE_CANDIDATE

actionkit/openapi.json POST /projects/{project_id}/tools/#GREENHOUSE_UPDATE_CANDIDATE



# Update Job Opening
Source: https://docs.useparagon.com/actionkit/integrations/greenhouse/GREENHOUSE_UPDATE_JOB_OPENING

actionkit/openapi.json POST /projects/{project_id}/tools/#GREENHOUSE_UPDATE_JOB_OPENING



# Greenhouse
Source: https://docs.useparagon.com/actionkit/integrations/greenhouse/overview

Browse the tools available for Greenhouse in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/greenhouse/GREENHOUSE_CREATE_APPLICATION" title="Create Application" />

  <Card href="/actionkit/integrations/greenhouse/GREENHOUSE_UPDATE_APPLICATION" title="Update Application" />

  <Card href="/actionkit/integrations/greenhouse/GREENHOUSE_GET_APPLICATION_BY_ID" title="Get Application By ID" />

  <Card href="/actionkit/integrations/greenhouse/GREENHOUSE_DELETE_APPLICATION" title="Delete Application" />

  <Card href="/actionkit/integrations/greenhouse/GREENHOUSE_CREATE_CANDIDATE" title="Create Candidate" />

  <Card href="/actionkit/integrations/greenhouse/GREENHOUSE_UPDATE_CANDIDATE" title="Update Candidate" />

  <Card href="/actionkit/integrations/greenhouse/GREENHOUSE_GET_CANDIDIDATE_BY_ID" title="Get Candididate By ID" />

  <Card href="/actionkit/integrations/greenhouse/GREENHOUSE_DELETE_CANDIDATE" title="Delete Candidate" />

  <Card href="/actionkit/integrations/greenhouse/GREENHOUSE_CREATE_JOB_OPENING" title="Create Job Opening" />

  <Card href="/actionkit/integrations/greenhouse/GREENHOUSE_UPDATE_JOB_OPENING" title="Update Job Opening" />

  <Card href="/actionkit/integrations/greenhouse/GREENHOUSE_GET_JOB_OPENING_BY_ID" title="Get Job Opening By ID" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Greenhouse. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#GUSTO_GET_EMPLOYEE_DIRECTORY



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

actionkit/openapi.json POST /projects/{project_id}/tools/#GUSTO_UPDATE_EMPLOYEE



# Gusto
Source: https://docs.useparagon.com/actionkit/integrations/gusto/overview

Browse the tools available for Gusto in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/gusto/GUSTO_CREATE_EMPLOYEE" title="Create Employee" />

  <Card href="/actionkit/integrations/gusto/GUSTO_UPDATE_EMPLOYEE" title="Update Employee" />

  <Card href="/actionkit/integrations/gusto/GUSTO_GET_EMPLOYEE_BY_ID" title="Get Employee By ID" />

  <Card href="/actionkit/integrations/gusto/GUSTO_GET_EMPLOYEE_DIRECTORY" title="Get Employee Directory" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Gusto. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#HUBSPOT_UPDATE_RECORD_ENGAGEMENTS



# HubSpot
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/overview

Browse the tools and triggers available for HubSpot in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/hubspot/HUBSPOT_CREATE_RECORD_COMPANIES" title="Create Record Companies" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_CREATE_RECORD_CONTACTS" title="Create Record Contacts" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_CREATE_RECORD_DEALS" title="Create Record Deals" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_CREATE_RECORD_ENGAGEMENTS" title="Create Record Engagements" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_CREATE_RECORD_ANY" title="Create Record Any" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_UPDATE_RECORD_COMPANIES" title="Update Record Companies" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_UPDATE_RECORD_CONTACTS" title="Update Record Contacts" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_UPDATE_RECORD_DEALS" title="Update Record Deals" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_UPDATE_RECORD_ENGAGEMENTS" title="Update Record Engagements" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_UPDATE_RECORD_ANY" title="Update Record Any" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_GET_RECORDS_COMPANIES" title="Get Records Companies" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_GET_RECORDS_CONTACTS" title="Get Records Contacts" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_GET_RECORDS_DEALS" title="Get Records Deals" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_GET_RECORDS_ENGAGEMENTS" title="Get Records Engagements" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_GET_RECORDS_ANY" title="Get Records Any" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_GET_RECORD_BY_ID_COMPANIES" title="Get Record By ID Companies" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_GET_RECORD_BY_ID_CONTACTS" title="Get Record By ID Contacts" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_GET_RECORD_BY_ID_DEALS" title="Get Record By ID Deals" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_GET_RECORD_BY_ID_ENGAGEMENTS" title="Get Record By ID Engagements" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_GET_RECORD_BY_ID_ANY" title="Get Record By ID Any" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_SEARCH_RECORDS_COMPANIES" title="Search Records Companies" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_SEARCH_RECORDS_CONTACTS" title="Search Records Contacts" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_SEARCH_RECORDS_DEALS" title="Search Records Deals" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_SEARCH_RECORDS_ENGAGEMENTS" title="Search Records Engagements" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_SEARCH_RECORDS_ANY" title="Search Records Any" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_DELETE_RECORD_COMPANIES" title="Delete Record Companies" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_DELETE_RECORD_CONTACTS" title="Delete Record Contacts" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_DELETE_RECORD_DEALS" title="Delete Record Deals" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_DELETE_RECORD_ENGAGEMENTS" title="Delete Record Engagements" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_DELETE_RECORD_ANY" title="Delete Record Any" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_GET_CONTACTS_BY_LIST_ID" title="Get Contacts By List ID" />

  <Card href="/actionkit/integrations/hubspot/HUBSPOT_DESCRIBE_ACTION_SCHEMA" title="Describe Action Schema" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/hubspot/triggers/HUBSPOT_TRIGGER_RECORD_CREATED" title="Record Created" />

  <Card href="/actionkit/integrations/hubspot/triggers/HUBSPOT_TRIGGER_RECORD_UPDATED" title="Record Updated" />

  <Card href="/actionkit/integrations/hubspot/triggers/HUBSPOT_TRIGGER_RECORD_DELETED" title="Record Deleted" />

  <Card href="/actionkit/integrations/hubspot/triggers/HUBSPOT_TRIGGER_RECORD_DELETED_FOR_PRIVACY" title="Record Deleted for Privacy (GDPR)">
    Trigger when a record is deleted for privacy/regulatory reasons
  </Card>
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Record Created
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/triggers/HUBSPOT_TRIGGER_RECORD_CREATED

Trigger when a new record is created in HubSpot

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "hubspot",
  "type": "HUBSPOT_TRIGGER_RECORD_CREATED",
  "parameters": {
    "recordType": "companies",
    "filterFormula": "field"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record type

  * Allowed values: `companies`, `contacts`, `deals`, Custom Object (`<specified by objectName property>`)
  * Options can be loaded by using the `cacheAllObjectTypes` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<Accordion title="When Custom Object is selected">
  Additional options when this parameter is set to `<specified by objectName property>`.

  <ParamField type="TEXTAREA">
    The Name of the Custom Object to create. Use Connect Portal Workflow Settings to allow users to select a Custom Object Mapping.

    * Example value: `{{settings.objectType}}`
  </ParamField>
</Accordion>

<ParamField type="CONDITIONAL">
  Only trigger on new records that match these filters.

  * Example value: `field`
  * Supported filter fields are loaded from `cachedFields` after selecting `recordType`.
  * Supported operators: `$none`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$numberGreaterThan`, `$numberLessThan`, `$numberEquals`, `$numberDoesNotEqual`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$exists`, `$doesNotExist`
</ParamField>


# Record Deleted
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/triggers/HUBSPOT_TRIGGER_RECORD_DELETED

Trigger when a record is deleted in HubSpot

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "hubspot",
  "type": "HUBSPOT_TRIGGER_RECORD_DELETED",
  "parameters": {
    "recordType": "companies",
    "filterFormula": "field"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record type

  * Allowed values: `companies`, `contacts`, `deals`, Custom Object (`<specified by objectName property>`)
  * Options can be loaded by using the `cacheAllObjectTypes` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<Accordion title="When Custom Object is selected">
  Additional options when this parameter is set to `<specified by objectName property>`.

  <ParamField type="TEXTAREA">
    The Name of the Custom Object to create. Use Connect Portal Workflow Settings to allow users to select a Custom Object Mapping.

    * Example value: `{{settings.objectType}}`
  </ParamField>
</Accordion>

<ParamField type="CONDITIONAL">
  Only trigger on new records that match these filters.

  * Example value: `field`
  * Supported filter fields are loaded from `cachedFields` after selecting `recordType`.
  * Supported operators: `$none`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$numberGreaterThan`, `$numberLessThan`, `$numberEquals`, `$numberDoesNotEqual`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$exists`, `$doesNotExist`
</ParamField>


# Record Deleted for Privacy (GDPR)
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/triggers/HUBSPOT_TRIGGER_RECORD_DELETED_FOR_PRIVACY

Trigger when a record is deleted for privacy/regulatory reasons

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "hubspot",
  "type": "HUBSPOT_TRIGGER_RECORD_DELETED_FOR_PRIVACY",
  "parameters": {
    "recordType": "contact"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record type

  * Allowed values: `contact`, `conversation`
  * Options can be loaded by using the `cacheAllObjectTypes` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# Record Updated
Source: https://docs.useparagon.com/actionkit/integrations/hubspot/triggers/HUBSPOT_TRIGGER_RECORD_UPDATED

Trigger when a record is updated in HubSpot

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "hubspot",
  "type": "HUBSPOT_TRIGGER_RECORD_UPDATED",
  "parameters": {
    "recordType": "companies",
    "filterFormula": "field"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record type

  * Allowed values: `companies`, `contacts`, `deals`, Custom Object (`<specified by objectName property>`)
  * Options can be loaded by using the `cacheAllObjectTypes` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<Accordion title="When Custom Object is selected">
  Additional options when this parameter is set to `<specified by objectName property>`.

  <ParamField type="TEXTAREA">
    The Name of the Custom Object to create. Use Connect Portal Workflow Settings to allow users to select a Custom Object Mapping.

    * Example value: `{{settings.objectType}}`
  </ParamField>
</Accordion>

<ParamField type="CONDITIONAL">
  Only trigger on new records that match these filters.

  * Example value: `field`
  * Supported filter fields are loaded from `cachedFields` after selecting `recordType`.
  * Supported operators: `$none`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$numberGreaterThan`, `$numberLessThan`, `$numberEquals`, `$numberDoesNotEqual`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$exists`, `$doesNotExist`
</ParamField>


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#INTERCOM_SEARCH_CONTACTS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#INTERCOM_SEND_MESSAGE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#INTERCOM_UPDATE_CONTACT



# Intercom
Source: https://docs.useparagon.com/actionkit/integrations/intercom/overview

Browse the tools and triggers available for Intercom in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/intercom/INTERCOM_CREATE_CONTACT" title="Create Contact" />

  <Card href="/actionkit/integrations/intercom/INTERCOM_UPDATE_CONTACT" title="Update Contact" />

  <Card href="/actionkit/integrations/intercom/INTERCOM_GET_CONTACT_BY_ID" title="Get Contact By ID" />

  <Card href="/actionkit/integrations/intercom/INTERCOM_SEARCH_CONTACTS" title="Search Contacts" />

  <Card href="/actionkit/integrations/intercom/INTERCOM_SEND_MESSAGE" title="Send Message" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/intercom/triggers/INTERCOM_TRIGGER_CONTACT_CREATED" title="New Contact Created" />

  <Card href="/actionkit/integrations/intercom/triggers/INTERCOM_TRIGGER_CONTACT_UPDATED" title="Contact Updated" />

  <Card href="/actionkit/integrations/intercom/triggers/INTERCOM_TRIGGER_COMPANY_CREATED" title="New Company Created" />

  <Card href="/actionkit/integrations/intercom/triggers/INTERCOM_TRIGGER_COMPANY_UPDATED" title="Company Updated" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Company Created
Source: https://docs.useparagon.com/actionkit/integrations/intercom/triggers/INTERCOM_TRIGGER_COMPANY_CREATED

Triggers when a new company is created in Intercom

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "intercom",
  "type": "INTERCOM_TRIGGER_COMPANY_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Company Updated
Source: https://docs.useparagon.com/actionkit/integrations/intercom/triggers/INTERCOM_TRIGGER_COMPANY_UPDATED

Triggers when a company is updated in Intercom

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "intercom",
  "type": "INTERCOM_TRIGGER_COMPANY_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# New Contact Created
Source: https://docs.useparagon.com/actionkit/integrations/intercom/triggers/INTERCOM_TRIGGER_CONTACT_CREATED

Triggers when a new contact is created in Intercom

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "intercom",
  "type": "INTERCOM_TRIGGER_CONTACT_CREATED",
  "parameters": {
    "filterFormula": "filter by property"
  }
}
```

**Configuration options:**

<ParamField type="CONDITIONAL">
  Only trigger on records that match these filters.

  * Example value: `filter by property`
  * Supported filter fields: `id`, `owner_id`, `role`
  * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`
</ParamField>


# Contact Updated
Source: https://docs.useparagon.com/actionkit/integrations/intercom/triggers/INTERCOM_TRIGGER_CONTACT_UPDATED

Triggers when a contact is updated in Intercom

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "intercom",
  "type": "INTERCOM_TRIGGER_CONTACT_UPDATED",
  "parameters": {
    "filterFormula": "filter by property"
  }
}
```

**Configuration options:**

<ParamField type="CONDITIONAL">
  Only trigger on records that match these filters.

  * Example value: `filter by property`
  * Supported filter fields: `id`, `owner_id`, `role`
  * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`
</ParamField>


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

actionkit/openapi.json POST /projects/{project_id}/tools/#JIRA_CREATE_ISSUE



# Delete Issue
Source: https://docs.useparagon.com/actionkit/integrations/jira/JIRA_DELETE_ISSUE

actionkit/openapi.json POST /projects/{project_id}/tools/#JIRA_DELETE_ISSUE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#JIRA_DESCRIBE_ACTION_SCHEMA



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#JIRA_SEARCH_BY_JQL



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#JIRA_UPDATE_ISSUE_ANY



# Jira
Source: https://docs.useparagon.com/actionkit/integrations/jira/overview

Browse the tools and triggers available for Jira in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/jira/JIRA_CREATE_ISSUE" title="Create Issue" />

  <Card href="/actionkit/integrations/jira/JIRA_UPDATE_ISSUE" title="Update Issue" />

  <Card href="/actionkit/integrations/jira/JIRA_DELETE_ISSUE" title="Delete Issue" />

  <Card href="/actionkit/integrations/jira/JIRA_GET_ISSUE_BY_KEY" title="Get Issue By Key" />

  <Card href="/actionkit/integrations/jira/JIRA_FILTER_ISSUES" title="Filter Issues" />

  <Card href="/actionkit/integrations/jira/JIRA_SEARCH_BY_JQL" title="Search By JQL" />

  <Card href="/actionkit/integrations/jira/JIRA_UPDATE_ISSUE_ANY" title="Update Issue Any" />

  <Card href="/actionkit/integrations/jira/JIRA_DESCRIBE_ACTION_SCHEMA" title="Describe Action Schema" />

  <Card href="/actionkit/integrations/jira/JIRA_GET_PROJECTS" title="Get Projects" />

  <Card href="/actionkit/integrations/jira/JIRA_GET_ISSUE_TYPES_BY_PROJECT" title="Get Issue Types By Project" />

  <Card href="/actionkit/integrations/jira/JIRA_GET_ISSUE_TYPES" title="Get Issue Types" />

  <Card href="/actionkit/integrations/jira/JIRA_GET_ISSUE_STATUS_BY_PROJECT" title="Get Issue Status By Project" />

  <Card href="/actionkit/integrations/jira/JIRA_GET_ALL_ASSIGNEES_BY_PROJECT" title="Get All Assignees By Project" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/jira/triggers/JIRA_TRIGGER_ISSUE_CREATED" title="New Issue" />

  <Card href="/actionkit/integrations/jira/triggers/JIRA_TRIGGER_ISSUE_UPDATED" title="Issue Updated" />

  <Card href="/actionkit/integrations/jira/triggers/JIRA_TRIGGER_COMMENT_CREATED" title="New Comment" />

  <Card href="/actionkit/integrations/jira/triggers/JIRA_TRIGGER_PROJECT_CREATED" title="Project Created" />

  <Card href="/actionkit/integrations/jira/triggers/JIRA_TRIGGER_PROJECT_UPDATED" title="Project Updated" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Comment
Source: https://docs.useparagon.com/actionkit/integrations/jira/triggers/JIRA_TRIGGER_COMMENT_CREATED

Trigger when a new Jira comment is created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "jira",
  "type": "JIRA_TRIGGER_COMMENT_CREATED",
  "parameters": {
    "jqlQuery": "project = {{settings.project}} \nAND status = {{settings.status}}"
  }
}
```

**Configuration options:**

<ParamField type="CODE">
  Only trigger when new issues match the following query using JIRA Query Language (JQL) ([https://confluence.atlassian.com/jiracoreserver073/advanced-searching-861257209.html#Advancedsearching-ConstructingJQLqueries](https://confluence.atlassian.com/jiracoreserver073/advanced-searching-861257209.html#Advancedsearching-ConstructingJQLqueries)).

  * Example value: `project = {{settings.project}} \nAND status = {{settings.status}}`
</ParamField>


# New Issue
Source: https://docs.useparagon.com/actionkit/integrations/jira/triggers/JIRA_TRIGGER_ISSUE_CREATED

Trigger when a new Jira issue is created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "jira",
  "type": "JIRA_TRIGGER_ISSUE_CREATED",
  "parameters": {
    "jqlQuery": "project = {{settings.project}} \nAND status = {{settings.status}}"
  }
}
```

**Configuration options:**

<ParamField type="CODE">
  Only trigger when new issues match the following query using JIRA Query Language (JQL) ([https://confluence.atlassian.com/jiracoreserver073/advanced-searching-861257209.html#Advancedsearching-ConstructingJQLqueries](https://confluence.atlassian.com/jiracoreserver073/advanced-searching-861257209.html#Advancedsearching-ConstructingJQLqueries)).

  * Example value: `project = {{settings.project}} \nAND status = {{settings.status}}`
</ParamField>


# Issue Updated
Source: https://docs.useparagon.com/actionkit/integrations/jira/triggers/JIRA_TRIGGER_ISSUE_UPDATED

Trigger when a Jira issue is updated

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "jira",
  "type": "JIRA_TRIGGER_ISSUE_UPDATED",
  "parameters": {
    "jqlQuery": "project = {{settings.project}} \nAND status = {{settings.status}}"
  }
}
```

**Configuration options:**

<ParamField type="CODE">
  Only trigger when new issues match the following query using JIRA Query Language (JQL) ([https://confluence.atlassian.com/jiracoreserver073/advanced-searching-861257209.html#Advancedsearching-ConstructingJQLqueries](https://confluence.atlassian.com/jiracoreserver073/advanced-searching-861257209.html#Advancedsearching-ConstructingJQLqueries)).

  * Example value: `project = {{settings.project}} \nAND status = {{settings.status}}`
</ParamField>


# Project Created
Source: https://docs.useparagon.com/actionkit/integrations/jira/triggers/JIRA_TRIGGER_PROJECT_CREATED

Trigger when a new Jira project is created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "jira",
  "type": "JIRA_TRIGGER_PROJECT_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Project Updated
Source: https://docs.useparagon.com/actionkit/integrations/jira/triggers/JIRA_TRIGGER_PROJECT_UPDATED

Trigger when a Jira project is updated

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "jira",
  "type": "JIRA_TRIGGER_PROJECT_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#KLAVIYO_CREATE_CAMPAIGN



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

actionkit/openapi.json POST /projects/{project_id}/tools/#KLAVIYO_CREATE_LIST



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

actionkit/openapi.json POST /projects/{project_id}/tools/#KLAVIYO_CREATE_TEMPLATE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#KLAVIYO_GET_CAMPAIGN



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#KLAVIYO_GET_LIST_SUBSCRIBER



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

actionkit/openapi.json POST /projects/{project_id}/tools/#KLAVIYO_GET_PROFILE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#KLAVIYO_GET_SEGMENT_SUBSCRIBERS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#KLAVIYO_GET_TEMPLATES



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#KLAVIYO_UNSUBSCRIBE_FROM_LIST



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

actionkit/openapi.json POST /projects/{project_id}/tools/#KLAVIYO_UPDATE_PROFILE



# Klaviyo
Source: https://docs.useparagon.com/actionkit/integrations/klaviyo/overview

Browse the tools available for Klaviyo in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_CREATE_CAMPAIGN" title="Create Campaign" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_GET_CAMPAIGN" title="Get Campaign" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_SEND_CAMPAIGN" title="Send Campaign" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_CREATE_LIST" title="Create List" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_GET_LISTS" title="Get Lists" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_ADD_SUBSCRIBER_TO_LIST" title="Add Subscriber To List" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_GET_LIST_SUBSCRIBER" title="Get List Subscriber" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_UNSUBSCRIBE_FROM_LIST" title="Unsubscribe From List" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_CREATE_TEMPLATE" title="Create Template" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_GET_TEMPLATES" title="Get Templates" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_GET_PROFILE" title="Get Profile" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_UPDATE_PROFILE" title="Update Profile" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_GET_SEGEMENTS" title="Get Segements" />

  <Card href="/actionkit/integrations/klaviyo/KLAVIYO_GET_SEGMENT_SUBSCRIBERS" title="Get Segment Subscribers" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Klaviyo. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#LEVER_CREATE_OPPORTUNITY



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#LEVER_UPDATE_CONTACT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#LEVER_UPDATE_POSTING



# Lever
Source: https://docs.useparagon.com/actionkit/integrations/lever/overview

Browse the tools available for Lever in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/lever/LEVER_CREATE_OPPORTUNITY" title="Create Opportunity" />

  <Card href="/actionkit/integrations/lever/LEVER_GET_OPPORTUNITY_BY_ID" title="Get Opportunity By ID" />

  <Card href="/actionkit/integrations/lever/LEVER_GET_OPPORTUNITIES" title="Get Opportunities" />

  <Card href="/actionkit/integrations/lever/LEVER_UPDATE_CONTACT" title="Update Contact" />

  <Card href="/actionkit/integrations/lever/LEVER_GET_CONTACT_BY_ID" title="Get Contact By ID" />

  <Card href="/actionkit/integrations/lever/LEVER_CREATE_POSTING" title="Create Posting" />

  <Card href="/actionkit/integrations/lever/LEVER_UPDATE_POSTING" title="Update Posting" />

  <Card href="/actionkit/integrations/lever/LEVER_GET_POSTING_BY_ID" title="Get Posting By ID" />

  <Card href="/actionkit/integrations/lever/LEVER_GET_POSTINGS" title="Get Postings" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Lever. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#LINEAR_ARCHIVE_ISSUE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#LINEAR_CREATE_ISSUE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#LINEAR_CREATE_SUB_ISSUE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#LINEAR_DELETE_ISSUE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#LINEAR_SEARCH_ISSUE



# Search Projects
Source: https://docs.useparagon.com/actionkit/integrations/linear/LINEAR_SEARCH_PROJECTS

actionkit/openapi.json POST /projects/{project_id}/tools/#LINEAR_SEARCH_PROJECTS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#LINEAR_SEARCH_TEAMS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#LINEAR_UPDATE_ISSUE



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

actionkit/openapi.json POST /projects/{project_id}/tools/#LINEAR_UPDATE_PROJECT



# Linear
Source: https://docs.useparagon.com/actionkit/integrations/linear/overview

Browse the tools and triggers available for Linear in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/linear/LINEAR_CREATE_ISSUE" title="Create Issue" />

  <Card href="/actionkit/integrations/linear/LINEAR_UPDATE_ISSUE" title="Update Issue" />

  <Card href="/actionkit/integrations/linear/LINEAR_GET_ISSUE_BY_ID" title="Get Issue By ID" />

  <Card href="/actionkit/integrations/linear/LINEAR_GET_ISSUE_BY_ISSUE_IDENTIFIER" title="Get Issue By Issue Identifier" />

  <Card href="/actionkit/integrations/linear/LINEAR_SEARCH_ISSUE" title="Search Issue" />

  <Card href="/actionkit/integrations/linear/LINEAR_DELETE_ISSUE" title="Delete Issue" />

  <Card href="/actionkit/integrations/linear/LINEAR_ARCHIVE_ISSUE" title="Archive Issue" />

  <Card href="/actionkit/integrations/linear/LINEAR_CREATE_SUB_ISSUE" title="Create Sub Issue" />

  <Card href="/actionkit/integrations/linear/LINEAR_CREATE_PROJECT" title="Create Project" />

  <Card href="/actionkit/integrations/linear/LINEAR_UPDATE_PROJECT" title="Update Project" />

  <Card href="/actionkit/integrations/linear/LINEAR_GET_PROJECT_BY_ID" title="Get Project By ID" />

  <Card href="/actionkit/integrations/linear/LINEAR_DELETE_PROJECT" title="Delete Project" />

  <Card href="/actionkit/integrations/linear/LINEAR_SEARCH_PROJECTS" title="Search Projects" />

  <Card href="/actionkit/integrations/linear/LINEAR_SEARCH_TEAMS" title="Search Teams" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/linear/triggers/LINEAR_TRIGGER_ISSUE_CREATED" title="New Issue Created" />

  <Card href="/actionkit/integrations/linear/triggers/LINEAR_TRIGGER_STATUS_UPDATED" title="Issue Status Updated" />

  <Card href="/actionkit/integrations/linear/triggers/LINEAR_TRIGGER_LABEL_ADDED" title="Issue Label Added or Removed" />

  <Card href="/actionkit/integrations/linear/triggers/LINEAR_TRIGGER_ISSUE_DELETED" title="Issue Deleted" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Issue Created
Source: https://docs.useparagon.com/actionkit/integrations/linear/triggers/LINEAR_TRIGGER_ISSUE_CREATED

Trigger when a new record is created in Linear

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "linear",
  "type": "LINEAR_TRIGGER_ISSUE_CREATED",
  "parameters": {
    "teamId": "a70bdf0f-530a-4887-857d-46151b52b47c",
    "filterFormula": "Field"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Use Connect Portal User Settings to allow users to select a Linear Team's ID.  Leaving this blank will trigger this workflow for every public team.

  * Example value: `a70bdf0f-530a-4887-857d-46151b52b47c`
  * Options can be loaded by using the `getTeams` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="CONDITIONAL">
  Only trigger on records that match these filters. Please maintain casing of the string for proper filtering.

  * Example value: `Field`
  * Supported filter fields: `title`, `team.id`, `organizationId`, `state.id`, `labelIds`
  * Supported operators: `$arrayIsIn`, `$arrayIsNotIn`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$stringContains`, `$stringDoesNotContain`, `$stringGreaterThan`, `$stringLessThan`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$numberGreaterThan`, `$numberLessThan`, `$dateTimeAfter`, `$dateTimeBefore`
</ParamField>


# Issue Deleted
Source: https://docs.useparagon.com/actionkit/integrations/linear/triggers/LINEAR_TRIGGER_ISSUE_DELETED

Trigger when a record is deleted in Linear

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "linear",
  "type": "LINEAR_TRIGGER_ISSUE_DELETED",
  "parameters": {
    "teamId": "a70bdf0f-530a-4887-857d-46151b52b47c",
    "filterFormula": "Field"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Use Connect Portal User Settings to allow users to select a Linear Team's ID.  Leaving this blank will trigger this workflow for every public team.

  * Example value: `a70bdf0f-530a-4887-857d-46151b52b47c`
  * Options can be loaded by using the `getTeams` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="CONDITIONAL">
  Only trigger on records that match these filters. Please maintain casing of the string for proper filtering.

  * Example value: `Field`
  * Supported filter fields: `title`, `team.id`, `organizationId`, `state.id`, `labelIds`
  * Supported operators: `$arrayIsIn`, `$arrayIsNotIn`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$stringContains`, `$stringDoesNotContain`, `$stringGreaterThan`, `$stringLessThan`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$numberGreaterThan`, `$numberLessThan`, `$dateTimeAfter`, `$dateTimeBefore`
</ParamField>


# Issue Label Added or Removed
Source: https://docs.useparagon.com/actionkit/integrations/linear/triggers/LINEAR_TRIGGER_LABEL_ADDED

Trigger when a label is added or removed in Linear

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "linear",
  "type": "LINEAR_TRIGGER_LABEL_ADDED",
  "parameters": {
    "teamId": "a70bdf0f-530a-4887-857d-46151b52b47c",
    "filterFormula": "Field"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Use Connect Portal User Settings to allow users to select a Linear Team's ID.  Leaving this blank will trigger this workflow for every public team.

  * Example value: `a70bdf0f-530a-4887-857d-46151b52b47c`
  * Options can be loaded by using the `getTeams` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="CONDITIONAL">
  Only trigger on records that match these filters. Please maintain casing of the string for proper filtering.

  * Example value: `Field`
  * Supported filter fields: `labelIds`
  * Supported operators: `$arrayIsIn`, `$arrayIsNotIn`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$stringContains`, `$stringDoesNotContain`, `$stringGreaterThan`, `$stringLessThan`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$numberGreaterThan`, `$numberLessThan`, `$dateTimeAfter`, `$dateTimeBefore`
</ParamField>


# Issue Status Updated
Source: https://docs.useparagon.com/actionkit/integrations/linear/triggers/LINEAR_TRIGGER_STATUS_UPDATED

Trigger when an issue’s status is updated

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "linear",
  "type": "LINEAR_TRIGGER_STATUS_UPDATED",
  "parameters": {
    "teamId": "a70bdf0f-530a-4887-857d-46151b52b47c",
    "filterFormula": "Field"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Use Connect Portal User Settings to allow users to select a Linear Team's ID.  Leaving this blank will trigger this workflow for every public team.

  * Example value: `a70bdf0f-530a-4887-857d-46151b52b47c`
  * Options can be loaded by using the `getTeams` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="CONDITIONAL">
  Only trigger on records that match these filters. Please maintain casing of the string for proper filtering.

  * Example value: `Field`
  * Supported filter fields: `stateId`
  * Supported operators: `$arrayIsIn`, `$arrayIsNotIn`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$stringContains`, `$stringDoesNotContain`, `$stringGreaterThan`, `$stringLessThan`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$numberGreaterThan`, `$numberLessThan`, `$dateTimeAfter`, `$dateTimeBefore`
</ParamField>


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#LINKEDIN_GET_PROFILE_BY_ID



# LinkedIn
Source: https://docs.useparagon.com/actionkit/integrations/linkedin/overview

Browse the tools available for LinkedIn in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/linkedin/LINKEDIN_GET_PROFILE_BY_ID" title="Get Profile By ID" />

  <Card href="/actionkit/integrations/linkedin/LINKEDIN_CREATE_POST" title="Create Post" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for LinkedIn. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#MAILCHIMP_CREATE_CAMPAIGN



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#MAILCHIMP_SEARCH_CAMPAIGNS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#MAILCHIMP_SEARCH_LISTS



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

actionkit/openapi.json POST /projects/{project_id}/tools/#MAILCHIMP_SEND_CAMPAIGN



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#MAILCHIMP_UPDATE_CONTACT_TO_LIST



# Mailchimp
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/overview

Browse the tools and triggers available for Mailchimp in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/mailchimp/MAILCHIMP_CREATE_CAMPAIGN" title="Create Campaign" />

  <Card href="/actionkit/integrations/mailchimp/MAILCHIMP_UPDATE_CAMPAIGN" title="Update Campaign" />

  <Card href="/actionkit/integrations/mailchimp/MAILCHIMP_SEND_CAMPAIGN" title="Send Campaign" />

  <Card href="/actionkit/integrations/mailchimp/MAILCHIMP_SEARCH_CAMPAIGNS" title="Search Campaigns" />

  <Card href="/actionkit/integrations/mailchimp/MAILCHIMP_GET_CAMPAIGN_BY_ID" title="Get Campaign By ID" />

  <Card href="/actionkit/integrations/mailchimp/MAILCHIMP_DELETE_CAMPAIGN_BY_ID" title="Delete Campaign By ID" />

  <Card href="/actionkit/integrations/mailchimp/MAILCHIMP_CREATE_LIST" title="Create List" />

  <Card href="/actionkit/integrations/mailchimp/MAILCHIMP_GET_LIST_BY_ID" title="Get List By ID" />

  <Card href="/actionkit/integrations/mailchimp/MAILCHIMP_SEARCH_LISTS" title="Search Lists" />

  <Card href="/actionkit/integrations/mailchimp/MAILCHIMP_ADD_CONTACT_TO_LIST" title="Add Contact To List" />

  <Card href="/actionkit/integrations/mailchimp/MAILCHIMP_UPDATE_CONTACT_TO_LIST" title="Update Contact To List" />

  <Card href="/actionkit/integrations/mailchimp/MAILCHIMP_GET_CONTACTS_FROM_LIST" title="Get Contacts From List" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/mailchimp/triggers/MAILCHIMP_TRIGGER_LIST" title="Mailchimp Lists" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Mailchimp Lists
Source: https://docs.useparagon.com/actionkit/integrations/mailchimp/triggers/MAILCHIMP_TRIGGER_LIST

Mailchimp Lists

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "mailchimp",
  "type": "MAILCHIMP_TRIGGER_LIST",
  "parameters": {
    "listId": "{{settings.list}}"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Unique Id for the list

  * Example value: `{{settings.list}}`
</ParamField>


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#MARKETO_GET_LEAD_BY_ID



# Marketo
Source: https://docs.useparagon.com/actionkit/integrations/marketo/overview

Browse the tools available for Marketo in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/marketo/MARKETO_CREATE_OR_UPDATE_LEAD" title="Create Or Update Lead" />

  <Card href="/actionkit/integrations/marketo/MARKETO_GET_LEADS" title="Get Leads" />

  <Card href="/actionkit/integrations/marketo/MARKETO_GET_LEAD_BY_ID" title="Get Lead By ID" />

  <Card href="/actionkit/integrations/marketo/MARKETO_ADD_LEADS_TO_LIST" title="Add Leads To List" />

  <Card href="/actionkit/integrations/marketo/MARKETO_CREATE_CUSTOM_OBJECT" title="Create Custom Object" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Marketo. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Microsoft Dynamics Create Record Account
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_ACCOUNT

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_ACCOUNT



# Microsoft Dynamics Create Record Any
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_ANY

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_ANY



# Microsoft Dynamics Create Record Call
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_CALL

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_CALL



# Microsoft Dynamics Create Record Contact
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_CONTACT

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_CONTACT



# Microsoft Dynamics Create Record Lead
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_LEAD

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_LEAD



# Microsoft Dynamics Create Record Meeting
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_MEETING

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_MEETING



# Microsoft Dynamics Create Record Note
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_NOTE

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_NOTE



# Microsoft Dynamics Create Record Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_OPPORTUNITY



# Microsoft Dynamics Create Record Task
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_CREATE_RECORD_TASK



# Microsoft Dynamics Delete Record Account
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_ACCOUNT

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_ACCOUNT



# Microsoft Dynamics Delete Record Any
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_ANY

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_ANY



# Microsoft Dynamics Delete Record Call
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_CALL

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_CALL



# Microsoft Dynamics Delete Record Contact
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_CONTACT

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_CONTACT



# Microsoft Dynamics Delete Record Lead
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_LEAD

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_LEAD



# Microsoft Dynamics Delete Record Meeting
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_MEETING

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_MEETING



# Microsoft Dynamics Delete Record Note
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_NOTE

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_NOTE



# Microsoft Dynamics Delete Record Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_OPPORTUNITY



# Microsoft Dynamics Delete Record Task
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DELETE_RECORD_TASK



# Microsoft Dynamics Describe Action Schema
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DESCRIBE_ACTION_SCHEMA

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_DESCRIBE_ACTION_SCHEMA



# Microsoft Dynamics Get Record By ID Account
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_ACCOUNT

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_ACCOUNT



# Microsoft Dynamics Get Record By ID Any
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_ANY

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_ANY



# Microsoft Dynamics Get Record By ID Call
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_CALL

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_CALL



# Microsoft Dynamics Get Record By ID Contact
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_CONTACT

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_CONTACT



# Microsoft Dynamics Get Record By ID Lead
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_LEAD

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_LEAD



# Microsoft Dynamics Get Record By ID Meeting
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_MEETING

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_MEETING



# Microsoft Dynamics Get Record By ID Note
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_NOTE

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_NOTE



# Microsoft Dynamics Get Record By ID Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_OPPORTUNITY



# Microsoft Dynamics Get Record By ID Task
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_TASK



# Microsoft Dynamics Search Records Account
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_ACCOUNT

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_ACCOUNT



# Microsoft Dynamics Search Records Any
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_ANY

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_ANY



# Microsoft Dynamics Search Records Call
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_CALL

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_CALL



# Microsoft Dynamics Search Records Contact
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_CONTACT

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_CONTACT



# Microsoft Dynamics Search Records Lead
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_LEAD

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_LEAD



# Microsoft Dynamics Search Records Meeting
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_MEETING

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_MEETING



# Microsoft Dynamics Search Records Note
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_NOTE

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_NOTE



# Microsoft Dynamics Search Records Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_OPPORTUNITY



# Microsoft Dynamics Search Records Task
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_SEARCH_RECORDS_TASK



# Microsoft Dynamics Update Record Account
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_ACCOUNT

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_ACCOUNT



# Microsoft Dynamics Update Record Any
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_ANY

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_ANY



# Microsoft Dynamics Update Record Call
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_CALL

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_CALL



# Microsoft Dynamics Update Record Contact
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_CONTACT

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_CONTACT



# Microsoft Dynamics Update Record Lead
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_LEAD

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_LEAD



# Microsoft Dynamics Update Record Meeting
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_MEETING

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_MEETING



# Microsoft Dynamics Update Record Note
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_NOTE

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_NOTE



# Microsoft Dynamics Update Record Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_OPPORTUNITY



# Microsoft Dynamics Update Record Task
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#MICROSOFT_DYNAMICS_UPDATE_RECORD_TASK



# Dynamics 365 Sales
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/overview

Browse the tools and triggers available for Dynamics 365 Sales in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_OPPORTUNITY" title="Microsoft Dynamics Create Record Opportunity" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_ACCOUNT" title="Microsoft Dynamics Create Record Account" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_CONTACT" title="Microsoft Dynamics Create Record Contact" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_LEAD" title="Microsoft Dynamics Create Record Lead" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_CALL" title="Microsoft Dynamics Create Record Call" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_MEETING" title="Microsoft Dynamics Create Record Meeting" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_TASK" title="Microsoft Dynamics Create Record Task" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_NOTE" title="Microsoft Dynamics Create Record Note" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_CREATE_RECORD_ANY" title="Microsoft Dynamics Create Record Any" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_OPPORTUNITY" title="Microsoft Dynamics Update Record Opportunity" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_ACCOUNT" title="Microsoft Dynamics Update Record Account" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_CONTACT" title="Microsoft Dynamics Update Record Contact" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_LEAD" title="Microsoft Dynamics Update Record Lead" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_CALL" title="Microsoft Dynamics Update Record Call" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_MEETING" title="Microsoft Dynamics Update Record Meeting" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_TASK" title="Microsoft Dynamics Update Record Task" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_NOTE" title="Microsoft Dynamics Update Record Note" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_UPDATE_RECORD_ANY" title="Microsoft Dynamics Update Record Any" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_OPPORTUNITY" title="Microsoft Dynamics Get Record By ID Opportunity" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_ACCOUNT" title="Microsoft Dynamics Get Record By ID Account" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_CONTACT" title="Microsoft Dynamics Get Record By ID Contact" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_LEAD" title="Microsoft Dynamics Get Record By ID Lead" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_CALL" title="Microsoft Dynamics Get Record By ID Call" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_MEETING" title="Microsoft Dynamics Get Record By ID Meeting" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_TASK" title="Microsoft Dynamics Get Record By ID Task" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_NOTE" title="Microsoft Dynamics Get Record By ID Note" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_GET_RECORD_BY_ID_ANY" title="Microsoft Dynamics Get Record By ID Any" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_OPPORTUNITY" title="Microsoft Dynamics Search Records Opportunity" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_ACCOUNT" title="Microsoft Dynamics Search Records Account" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_CONTACT" title="Microsoft Dynamics Search Records Contact" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_LEAD" title="Microsoft Dynamics Search Records Lead" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_CALL" title="Microsoft Dynamics Search Records Call" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_MEETING" title="Microsoft Dynamics Search Records Meeting" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_TASK" title="Microsoft Dynamics Search Records Task" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_NOTE" title="Microsoft Dynamics Search Records Note" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_SEARCH_RECORDS_ANY" title="Microsoft Dynamics Search Records Any" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_OPPORTUNITY" title="Microsoft Dynamics Delete Record Opportunity" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_ACCOUNT" title="Microsoft Dynamics Delete Record Account" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_CONTACT" title="Microsoft Dynamics Delete Record Contact" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_LEAD" title="Microsoft Dynamics Delete Record Lead" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_CALL" title="Microsoft Dynamics Delete Record Call" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_MEETING" title="Microsoft Dynamics Delete Record Meeting" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_TASK" title="Microsoft Dynamics Delete Record Task" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_NOTE" title="Microsoft Dynamics Delete Record Note" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DELETE_RECORD_ANY" title="Microsoft Dynamics Delete Record Any" />

  <Card href="/actionkit/integrations/microsoftDynamics/MICROSOFT_DYNAMICS_DESCRIBE_ACTION_SCHEMA" title="Microsoft Dynamics Describe Action Schema" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/microsoftDynamics/triggers/MICROSOFT_DYNAMICS_TRIGGER_RECORD_CREATED" title="New Record" />

  <Card href="/actionkit/integrations/microsoftDynamics/triggers/MICROSOFT_DYNAMICS_TRIGGER_RECORD_UPDATED" title="Record Updated" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Record
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/triggers/MICROSOFT_DYNAMICS_TRIGGER_RECORD_CREATED

Trigger when a new Dynamics 365 record is created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "microsoftDynamics",
  "type": "MICROSOFT_DYNAMICS_TRIGGER_RECORD_CREATED",
  "parameters": {
    "mdEntity": "Opportunity",
    "filterFormula": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "name",
              "operator": "$stringExactlyMatches",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Choose an entity

  * Allowed values: Opportunity (`Opportunity`), Account (`Account`), Contact (`Contact`), Lead (`Lead`), Call (`Call`), Meeting (`Meeting`), Task (`Task`), Note (`Note`), Custom Entity (`<specified by entity property>`)
  * Options can be loaded by using the `cachedCustomEntities` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<Accordion title="When Opportunity is selected">
  Additional options when this parameter is set to `Opportunity`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `name`, `customerid`, `salesstagecode`, `estimatedclosedate`, `actualclosedate`, `estimatedvalue`, `description`, `_ownerid_value`, `transactioncurrencyid`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Account is selected">
  Additional options when this parameter is set to `Account`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `name`, `_ownerid_value`, `websiteurl`, `telephone1`, `description`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Contact is selected">
  Additional options when this parameter is set to `Contact`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `firstname`, `lastname`, `emailaddress1`, `telephone1`, `jobtitle`, `description`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Lead is selected">
  Additional options when this parameter is set to `Lead`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `subject`, `firstname`, `lastname`, `emailaddress1`, `telephone1`, `websiteurl`, `jobtitle`, `salesstagecode`, `description`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Call is selected">
  Additional options when this parameter is set to `Call`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `subject`, `directioncode`, `_regardingobjectid_value`, `phonenumber`, `actualdurationminutes`, `description`, `scheduledend`, `prioritycode`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Meeting is selected">
  Additional options when this parameter is set to `Meeting`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `subject`, `scheduledstart`, `scheduledend`, `_regardingobjectid_value`, `location`, `description`, `prioritycode`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Task is selected">
  Additional options when this parameter is set to `Task`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `subject`, `_regardingobjectid_value`, `scheduledend`, `_ownerid_value`, `prioritycode`, `description`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Note is selected">
  Additional options when this parameter is set to `Note`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `_objectid_value`, `subject`, `notetext`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Custom Entity is selected">
  Additional options when this parameter is set to `<specified by entity property>`.

  <ParamField type="TEXTAREA">
    The Entity Set Name of the Object. Use Connect Portal Workflow Settings to allow users to select a Custom Object.

    * Example value: `entitysetname`
  </ParamField>

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>


# Record Updated
Source: https://docs.useparagon.com/actionkit/integrations/microsoftDynamics/triggers/MICROSOFT_DYNAMICS_TRIGGER_RECORD_UPDATED

Trigger when a Dynamics 365 record is updated

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "microsoftDynamics",
  "type": "MICROSOFT_DYNAMICS_TRIGGER_RECORD_UPDATED",
  "parameters": {
    "mdEntity": "Opportunity",
    "filterFormula": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "name",
              "operator": "$stringExactlyMatches",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Choose an entity

  * Allowed values: Opportunity (`Opportunity`), Account (`Account`), Contact (`Contact`), Lead (`Lead`), Call (`Call`), Meeting (`Meeting`), Task (`Task`), Note (`Note`), Custom Entity (`<specified by entity property>`)
  * Options can be loaded by using the `cachedCustomEntities` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<Accordion title="When Opportunity is selected">
  Additional options when this parameter is set to `Opportunity`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `name`, `customerid`, `salesstagecode`, `estimatedclosedate`, `actualclosedate`, `estimatedvalue`, `description`, `_ownerid_value`, `transactioncurrencyid`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Account is selected">
  Additional options when this parameter is set to `Account`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `name`, `_ownerid_value`, `websiteurl`, `telephone1`, `description`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Contact is selected">
  Additional options when this parameter is set to `Contact`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `firstname`, `lastname`, `emailaddress1`, `telephone1`, `jobtitle`, `description`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Lead is selected">
  Additional options when this parameter is set to `Lead`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `subject`, `firstname`, `lastname`, `emailaddress1`, `telephone1`, `websiteurl`, `jobtitle`, `salesstagecode`, `description`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Call is selected">
  Additional options when this parameter is set to `Call`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `subject`, `directioncode`, `_regardingobjectid_value`, `phonenumber`, `actualdurationminutes`, `description`, `scheduledend`, `prioritycode`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Meeting is selected">
  Additional options when this parameter is set to `Meeting`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `subject`, `scheduledstart`, `scheduledend`, `_regardingobjectid_value`, `location`, `description`, `prioritycode`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Task is selected">
  Additional options when this parameter is set to `Task`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `subject`, `_regardingobjectid_value`, `scheduledend`, `_ownerid_value`, `prioritycode`, `description`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Note is selected">
  Additional options when this parameter is set to `Note`.

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields: `_objectid_value`, `subject`, `notetext`
    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>

<Accordion title="When Custom Entity is selected">
  Additional options when this parameter is set to `<specified by entity property>`.

  <ParamField type="TEXTAREA">
    The Entity Set Name of the Object. Use Connect Portal Workflow Settings to allow users to select a Custom Object.

    * Example value: `entitysetname`
  </ParamField>

  <ParamField type="CONDITIONAL">
    Search for records that match specified filters.

    * Supported filter fields are loaded from `cachedFields` after selecting `mdEntity`.
    * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringContains`, `$numberLessThan`, `$dateTimeBefore`, `$numberEquals`, `$dateTimeEquals`, `$numberGreaterThan`, `$dateTimeAfter`, `$numberDoesNotEqual`, `$numberGreaterThanOrEqualTo`, `$numberLessThanOrEqualTo`, `$booleanTrue`, `$booleanFalse`
  </ParamField>
</Accordion>


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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#TEAMS_JOINED_TEAM_LIST



# List Messages In Chat
Source: https://docs.useparagon.com/actionkit/integrations/microsoftTeams/TEAMS_LIST_MESSAGES_IN_CHAT

actionkit/openapi.json POST /projects/{project_id}/tools/#TEAMS_LIST_MESSAGES_IN_CHAT



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

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#TEAMS_SEND_MESSAGE_IN_CHAT



# Microsoft Teams
Source: https://docs.useparagon.com/actionkit/integrations/microsoftTeams/overview

Browse the tools and triggers available for Microsoft Teams in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/microsoftTeams/TEAMS_SEND_MESSAGE_IN_CHANNEL" title="Send Message In Channel" />

  <Card href="/actionkit/integrations/microsoftTeams/TEAMS_SEND_MESSAGE_IN_CHAT" title="Send Message In Chat" />

  <Card href="/actionkit/integrations/microsoftTeams/TEAMS_GET_USER_BY_EMAIL" title="Get User By Email" />

  <Card href="/actionkit/integrations/microsoftTeams/TEAMS_JOINED_TEAM_LIST" title="Joined Team List" />

  <Card href="/actionkit/integrations/microsoftTeams/TEAMS_CHANNEL_LIST" title="Channel List" />

  <Card href="/actionkit/integrations/microsoftTeams/TEAMS_MEMBER_LIST" title="Member List" />

  <Card href="/actionkit/integrations/microsoftTeams/TEAMS_LIST_MESSAGES_IN_CHAT" title="List Messages In Chat" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/microsoftTeams/triggers/TEAMS_TRIGGER_CHANNEL_CREATED" title="Channel Created" />

  <Card href="/actionkit/integrations/microsoftTeams/triggers/TEAMS_TRIGGER_CHAT_CREATED" title="Chat Created" />

  <Card href="/actionkit/integrations/microsoftTeams/triggers/TEAMS_TRIGGER_CHAT_UPDATED" title="Chat Updated" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Channel Created
Source: https://docs.useparagon.com/actionkit/integrations/microsoftTeams/triggers/TEAMS_TRIGGER_CHANNEL_CREATED

Trigger when a Channel is created in Microsoft Teams

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "microsoftTeams",
  "type": "TEAMS_TRIGGER_CHANNEL_CREATED",
  "parameters": {
    "teamId": "e4da8430-de80-4815-9785-9c2441c24a7b"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  The ID of the Team to search for users in. Use Connect Portal User Settings to allow your user to select a Team.

  * Example value: `e4da8430-de80-4815-9785-9c2441c24a7b`
</ParamField>


# Chat Created
Source: https://docs.useparagon.com/actionkit/integrations/microsoftTeams/triggers/TEAMS_TRIGGER_CHAT_CREATED

Trigger when a Chat is created in Microsoft Teams

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "microsoftTeams",
  "type": "TEAMS_TRIGGER_CHAT_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Chat Updated
Source: https://docs.useparagon.com/actionkit/integrations/microsoftTeams/triggers/TEAMS_TRIGGER_CHAT_UPDATED

Trigger when a Chat is updated in Microsoft Teams

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "microsoftTeams",
  "type": "TEAMS_TRIGGER_CHAT_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


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

actionkit/openapi.json POST /projects/{project_id}/tools/#MONDAY_ARCHIVE_ITEM



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

actionkit/openapi.json POST /projects/{project_id}/tools/#MONDAY_CREATE_ITEM



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

actionkit/openapi.json POST /projects/{project_id}/tools/#MONDAY_CREATE_SUBITEM



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

actionkit/openapi.json POST /projects/{project_id}/tools/#MONDAY_DELETE_ITEM



# Get Item By External ID
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_GET_ITEM_BY_EXTERNAL_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#MONDAY_GET_ITEM_BY_EXTERNAL_ID



# Get Item By ID
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_GET_ITEM_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#MONDAY_GET_ITEM_BY_ID



# Search Items
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_SEARCH_ITEMS

actionkit/openapi.json POST /projects/{project_id}/tools/#MONDAY_SEARCH_ITEMS



# Search Users
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_SEARCH_USERS

actionkit/openapi.json POST /projects/{project_id}/tools/#MONDAY_SEARCH_USERS



# Update Item
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/MONDAY_UPDATE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#MONDAY_UPDATE_ITEM



# Monday.com
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/overview

Browse the tools and triggers available for Monday.com in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/monday.com/MONDAY_CREATE_ITEM" title="Create Item" />

  <Card href="/actionkit/integrations/monday.com/MONDAY_UPDATE_ITEM" title="Update Item" />

  <Card href="/actionkit/integrations/monday.com/MONDAY_GET_ITEM_BY_ID" title="Get Item By ID" />

  <Card href="/actionkit/integrations/monday.com/MONDAY_GET_ITEM_BY_EXTERNAL_ID" title="Get Item By External ID" />

  <Card href="/actionkit/integrations/monday.com/MONDAY_SEARCH_ITEMS" title="Search Items" />

  <Card href="/actionkit/integrations/monday.com/MONDAY_DELETE_ITEM" title="Delete Item" />

  <Card href="/actionkit/integrations/monday.com/MONDAY_ARCHIVE_ITEM" title="Archive Item" />

  <Card href="/actionkit/integrations/monday.com/MONDAY_CREATE_SUBITEM" title="Create Subitem" />

  <Card href="/actionkit/integrations/monday.com/MONDAY_SEARCH_USERS" title="Search Users" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/monday.com/triggers/MONDAY_TRIGGER_ITEM_CREATED_WITH_NEW_API_VERSION" title="Item Created" />

  <Card href="/actionkit/integrations/monday.com/triggers/MONDAY_TRIGGER_ITEM_UPDATED_WITH_NEW_API_VERSION" title="Item Updated" />

  <Card href="/actionkit/integrations/monday.com/triggers/MONDAY_TRIGGER_COMMENT_CREATED" title="New Comment on Item" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Comment on Item
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/triggers/MONDAY_TRIGGER_COMMENT_CREATED

Trigger when a comment is created in Monday.com

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "monday.com",
  "type": "MONDAY_TRIGGER_COMMENT_CREATED",
  "parameters": {
    "boardId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Board ID

  * Options can be loaded by using the `boards` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# Item Created
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/triggers/MONDAY_TRIGGER_ITEM_CREATED_WITH_NEW_API_VERSION

Trigger when an item is created in Monday.com

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "monday.com",
  "type": "MONDAY_TRIGGER_ITEM_CREATED_WITH_NEW_API_VERSION",
  "parameters": {
    "boardId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Board ID

  * Options can be loaded by using the `boards` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# Item Updated
Source: https://docs.useparagon.com/actionkit/integrations/monday.com/triggers/MONDAY_TRIGGER_ITEM_UPDATED_WITH_NEW_API_VERSION

Trigger when an item is updated in Monday.com

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "monday.com",
  "type": "MONDAY_TRIGGER_ITEM_UPDATED_WITH_NEW_API_VERSION",
  "parameters": {
    "boardId": "example-value"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Board ID

  * Options can be loaded by using the `boards` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>


# Access Soap Api With Body
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_ACCESS_SOAP_API_WITH_BODY

actionkit/openapi.json POST /projects/{project_id}/tools/#NETSUITE_ACCESS_SOAP_API_WITH_BODY



# Create Account
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_CREATE_ACCOUNT

actionkit/openapi.json POST /projects/{project_id}/tools/#NETSUITE_CREATE_ACCOUNT



# Create Bill
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_CREATE_BILL

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#NETSUITE_CREATE_TAX_GROUP



# Create Vendor
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_CREATE_VENDOR

actionkit/openapi.json POST /projects/{project_id}/tools/#NETSUITE_CREATE_VENDOR



# Delete Account
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_DELETE_ACCOUNT

actionkit/openapi.json POST /projects/{project_id}/tools/#NETSUITE_DELETE_ACCOUNT



# Delete Bill
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_DELETE_BILL

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#NETSUITE_DELETE_TAX_GROUP



# Delete Vendor
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_DELETE_VENDOR

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#NETSUITE_SEARCH_ACCOUNTS



# Search Bills
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_SEARCH_BILLS

actionkit/openapi.json POST /projects/{project_id}/tools/#NETSUITE_SEARCH_BILLS



# Search Contacts By Saved Search ID
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_SEARCH_CONTACTS_BY_SAVED_SEARCH_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#NETSUITE_SEARCH_CONTACTS_BY_SAVED_SEARCH_ID



# Search Payment Terms
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_SEARCH_PAYMENT_TERMS

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#NETSUITE_SEARCH_TAX_CODES



# Search Vendors
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_SEARCH_VENDORS

actionkit/openapi.json POST /projects/{project_id}/tools/#NETSUITE_SEARCH_VENDORS



# Update Account
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_UPDATE_ACCOUNT

actionkit/openapi.json POST /projects/{project_id}/tools/#NETSUITE_UPDATE_ACCOUNT



# Update Bill
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_UPDATE_BILL

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#NETSUITE_UPDATE_TAX_GROUP



# Update Vendor
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/NETSUITE_UPDATE_VENDOR

actionkit/openapi.json POST /projects/{project_id}/tools/#NETSUITE_UPDATE_VENDOR



# NetSuite
Source: https://docs.useparagon.com/actionkit/integrations/netsuite/overview

Browse the tools available for NetSuite in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/netsuite/NETSUITE_CREATE_VENDOR" title="Create Vendor" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_UPDATE_VENDOR" title="Update Vendor" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_GET_VENDOR_BY_ID" title="Get Vendor By ID" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_SEARCH_VENDORS" title="Search Vendors" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_DELETE_VENDOR" title="Delete Vendor" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_CREATE_BILL" title="Create Bill" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_UPDATE_BILL" title="Update Bill" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_GET_BILL_BY_ID" title="Get Bill By ID" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_SEARCH_BILLS" title="Search Bills" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_DELETE_BILL" title="Delete Bill" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_CREATE_ACCOUNT" title="Create Account" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_UPDATE_ACCOUNT" title="Update Account" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_GET_ACCOUNT_BY_ID" title="Get Account By ID" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_SEARCH_ACCOUNTS" title="Search Accounts" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_DELETE_ACCOUNT" title="Delete Account" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_CREATE_TAX_GROUP" title="Create Tax Group" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_UPDATE_TAX_GROUP" title="Update Tax Group" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_GET_TAX_GROUP_BY_ID" title="Get Tax Group By ID" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_DELETE_TAX_GROUP" title="Delete Tax Group" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_SEARCH_TAX_CODES" title="Search Tax Codes" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_SEARCH_PAYMENT_TERMS" title="Search Payment Terms" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_GET_PAYMENT_TERM_BY_ID" title="Get Payment Term By ID" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_SEARCH_POSTING_PERIODS" title="Search Posting Periods" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_SEARCH_CONTACTS_BY_SAVED_SEARCH_ID" title="Search Contacts By Saved Search ID" />

  <Card href="/actionkit/integrations/netsuite/NETSUITE_ACCESS_SOAP_API_WITH_BODY" title="Access Soap Api With Body" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for NetSuite. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Archive Page
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_ARCHIVE_PAGE

actionkit/openapi.json POST /projects/{project_id}/tools/#NOTION_ARCHIVE_PAGE



# Create Page
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_CREATE_PAGE

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#NOTION_GET_PAGE_CONTENT



# Search Pages
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_SEARCH_PAGES

actionkit/openapi.json POST /projects/{project_id}/tools/#NOTION_SEARCH_PAGES



# Update Block
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_UPDATE_BLOCK

actionkit/openapi.json POST /projects/{project_id}/tools/#NOTION_UPDATE_BLOCK



# Update Page
Source: https://docs.useparagon.com/actionkit/integrations/notion/NOTION_UPDATE_PAGE

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#NOTION_UPDATE_PAGE_WITH_MARKDOWN



# Notion
Source: https://docs.useparagon.com/actionkit/integrations/notion/overview

Browse the tools and triggers available for Notion in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/notion/NOTION_CREATE_PAGE" title="Create Page" />

  <Card href="/actionkit/integrations/notion/NOTION_UPDATE_PAGE" title="Update Page" />

  <Card href="/actionkit/integrations/notion/NOTION_GET_PAGE_BY_ID" title="Get Page By ID" />

  <Card href="/actionkit/integrations/notion/NOTION_ARCHIVE_PAGE" title="Archive Page" />

  <Card href="/actionkit/integrations/notion/NOTION_SEARCH_PAGES" title="Search Pages" />

  <Card href="/actionkit/integrations/notion/NOTION_GET_PAGE_CONTENT" title="Get Page Content" />

  <Card href="/actionkit/integrations/notion/NOTION_UPDATE_BLOCK" title="Update Block" />

  <Card href="/actionkit/integrations/notion/NOTION_GET_BLOCK_BY_ID" title="Get Block By ID" />

  <Card href="/actionkit/integrations/notion/NOTION_DELETE_BLOCK" title="Delete Block" />

  <Card href="/actionkit/integrations/notion/NOTION_GET_PAGE_AS_MARKDOWN" title="Get Page As Markdown" />

  <Card href="/actionkit/integrations/notion/NOTION_CREATE_PAGE_WITH_MARKDOWN" title="Create Page With Markdown" />

  <Card href="/actionkit/integrations/notion/NOTION_UPDATE_PAGE_WITH_MARKDOWN" title="Update Page With Markdown" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/notion/triggers/NOTION_TRIGGER_PAGE_CREATED" title="Page Created" />

  <Card href="/actionkit/integrations/notion/triggers/NOTION_TRIGGER_PAGE_UPDATED" title="Page Updated" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Page Created
Source: https://docs.useparagon.com/actionkit/integrations/notion/triggers/NOTION_TRIGGER_PAGE_CREATED

Trigger when a Page or Database entry is created in Notion

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "notion",
  "type": "NOTION_TRIGGER_PAGE_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Page Updated
Source: https://docs.useparagon.com/actionkit/integrations/notion/triggers/NOTION_TRIGGER_PAGE_UPDATED

Trigger when a Page or Database entry is updated in Notion

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "notion",
  "type": "NOTION_TRIGGER_PAGE_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Create Folder
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_CREATE_FOLDER

actionkit/openapi.json POST /projects/{project_id}/tools/#ONEDRIVE_CREATE_FOLDER



# Delete Folder
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_DELETE_FOLDER

actionkit/openapi.json POST /projects/{project_id}/tools/#ONEDRIVE_DELETE_FOLDER



# Download File
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_DOWNLOAD_FILE

actionkit/openapi.json POST /projects/{project_id}/tools/#ONEDRIVE_DOWNLOAD_FILE

This Tool will respond with a temporary signed download URL from the OneDrive API. Send a request to this URL to get a response with a byte stream of the file data.


# Get File By ID
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_GET_FILE_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#ONEDRIVE_LIST_CONTENTS



# Move Folder
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_MOVE_FOLDER

actionkit/openapi.json POST /projects/{project_id}/tools/#ONEDRIVE_MOVE_FOLDER



# Save File
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_SAVE_FILE

actionkit/openapi.json POST /projects/{project_id}/tools/#ONEDRIVE_SAVE_FILE



# Search Folders
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/ONEDRIVE_SEARCH_FOLDERS

actionkit/openapi.json POST /projects/{project_id}/tools/#ONEDRIVE_SEARCH_FOLDERS



# OneDrive
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/overview

Browse the tools and triggers available for OneDrive in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/onedrive/ONEDRIVE_GET_FILE_BY_ID" title="Get File By ID" />

  <Card href="/actionkit/integrations/onedrive/ONEDRIVE_SAVE_FILE" title="Save File" />

  <Card href="/actionkit/integrations/onedrive/ONEDRIVE_LIST_CONTENTS" title="List Contents" />

  <Card href="/actionkit/integrations/onedrive/ONEDRIVE_CREATE_FOLDER" title="Create Folder" />

  <Card href="/actionkit/integrations/onedrive/ONEDRIVE_GET_FOLDER_BY_ID" title="Get Folder By ID" />

  <Card href="/actionkit/integrations/onedrive/ONEDRIVE_SEARCH_FOLDERS" title="Search Folders" />

  <Card href="/actionkit/integrations/onedrive/ONEDRIVE_MOVE_FOLDER" title="Move Folder" />

  <Card href="/actionkit/integrations/onedrive/ONEDRIVE_DELETE_FOLDER" title="Delete Folder" />

  <Card href="/actionkit/integrations/onedrive/ONEDRIVE_DOWNLOAD_FILE" title="Download File" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/onedrive/triggers/ONEDRIVE_TRIGGER_FILE_CHANGE" title="File Change">
    Trigger when there are changes to content within the hierarchy of the root folder.
  </Card>
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# File Change
Source: https://docs.useparagon.com/actionkit/integrations/onedrive/triggers/ONEDRIVE_TRIGGER_FILE_CHANGE

Trigger when there are changes to content within the hierarchy of the root folder.

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "onedrive",
  "type": "ONEDRIVE_TRIGGER_FILE_CHANGE",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Create Page
Source: https://docs.useparagon.com/actionkit/integrations/onenote/ONENOTE_CREATE_PAGE

actionkit/openapi.json POST /projects/{project_id}/tools/#ONENOTE_CREATE_PAGE



# Delete Page
Source: https://docs.useparagon.com/actionkit/integrations/onenote/ONENOTE_DELETE_PAGE

actionkit/openapi.json POST /projects/{project_id}/tools/#ONENOTE_DELETE_PAGE



# Get Page By ID
Source: https://docs.useparagon.com/actionkit/integrations/onenote/ONENOTE_GET_PAGE_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#ONENOTE_GET_PAGE_BY_ID



# Search Pages
Source: https://docs.useparagon.com/actionkit/integrations/onenote/ONENOTE_SEARCH_PAGES

actionkit/openapi.json POST /projects/{project_id}/tools/#ONENOTE_SEARCH_PAGES



# Update Page
Source: https://docs.useparagon.com/actionkit/integrations/onenote/ONENOTE_UPDATE_PAGE

actionkit/openapi.json POST /projects/{project_id}/tools/#ONENOTE_UPDATE_PAGE



# OneNote
Source: https://docs.useparagon.com/actionkit/integrations/onenote/overview

Browse the tools available for OneNote in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/onenote/ONENOTE_CREATE_PAGE" title="Create Page" />

  <Card href="/actionkit/integrations/onenote/ONENOTE_UPDATE_PAGE" title="Update Page" />

  <Card href="/actionkit/integrations/onenote/ONENOTE_GET_PAGE_BY_ID" title="Get Page By ID" />

  <Card href="/actionkit/integrations/onenote/ONENOTE_DELETE_PAGE" title="Delete Page" />

  <Card href="/actionkit/integrations/onenote/ONENOTE_SEARCH_PAGES" title="Search Pages" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for OneNote. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Create Event
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_CREATE_EVENT

actionkit/openapi.json POST /projects/{project_id}/tools/#OUTLOOK_CREATE_EVENT



# Delete Event
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_DELETE_EVENT

actionkit/openapi.json POST /projects/{project_id}/tools/#OUTLOOK_DELETE_EVENT



# Get Events
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_GET_EVENTS

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#OUTLOOK_GET_MESSAGES



# Get Message By ID
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_GET_MESSAGE_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#OUTLOOK_GET_MESSAGE_BY_ID



# Send Message
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_SEND_MESSAGE

actionkit/openapi.json POST /projects/{project_id}/tools/#OUTLOOK_SEND_MESSAGE



# Update Event
Source: https://docs.useparagon.com/actionkit/integrations/outlook/OUTLOOK_UPDATE_EVENT

actionkit/openapi.json POST /projects/{project_id}/tools/#OUTLOOK_UPDATE_EVENT



# Microsoft Outlook
Source: https://docs.useparagon.com/actionkit/integrations/outlook/overview

Browse the tools and triggers available for Microsoft Outlook in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/outlook/OUTLOOK_CREATE_EVENT" title="Create Event" />

  <Card href="/actionkit/integrations/outlook/OUTLOOK_UPDATE_EVENT" title="Update Event" />

  <Card href="/actionkit/integrations/outlook/OUTLOOK_GET_EVENT_BY_ID" title="Get Event By ID" />

  <Card href="/actionkit/integrations/outlook/OUTLOOK_GET_EVENTS" title="Get Events" />

  <Card href="/actionkit/integrations/outlook/OUTLOOK_DELETE_EVENT" title="Delete Event" />

  <Card href="/actionkit/integrations/outlook/OUTLOOK_GET_MESSAGES" title="Get Messages" />

  <Card href="/actionkit/integrations/outlook/OUTLOOK_GET_MESSAGE_BY_ID" title="Get Message By ID" />

  <Card href="/actionkit/integrations/outlook/OUTLOOK_SEND_MESSAGE" title="Send Message" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/outlook/triggers/OUTLOOK_TRIGGER_EVENT_CREATED_WEBHOOK" title="Event Created" />

  <Card href="/actionkit/integrations/outlook/triggers/OUTLOOK_TRIGGER_EVENT_UPDATED_WEBHOOK" title="Event Updated" />

  <Card href="/actionkit/integrations/outlook/triggers/OUTLOOK_TRIGGER_EVENT_REMOVED_WEBHOOK" title="Event Removed" />

  <Card href="/actionkit/integrations/outlook/triggers/OUTLOOK_TRIGGER_NEW_MESSAGE_WEBHOOK" title="New Message" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Event Created
Source: https://docs.useparagon.com/actionkit/integrations/outlook/triggers/OUTLOOK_TRIGGER_EVENT_CREATED_WEBHOOK

Trigger when an Event is created in Outlook

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "outlook",
  "type": "OUTLOOK_TRIGGER_EVENT_CREATED_WEBHOOK",
  "parameters": {
    "userId": "1b671a64-40d5-491e-99b0-da01ff1f3341"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Specify a user ID to perform this action if you are working with an application token.

  * Example value: `1b671a64-40d5-491e-99b0-da01ff1f3341`
</ParamField>


# Event Removed
Source: https://docs.useparagon.com/actionkit/integrations/outlook/triggers/OUTLOOK_TRIGGER_EVENT_REMOVED_WEBHOOK

Trigger when an Event is removed in Outlook

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "outlook",
  "type": "OUTLOOK_TRIGGER_EVENT_REMOVED_WEBHOOK",
  "parameters": {
    "userId": "1b671a64-40d5-491e-99b0-da01ff1f3341"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Specify a user ID to perform this action if you are working with an application token.

  * Example value: `1b671a64-40d5-491e-99b0-da01ff1f3341`
</ParamField>


# Event Updated
Source: https://docs.useparagon.com/actionkit/integrations/outlook/triggers/OUTLOOK_TRIGGER_EVENT_UPDATED_WEBHOOK

Trigger when an Event is updated in Outlook

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "outlook",
  "type": "OUTLOOK_TRIGGER_EVENT_UPDATED_WEBHOOK",
  "parameters": {
    "userId": "1b671a64-40d5-491e-99b0-da01ff1f3341"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Specify a user ID to perform this action if you are working with an application token.

  * Example value: `1b671a64-40d5-491e-99b0-da01ff1f3341`
</ParamField>


# New Message
Source: https://docs.useparagon.com/actionkit/integrations/outlook/triggers/OUTLOOK_TRIGGER_NEW_MESSAGE_WEBHOOK

Trigger when a new Message is received in Outlook

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "outlook",
  "type": "OUTLOOK_TRIGGER_NEW_MESSAGE_WEBHOOK",
  "parameters": {
    "userId": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "mailFolder": "{{settings.mailfolder}}"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Specify a user ID to perform this action if you are working with an application token.

  * Example value: `1b671a64-40d5-491e-99b0-da01ff1f3341`
</ParamField>

<ParamField type="TEXTAREA">
  Use Connect Portal Workflow Settings to allow users to select which mail folder to get messages from. Defaults to the user’s primary mail folder if left blank.

  * Example value: `{{settings.mailfolder}}`
</ParamField>


# Add Prospect To Sequence
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_ADD_PROSPECT_TO_SEQUENCE

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#OUTREACH_CREATE_ACCOUNT



# Create Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_CREATE_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#OUTREACH_CREATE_OPPORTUNITY



# Create Prospect
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_CREATE_PROSPECT

actionkit/openapi.json POST /projects/{project_id}/tools/#OUTREACH_CREATE_PROSPECT



# Get Accounts
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_GET_ACCOUNTS

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#OUTREACH_UPDATE_ACCOUNT



# Update Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_UPDATE_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#OUTREACH_UPDATE_OPPORTUNITY



# Update Prospect
Source: https://docs.useparagon.com/actionkit/integrations/outreach/OUTREACH_UPDATE_PROSPECT

actionkit/openapi.json POST /projects/{project_id}/tools/#OUTREACH_UPDATE_PROSPECT



# Outreach
Source: https://docs.useparagon.com/actionkit/integrations/outreach/overview

Browse the tools available for Outreach in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/outreach/OUTREACH_CREATE_ACCOUNT" title="Create Account" />

  <Card href="/actionkit/integrations/outreach/OUTREACH_UPDATE_ACCOUNT" title="Update Account" />

  <Card href="/actionkit/integrations/outreach/OUTREACH_GET_ACCOUNTS" title="Get Accounts" />

  <Card href="/actionkit/integrations/outreach/OUTREACH_GET_ACCOUNT_BY_ID" title="Get Account By ID" />

  <Card href="/actionkit/integrations/outreach/OUTREACH_CREATE_OPPORTUNITY" title="Create Opportunity" />

  <Card href="/actionkit/integrations/outreach/OUTREACH_UPDATE_OPPORTUNITY" title="Update Opportunity" />

  <Card href="/actionkit/integrations/outreach/OUTREACH_GET_OPPORTUNITIES" title="Get Opportunities" />

  <Card href="/actionkit/integrations/outreach/OUTREACH_GET_OPPORTUNITY_BY_ID" title="Get Opportunity By ID" />

  <Card href="/actionkit/integrations/outreach/OUTREACH_CREATE_PROSPECT" title="Create Prospect" />

  <Card href="/actionkit/integrations/outreach/OUTREACH_UPDATE_PROSPECT" title="Update Prospect" />

  <Card href="/actionkit/integrations/outreach/OUTREACH_GET_PROSPECTS" title="Get Prospects" />

  <Card href="/actionkit/integrations/outreach/OUTREACH_GET_PROSPECT_BY_ID" title="Get Prospect By ID" />

  <Card href="/actionkit/integrations/outreach/OUTREACH_ADD_PROSPECT_TO_SEQUENCE" title="Add Prospect To Sequence" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Outreach. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Create Document
Source: https://docs.useparagon.com/actionkit/integrations/pandadoc/PANDA_DOC_CREATE_DOCUMENT

actionkit/openapi.json POST /projects/{project_id}/tools/#PANDA_DOC_CREATE_DOCUMENT



# Delete Document
Source: https://docs.useparagon.com/actionkit/integrations/pandadoc/PANDA_DOC_DELETE_DOCUMENT

actionkit/openapi.json POST /projects/{project_id}/tools/#PANDA_DOC_DELETE_DOCUMENT



# 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}/tools/#PANDA_DOC_GET_DOCUMENT_BY_ID



# Search Documents
Source: https://docs.useparagon.com/actionkit/integrations/pandadoc/PANDA_DOC_SEARCH_DOCUMENTS

actionkit/openapi.json POST /projects/{project_id}/tools/#PANDA_DOC_SEARCH_DOCUMENTS



# Send Document
Source: https://docs.useparagon.com/actionkit/integrations/pandadoc/PANDA_DOC_SEND_DOCUMENT

actionkit/openapi.json POST /projects/{project_id}/tools/#PANDA_DOC_SEND_DOCUMENT



# Update Document
Source: https://docs.useparagon.com/actionkit/integrations/pandadoc/PANDA_DOC_UPDATE_DOCUMENT

actionkit/openapi.json POST /projects/{project_id}/tools/#PANDA_DOC_UPDATE_DOCUMENT



# PandaDoc
Source: https://docs.useparagon.com/actionkit/integrations/pandadoc/overview

Browse the tools available for PandaDoc in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/pandadoc/PANDA_DOC_CREATE_DOCUMENT" title="Create Document" />

  <Card href="/actionkit/integrations/pandadoc/PANDA_DOC_UPDATE_DOCUMENT" title="Update Document" />

  <Card href="/actionkit/integrations/pandadoc/PANDA_DOC_GET_DOCUMENT_BY_ID" title="Get Document By ID" />

  <Card href="/actionkit/integrations/pandadoc/PANDA_DOC_DELETE_DOCUMENT" title="Delete Document" />

  <Card href="/actionkit/integrations/pandadoc/PANDA_DOC_SEND_DOCUMENT" title="Send Document" />

  <Card href="/actionkit/integrations/pandadoc/PANDA_DOC_SEARCH_DOCUMENTS" title="Search Documents" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for PandaDoc. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Add Prospect To List
Source: https://docs.useparagon.com/actionkit/integrations/pardot/PARDOT_ADD_PROSPECT_TO_LIST

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#PARDOT_SEARCH_PROSPECTS



# Pardot
Source: https://docs.useparagon.com/actionkit/integrations/pardot/overview

Browse the tools available for Pardot in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/pardot/PARDOT_CREATE_OR_UPDATE_PROSPECT" title="Create Or Update Prospect" />

  <Card href="/actionkit/integrations/pardot/PARDOT_SEARCH_PROSPECTS" title="Search Prospects" />

  <Card href="/actionkit/integrations/pardot/PARDOT_GET_PROSPECT_BY_ID" title="Get Prospect By ID" />

  <Card href="/actionkit/integrations/pardot/PARDOT_DELETE_PROSPECT_BY_ID" title="Delete Prospect By ID" />

  <Card href="/actionkit/integrations/pardot/PARDOT_ADD_PROSPECT_TO_LIST" title="Add Prospect To List" />

  <Card href="/actionkit/integrations/pardot/PARDOT_REMOVE_PROSPECT_FROM_LIST" title="Remove Prospect From List" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Pardot. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Create Record Activities
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_ACTIVITIES_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_CREATE_RECORD_ANY



# Create Record Deals
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_DEALS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#PIPEDRIVE_CREATE_RECORD_DEALS_V2



# Create Record Leads
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_LEADS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_CREATE_RECORD_NOTES



# Create Record Organizations
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_ORGANIZATIONS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#PIPEDRIVE_CREATE_RECORD_ORGANIZATIONS_V2



# Create Record Persons
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_PERSONS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_CREATE_RECORD_USERS



# Delete Record Activities
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_ACTIVITIES_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_DELETE_RECORD_ANY



# Delete Record Deals
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_DEALS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#PIPEDRIVE_DELETE_RECORD_DEALS_V2



# Delete Record Leads
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_LEADS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_DELETE_RECORD_NOTES



# Delete Record Organizations
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_ORGANIZATIONS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#PIPEDRIVE_DELETE_RECORD_ORGANIZATIONS_V2



# Delete Record Persons
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_PERSONS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#PIPEDRIVE_DESCRIBE_ACTION_SCHEMA



# Get Records Activities
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_ACTIVITIES_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_GET_RECORDS_ANY



# Get Records Deals
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_DEALS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#PIPEDRIVE_GET_RECORDS_DEALS_V2



# Get Records Leads
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_LEADS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_GET_RECORDS_NOTES



# Get Records Organizations
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_ORGANIZATIONS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#PIPEDRIVE_GET_RECORDS_ORGANIZATIONS_V2



# Get Records Persons
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_PERSONS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_GET_RECORDS_USERS



# Get Record By ID Activities
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_ACTIVITIES_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_ANY



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

actionkit/openapi.json POST /projects/{project_id}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_DEALS_V2



# Get Record By ID Leads
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_LEADS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_NOTES



# Get Record By ID Organizations
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_ORGANIZATIONS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_ORGANIZATIONS_V2



# Get Record By ID Persons
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_PERSONS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_GET_RECORD_BY_ID_USERS



# Update Record Activities
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_ACTIVITIES_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_UPDATE_RECORD_ANY



# Update Record Deals
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_DEALS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#PIPEDRIVE_UPDATE_RECORD_DEALS_V2



# Update Record Leads
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_LEADS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_UPDATE_RECORD_NOTES



# Update Record Organizations
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_ORGANIZATIONS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#PIPEDRIVE_UPDATE_RECORD_ORGANIZATIONS_V2



# Update Record Persons
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_PERSONS_V2

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#PIPEDRIVE_UPDATE_RECORD_USERS



# Pipedrive
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/overview

Browse the tools and triggers available for Pipedrive in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_ACTIVITIES_V2" title="Create Record Activities" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_DEALS_V2" title="Create Record Deals" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_LEADS_V2" title="Create Record Leads" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_NOTES" title="Create Record Notes" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_ORGANIZATIONS_V2" title="Create Record Organizations" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_PERSONS_V2" title="Create Record Persons" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_USERS" title="Create Record Users" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_CREATE_RECORD_ANY" title="Create Record Any" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_ACTIVITIES_V2" title="Update Record Activities" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_DEALS_V2" title="Update Record Deals" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_LEADS_V2" title="Update Record Leads" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_NOTES" title="Update Record Notes" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_ORGANIZATIONS_V2" title="Update Record Organizations" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_PERSONS_V2" title="Update Record Persons" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_USERS" title="Update Record Users" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_UPDATE_RECORD_ANY" title="Update Record Any" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_ACTIVITIES_V2" title="Get Record By ID Activities" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_DEALS_V2" title="Get Record By ID Deals" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_LEADS_V2" title="Get Record By ID Leads" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_NOTES" title="Get Record By ID Notes" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_ORGANIZATIONS_V2" title="Get Record By ID Organizations" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_PERSONS_V2" title="Get Record By ID Persons" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_USERS" title="Get Record By ID Users" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORD_BY_ID_ANY" title="Get Record By ID Any" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_ACTIVITIES_V2" title="Get Records Activities" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_DEALS_V2" title="Get Records Deals" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_LEADS_V2" title="Get Records Leads" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_NOTES" title="Get Records Notes" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_ORGANIZATIONS_V2" title="Get Records Organizations" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_PERSONS_V2" title="Get Records Persons" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_USERS" title="Get Records Users" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_GET_RECORDS_ANY" title="Get Records Any" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_ACTIVITIES_V2" title="Delete Record Activities" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_DEALS_V2" title="Delete Record Deals" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_LEADS_V2" title="Delete Record Leads" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_NOTES" title="Delete Record Notes" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_ORGANIZATIONS_V2" title="Delete Record Organizations" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_PERSONS_V2" title="Delete Record Persons" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_USERS" title="Delete Record Users" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_DELETE_RECORD_ANY" title="Delete Record Any" />

  <Card href="/actionkit/integrations/pipedrive/PIPEDRIVE_DESCRIBE_ACTION_SCHEMA" title="Describe Action Schema" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/pipedrive/triggers/PIPEDRIVE_TRIGGER_RECORD_CREATED" title="Record Created" />

  <Card href="/actionkit/integrations/pipedrive/triggers/PIPEDRIVE_TRIGGER_RECORD_UPDATED" title="Record Updated" />

  <Card href="/actionkit/integrations/pipedrive/triggers/PIPEDRIVE_TRIGGER_LEAD_CREATED" title="Lead Created" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Lead Created
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/triggers/PIPEDRIVE_TRIGGER_LEAD_CREATED

Lead Created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "pipedrive",
  "type": "PIPEDRIVE_TRIGGER_LEAD_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Record Created
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/triggers/PIPEDRIVE_TRIGGER_RECORD_CREATED

Record Created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "pipedrive",
  "type": "PIPEDRIVE_TRIGGER_RECORD_CREATED",
  "parameters": {
    "recordType": "activities",
    "triggerFilterFormula": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "field",
              "operator": "$arrayIsEmpty",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record Type

  * Allowed values: `activities`, `activities_v2`, `deals`, `deals_v2`, `organizations`, `organizations_v2`, `persons`, `persons_v2`, `notes`
  * Options can be loaded by using the `cacheObjectTypes` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="CONDITIONAL">
  Only trigger on records that match these filters.

  * Supported filter fields are loaded from `cacheObjectFields` after selecting `recordType`.
  * Supported operators: `$arrayIsEmpty`, `$arrayIsNotEmpty`, `$booleanFalse`, `$booleanTrue`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$isUndefinedOrNull`, `$isNotUndefinedOrNull`, `$exists`, `$doesNotExist`, `$numberDoesNotEqual`, `$numberEquals`, `$numberGreaterThan`, `$numberLessThan`, `$stringContains`, `$stringDoesNotContain`, `$stringDoesNotEndWith`, `$stringDoesNotExactlyMatch`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringExactlyMatches`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`
</ParamField>


# Record Updated
Source: https://docs.useparagon.com/actionkit/integrations/pipedrive/triggers/PIPEDRIVE_TRIGGER_RECORD_UPDATED

Record Updated

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "pipedrive",
  "type": "PIPEDRIVE_TRIGGER_RECORD_UPDATED",
  "parameters": {
    "recordType": "activities",
    "triggerFilterFormula": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "field",
              "operator": "$arrayIsEmpty",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record Type

  * Allowed values: `activities`, `activities_v2`, `deals`, `deals_v2`, `organizations`, `organizations_v2`, `persons`, `persons_v2`, `notes`
  * Options can be loaded by using the `cacheObjectTypes` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<ParamField type="CONDITIONAL">
  Only trigger on records that match these filters.

  * Supported filter fields are loaded from `cacheObjectFields` after selecting `recordType`.
  * Supported operators: `$arrayIsEmpty`, `$arrayIsNotEmpty`, `$booleanFalse`, `$booleanTrue`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$isUndefinedOrNull`, `$isNotUndefinedOrNull`, `$exists`, `$doesNotExist`, `$numberDoesNotEqual`, `$numberEquals`, `$numberGreaterThan`, `$numberLessThan`, `$stringContains`, `$stringDoesNotContain`, `$stringDoesNotEndWith`, `$stringDoesNotExactlyMatch`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringExactlyMatches`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`
</ParamField>


# Create Component
Source: https://docs.useparagon.com/actionkit/integrations/productboard/PRODUCTBOARD_CREATE_COMPONENT

actionkit/openapi.json POST /projects/{project_id}/tools/#PRODUCTBOARD_CREATE_COMPONENT



# Create Feature
Source: https://docs.useparagon.com/actionkit/integrations/productboard/PRODUCTBOARD_CREATE_FEATURE

actionkit/openapi.json POST /projects/{project_id}/tools/#PRODUCTBOARD_CREATE_FEATURE



# Delete Feature
Source: https://docs.useparagon.com/actionkit/integrations/productboard/PRODUCTBOARD_DELETE_FEATURE

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#PRODUCTBOARD_UPDATE_COMPONENT



# Update Feature
Source: https://docs.useparagon.com/actionkit/integrations/productboard/PRODUCTBOARD_UPDATE_FEATURE

actionkit/openapi.json POST /projects/{project_id}/tools/#PRODUCTBOARD_UPDATE_FEATURE



# Productboard
Source: https://docs.useparagon.com/actionkit/integrations/productboard/overview

Browse the tools available for Productboard in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/productboard/PRODUCTBOARD_CREATE_FEATURE" title="Create Feature" />

  <Card href="/actionkit/integrations/productboard/PRODUCTBOARD_UPDATE_FEATURE" title="Update Feature" />

  <Card href="/actionkit/integrations/productboard/PRODUCTBOARD_GET_FEATURE_BY_ID" title="Get Feature By ID" />

  <Card href="/actionkit/integrations/productboard/PRODUCTBOARD_DELETE_FEATURE" title="Delete Feature" />

  <Card href="/actionkit/integrations/productboard/PRODUCTBOARD_CREATE_COMPONENT" title="Create Component" />

  <Card href="/actionkit/integrations/productboard/PRODUCTBOARD_UPDATE_COMPONENT" title="Update Component" />

  <Card href="/actionkit/integrations/productboard/PRODUCTBOARD_GET_COMPONENT_BY_ID" title="Get Component By ID" />

  <Card href="/actionkit/integrations/productboard/PRODUCTBOARD_GET_PRODUCT_BY_ID" title="Get Product By ID" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Productboard. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Create Customer
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_CREATE_CUSTOMER

actionkit/openapi.json POST /projects/{project_id}/tools/#QUICKBOOKS_CREATE_CUSTOMER



# Create Invoice
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_CREATE_INVOICE

actionkit/openapi.json POST /projects/{project_id}/tools/#QUICKBOOKS_CREATE_INVOICE



# Create Payment
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_CREATE_PAYMENT

actionkit/openapi.json POST /projects/{project_id}/tools/#QUICKBOOKS_CREATE_PAYMENT



# Get Accounts
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_GET_ACCOUNTS

actionkit/openapi.json POST /projects/{project_id}/tools/#QUICKBOOKS_GET_ACCOUNTS



# Get Customers
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_GET_CUSTOMERS

actionkit/openapi.json POST /projects/{project_id}/tools/#QUICKBOOKS_GET_CUSTOMERS



# Get Invoices
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_GET_INVOICES

actionkit/openapi.json POST /projects/{project_id}/tools/#QUICKBOOKS_GET_INVOICES



# Get Payments
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_GET_PAYMENTS

actionkit/openapi.json POST /projects/{project_id}/tools/#QUICKBOOKS_GET_PAYMENTS



# Send Invoice
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_SEND_INVOICE

actionkit/openapi.json POST /projects/{project_id}/tools/#QUICKBOOKS_SEND_INVOICE



# Update Customer
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_UPDATE_CUSTOMER

actionkit/openapi.json POST /projects/{project_id}/tools/#QUICKBOOKS_UPDATE_CUSTOMER



# Update Invoice
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/QUICKBOOKS_UPDATE_INVOICE

actionkit/openapi.json POST /projects/{project_id}/tools/#QUICKBOOKS_UPDATE_INVOICE



# QuickBooks
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/overview

Browse the tools and triggers available for QuickBooks in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/quickbooks/QUICKBOOKS_GET_ACCOUNTS" title="Get Accounts" />

  <Card href="/actionkit/integrations/quickbooks/QUICKBOOKS_GET_CUSTOMERS" title="Get Customers" />

  <Card href="/actionkit/integrations/quickbooks/QUICKBOOKS_CREATE_CUSTOMER" title="Create Customer" />

  <Card href="/actionkit/integrations/quickbooks/QUICKBOOKS_UPDATE_CUSTOMER" title="Update Customer" />

  <Card href="/actionkit/integrations/quickbooks/QUICKBOOKS_GET_INVOICES" title="Get Invoices" />

  <Card href="/actionkit/integrations/quickbooks/QUICKBOOKS_CREATE_INVOICE" title="Create Invoice" />

  <Card href="/actionkit/integrations/quickbooks/QUICKBOOKS_UPDATE_INVOICE" title="Update Invoice" />

  <Card href="/actionkit/integrations/quickbooks/QUICKBOOKS_SEND_INVOICE" title="Send Invoice" />

  <Card href="/actionkit/integrations/quickbooks/QUICKBOOKS_GET_PAYMENTS" title="Get Payments" />

  <Card href="/actionkit/integrations/quickbooks/QUICKBOOKS_CREATE_PAYMENT" title="Create Payment" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_ACCOUNT_CREATED" title="New Account" />

  <Card href="/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_CUSTOMER_CREATED" title="New Customer" />

  <Card href="/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_CUSTOMER_UPDATED" title="Customer Updated" />

  <Card href="/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_INVOICE_CREATED" title="New Invoice" />

  <Card href="/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_INVOICE_UPDATED" title="Invoice Updated" />

  <Card href="/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_PURCHASE_CREATED" title="New Purchase" />

  <Card href="/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_PURCHASE_UPDATED" title="Updated Purchase" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Account
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_ACCOUNT_CREATED

Trigger when an account is created in QuickBooks

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "quickbooks",
  "type": "QUICKBOOKS_TRIGGER_ACCOUNT_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# New Customer
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_CUSTOMER_CREATED

Trigger when a customer is created in QuickBooks

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "quickbooks",
  "type": "QUICKBOOKS_TRIGGER_CUSTOMER_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Customer Updated
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_CUSTOMER_UPDATED

Trigger when a Customer is updated in Quickbooks

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "quickbooks",
  "type": "QUICKBOOKS_TRIGGER_CUSTOMER_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# New Invoice
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_INVOICE_CREATED

Trigger when an invoice is created in QuickBooks

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "quickbooks",
  "type": "QUICKBOOKS_TRIGGER_INVOICE_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Invoice Updated
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_INVOICE_UPDATED

Trigger when an invoice is updated in Quickbooks

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "quickbooks",
  "type": "QUICKBOOKS_TRIGGER_INVOICE_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# New Purchase
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_PURCHASE_CREATED

Trigger when a purchase is created in QuickBooks

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "quickbooks",
  "type": "QUICKBOOKS_TRIGGER_PURCHASE_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Updated Purchase
Source: https://docs.useparagon.com/actionkit/integrations/quickbooks/triggers/QUICKBOOKS_TRIGGER_PURCHASE_UPDATED

Trigger when a purchase is updated in QuickBooks

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "quickbooks",
  "type": "QUICKBOOKS_TRIGGER_PURCHASE_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Create Vendor
Source: https://docs.useparagon.com/actionkit/integrations/ramp/RAMP_CREATE_VENDOR

actionkit/openapi.json POST /projects/{project_id}/tools/#RAMP_CREATE_VENDOR



# Get Location By ID
Source: https://docs.useparagon.com/actionkit/integrations/ramp/RAMP_GET_LOCATION_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#RAMP_GET_LOCATION_BY_ID



# Get Vendor By ID
Source: https://docs.useparagon.com/actionkit/integrations/ramp/RAMP_GET_VENDOR_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#RAMP_GET_VENDOR_BY_ID



# List Locations
Source: https://docs.useparagon.com/actionkit/integrations/ramp/RAMP_LIST_LOCATIONS

actionkit/openapi.json POST /projects/{project_id}/tools/#RAMP_LIST_LOCATIONS



# List Vendors
Source: https://docs.useparagon.com/actionkit/integrations/ramp/RAMP_LIST_VENDORS

actionkit/openapi.json POST /projects/{project_id}/tools/#RAMP_LIST_VENDORS



# Update Vendor
Source: https://docs.useparagon.com/actionkit/integrations/ramp/RAMP_UPDATE_VENDOR

actionkit/openapi.json POST /projects/{project_id}/tools/#RAMP_UPDATE_VENDOR



# Ramp
Source: https://docs.useparagon.com/actionkit/integrations/ramp/overview

Browse the tools available for Ramp in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/ramp/RAMP_CREATE_VENDOR" title="Create Vendor" />

  <Card href="/actionkit/integrations/ramp/RAMP_UPDATE_VENDOR" title="Update Vendor" />

  <Card href="/actionkit/integrations/ramp/RAMP_GET_VENDOR_BY_ID" title="Get Vendor By ID" />

  <Card href="/actionkit/integrations/ramp/RAMP_LIST_VENDORS" title="List Vendors" />

  <Card href="/actionkit/integrations/ramp/RAMP_GET_LOCATION_BY_ID" title="Get Location By ID" />

  <Card href="/actionkit/integrations/ramp/RAMP_LIST_LOCATIONS" title="List Locations" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Ramp. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Create Bill
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_CREATE_BILL

actionkit/openapi.json POST /projects/{project_id}/tools/#SAGE_INTACCT_CREATE_BILL



# Create Vendor
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_CREATE_VENDOR

actionkit/openapi.json POST /projects/{project_id}/tools/#SAGE_INTACCT_CREATE_VENDOR



# Delete Bill
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_DELETE_BILL

actionkit/openapi.json POST /projects/{project_id}/tools/#SAGE_INTACCT_DELETE_BILL



# Delete Vendor
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_DELETE_VENDOR

actionkit/openapi.json POST /projects/{project_id}/tools/#SAGE_INTACCT_DELETE_VENDOR



# 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}/tools/#SAGE_INTACCT_GET_ACCOUNT_BY_ID



# 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}/tools/#SAGE_INTACCT_GET_BILLS_BY_ID



# Get Dimensions
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_GET_DIMENSIONS

actionkit/openapi.json POST /projects/{project_id}/tools/#SAGE_INTACCT_GET_DIMENSIONS



# 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}/tools/#SAGE_INTACCT_GET_PAYMENT_TERM_BY_ID



# 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}/tools/#SAGE_INTACCT_GET_VENDOR_BY_ID



# Search Accounts
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_ACCOUNTS

actionkit/openapi.json POST /projects/{project_id}/tools/#SAGE_INTACCT_SEARCH_ACCOUNTS



# Search Bills
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_BILLS

actionkit/openapi.json POST /projects/{project_id}/tools/#SAGE_INTACCT_SEARCH_BILLS



# Search Payment Terms
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_PAYMENT_TERMS

actionkit/openapi.json POST /projects/{project_id}/tools/#SAGE_INTACCT_SEARCH_PAYMENT_TERMS



# Search Vendors
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_VENDORS

actionkit/openapi.json POST /projects/{project_id}/tools/#SAGE_INTACCT_SEARCH_VENDORS



# Search Vendor Types
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_VENDOR_TYPES

actionkit/openapi.json POST /projects/{project_id}/tools/#SAGE_INTACCT_SEARCH_VENDOR_TYPES



# Update Bill
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_UPDATE_BILL

actionkit/openapi.json POST /projects/{project_id}/tools/#SAGE_INTACCT_UPDATE_BILL



# Update Vendor
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/SAGE_INTACCT_UPDATE_VENDOR

actionkit/openapi.json POST /projects/{project_id}/tools/#SAGE_INTACCT_UPDATE_VENDOR



# Sage Intacct
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/overview

Browse the tools and triggers available for Sage Intacct in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_CREATE_VENDOR" title="Create Vendor" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_UPDATE_VENDOR" title="Update Vendor" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_DELETE_VENDOR" title="Delete Vendor" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_VENDORS" title="Search Vendors" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_GET_VENDOR_BY_ID" title="Get Vendor By ID" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_VENDOR_TYPES" title="Search Vendor Types" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_CREATE_BILL" title="Create Bill" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_UPDATE_BILL" title="Update Bill" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_DELETE_BILL" title="Delete Bill" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_BILLS" title="Search Bills" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_GET_BILLS_BY_ID" title="Get Bills By ID" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_PAYMENT_TERMS" title="Search Payment Terms" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_GET_PAYMENT_TERM_BY_ID" title="Get Payment Term By ID" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_SEARCH_ACCOUNTS" title="Search Accounts" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_GET_ACCOUNT_BY_ID" title="Get Account By ID" />

  <Card href="/actionkit/integrations/sageintacct/SAGE_INTACCT_GET_DIMENSIONS" title="Get Dimensions" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/sageintacct/triggers/SAGE_INTACCT_TRIGGER_RECORD_CREATED" title="New Record" />

  <Card href="/actionkit/integrations/sageintacct/triggers/SAGE_INTACCT_TRIGGER_RECORD_UPDATED" title="Record Updated" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Record
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/triggers/SAGE_INTACCT_TRIGGER_RECORD_CREATED

Trigger when a new record is created in Sage Intacct

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "sageintacct",
  "type": "SAGE_INTACCT_TRIGGER_RECORD_CREATED",
  "parameters": {
    "recordType": "BILL"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record Type

  * Allowed values: `BILL`, `VENDOR`
</ParamField>


# Record Updated
Source: https://docs.useparagon.com/actionkit/integrations/sageintacct/triggers/SAGE_INTACCT_TRIGGER_RECORD_UPDATED

Trigger when a record is updated in Sage Intacct

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "sageintacct",
  "type": "SAGE_INTACCT_TRIGGER_RECORD_UPDATED",
  "parameters": {
    "recordType": "BILL"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record Type

  * Allowed values: `BILL`, `VENDOR`
</ParamField>


# Create Custom Field Account
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_ACCOUNT

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#SALESFORCE_CREATE_RECORD_TASK



# Delete Record Account
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_DELETE_RECORD_ACCOUNT

actionkit/openapi.json POST /projects/{project_id}/tools/#SALESFORCE_DELETE_RECORD_ACCOUNT



# Delete Record Any
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_DELETE_RECORD_ANY

actionkit/openapi.json POST /projects/{project_id}/tools/#SALESFORCE_DELETE_RECORD_ANY



# Delete Record Contact
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_DELETE_RECORD_CONTACT

actionkit/openapi.json POST /projects/{project_id}/tools/#SALESFORCE_DELETE_RECORD_CONTACT



# Delete Record Lead
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_DELETE_RECORD_LEAD

actionkit/openapi.json POST /projects/{project_id}/tools/#SALESFORCE_DELETE_RECORD_LEAD



# Delete Record Opportunity
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_DELETE_RECORD_OPPORTUNITY

actionkit/openapi.json POST /projects/{project_id}/tools/#SALESFORCE_DELETE_RECORD_OPPORTUNITY



# Delete Record Task
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_DELETE_RECORD_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#SALESFORCE_DELETE_RECORD_TASK



# Describe Action Schema
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/SALESFORCE_DESCRIBE_ACTION_SCHEMA

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#SALESFORCE_WRITE_SOQL_QUERY



# Salesforce
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/overview

Browse the tools and triggers available for Salesforce in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_RECORD_CONTACT" title="Create Record Contact" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_RECORD_LEAD" title="Create Record Lead" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_RECORD_OPPORTUNITY" title="Create Record Opportunity" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_RECORD_TASK" title="Create Record Task" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_RECORD_ACCOUNT" title="Create Record Account" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_RECORD_ANY" title="Create Record Any" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_UPDATE_RECORD_CONTACT" title="Update Record Contact" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_UPDATE_RECORD_LEAD" title="Update Record Lead" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_UPDATE_RECORD_OPPORTUNITY" title="Update Record Opportunity" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_UPDATE_RECORD_TASK" title="Update Record Task" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_UPDATE_RECORD_ACCOUNT" title="Update Record Account" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_UPDATE_RECORD_ANY" title="Update Record Any" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_DELETE_RECORD_CONTACT" title="Delete Record Contact" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_DELETE_RECORD_LEAD" title="Delete Record Lead" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_DELETE_RECORD_OPPORTUNITY" title="Delete Record Opportunity" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_DELETE_RECORD_TASK" title="Delete Record Task" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_DELETE_RECORD_ACCOUNT" title="Delete Record Account" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_DELETE_RECORD_ANY" title="Delete Record Any" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_ID_CONTACT" title="Get Record By ID Contact" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_ID_LEAD" title="Get Record By ID Lead" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_ID_OPPORTUNITY" title="Get Record By ID Opportunity" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_ID_TASK" title="Get Record By ID Task" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_ID_ACCOUNT" title="Get Record By ID Account" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_ID_ANY" title="Get Record By ID Any" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_SEARCH_RECORDS_CONTACT" title="Search Records Contact" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_SEARCH_RECORDS_LEAD" title="Search Records Lead" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_SEARCH_RECORDS_OPPORTUNITY" title="Search Records Opportunity" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_SEARCH_RECORDS_TASK" title="Search Records Task" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_SEARCH_RECORDS_ACCOUNT" title="Search Records Account" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_SEARCH_RECORDS_ANY" title="Search Records Any" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_VIEW_ID_CONTACT" title="Get Record By View ID Contact" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_VIEW_ID_LEAD" title="Get Record By View ID Lead" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_VIEW_ID_OPPORTUNITY" title="Get Record By View ID Opportunity" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_VIEW_ID_TASK" title="Get Record By View ID Task" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_VIEW_ID_ACCOUNT" title="Get Record By View ID Account" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_GET_RECORD_BY_VIEW_ID_ANY" title="Get Record By View ID Any" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_CONTACT" title="Create Custom Field Contact" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_LEAD" title="Create Custom Field Lead" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_OPPORTUNITY" title="Create Custom Field Opportunity" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_TASK" title="Create Custom Field Task" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_ACCOUNT" title="Create Custom Field Account" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_FIELD_ANY" title="Create Custom Field Any" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_WRITE_SOQL_QUERY" title="Write SOQL Query" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_CREATE_CUSTOM_OBJECT" title="Create Custom Object" />

  <Card href="/actionkit/integrations/salesforce/SALESFORCE_DESCRIBE_ACTION_SCHEMA" title="Describe Action Schema" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/salesforce/triggers/SALESFORCE_TRIGGER_RECORD_CREATED" title="New Record" />

  <Card href="/actionkit/integrations/salesforce/triggers/SALESFORCE_TRIGGER_RECORD_DELETED" title="Record Deleted" />

  <Card href="/actionkit/integrations/salesforce/triggers/SALESFORCE_TRIGGER_RECORD_UPDATED" title="Record Updated" />

  <Card href="/actionkit/integrations/salesforce/triggers/SALESFORCE_TRIGGER_CAMPAIGN_MEMBER_ADDED" title="Campaign Member Added" />

  <Card href="/actionkit/integrations/salesforce/triggers/SALESFORCE_TRIGGER_CAMPAIGN_OPPORTUNITY_ADDED" title="Campaign Opportunity Added" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Campaign Member Added
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/triggers/SALESFORCE_TRIGGER_CAMPAIGN_MEMBER_ADDED

Trigger when a contact/lead is added to a campaign

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "salesforce",
  "type": "SALESFORCE_TRIGGER_CAMPAIGN_MEMBER_ADDED",
  "parameters": {
    "campaignId": "{{settings.campaign}}",
    "filterFormula": "filter by column"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  The campaign to watch for new Campaign Members. Use Connect Portal Workflow Settings to allow users to select a campaign.

  * Example value: `{{settings.campaign}}`
</ParamField>

<ParamField type="CONDITIONAL">
  Only trigger on records that match these filters.

  * Example value: `filter by column`
  * Supported filter fields: `Id`, `LeadId`, `ContactId`, `Status`, `Type`, `Name`, `Email`
  * Supported operators: `$none`, `$stringContains`, `$stringDoesNotContain`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$numberGreaterThan`, `$numberLessThan`, `$numberEquals`, `$numberDoesNotEqual`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$booleanTrue`, `$booleanFalse`, `$exists`, `$doesNotExist`
</ParamField>


# Campaign Opportunity Added
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/triggers/SALESFORCE_TRIGGER_CAMPAIGN_OPPORTUNITY_ADDED

Trigger when an opportunity is added to a campaign

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "salesforce",
  "type": "SALESFORCE_TRIGGER_CAMPAIGN_OPPORTUNITY_ADDED",
  "parameters": {
    "campaignId": "{{settings.campaign}}",
    "filterFormula": "filter by column"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  The campaign to watch for new Campaign Members. Use Connect Portal Workflow Settings to allow users to select a campaign.

  * Example value: `{{settings.campaign}}`
</ParamField>

<ParamField type="CONDITIONAL">
  Only trigger on records that match these filters.

  * Example value: `filter by column`
  * Supported filter fields: `Id`, `Name`, `ContactId`, `StageName`, `Probability`, `Type`
  * Supported operators: `$none`, `$stringContains`, `$stringDoesNotContain`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$numberGreaterThan`, `$numberLessThan`, `$numberEquals`, `$numberDoesNotEqual`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$booleanTrue`, `$booleanFalse`, `$exists`, `$doesNotExist`
</ParamField>


# New Record
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/triggers/SALESFORCE_TRIGGER_RECORD_CREATED

Trigger when a new Salesforce record is created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "salesforce",
  "type": "SALESFORCE_TRIGGER_RECORD_CREATED",
  "parameters": {
    "recordType": "Opportunity",
    "recordsFilterFormula": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "field",
              "operator": "$stringContains",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record type

  * Allowed values: `Opportunity`, `Account`, `Contact`, `Lead`, `Task`, Custom Object (`<specified by objectName property>`)
  * Options can be loaded by using the `recordTypes` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<Accordion title="When Custom Object is selected">
  Additional options when this parameter is set to `<specified by objectName property>`.

  <ParamField type="TEXTAREA">
    The API Name of the Object. Use Connect Portal Workflow Settings to allow users to select a Custom Object.

    * Example value: `{{settings.objectType}}`
  </ParamField>
</Accordion>

<ParamField type="CONDITIONAL">
  Only trigger on new records that match these filters.

  * Supported filter fields are loaded from `cachedFields` after selecting `recordType`.
  * Supported operators: `$none`, `$stringContains`, `$stringDoesNotContain`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$numberGreaterThan`, `$numberLessThan`, `$numberEquals`, `$numberDoesNotEqual`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$booleanTrue`, `$booleanFalse`, `$exists`, `$doesNotExist`
</ParamField>


# Record Deleted
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/triggers/SALESFORCE_TRIGGER_RECORD_DELETED

Trigger when a Salesforce record is deleted

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "salesforce",
  "type": "SALESFORCE_TRIGGER_RECORD_DELETED",
  "parameters": {
    "recordType": "Opportunity",
    "recordsFilterFormula": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "field",
              "operator": "$stringContains",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record type

  * Allowed values: `Opportunity`, `Account`, `Contact`, `Lead`, `Task`, Custom Object (`<specified by objectName property>`)
  * Options can be loaded by using the `recordTypes` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<Accordion title="When Custom Object is selected">
  Additional options when this parameter is set to `<specified by objectName property>`.

  <ParamField type="TEXTAREA">
    The API Name of the Object. Use Connect Portal Workflow Settings to allow users to select a Custom Object.

    * Example value: `{{settings.objectType}}`
  </ParamField>
</Accordion>

<ParamField type="CONDITIONAL">
  Only trigger on deleted records that match these filters.

  * Supported filter fields are loaded from `cachedFields` after selecting `recordType`.
  * Supported operators: `$none`, `$stringContains`, `$stringDoesNotContain`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$numberGreaterThan`, `$numberLessThan`, `$numberEquals`, `$numberDoesNotEqual`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$booleanTrue`, `$booleanFalse`, `$exists`, `$doesNotExist`
</ParamField>


# Record Updated
Source: https://docs.useparagon.com/actionkit/integrations/salesforce/triggers/SALESFORCE_TRIGGER_RECORD_UPDATED

Trigger when a Salesforce record is updated

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "salesforce",
  "type": "SALESFORCE_TRIGGER_RECORD_UPDATED",
  "parameters": {
    "recordType": "Opportunity",
    "recordsFilterFormula": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "field",
              "operator": "$stringContains",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record type

  * Allowed values: `Opportunity`, `Account`, `Contact`, `Lead`, `Task`, Custom Object (`<specified by objectName property>`)
  * Options can be loaded by using the `recordTypes` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<Accordion title="When Custom Object is selected">
  Additional options when this parameter is set to `<specified by objectName property>`.

  <ParamField type="TEXTAREA">
    The API Name of the Object. Use Connect Portal Workflow Settings to allow users to select a Custom Object.

    * Example value: `{{settings.objectType}}`
  </ParamField>
</Accordion>

<ParamField type="CONDITIONAL">
  Only trigger on updated records that match these filters.

  * Supported filter fields are loaded from `cachedFields` after selecting `recordType`.
  * Supported operators: `$none`, `$stringContains`, `$stringDoesNotContain`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$numberGreaterThan`, `$numberLessThan`, `$numberEquals`, `$numberDoesNotEqual`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$booleanTrue`, `$booleanFalse`, `$exists`, `$doesNotExist`
</ParamField>


# Create Supplier Invoice
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_CREATE_SUPPLIER_INVOICE

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#SAP_SEARCH_CUSTOMERS



# Search Suppliers
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_SEARCH_SUPPLIERS

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#SAP_SEARCH_SUPPLIER_INVOICES



# Update Customer
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_UPDATE_CUSTOMER

actionkit/openapi.json POST /projects/{project_id}/tools/#SAP_UPDATE_CUSTOMER



# Update Supplier
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/SAP_UPDATE_SUPPLIER

actionkit/openapi.json POST /projects/{project_id}/tools/#SAP_UPDATE_SUPPLIER



# SAP S/4HANA
Source: https://docs.useparagon.com/actionkit/integrations/saps4hana/overview

Browse the tools available for SAP S/4HANA in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/saps4hana/SAP_CREATE_SUPPLIER_INVOICE" title="Create Supplier Invoice" />

  <Card href="/actionkit/integrations/saps4hana/SAP_GET_SUPPLIER_INVOICE_BY_ID" title="Get Supplier Invoice By ID" />

  <Card href="/actionkit/integrations/saps4hana/SAP_SEARCH_SUPPLIER_INVOICES" title="Search Supplier Invoices" />

  <Card href="/actionkit/integrations/saps4hana/SAP_DELETE_SUPPLIER_INVOICE" title="Delete Supplier Invoice" />

  <Card href="/actionkit/integrations/saps4hana/SAP_GET_SUPPLIER_BY_ID" title="Get Supplier By ID" />

  <Card href="/actionkit/integrations/saps4hana/SAP_SEARCH_SUPPLIERS" title="Search Suppliers" />

  <Card href="/actionkit/integrations/saps4hana/SAP_UPDATE_SUPPLIER" title="Update Supplier" />

  <Card href="/actionkit/integrations/saps4hana/SAP_GET_CUSTOMER_BY_ID" title="Get Customer By ID" />

  <Card href="/actionkit/integrations/saps4hana/SAP_SEARCH_CUSTOMERS" title="Search Customers" />

  <Card href="/actionkit/integrations/saps4hana/SAP_UPDATE_CUSTOMER" title="Update Customer" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for SAP S/4HANA. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Create Ticket
Source: https://docs.useparagon.com/actionkit/integrations/servicenow/SERVICENOW_CREATE_TICKET

actionkit/openapi.json POST /projects/{project_id}/tools/#SERVICENOW_CREATE_TICKET



# Delete Ticket
Source: https://docs.useparagon.com/actionkit/integrations/servicenow/SERVICENOW_DELETE_TICKET

actionkit/openapi.json POST /projects/{project_id}/tools/#SERVICENOW_DELETE_TICKET



# Get Tickets
Source: https://docs.useparagon.com/actionkit/integrations/servicenow/SERVICENOW_GET_TICKETS

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#SERVICENOW_GET_TICKET_BY_ID



# Search Records
Source: https://docs.useparagon.com/actionkit/integrations/servicenow/SERVICENOW_SEARCH_RECORDS

actionkit/openapi.json POST /projects/{project_id}/tools/#SERVICENOW_SEARCH_RECORDS



# Update Ticket
Source: https://docs.useparagon.com/actionkit/integrations/servicenow/SERVICENOW_UPDATE_TICKET

actionkit/openapi.json POST /projects/{project_id}/tools/#SERVICENOW_UPDATE_TICKET



# ServiceNow
Source: https://docs.useparagon.com/actionkit/integrations/servicenow/overview

Browse the tools available for ServiceNow in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/servicenow/SERVICENOW_CREATE_TICKET" title="Create Ticket" />

  <Card href="/actionkit/integrations/servicenow/SERVICENOW_UPDATE_TICKET" title="Update Ticket" />

  <Card href="/actionkit/integrations/servicenow/SERVICENOW_DELETE_TICKET" title="Delete Ticket" />

  <Card href="/actionkit/integrations/servicenow/SERVICENOW_GET_TICKETS" title="Get Tickets" />

  <Card href="/actionkit/integrations/servicenow/SERVICENOW_GET_TICKET_BY_ID" title="Get Ticket By ID" />

  <Card href="/actionkit/integrations/servicenow/SERVICENOW_SEARCH_RECORDS" title="Search Records" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for ServiceNow. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Create Item
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_CREATE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#SHAREPOINT_CREATE_ITEM



# Create List
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_CREATE_LIST

actionkit/openapi.json POST /projects/{project_id}/tools/#SHAREPOINT_CREATE_LIST



# Create List Column
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_CREATE_LIST_COLUMN

actionkit/openapi.json POST /projects/{project_id}/tools/#SHAREPOINT_CREATE_LIST_COLUMN



# Delete Item
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_DELETE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#SHAREPOINT_GET_LIST_COLUMNS



# Save File
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_SAVE_FILE

actionkit/openapi.json POST /projects/{project_id}/tools/#SHAREPOINT_SAVE_FILE



# Update Item
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/SHAREPOINT_UPDATE_ITEM

actionkit/openapi.json POST /projects/{project_id}/tools/#SHAREPOINT_UPDATE_ITEM



# SharePoint
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/overview

Browse the tools and triggers available for SharePoint in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/sharepoint/SHAREPOINT_SAVE_FILE" title="Save File" />

  <Card href="/actionkit/integrations/sharepoint/SHAREPOINT_CREATE_ITEM" title="Create Item" />

  <Card href="/actionkit/integrations/sharepoint/SHAREPOINT_UPDATE_ITEM" title="Update Item" />

  <Card href="/actionkit/integrations/sharepoint/SHAREPOINT_GET_ITEM_BY_ID" title="Get Item By ID" />

  <Card href="/actionkit/integrations/sharepoint/SHAREPOINT_GET_ITEMS_IN_A_LIST" title="Get Items In A List" />

  <Card href="/actionkit/integrations/sharepoint/SHAREPOINT_DELETE_ITEM" title="Delete Item" />

  <Card href="/actionkit/integrations/sharepoint/SHAREPOINT_CREATE_LIST" title="Create List" />

  <Card href="/actionkit/integrations/sharepoint/SHAREPOINT_GET_LIST_BY_ID" title="Get List By ID" />

  <Card href="/actionkit/integrations/sharepoint/SHAREPOINT_GET_LISTS" title="Get Lists" />

  <Card href="/actionkit/integrations/sharepoint/SHAREPOINT_GET_LIST_COLUMNS" title="Get List Columns" />

  <Card href="/actionkit/integrations/sharepoint/SHAREPOINT_CREATE_LIST_COLUMN" title="Create List Column" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/sharepoint/triggers/SHAREPOINT_TRIGGER_ITEM_CREATED" title="Item Created" />

  <Card href="/actionkit/integrations/sharepoint/triggers/SHAREPOINT_TRIGGER_ITEM_UPDATED" title="Item Updated" />

  <Card href="/actionkit/integrations/sharepoint/triggers/SHAREPOINT_TRIGGER_FILE_DELETED" title="File Deleted">
    Trigger when a File is deleted from the Documents list in SharePoint
  </Card>

  <Card href="/actionkit/integrations/sharepoint/triggers/SHAREPOINT_TRIGGER_PAGE_MODIFIED" title="Page Modified">
    Trigger when a Site Page is created or updated in SharePoint
  </Card>
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# File Deleted
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/triggers/SHAREPOINT_TRIGGER_FILE_DELETED

Trigger when a File is deleted from the Documents list in SharePoint

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "sharepoint",
  "type": "SHAREPOINT_TRIGGER_FILE_DELETED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Item Created
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/triggers/SHAREPOINT_TRIGGER_ITEM_CREATED

Trigger when an Item is created in SharePoint

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "sharepoint",
  "type": "SHAREPOINT_TRIGGER_ITEM_CREATED",
  "parameters": {
    "listId": "22e03ef3-6ef4-424d-a1d3-92a337807c30"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  The List ID of the item in Sharepoint. Use Connect Portal User Settings to allow users to select a List.

  * Example value: `22e03ef3-6ef4-424d-a1d3-92a337807c30`
</ParamField>


# Item Updated
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/triggers/SHAREPOINT_TRIGGER_ITEM_UPDATED

Trigger when an Item is updated in SharePoint

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "sharepoint",
  "type": "SHAREPOINT_TRIGGER_ITEM_UPDATED",
  "parameters": {
    "listId": "22e03ef3-6ef4-424d-a1d3-92a337807c30"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  The List ID of the item in Sharepoint. Use Connect Portal User Settings to allow users to select a List.

  * Example value: `22e03ef3-6ef4-424d-a1d3-92a337807c30`
</ParamField>


# Page Modified
Source: https://docs.useparagon.com/actionkit/integrations/sharepoint/triggers/SHAREPOINT_TRIGGER_PAGE_MODIFIED

Trigger when a Site Page is created or updated in SharePoint

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "sharepoint",
  "type": "SHAREPOINT_TRIGGER_PAGE_MODIFIED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Create Customer
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_CREATE_CUSTOMER

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_CREATE_CUSTOMER



# Create Customer GRAPHQL
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_CREATE_CUSTOMER_GRAPHQL

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_CREATE_CUSTOMER_GRAPHQL



# Create Order
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_CREATE_ORDER

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_CREATE_ORDER



# Create Order GRAPHQL
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_CREATE_ORDER_GRAPHQL

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_CREATE_ORDER_GRAPHQL



# Create Product
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_CREATE_PRODUCT

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#SHOPIFY_GET_ABANDONED_CARTS



# Get Abandoned Carts GRAPHQL
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_GET_ABANDONED_CARTS_GRAPHQL

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_GET_ABANDONED_CARTS_GRAPHQL



# Get Customers
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_GET_CUSTOMERS

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_GET_CUSTOMERS



# Get Customers GRAPHQL
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_GET_CUSTOMERS_GRAPHQL

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_GET_CUSTOMERS_GRAPHQL



# Get Orders
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_GET_ORDERS

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_GET_ORDERS



# Get Orders GRAPHQL
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_GET_ORDERS_GRAPHQL

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_GET_ORDERS_GRAPHQL



# Get Products
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_GET_PRODUCTS

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#SHOPIFY_GET_PRODUCTS_GRAPHQL



# Search Customers
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_SEARCH_CUSTOMERS

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_SEARCH_CUSTOMERS



# Update Customer
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_UPDATE_CUSTOMER

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_UPDATE_CUSTOMER



# Update Customer GRAPHQL
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_UPDATE_CUSTOMER_GRAPHQL

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_UPDATE_CUSTOMER_GRAPHQL



# Update Order
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_UPDATE_ORDER

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_UPDATE_ORDER



# Update Order GRAPHQL
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_UPDATE_ORDER_GRAPHQL

actionkit/openapi.json POST /projects/{project_id}/tools/#SHOPIFY_UPDATE_ORDER_GRAPHQL



# Update Product
Source: https://docs.useparagon.com/actionkit/integrations/shopify/SHOPIFY_UPDATE_PRODUCT

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#SHOPIFY_UPDATE_PRODUCT_GRAPHQL



# Shopify
Source: https://docs.useparagon.com/actionkit/integrations/shopify/overview

Browse the tools and triggers available for Shopify in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/shopify/SHOPIFY_GET_CUSTOMERS" title="Get Customers" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_SEARCH_CUSTOMERS" title="Search Customers" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_CREATE_CUSTOMER" title="Create Customer" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_UPDATE_CUSTOMER" title="Update Customer" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_GET_ORDERS" title="Get Orders" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_CREATE_ORDER" title="Create Order" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_UPDATE_ORDER" title="Update Order" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_GET_ABANDONED_CARTS" title="Get Abandoned Carts" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_GET_PRODUCTS" title="Get Products" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_CREATE_PRODUCT" title="Create Product" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_UPDATE_PRODUCT" title="Update Product" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_GET_PRODUCTS_GRAPHQL" title="Get Products GRAPHQL" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_CREATE_PRODUCT_GRAPHQL" title="Create Product GRAPHQL" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_UPDATE_PRODUCT_GRAPHQL" title="Update Product GRAPHQL" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_CREATE_CUSTOMER_GRAPHQL" title="Create Customer GRAPHQL" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_UPDATE_CUSTOMER_GRAPHQL" title="Update Customer GRAPHQL" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_GET_CUSTOMERS_GRAPHQL" title="Get Customers GRAPHQL" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_CREATE_ORDER_GRAPHQL" title="Create Order GRAPHQL" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_UPDATE_ORDER_GRAPHQL" title="Update Order GRAPHQL" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_GET_ORDERS_GRAPHQL" title="Get Orders GRAPHQL" />

  <Card href="/actionkit/integrations/shopify/SHOPIFY_GET_ABANDONED_CARTS_GRAPHQL" title="Get Abandoned Carts GRAPHQL" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_ORDER_CREATED_GRAPHQL" title="New Order (GraphQL)" />

  <Card href="/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_ORDER_UPDATED_GRAPHQL" title="Order Updated (GraphQL)" />

  <Card href="/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_CUSTOMER_CREATED_GRAPHQL" title="New Customer (GraphQL)" />

  <Card href="/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_CUSTOMER_UPDATED_GRAPHQL" title="Customer Updated (GraphQL)" />

  <Card href="/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_PRODUCT_CREATED_GRAPHQL" title="New Product (GraphQL)" />

  <Card href="/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_PRODUCT_UPDATED_GRAPHQL" title="Product Updated (GraphQL)" />

  <Card href="/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_CUSTOMER_DATA_REQUEST" title="Customer Data Request" />

  <Card href="/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_CUSTOMER_DATA_ERASURE_REQUEST" title="Customer Data Erasure Request">
    Trigger when a customer data erasure is requested in Shopify
  </Card>

  <Card href="/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_SHOP_DATA_ERASURE_REQUEST" title="Shop Data Erasure Request" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Customer (GraphQL)
Source: https://docs.useparagon.com/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_CUSTOMER_CREATED_GRAPHQL

Trigger when a customer is created in Shopify

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "shopify",
  "type": "SHOPIFY_TRIGGER_CUSTOMER_CREATED_GRAPHQL",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Customer Data Erasure Request
Source: https://docs.useparagon.com/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_CUSTOMER_DATA_ERASURE_REQUEST

Trigger when a customer data erasure is requested in Shopify

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "shopify",
  "type": "SHOPIFY_TRIGGER_CUSTOMER_DATA_ERASURE_REQUEST",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Customer Data Request
Source: https://docs.useparagon.com/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_CUSTOMER_DATA_REQUEST

Trigger when a customer data is requested in Shopify

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "shopify",
  "type": "SHOPIFY_TRIGGER_CUSTOMER_DATA_REQUEST",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Customer Updated (GraphQL)
Source: https://docs.useparagon.com/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_CUSTOMER_UPDATED_GRAPHQL

Trigger when a customer is updated in Shopify

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "shopify",
  "type": "SHOPIFY_TRIGGER_CUSTOMER_UPDATED_GRAPHQL",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# New Order (GraphQL)
Source: https://docs.useparagon.com/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_ORDER_CREATED_GRAPHQL

Trigger when an order is created in Shopify

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "shopify",
  "type": "SHOPIFY_TRIGGER_ORDER_CREATED_GRAPHQL",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Order Updated (GraphQL)
Source: https://docs.useparagon.com/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_ORDER_UPDATED_GRAPHQL

Trigger when an order is updated in Shopify

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "shopify",
  "type": "SHOPIFY_TRIGGER_ORDER_UPDATED_GRAPHQL",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# New Product (GraphQL)
Source: https://docs.useparagon.com/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_PRODUCT_CREATED_GRAPHQL

Trigger when a product is created in Shopify

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "shopify",
  "type": "SHOPIFY_TRIGGER_PRODUCT_CREATED_GRAPHQL",
  "parameters": {
    "status": "active"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Status

  * Allowed values: `active`, `archived`, `draft`
</ParamField>


# Product Updated (GraphQL)
Source: https://docs.useparagon.com/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_PRODUCT_UPDATED_GRAPHQL

Trigger when a product is updated in Shopify

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "shopify",
  "type": "SHOPIFY_TRIGGER_PRODUCT_UPDATED_GRAPHQL",
  "parameters": {
    "status": "active"
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Status

  * Allowed values: `active`, `archived`, `draft`
</ParamField>


# Shop Data Erasure Request
Source: https://docs.useparagon.com/actionkit/integrations/shopify/triggers/SHOPIFY_TRIGGER_SHOP_DATA_ERASURE_REQUEST

Trigger when a shop data erasure is requested in Shopify

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "shopify",
  "type": "SHOPIFY_TRIGGER_SHOP_DATA_ERASURE_REQUEST",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Create Epic
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_CREATE_EPIC

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_CREATE_EPIC



# Create Project
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_CREATE_PROJECT

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_CREATE_PROJECT



# Create Story
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_CREATE_STORY

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_CREATE_STORY



# Delete Epic
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_DELETE_EPIC

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_DELETE_EPIC



# Delete Project
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_DELETE_PROJECT

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_DELETE_PROJECT



# Delete Story
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_DELETE_STORY

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_DELETE_STORY



# Get Custom Fields
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_GET_CUSTOM_FIELDS

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_GET_CUSTOM_FIELDS



# Get Epic By ID
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_GET_EPIC_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_GET_EPIC_BY_ID



# Get Project By ID
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_GET_PROJECT_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_GET_PROJECT_BY_ID



# Get Stories By Epic
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_GET_STORIES_BY_EPIC

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_GET_STORIES_BY_EPIC



# Get Stories By Project
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_GET_STORIES_BY_PROJECT

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_GET_STORIES_BY_PROJECT



# Get Story By ID
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_GET_STORY_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_GET_STORY_BY_ID



# Search Stories
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_SEARCH_STORIES

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_SEARCH_STORIES



# Update Epic
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_UPDATE_EPIC

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_UPDATE_EPIC



# Update Project
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_UPDATE_PROJECT

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_UPDATE_PROJECT



# Update Story
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/SHORTCUT_UPDATE_STORY

actionkit/openapi.json POST /projects/{project_id}/tools/#SHORTCUT_UPDATE_STORY



# Shortcut
Source: https://docs.useparagon.com/actionkit/integrations/shortcut/overview

Browse the tools available for Shortcut in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/shortcut/SHORTCUT_CREATE_STORY" title="Create Story" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_UPDATE_STORY" title="Update Story" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_GET_STORY_BY_ID" title="Get Story By ID" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_GET_STORIES_BY_PROJECT" title="Get Stories By Project" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_GET_STORIES_BY_EPIC" title="Get Stories By Epic" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_SEARCH_STORIES" title="Search Stories" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_DELETE_STORY" title="Delete Story" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_CREATE_EPIC" title="Create Epic" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_UPDATE_EPIC" title="Update Epic" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_GET_EPIC_BY_ID" title="Get Epic By ID" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_DELETE_EPIC" title="Delete Epic" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_CREATE_PROJECT" title="Create Project" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_UPDATE_PROJECT" title="Update Project" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_GET_PROJECT_BY_ID" title="Get Project By ID" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_DELETE_PROJECT" title="Delete Project" />

  <Card href="/actionkit/integrations/shortcut/SHORTCUT_GET_CUSTOM_FIELDS" title="Get Custom Fields" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Shortcut. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Get Users By Name
Source: https://docs.useparagon.com/actionkit/integrations/slack/SLACK_GET_USERS_BY_NAME

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#SLACK_LIST_CHANNELS



# List Members
Source: https://docs.useparagon.com/actionkit/integrations/slack/SLACK_LIST_MEMBERS

actionkit/openapi.json POST /projects/{project_id}/tools/#SLACK_LIST_MEMBERS



# Search Messages
Source: https://docs.useparagon.com/actionkit/integrations/slack/SLACK_SEARCH_MESSAGES

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#SLACK_SEND_DIRECT_MESSAGE



# Send Message
Source: https://docs.useparagon.com/actionkit/integrations/slack/SLACK_SEND_MESSAGE

actionkit/openapi.json POST /projects/{project_id}/tools/#SLACK_SEND_MESSAGE



# Slack
Source: https://docs.useparagon.com/actionkit/integrations/slack/overview

Browse the tools and triggers available for Slack in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/slack/SLACK_LIST_MEMBERS" title="List Members" />

  <Card href="/actionkit/integrations/slack/SLACK_LIST_CHANNELS" title="List Channels" />

  <Card href="/actionkit/integrations/slack/SLACK_GET_USER_BY_EMAIL" title="Get User By Email" />

  <Card href="/actionkit/integrations/slack/SLACK_SEARCH_MESSAGES" title="Search Messages" />

  <Card href="/actionkit/integrations/slack/SLACK_SEND_DIRECT_MESSAGE" title="Send Direct Message" />

  <Card href="/actionkit/integrations/slack/SLACK_SEND_MESSAGE" title="Send Message" />

  <Card href="/actionkit/integrations/slack/SLACK_GET_USERS_BY_NAME" title="Get Users By Name" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_DIRECT_MESSAGE_CREATED" title="Direct Message Created" />

  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_CHANNEL_CREATED" title="Channel Created" />

  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_DIRECT_MESSAGE_POSTED" title="Direct Message Sent" />

  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_FILE_DELETED" title="File Deleted" />

  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_GROUP_MESSAGE_POSTED" title="Group Message Sent" />

  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_CHANNEL_MESSAGE_POSTED" title="Channel Message Sent" />

  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_DIRECT_MESSAGE_UPDATED" title="Direct Message Updated" />

  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_GROUP_MESSAGE_UPDATED" title="Group Message Updated" />

  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_CHANNEL_MESSAGE_UPDATED" title="Channel Message Updated" />

  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_APP_MENTIONED" title="App Mentioned">
    Trigger when your application is mentioned in a message in Slack
  </Card>

  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_NEW_REACTION" title="New Message Reaction" />

  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_REACTION_REMOVED" title="Message Reaction Removed" />

  <Card href="/actionkit/integrations/slack/triggers/SLACK_TRIGGER_MESSAGE_INTERACTION" title="Message Interaction">
    Trigger when global and message shortcuts are interacted with in Slack
  </Card>
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# App Mentioned
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_APP_MENTIONED

Trigger when your application is mentioned in a message in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_APP_MENTIONED",
  "parameters": {
    "appMentionedFilter": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "user",
              "operator": "$stringExactlyMatches",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="CONDITIONAL">
  Search for records that match specified filters.

  * Supported filter fields: `user`, `channel`
  * Supported operators: `$stringExactlyMatches`
</ParamField>

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "client_msg_id": "123123123",
  "type": "app_mention",
  "text": "Your app <@app_id> is mentioned.",
  "user": "U048S106P",
  "ts": "1360782400.498405",
  "blocks": [
    {
      "type": "rich_text",
      "block_id": "S4RPr",
      "elements": [
        {
          "type": "rich_text_section",
          "elements": [
            {
              "type": "user",
              "user_id": "U04URSJ58"
            },
            {
              "text": "mock-text",
              "type": "text"
            }
          ]
        }
      ]
    }
  ],
  "team": "TM7705V",
  "channel": "C03NFFWH13M",
  "event_context": "mock-event-context",
  "event_ts": "1360782400.498405"
}
```


# Channel Created
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_CHANNEL_CREATED

Trigger when a channel was created in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_CHANNEL_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "type": "channel_created",
  "channel": {
    "id": "C0553690LQM",
    "is_channel": true,
    "name": "test-webhook",
    "name_normalized": "test-webhook",
    "created": 1682576941,
    "creator": "U02T23UL0R1",
    "is_shared": false,
    "is_org_shared": false,
    "context_team_id": "TM7FL705V",
    "channel": "mock-channel-id",
    "channel_type": "channel",
    "event_context": "mock-event-context",
    "event_ts": "1682576941.441499",
    "subtype": "channel_join",
    "text": "<@mock-user-id> has joined the channel",
    "ts": "1682576941.441499",
    "type": "message",
    "user": "mock-user-id",
    "is_archived": false,
    "is_ext_shared": false,
    "is_frozen": false,
    "is_general": false,
    "is_group": false,
    "is_im": false,
    "is_mpim": false,
    "is_pending_ext_shared": false,
    "is_private": false,
    "parent_conversation": null,
    "pending_connected_team_ids": [],
    "pending_shared": [],
    "previous_names": [],
    "purpose": {
      "creator": "",
      "last_set": 0,
      "value": ""
    },
    "shared_team_ids": [
      "T05FCKSSGAK"
    ],
    "topic": {
      "creator": "",
      "last_set": 0,
      "value": ""
    },
    "unlinked": 0,
    "updated": 1764319818291
  },
  "event_ts": "1764319818.015000"
}
```


# Channel Message Sent
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_CHANNEL_MESSAGE_POSTED

Trigger when a channel message is posted in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_CHANNEL_MESSAGE_POSTED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "type": "message",
  "subtype": "channel_join",
  "ts": "1682576941.441499",
  "team": "mock-team-id",
  "user": "U02T23UL0R1",
  "text": "<@U02T23UL0R1> has joined the channel",
  "blocks": [
    {
      "type": "rich_text",
      "block_id": "mock-block-id",
      "elements": [
        {
          "type": "rich_text_section",
          "elements": [
            {
              "text": "mock-text",
              "type": "text"
            }
          ]
        }
      ]
    }
  ],
  "channel": "C0553690LQM",
  "event_ts": "1682576941.441499",
  "channel_type": "channel",
  "display_as_bot": false,
  "upload": false,
  "files": [],
  "client_msg_id": "mock-client-msg-id",
  "event_context": "mock-event-context"
}
```


# Channel Message Updated
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_CHANNEL_MESSAGE_UPDATED

Trigger when a channel message is updated in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_CHANNEL_MESSAGE_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "type": "message",
  "subtype": "message_changed",
  "message": {
    "client_msg_id": "df1d041e-9c4a-4a09-a5ab-dff83ea4f48b",
    "type": "message",
    "text": "mail  password",
    "user": "U02T23UL0R1",
    "team": "TM7FL705V",
    "blocks": [
      {
        "block_id": "mock-block-id",
        "elements": [
          {
            "elements": [
              {
                "text": "mock-text",
                "type": "text"
              }
            ],
            "type": "rich_text_section"
          }
        ],
        "type": "rich_text"
      }
    ],
    "files": [],
    "display_as_bot": false,
    "upload": false,
    "edited": {
      "user": "U02T23UL0R1",
      "ts": "1682408029.257029"
    },
    "ts": "1682408029.257029",
    "source_team": "TM7FL705V",
    "user_team": "TM7FL705V"
  },
  "previous_message": {
    "client_msg_id": "df1d041e-9c4a-4a09-a5ab-dff83ea4f48b",
    "type": "message",
    "text": "mail ka password",
    "display_as_bot": false,
    "user": "U02T23UL0R1",
    "ts": "1682408029.257029",
    "blocks": [
      {
        "block_id": "mock-block-id",
        "elements": [
          {
            "elements": [
              {
                "text": "mock-text",
                "type": "text"
              }
            ],
            "type": "rich_text_section"
          }
        ],
        "type": "rich_text"
      }
    ],
    "files": [],
    "upload": false,
    "team": "TM7FL705V"
  },
  "channel": "D04B4K12K4J",
  "hidden": true,
  "ts": "1682576024.000100",
  "event_ts": "1682576024.000100",
  "channel_type": "im",
  "event_context": "mock-event-context"
}
```


# Direct Message Created
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_DIRECT_MESSAGE_CREATED

Trigger when a DM was created in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_DIRECT_MESSAGE_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "type": "im_created",
  "user": "mock-user-id",
  "channel": {
    "id": "C0553690LQM",
    "user": "mock-user-id",
    "is_im": true,
    "latest": null,
    "is_open": false,
    "updated": 1764319159873,
    "is_frozen": false,
    "last_read": "0000000000.000000",
    "is_archived": false,
    "unread_count": 0,
    "is_channel": true,
    "name": "test-webhook",
    "name_normalized": "test-webhook",
    "created": 1682576941,
    "creator": "U02T23UL0R1",
    "is_shared": false,
    "is_org_shared": false,
    "context_team_id": "TM7FL705V",
    "unread_count_display": 0
  },
  "event_ts": "1682576941.441499"
}
```


# Direct Message Sent
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_DIRECT_MESSAGE_POSTED

Trigger when a message is posted in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_DIRECT_MESSAGE_POSTED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "ts": "1760013930.211109",
  "team": "mock-team-id",
  "text": "mock-text",
  "type": "message",
  "user": "mock-user-id",
  "blocks": [
    {
      "type": "rich_text",
      "block_id": "mock-block-id",
      "elements": [
        {
          "type": "rich_text_section",
          "elements": [
            {
              "text": "mock-text",
              "type": "text"
            }
          ]
        }
      ]
    }
  ],
  "channel": "mock-channel-id",
  "event_ts": "1760013930.211109",
  "channel_type": "im",
  "client_msg_id": "mock-client-msg-id",
  "event_context": "mock-event-context"
}
```


# Direct Message Updated
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_DIRECT_MESSAGE_UPDATED

Trigger when a direct message is updated in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_DIRECT_MESSAGE_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "type": "message",
  "subtype": "message_changed",
  "message": {
    "client_msg_id": "df1d041e-9c4a-4a09-a5ab-dff83ea4f48b",
    "type": "message",
    "text": "mail  password",
    "user": "U02T23UL0R1",
    "team": "TM7FL705V",
    "blocks": [
      {
        "block_id": "mock-block-id",
        "elements": [
          {
            "elements": [
              {
                "text": "mock-text",
                "type": "text"
              }
            ],
            "type": "rich_text_section"
          }
        ],
        "type": "rich_text"
      }
    ],
    "files": [],
    "display_as_bot": false,
    "upload": false,
    "edited": {
      "user": "U02T23UL0R1",
      "ts": "1682408029.257029"
    },
    "ts": "1682408029.257029",
    "source_team": "TM7FL705V",
    "user_team": "TM7FL705V"
  },
  "previous_message": {
    "client_msg_id": "df1d041e-9c4a-4a09-a5ab-dff83ea4f48b",
    "type": "message",
    "text": "mail ka password",
    "display_as_bot": false,
    "user": "U02T23UL0R1",
    "ts": "1682408029.257029",
    "blocks": [
      {
        "block_id": "mock-block-id",
        "elements": [
          {
            "elements": [
              {
                "text": "mock-text",
                "type": "text"
              }
            ],
            "type": "rich_text_section"
          }
        ],
        "type": "rich_text"
      }
    ],
    "files": [],
    "upload": false,
    "team": "TM7FL705V"
  },
  "channel": "D04B4K12K4J",
  "hidden": true,
  "ts": "1682576024.000100",
  "event_ts": "1682576024.000100",
  "channel_type": "im",
  "event_context": "mock-event-context"
}
```


# File Deleted
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_FILE_DELETED

Trigger when a file is deleted in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_FILE_DELETED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "type": "file_deleted",
  "file_id": "F05L9MF5DTQ",
  "channel_ids": [
    "C05LVIR6PP"
  ],
  "event_ts": "1360782804.08312123"
}
```


# Group Message Sent
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_GROUP_MESSAGE_POSTED

Trigger when a group message is posted in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_GROUP_MESSAGE_POSTED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "type": "message",
  "client_msg_id": "mock-client-msg-id",
  "event_context": "mock-event-context",
  "team": "T05FCKSSGAK",
  "blocks": [
    {
      "block_id": "mock-block-id",
      "elements": [
        {
          "elements": [
            {
              "text": "mock-text",
              "type": "text"
            }
          ],
          "type": "rich_text_section"
        }
      ],
      "type": "rich_text"
    }
  ],
  "ts": "1682576941.441499",
  "user": "U02T23UL0R1",
  "text": "<@U02T23UL0R1> has joined the channel",
  "channel": "C0553690LQM",
  "event_ts": "1682576941.441499",
  "channel_type": "mpim"
}
```


# Group Message Updated
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_GROUP_MESSAGE_UPDATED

Trigger when a group message is updated in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_GROUP_MESSAGE_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "type": "message",
  "subtype": "message_changed",
  "message": {
    "client_msg_id": "df1d041e-9c4a-4a09-a5ab-dff83ea4f48b",
    "type": "message",
    "text": "mail  password",
    "user": "U02T23UL0R1",
    "team": "TM7FL705V",
    "blocks": [
      {
        "block_id": "mock-block-id",
        "elements": [
          {
            "elements": [
              {
                "text": "mock-text",
                "type": "text"
              }
            ],
            "type": "rich_text_section"
          }
        ],
        "type": "rich_text"
      }
    ],
    "files": [],
    "display_as_bot": false,
    "upload": false,
    "edited": {
      "user": "U02T23UL0R1",
      "ts": "1682408029.257029"
    },
    "ts": "1682408029.257029",
    "source_team": "TM7FL705V",
    "user_team": "TM7FL705V"
  },
  "previous_message": {
    "client_msg_id": "df1d041e-9c4a-4a09-a5ab-dff83ea4f48b",
    "type": "message",
    "text": "mail ka password",
    "display_as_bot": false,
    "user": "U02T23UL0R1",
    "ts": "1682408029.257029",
    "blocks": [
      {
        "block_id": "mock-block-id",
        "elements": [
          {
            "elements": [
              {
                "text": "mock-text",
                "type": "text"
              }
            ],
            "type": "rich_text_section"
          }
        ],
        "type": "rich_text"
      }
    ],
    "files": [],
    "upload": false,
    "team": "TM7FL705V"
  },
  "channel": "D04B4K12K4J",
  "hidden": true,
  "ts": "1682576024.000100",
  "event_ts": "1682576024.000100",
  "channel_type": "im",
  "event_context": "mock-event-context"
}
```


# Message Interaction
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_MESSAGE_INTERACTION

Trigger when global and message shortcuts are interacted with in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_MESSAGE_INTERACTION",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "type": "block_actions",
  "user": {
    "id": "U05FHR8WY94",
    "username": "mock",
    "name": "mock",
    "team_id": "T05FCDEOGAK"
  },
  "api_app_id": "F5JFQPAQS5B",
  "token": "L7IX6dGhLCZnYlRkjHJE6FE4",
  "container": {
    "type": "message",
    "message_ts": "1702463410.208979",
    "channel_id": "C069FDS4JWV",
    "is_ephemeral": false
  },
  "trigger_id": "5522672900359.6335258913941.9a930ce254ab481dcf90c6ad200e636f",
  "team": {
    "id": "T05FCDEOGAK",
    "domain": "mock"
  },
  "enterprise": null,
  "is_enterprise_install": false,
  "channel": {
    "id": "C069FDS4JWV",
    "name": "privategroup"
  },
  "message": {
    "bot_id": "EFCOGT05DAK",
    "type": "message",
    "text": "bro",
    "app_id": "AQPS5BQA05F",
    "team": "T05FCDEOGAK",
    "blocks": [
      {
        "text": {
          "text": "New request",
          "type": "plain_text",
          "emoji": true
        },
        "type": "header",
        "block_id": "QZRVZ"
      },
      {
        "type": "section",
        "fields": [
          {
            "text": "*When:*\nAug 10 - Aug 13",
            "type": "mrkdwn",
            "verbatim": false
          }
        ],
        "block_id": "zcsYJ"
      },
      {
        "type": "actions",
        "block_id": "bBxhy",
        "elements": [
          {
            "text": {
              "text": "Approve",
              "type": "plain_text",
              "emoji": true
            },
            "type": "button",
            "style": "primary",
            "value": "click_me_123",
            "action_id": "uSoeH"
          }
        ]
      }
    ],
    "ts": "1759934456.031349",
    "user": "U05FD5S2023"
  },
  "state": {
    "values": {}
  },
  "response_url": "https://hooks.slack.com/actions/T05FCDEOGAK/6335263953942/xKHT0IcAFsOLYl0HTf3LkU4S",
  "actions": [
    {
      "action_id": "Yg6CW",
      "block_id": "bBxhy",
      "text": {
        "type": "plain_text",
        "text": "Reject",
        "emoji": true
      },
      "value": "click_me_123",
      "style": "danger",
      "type": "button",
      "action_ts": "1702463475.096267"
    }
  ]
}
```


# New Message Reaction
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_NEW_REACTION

Trigger when a reaction was added to an message in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_NEW_REACTION",
  "parameters": {
    "reactionFilter": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "item_user",
              "operator": "$stringExactlyMatches",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="CONDITIONAL">
  Search for reactions that match specified filters.

  * Supported filter fields: `item_user`, `user`, `channel`
  * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`
</ParamField>

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "type": "reaction_added",
  "user": "U123ABC456",
  "reaction": "thumbsup",
  "item_user": "U222222222",
  "item": {
    "type": "message",
    "channel": "C123ABC456",
    "ts": "1360782400.498405"
  },
  "event_ts": "1360782804.083113",
  "event_context": "mock-event-context"
}
```


# Message Reaction Removed
Source: https://docs.useparagon.com/actionkit/integrations/slack/triggers/SLACK_TRIGGER_REACTION_REMOVED

Trigger when a reaction is removed from an message in Slack

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "slack",
  "type": "SLACK_TRIGGER_REACTION_REMOVED",
  "parameters": {
    "reactionFilter": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "item_user",
              "operator": "$stringExactlyMatches",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="CONDITIONAL">
  Search for reactions that match specified filters.

  * Supported filter fields: `item_user`, `user`, `channel`
  * Supported operators: `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`
</ParamField>

## Example Payload

This is an example payload that Paragon sends to your configured webhook URL. Learn more about handling trigger payloads in [Receiving Webhooks](/actionkit/triggers/receiving-webhooks).

```json Example expandable theme={null}
{
  "type": "reaction_removed",
  "user": "U123ABC456",
  "reaction": "thumbsup",
  "item_user": "U222222222",
  "item": {
    "type": "message",
    "channel": "C123ABC456",
    "ts": "1360782400.498405"
  },
  "event_ts": "1360782804.083113",
  "event_context": "mock-event-context"
}
```


# Create Customer
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_CREATE_CUSTOMER

actionkit/openapi.json POST /projects/{project_id}/tools/#STRIPE_CREATE_CUSTOMER



# Create Product
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_CREATE_PRODUCT

actionkit/openapi.json POST /projects/{project_id}/tools/#STRIPE_CREATE_PRODUCT



# Create Subscription
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_CREATE_SUBSCRIPTION

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#STRIPE_GET_BALANCE_TRANSACTIONS



# Get Customers
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_GET_CUSTOMERS

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#STRIPE_GET_PLANS



# Get Products
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_GET_PRODUCTS

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#STRIPE_GET_SUBSCRIPTIONS



# Update Customer
Source: https://docs.useparagon.com/actionkit/integrations/stripe/STRIPE_UPDATE_CUSTOMER

actionkit/openapi.json POST /projects/{project_id}/tools/#STRIPE_UPDATE_CUSTOMER



# Stripe
Source: https://docs.useparagon.com/actionkit/integrations/stripe/overview

Browse the tools available for Stripe in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/stripe/STRIPE_CREATE_CUSTOMER" title="Create Customer" />

  <Card href="/actionkit/integrations/stripe/STRIPE_GET_CUSTOMER_BY_ID" title="Get Customer By ID" />

  <Card href="/actionkit/integrations/stripe/STRIPE_GET_CUSTOMERS" title="Get Customers" />

  <Card href="/actionkit/integrations/stripe/STRIPE_CREATE_SUBSCRIPTION" title="Create Subscription" />

  <Card href="/actionkit/integrations/stripe/STRIPE_GET_SUBSCRIPTIONS" title="Get Subscriptions" />

  <Card href="/actionkit/integrations/stripe/STRIPE_UPDATE_CUSTOMER" title="Update Customer" />

  <Card href="/actionkit/integrations/stripe/STRIPE_CREATE_PRODUCT" title="Create Product" />

  <Card href="/actionkit/integrations/stripe/STRIPE_GET_PRODUCT_BY_ID" title="Get Product By ID" />

  <Card href="/actionkit/integrations/stripe/STRIPE_GET_BALANCE_TRANSACTIONS" title="Get Balance Transactions" />

  <Card href="/actionkit/integrations/stripe/STRIPE_GET_PLANS" title="Get Plans" />

  <Card href="/actionkit/integrations/stripe/STRIPE_GET_PRODUCTS" title="Get Products" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Stripe. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Close Task
Source: https://docs.useparagon.com/actionkit/integrations/todoist/TODOIST_CLOSE_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#TODOIST_CLOSE_TASK



# Create Project
Source: https://docs.useparagon.com/actionkit/integrations/todoist/TODOIST_CREATE_PROJECT

actionkit/openapi.json POST /projects/{project_id}/tools/#TODOIST_CREATE_PROJECT



# Create Task
Source: https://docs.useparagon.com/actionkit/integrations/todoist/TODOIST_CREATE_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#TODOIST_CREATE_TASK



# Delete Project
Source: https://docs.useparagon.com/actionkit/integrations/todoist/TODOIST_DELETE_PROJECT

actionkit/openapi.json POST /projects/{project_id}/tools/#TODOIST_DELETE_PROJECT



# Delete Task
Source: https://docs.useparagon.com/actionkit/integrations/todoist/TODOIST_DELETE_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#TODOIST_DELETE_TASK



# Get All Projects
Source: https://docs.useparagon.com/actionkit/integrations/todoist/TODOIST_GET_ALL_PROJECTS

actionkit/openapi.json POST /projects/{project_id}/tools/#TODOIST_GET_ALL_PROJECTS



# Get Project By ID
Source: https://docs.useparagon.com/actionkit/integrations/todoist/TODOIST_GET_PROJECT_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#TODOIST_GET_PROJECT_BY_ID



# Get Task By ID
Source: https://docs.useparagon.com/actionkit/integrations/todoist/TODOIST_GET_TASK_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#TODOIST_GET_TASK_BY_ID



# Search Tasks
Source: https://docs.useparagon.com/actionkit/integrations/todoist/TODOIST_SEARCH_TASKS

actionkit/openapi.json POST /projects/{project_id}/tools/#TODOIST_SEARCH_TASKS



# Update Project
Source: https://docs.useparagon.com/actionkit/integrations/todoist/TODOIST_UPDATE_PROJECT

actionkit/openapi.json POST /projects/{project_id}/tools/#TODOIST_UPDATE_PROJECT



# Update Task
Source: https://docs.useparagon.com/actionkit/integrations/todoist/TODOIST_UPDATE_TASK

actionkit/openapi.json POST /projects/{project_id}/tools/#TODOIST_UPDATE_TASK



# Todoist
Source: https://docs.useparagon.com/actionkit/integrations/todoist/overview

Browse the tools available for Todoist in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/todoist/TODOIST_CREATE_PROJECT" title="Create Project" />

  <Card href="/actionkit/integrations/todoist/TODOIST_UPDATE_PROJECT" title="Update Project" />

  <Card href="/actionkit/integrations/todoist/TODOIST_GET_PROJECT_BY_ID" title="Get Project By ID" />

  <Card href="/actionkit/integrations/todoist/TODOIST_GET_ALL_PROJECTS" title="Get All Projects" />

  <Card href="/actionkit/integrations/todoist/TODOIST_DELETE_PROJECT" title="Delete Project" />

  <Card href="/actionkit/integrations/todoist/TODOIST_CREATE_TASK" title="Create Task" />

  <Card href="/actionkit/integrations/todoist/TODOIST_UPDATE_TASK" title="Update Task" />

  <Card href="/actionkit/integrations/todoist/TODOIST_GET_TASK_BY_ID" title="Get Task By ID" />

  <Card href="/actionkit/integrations/todoist/TODOIST_SEARCH_TASKS" title="Search Tasks" />

  <Card href="/actionkit/integrations/todoist/TODOIST_CLOSE_TASK" title="Close Task" />

  <Card href="/actionkit/integrations/todoist/TODOIST_DELETE_TASK" title="Delete Task" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Todoist. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Create Card
Source: https://docs.useparagon.com/actionkit/integrations/trello/TRELLO_CREATE_CARD

actionkit/openapi.json POST /projects/{project_id}/tools/#TRELLO_CREATE_CARD



# Delete Card
Source: https://docs.useparagon.com/actionkit/integrations/trello/TRELLO_DELETE_CARD

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#TRELLO_SEARCH_BOARDS



# Search Cards
Source: https://docs.useparagon.com/actionkit/integrations/trello/TRELLO_SEARCH_CARDS

actionkit/openapi.json POST /projects/{project_id}/tools/#TRELLO_SEARCH_CARDS



# Update Card
Source: https://docs.useparagon.com/actionkit/integrations/trello/TRELLO_UPDATE_CARD

actionkit/openapi.json POST /projects/{project_id}/tools/#TRELLO_UPDATE_CARD



# Trello
Source: https://docs.useparagon.com/actionkit/integrations/trello/overview

Browse the tools and triggers available for Trello in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/trello/TRELLO_CREATE_CARD" title="Create Card" />

  <Card href="/actionkit/integrations/trello/TRELLO_UPDATE_CARD" title="Update Card" />

  <Card href="/actionkit/integrations/trello/TRELLO_GET_CARDS_IN_BOARD" title="Get Cards In Board" />

  <Card href="/actionkit/integrations/trello/TRELLO_DELETE_CARD" title="Delete Card" />

  <Card href="/actionkit/integrations/trello/TRELLO_SEARCH_CARDS" title="Search Cards" />

  <Card href="/actionkit/integrations/trello/TRELLO_GET_LISTS_IN_BOARD" title="Get Lists In Board" />

  <Card href="/actionkit/integrations/trello/TRELLO_SEARCH_BOARDS" title="Search Boards" />

  <Card href="/actionkit/integrations/trello/TRELLO_GET_BOARDS_MEMBER_BELONG_TO" title="Get Boards Member Belong To" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/trello/triggers/TRELLO_TRIGGER_BOARD_CREATED" title="Board Created" />

  <Card href="/actionkit/integrations/trello/triggers/TRELLO_TRIGGER_BOARD_UPDATED" title="Board Updated" />

  <Card href="/actionkit/integrations/trello/triggers/TRELLO_TRIGGER_CARD_CREATED" title="Card Created" />

  <Card href="/actionkit/integrations/trello/triggers/TRELLO_TRIGGER_CARD_UPDATED" title="Card Updated" />

  <Card href="/actionkit/integrations/trello/triggers/TRELLO_TRIGGER_COMMENT_CREATED" title="Comment Created" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# Board Created
Source: https://docs.useparagon.com/actionkit/integrations/trello/triggers/TRELLO_TRIGGER_BOARD_CREATED

Trigger when a new Trello board is created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "trello",
  "type": "TRELLO_TRIGGER_BOARD_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Board Updated
Source: https://docs.useparagon.com/actionkit/integrations/trello/triggers/TRELLO_TRIGGER_BOARD_UPDATED

Trigger when a Trello board is updated

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "trello",
  "type": "TRELLO_TRIGGER_BOARD_UPDATED",
  "parameters": {
    "boardId": "{{settings.board}}"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Select a Board to watch its updates. Use Connect Portal Workflow Settings to allow users to select a Trello Board.

  * Example value: `{{settings.board}}`
</ParamField>


# Card Created
Source: https://docs.useparagon.com/actionkit/integrations/trello/triggers/TRELLO_TRIGGER_CARD_CREATED

Trigger when a new Trello card is created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "trello",
  "type": "TRELLO_TRIGGER_CARD_CREATED",
  "parameters": {
    "boardId": "{{settings.board}}"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Select a Board to watch for new cards. Use Connect Portal Workflow Settings to allow users to select a Trello Board.

  * Example value: `{{settings.board}}`
</ParamField>


# Card Updated
Source: https://docs.useparagon.com/actionkit/integrations/trello/triggers/TRELLO_TRIGGER_CARD_UPDATED

Trigger when a Trello card is updated

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "trello",
  "type": "TRELLO_TRIGGER_CARD_UPDATED",
  "parameters": {
    "boardId": "{{settings.board}}"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Select a Board to watch for updated cards. Use Connect Portal Workflow Settings to allow users to select a Trello Board.

  * Example value: `{{settings.board}}`
</ParamField>


# Comment Created
Source: https://docs.useparagon.com/actionkit/integrations/trello/triggers/TRELLO_TRIGGER_COMMENT_CREATED

Trigger when a new Trello card commment is created

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "trello",
  "type": "TRELLO_TRIGGER_COMMENT_CREATED",
  "parameters": {
    "boardId": "{{settings.board}}"
  }
}
```

**Configuration options:**

<ParamField type="TEXTAREA">
  Select a Board to watch for card comments. Use Connect Portal Workflow Settings to allow users to select a Trello Board.

  * Example value: `{{settings.board}}`
</ParamField>


# Create Customer
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_CREATE_CUSTOMER

actionkit/openapi.json POST /projects/{project_id}/tools/#XERO_CREATE_CUSTOMER



# Create Invoice
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_CREATE_INVOICE

actionkit/openapi.json POST /projects/{project_id}/tools/#XERO_CREATE_INVOICE



# Create Payment
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_CREATE_PAYMENT

actionkit/openapi.json POST /projects/{project_id}/tools/#XERO_CREATE_PAYMENT



# Get Accounts
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_GET_ACCOUNTS

actionkit/openapi.json POST /projects/{project_id}/tools/#XERO_GET_ACCOUNTS



# Get Contacts
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_GET_CONTACTS

actionkit/openapi.json POST /projects/{project_id}/tools/#XERO_GET_CONTACTS



# Get Invoices
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_GET_INVOICES

actionkit/openapi.json POST /projects/{project_id}/tools/#XERO_GET_INVOICES



# Get Payments
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_GET_PAYMENTS

actionkit/openapi.json POST /projects/{project_id}/tools/#XERO_GET_PAYMENTS



# Send Invoice
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_SEND_INVOICE

actionkit/openapi.json POST /projects/{project_id}/tools/#XERO_SEND_INVOICE



# Update Customer
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_UPDATE_CUSTOMER

actionkit/openapi.json POST /projects/{project_id}/tools/#XERO_UPDATE_CUSTOMER



# Update Invoice
Source: https://docs.useparagon.com/actionkit/integrations/xero/XERO_UPDATE_INVOICE

actionkit/openapi.json POST /projects/{project_id}/tools/#XERO_UPDATE_INVOICE



# Xero
Source: https://docs.useparagon.com/actionkit/integrations/xero/overview

Browse the tools available for Xero in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/xero/XERO_GET_ACCOUNTS" title="Get Accounts" />

  <Card href="/actionkit/integrations/xero/XERO_GET_CONTACTS" title="Get Contacts" />

  <Card href="/actionkit/integrations/xero/XERO_CREATE_CUSTOMER" title="Create Customer" />

  <Card href="/actionkit/integrations/xero/XERO_UPDATE_CUSTOMER" title="Update Customer" />

  <Card href="/actionkit/integrations/xero/XERO_GET_INVOICES" title="Get Invoices" />

  <Card href="/actionkit/integrations/xero/XERO_CREATE_INVOICE" title="Create Invoice" />

  <Card href="/actionkit/integrations/xero/XERO_UPDATE_INVOICE" title="Update Invoice" />

  <Card href="/actionkit/integrations/xero/XERO_SEND_INVOICE" title="Send Invoice" />

  <Card href="/actionkit/integrations/xero/XERO_GET_PAYMENTS" title="Get Payments" />

  <Card href="/actionkit/integrations/xero/XERO_CREATE_PAYMENT" title="Create Payment" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Xero. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Add Comment To Ticket
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_ADD_COMMENT_TO_TICKET

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#ZENDESK_CREATE_TICKET



# Create User
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_CREATE_USER

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_CREATE_USER



# Delete Ticket
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_DELETE_TICKET

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_DELETE_TICKET



# Delete User
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_DELETE_USER

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_DELETE_USER



# Get Ticket Audits
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_GET_TICKET_AUDITS

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#ZENDESK_GET_TICKET_BY_ID



# Get Ticket Comments
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_GET_TICKET_COMMENTS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_GET_TICKET_COMMENTS



# Get Ticket Fields
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_GET_TICKET_FIELDS

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#ZENDESK_SEARCH_TICKETS



# Search Users
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_SEARCH_USERS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SEARCH_USERS



# Update Ticket
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_UPDATE_TICKET

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_UPDATE_TICKET



# Update User
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/ZENDESK_UPDATE_USER

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_UPDATE_USER



# Zendesk
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/overview

Browse the tools and triggers available for Zendesk in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/zendesk/ZENDESK_CREATE_TICKET" title="Create Ticket" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_UPDATE_TICKET" title="Update Ticket" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_DELETE_TICKET" title="Delete Ticket" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_ADD_COMMENT_TO_TICKET" title="Add Comment To Ticket" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_SEARCH_TICKETS" title="Search Tickets" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_GET_TICKET_BY_ID" title="Get Ticket By ID" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_CREATE_USER" title="Create User" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_UPDATE_USER" title="Update User" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_DELETE_USER" title="Delete User" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_SEARCH_USERS" title="Search Users" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_GET_USER_BY_ID" title="Get User By ID" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_GET_TICKET_FIELDS" title="Get Ticket Fields" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_GET_TICKET_AUDITS" title="Get Ticket Audits" />

  <Card href="/actionkit/integrations/zendesk/ZENDESK_GET_TICKET_COMMENTS" title="Get Ticket Comments" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/zendesk/triggers/ZENDESK_TRIGGER_TICKET_CREATED" title="New Ticket" />

  <Card href="/actionkit/integrations/zendesk/triggers/ZENDESK_TRIGGER_TICKET_UPDATED" title="Ticket Updated" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Ticket
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/triggers/ZENDESK_TRIGGER_TICKET_CREATED

New Ticket

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zendesk",
  "type": "ZENDESK_TRIGGER_TICKET_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Ticket Updated
Source: https://docs.useparagon.com/actionkit/integrations/zendesk/triggers/ZENDESK_TRIGGER_TICKET_UPDATED

Ticket Updated

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zendesk",
  "type": "ZENDESK_TRIGGER_TICKET_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Create Record Contacts
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_CREATE_RECORD_CONTACTS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_CREATE_RECORD_CONTACTS



# Create Record Deals
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_CREATE_RECORD_DEALS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_CREATE_RECORD_DEALS



# Create Record Leads
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_CREATE_RECORD_LEADS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_CREATE_RECORD_LEADS



# Create Record Tasks
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_CREATE_RECORD_TASKS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_CREATE_RECORD_TASKS



# Delete Record
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_DELETE_RECORD

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_DELETE_RECORD



# Get Custom Fields
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_GET_CUSTOM_FIELDS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_GET_CUSTOM_FIELDS



# Get Record By ID
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_GET_RECORD_BY_ID

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_GET_RECORD_BY_ID



# Search Records Contacts
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_SEARCH_RECORDS_CONTACTS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_SEARCH_RECORDS_CONTACTS



# Search Records Deals
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_SEARCH_RECORDS_DEALS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_SEARCH_RECORDS_DEALS



# Search Records Leads
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_SEARCH_RECORDS_LEADS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_SEARCH_RECORDS_LEADS



# Search Records Tasks
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_SEARCH_RECORDS_TASKS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_SEARCH_RECORDS_TASKS



# Update Record Contacts
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_UPDATE_RECORD_CONTACTS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_UPDATE_RECORD_CONTACTS



# Update Record Deals
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_UPDATE_RECORD_DEALS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_UPDATE_RECORD_DEALS



# Update Record Leads
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_UPDATE_RECORD_LEADS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_UPDATE_RECORD_LEADS



# Update Record Tasks
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/ZENDESK_SELL_UPDATE_RECORD_TASKS

actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SELL_UPDATE_RECORD_TASKS



# Zendesk Sell
Source: https://docs.useparagon.com/actionkit/integrations/zendesksell/overview

Browse the tools available for Zendesk Sell in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_CREATE_RECORD_CONTACTS" title="Create Record Contacts" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_CREATE_RECORD_DEALS" title="Create Record Deals" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_CREATE_RECORD_LEADS" title="Create Record Leads" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_CREATE_RECORD_TASKS" title="Create Record Tasks" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_UPDATE_RECORD_TASKS" title="Update Record Tasks" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_UPDATE_RECORD_DEALS" title="Update Record Deals" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_UPDATE_RECORD_LEADS" title="Update Record Leads" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_UPDATE_RECORD_CONTACTS" title="Update Record Contacts" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_SEARCH_RECORDS_TASKS" title="Search Records Tasks" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_SEARCH_RECORDS_DEALS" title="Search Records Deals" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_SEARCH_RECORDS_LEADS" title="Search Records Leads" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_SEARCH_RECORDS_CONTACTS" title="Search Records Contacts" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_DELETE_RECORD" title="Delete Record" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_GET_RECORD_BY_ID" title="Get Record By ID" />

  <Card href="/actionkit/integrations/zendesksell/ZENDESK_SELL_GET_CUSTOM_FIELDS" title="Get Custom Fields" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

No prebuilt ActionKit triggers are currently available for Zendesk Sell. You can define your own using [Custom Webhooks](/resources/custom-webhooks).


# Create Record Any
Source: https://docs.useparagon.com/actionkit/integrations/zohocrm/ZOHO_CRM_CREATE_RECORD_ANY

actionkit/openapi.json POST /projects/{project_id}/tools/#ZOHO_CRM_CREATE_RECORD_ANY



# Delete Record Any
Source: https://docs.useparagon.com/actionkit/integrations/zohocrm/ZOHO_CRM_DELETE_RECORD_ANY

actionkit/openapi.json POST /projects/{project_id}/tools/#ZOHO_CRM_DELETE_RECORD_ANY



# Describe Action Schema
Source: https://docs.useparagon.com/actionkit/integrations/zohocrm/ZOHO_CRM_DESCRIBE_ACTION_SCHEMA

actionkit/openapi.json POST /projects/{project_id}/tools/#ZOHO_CRM_DESCRIBE_ACTION_SCHEMA



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

actionkit/openapi.json POST /projects/{project_id}/tools/#ZOHO_CRM_GET_RECORD_BY_ID_ANY



# Search Records Any
Source: https://docs.useparagon.com/actionkit/integrations/zohocrm/ZOHO_CRM_SEARCH_RECORDS_ANY

actionkit/openapi.json POST /projects/{project_id}/tools/#ZOHO_CRM_SEARCH_RECORDS_ANY



# Update Record Any
Source: https://docs.useparagon.com/actionkit/integrations/zohocrm/ZOHO_CRM_UPDATE_RECORD_ANY

actionkit/openapi.json POST /projects/{project_id}/tools/#ZOHO_CRM_UPDATE_RECORD_ANY



# Write COQL Query
Source: https://docs.useparagon.com/actionkit/integrations/zohocrm/ZOHO_CRM_WRITE_COQL_QUERY

actionkit/openapi.json POST /projects/{project_id}/tools/#ZOHO_CRM_WRITE_COQL_QUERY



# Zoho CRM
Source: https://docs.useparagon.com/actionkit/integrations/zohocrm/overview

Browse the tools and triggers available for Zoho CRM in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/zohocrm/ZOHO_CRM_CREATE_RECORD_ANY" title="Create Record Any" />

  <Card href="/actionkit/integrations/zohocrm/ZOHO_CRM_UPDATE_RECORD_ANY" title="Update Record Any" />

  <Card href="/actionkit/integrations/zohocrm/ZOHO_CRM_GET_RECORD_BY_ID_ANY" title="Get Record By ID Any" />

  <Card href="/actionkit/integrations/zohocrm/ZOHO_CRM_SEARCH_RECORDS_ANY" title="Search Records Any" />

  <Card href="/actionkit/integrations/zohocrm/ZOHO_CRM_DELETE_RECORD_ANY" title="Delete Record Any" />

  <Card href="/actionkit/integrations/zohocrm/ZOHO_CRM_WRITE_COQL_QUERY" title="Write COQL Query" />

  <Card href="/actionkit/integrations/zohocrm/ZOHO_CRM_DESCRIBE_ACTION_SCHEMA" title="Describe Action Schema" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/zohocrm/triggers/ZOHO_CRM_TRIGGER_RECORD_CREATED" title="New Record" />

  <Card href="/actionkit/integrations/zohocrm/triggers/ZOHO_CRM_TRIGGER_RECORD_UPDATED" title="Record Updated" />
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Record
Source: https://docs.useparagon.com/actionkit/integrations/zohocrm/triggers/ZOHO_CRM_TRIGGER_RECORD_CREATED

Trigger when a new Zoho CRM record is created.

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zohocrm",
  "type": "ZOHO_CRM_TRIGGER_RECORD_CREATED",
  "parameters": {
    "recordType": "Accounts",
    "recordsFilterFormula": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "id",
              "operator": "$stringContains",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record type

  * Allowed values: `Accounts`, `Contacts`, `Leads`, `Tasks`, Custom Object (`<specified by objectName property>`)
  * Options can be loaded by using the `recordTypeCacheKey` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<Accordion title="When Custom Object is selected">
  Additional options when this parameter is set to `<specified by objectName property>`.

  <ParamField type="TEXTAREA">
    The API Name of the Object to create. Use Connect Portal Workflow Settings to allow users to select a Field Mapping.

    * Example value: `{{settings.objectType}}`
  </ParamField>
</Accordion>

<ParamField type="CONDITIONAL">
  Only trigger on new records that match these filters.

  * Supported filter fields: `id`
  * Supported filter fields are loaded from `fieldsCacheKey` after selecting `recordType`.
  * Supported operators: `$none`, `$stringContains`, `$stringDoesNotContain`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$numberGreaterThan`, `$numberLessThan`, `$numberEquals`, `$numberDoesNotEqual`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$booleanTrue`, `$booleanFalse`, `$exists`, `$doesNotExist`
</ParamField>


# Record Updated
Source: https://docs.useparagon.com/actionkit/integrations/zohocrm/triggers/ZOHO_CRM_TRIGGER_RECORD_UPDATED

Trigger when a Zoho CRM record is updated.

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zohocrm",
  "type": "ZOHO_CRM_TRIGGER_RECORD_UPDATED",
  "parameters": {
    "recordType": "Accounts",
    "recordsFilterFormula": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "id",
              "operator": "$stringContains",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="ENUM">
  Record type

  * Allowed values: `Accounts`, `Contacts`, `Leads`, `Tasks`, Custom Object (`<specified by objectName property>`)
  * Options can be loaded by using the `recordTypeCacheKey` key. Learn more in [User Configuration](/actionkit/triggers/user-configuration).
</ParamField>

<Accordion title="When Custom Object is selected">
  Additional options when this parameter is set to `<specified by objectName property>`.

  <ParamField type="TEXTAREA">
    The API Name of the Object to update. Use Connect Portal Workflow Settings to allow users to select a Field Mapping.

    * Example value: `{{settings.objectType}}`
  </ParamField>
</Accordion>

<ParamField type="CONDITIONAL">
  Only trigger on updated records that match these filters.

  * Supported filter fields: `id`
  * Supported filter fields are loaded from `fieldsCacheKey` after selecting `recordType`.
  * Supported operators: `$none`, `$stringContains`, `$stringDoesNotContain`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$numberGreaterThan`, `$numberLessThan`, `$numberEquals`, `$numberDoesNotEqual`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$booleanTrue`, `$booleanFalse`, `$exists`, `$doesNotExist`
</ParamField>


# Add Meeting Registrant
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_ADD_MEETING_REGISTRANT

actionkit/openapi.json POST /projects/{project_id}/tools/#ZOOM_ADD_MEETING_REGISTRANT



# Create Meeting
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_CREATE_MEETING

actionkit/openapi.json POST /projects/{project_id}/tools/#ZOOM_CREATE_MEETING



# Delete Meeting
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_DELETE_MEETING

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#ZOOM_DELETE_MEETING_REGISTRANT



# Get Meeting
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_GET_MEETING

actionkit/openapi.json POST /projects/{project_id}/tools/#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}/tools/#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}/tools/#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}/tools/#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}/tools/#ZOOM_SEARCH_RECORDING



# Update Meeting
Source: https://docs.useparagon.com/actionkit/integrations/zoom/ZOOM_UPDATE_MEETING

actionkit/openapi.json POST /projects/{project_id}/tools/#ZOOM_UPDATE_MEETING



# Zoom
Source: https://docs.useparagon.com/actionkit/integrations/zoom/overview

Browse the tools and triggers available for Zoom in ActionKit.

## Tools

<CardGroup>
  <Card href="/actionkit/integrations/zoom/ZOOM_CREATE_MEETING" title="Create Meeting" />

  <Card href="/actionkit/integrations/zoom/ZOOM_UPDATE_MEETING" title="Update Meeting" />

  <Card href="/actionkit/integrations/zoom/ZOOM_GET_MEETING" title="Get Meeting" />

  <Card href="/actionkit/integrations/zoom/ZOOM_GET_MEETING_BY_ID" title="Get Meeting By ID" />

  <Card href="/actionkit/integrations/zoom/ZOOM_DELETE_MEETING" title="Delete Meeting" />

  <Card href="/actionkit/integrations/zoom/ZOOM_ADD_MEETING_REGISTRANT" title="Add Meeting Registrant" />

  <Card href="/actionkit/integrations/zoom/ZOOM_GET_MEETING_REGISTRANT" title="Get Meeting Registrant" />

  <Card href="/actionkit/integrations/zoom/ZOOM_DELETE_MEETING_REGISTRANT" title="Delete Meeting Registrant" />

  <Card href="/actionkit/integrations/zoom/ZOOM_GET_RECORDING_BY_MEETING_ID" title="Get Recording By Meeting ID" />

  <Card href="/actionkit/integrations/zoom/ZOOM_SEARCH_RECORDING" title="Search Recording" />
</CardGroup>

<Info>**Don't see the tool you need?** Define your own using [Custom Tools](/actionkit/custom-tools).</Info>

## Triggers

<CardGroup>
  <Card href="/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_MEETING_CREATED" title="New Meeting" />

  <Card href="/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_MEETING_UPDATED" title="Meeting Updated" />

  <Card href="/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_MEETING_ENDED" title="Meeting Ended" />

  <Card href="/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_MEETING_REGISTRANT_CREATED" title="New Meeting Registrant" />

  <Card href="/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_PARTICIPANT_JOINED" title="Meeting Participant Joined" />

  <Card href="/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_PARTICIPANT_LEFT" title="Meeting Participant Left" />

  <Card href="/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_RECORDING_STARTED" title="New Recording" />

  <Card href="/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_RECORDING_COMPLETED" title="Complete Recording" />

  <Card href="/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_RECORDING_TRANSCRIPT_COMPLETED" title="Recording Transcript Completed">
    Trigger when the transcript of the recording is made available
  </Card>
</CardGroup>

<Info>**Don't see the trigger you need?** Define your own using [Custom Webhooks](/resources/custom-webhooks).</Info>


# New Meeting
Source: https://docs.useparagon.com/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_MEETING_CREATED

Trigger when a meeting is created in Zoom

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zoom",
  "type": "ZOOM_TRIGGER_MEETING_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Meeting Ended
Source: https://docs.useparagon.com/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_MEETING_ENDED

Trigger when a meeting host ends the meeting in Zoom

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zoom",
  "type": "ZOOM_TRIGGER_MEETING_ENDED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# New Meeting Registrant
Source: https://docs.useparagon.com/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_MEETING_REGISTRANT_CREATED

Trigger when a user registers for a meeting in Zoom

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zoom",
  "type": "ZOOM_TRIGGER_MEETING_REGISTRANT_CREATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Meeting Updated
Source: https://docs.useparagon.com/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_MEETING_UPDATED

Trigger when a meeting is updated in Zoom

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zoom",
  "type": "ZOOM_TRIGGER_MEETING_UPDATED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Meeting Participant Joined
Source: https://docs.useparagon.com/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_PARTICIPANT_JOINED

Trigger when a participant joins a meeting in Zoom

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zoom",
  "type": "ZOOM_TRIGGER_PARTICIPANT_JOINED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Meeting Participant Left
Source: https://docs.useparagon.com/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_PARTICIPANT_LEFT

Trigger when a participant has left the meeting in Zoom

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zoom",
  "type": "ZOOM_TRIGGER_PARTICIPANT_LEFT",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Complete Recording
Source: https://docs.useparagon.com/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_RECORDING_COMPLETED

Trigger when a meeting recording is ready to download

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zoom",
  "type": "ZOOM_TRIGGER_RECORDING_COMPLETED",
  "parameters": {
    "recordsFilterFormula": {
      "operator": "OR",
      "conditions": [
        {
          "operator": "AND",
          "conditions": [
            {
              "field": "Account ID",
              "operator": "$stringContains",
              "value": "example-value"
            }
          ]
        }
      ]
    }
  }
}
```

**Configuration options:**

<ParamField type="CONDITIONAL">
  Only trigger for meeting recordings that match these filters

  * Supported filter fields: `Account ID`, `Start Date`, `End Date`
  * Supported operators: `$none`, `$stringContains`, `$stringDoesNotContain`, `$stringExactlyMatches`, `$stringDoesNotExactlyMatch`, `$stringIsIn`, `$stringIsNotIn`, `$stringStartsWith`, `$stringDoesNotStartWith`, `$stringEndsWith`, `$stringDoesNotEndWith`, `$numberGreaterThan`, `$numberLessThan`, `$numberEquals`, `$numberDoesNotEqual`, `$dateTimeAfter`, `$dateTimeBefore`, `$dateTimeEquals`, `$booleanTrue`, `$booleanFalse`, `$exists`, `$doesNotExist`, `$isNotUndefinedOrNull`, `$isUndefinedOrNull`, `$arrayIsEmpty`, `$arrayIsNotEmpty`
</ParamField>


# New Recording
Source: https://docs.useparagon.com/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_RECORDING_STARTED

Trigger when a meeting recording is started in Zoom

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zoom",
  "type": "ZOOM_TRIGGER_RECORDING_STARTED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# Recording Transcript Completed
Source: https://docs.useparagon.com/actionkit/integrations/zoom/triggers/ZOOM_TRIGGER_RECORDING_TRANSCRIPT_COMPLETED

Trigger when the transcript of the recording is made available

## Subscribe

Send this request body to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger) to start listening for this event on behalf of your user:

```http Subscribe Request theme={null}
POST https://actionkit.useparagon.com/projects/{project_id}/trigger-subscriptions

Authorization: Bearer {Paragon User Token}
Content-Type: application/json

{
  "integration": "zoom",
  "type": "ZOOM_TRIGGER_RECORDING_TRANSCRIPT_COMPLETED",
  "parameters": {}
}
```

**Configuration options:**

This trigger does not require any configuration options.


# ActionKit
Source: https://docs.useparagon.com/actionkit/overview

ActionKit is an API to give your AI agent or app access to Paragon's catalog of pre-built Integration Tools and Triggers.

<Frame>
  <img alt="Action Kit Banner Pn" />
</Frame>

**ActionKit** exposes thousands of pre-built Tools (actions in a third-party system) and Triggers (events in a third-party system) across integrations through *one* consistent interface.

The main use cases for ActionKit include:

1. **AI agents**: Give your AI agent a deep understanding of your users' connected apps:
   * Expose [Tools](/actionkit/api-reference) as capabilities to your AI agent (with our API or MCP), with agent-optimized descriptions for tool calling accuracy.
   * Use [Triggers](/actionkit/triggers/overview) to listen for third-party events in your users' integrations and react to new data with your AI agent.
2. **In-app workflow builders**: Expand your in-app workflow builder with Paragon's catalog of thousands of pre-built Tools and Triggers:
   * Expose [Tools](/actionkit/api-reference) as action nodes in your in-app workflow builder by rendering Tool input schemas in your UI.
   * Expose [Triggers](/actionkit/triggers/overview) as trigger nodes for your users to discover and configure trigger points for their workflow automations.
3. **Front-end functions**: If your users interact with integration data in your app, use [Tools](/actionkit/api-reference) to power frontend features like displaying a table of Salesforce opportunities or a button to send a Slack notification.
4. **First-party automations**: If your app needs to react to data changes or new events from your users' connected apps, use [Triggers](/actionkit/triggers/overview) to listen for events like a new Slack @mention or new Salesforce lead.

ActionKit is built for real-life use cases, providing much deeper abstractions than 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



## Overview

ActionKit supports multiple formats for accessing Tool definitions from the API, for different use cases:

* **JSON Schema** `format=json_schema`
  * For AI agent use cases: in most cases, you can pass Tool 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 Tools to your product's workflow builder.
  * Learn more about the Paragon format below.

You can request a specific format in the [List Tools](/actionkit/api-reference/list-tools) API endpoint with the `format` query parameter.

## Paragon Format

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 Tools.

When using the Paragon format, you will need to support the following types of inputs in Paragon:

<table>
  <thead>
    <tr>
      <th>Input Type</th>
      <th>Key(s)</th>
      <th>Example</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td><strong>Enum input</strong> (dropdown)</td>
      <td><code>ENUM</code> | <code>DYNAMIC\_ENUM</code></td>

      <td>
        <img />
      </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 />
      </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 />
      </td>
    </tr>

    <tr>
      <td>**Text input**</td>
      <td><code>TEXT</code> | <code>TEXT\_NO\_VARS</code></td>

      <td>
        <img />
      </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 />
      </td>
    </tr>

    <tr>
      <td>**Code input**</td>
      <td><code>CODE</code></td>

      <td>
        <img />
      </td>
    </tr>

    <tr>
      <td>**Boolean input** (switch / toggle)</td>
      <td><code>BOOLEAN\_INPUT</code> | <code>SWITCH</code></td>

      <td>
        <img />
      </td>
    </tr>

    <tr>
      <td>**Filter / conditional input**</td>
      <td><code>CONDITIONAL</code> | <code>DYNAMIC\_CONDITIONAL</code></td>

      <td>
        <img />
      </td>
    </tr>
  </tbody>
</table>

### Tool polymorphism

To work around limitations of JSON Schema, the `json_schema` (default) format automatically breaks down polymorphic parameters into individual Tools.

For example, `SALESFORCE_CREATE_RECORD` splits into 6 distinct Tools:

* `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 Tools and instead will be represented as `dependentInputs` within the API (see below example).

When calling [Run Tool](/actionkit/api-reference/run-tool), you can reference either the specific Tool (e.g. `SALESFORCE_CREATE_OPPORTUNITY`) or the generic Tool (e.g. `SALESFORCE_CREATE_RECORD`), as long as the required parameters are supplied.

```json theme={null}
// Example format=paragon Tool 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

See all the integrations that are currently supported by ActionKit.

Available Tools are also listed in the [Reference](/actionkit/integrations) section under each integration name in the sidebar.

If you don't see the integration or tool you're looking for, try [creating a Custom Tool](/actionkit/custom-tools) or [reach out to us](mailto:support@useparagon.com) with more details.

* 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


# Get Example Payload
Source: https://docs.useparagon.com/actionkit/triggers/api-reference/get-example-payload

actionkit/triggers/openapi.json POST /projects/{project_id}/triggers/examples
Get example records for a trigger configuration.



# List Available Triggers
Source: https://docs.useparagon.com/actionkit/triggers/api-reference/list-available-triggers

actionkit/triggers/openapi.json GET /projects/{project_id}/triggers
List all triggers that you can subscribe to on behalf of your user.



# List Subscribed Triggers
Source: https://docs.useparagon.com/actionkit/triggers/api-reference/list-subscribed-triggers

actionkit/triggers/openapi.json GET /projects/{project_id}/trigger-subscriptions
List all triggers that a user is currently subscribed to.



# Subscribe to a Trigger
Source: https://docs.useparagon.com/actionkit/triggers/api-reference/subscribe-to-trigger

actionkit/triggers/openapi.json POST /projects/{project_id}/trigger-subscriptions
Subscribe to a trigger on behalf of your user.



# Unsubscribe from a Trigger
Source: https://docs.useparagon.com/actionkit/triggers/api-reference/unsubscribe-from-trigger

actionkit/triggers/openapi.json DELETE /projects/{project_id}/trigger-subscriptions/{subscription_id}
Unsubscribe from a trigger on behalf of your user.



# Update Subscription
Source: https://docs.useparagon.com/actionkit/triggers/api-reference/update-trigger-subscription

actionkit/triggers/openapi.json PATCH /projects/{project_id}/trigger-subscriptions/{subscription_id}
Update a trigger subscription's configuration on behalf of your user.



# Triggers API
Source: https://docs.useparagon.com/actionkit/triggers/overview

Subscribe to events from your users' integrations, using our catalog of pre-built triggers or Custom Webhooks.

ActionKit **Triggers API** provides our complete library of pre-built triggers in simple endpoints to discover, configure, and subscribe to events on behalf of your users.

You can use the Triggers API to:

* Add triggers to your workflow builder product from our catalog of 130+ integrations
* Kick off your AI agents / agentic workflows from events occurring in your users' connected integrations
* Subscribe your webhook to integration events on behalf of your users (for example, Slack: Message Received or Google Calendar: New Event)

## Getting Started

To get started with the Triggers API, you will need a Connected User with at least 1 account connected in a supported integration. You can then continue to start by configuring a webhook URL (below).

<Steps>
  <Step title="Configure a Webhook URL">
    In the Paragon dashboard, open **Settings** and add your Webhook URL under the **ActionKit** tab. This URL will receive events on behalf of all of your users.

    You can also save your generated Signing Secret to verify that incoming payloads to this webhook are coming from Paragon.
  </Step>

  <Step title="Activate a Trigger">
    Go to the Connected Users page and select the user you connected an integration with. In the Triggers section, turn on any kind of trigger that you want to listen for.

    You will see a code example for the equivalent API call you can use to subscribe a user to this trigger.
  </Step>

  <Step title="Trigger an Event">
    Trigger the event type you activated in the account you connected for your user.

    You can see the result delivered to your webhook (within a few seconds) or in [ActionKit Logs](/actionkit/actionkit-logs).
  </Step>
</Steps>

## API Usage

**Base URL**

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

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

**Authentication**

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

```js theme={null}
Authorization: Bearer [Paragon User Token]
```

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

<Accordion title="Using Multi-Account Authorization">
  [Multi Account Authorization](/apis/api-reference/multi-account-authorization#getting-started) is a set of SDK options that enables you to connect multiple accounts of the same integration type for a [Connected User](/billing/connected-users).

  You can use Multi-Account Authorization with Triggers API by specifying a credential with a header of `X-Paragon-Credential`.

  ```http REST API theme={null}
  POST https://actionkit.useparagon.com/projects/<Project ID>/triggers

  Authorization: Bearer <Paragon User Token>
  X-Paragon-Credential: <Credential ID>
  ```
</Accordion>


# Receiving Webhooks
Source: https://docs.useparagon.com/actionkit/triggers/receiving-webhooks

Learn how to receive, validate, and process webhook events for your users' trigger subscriptions.

## Webhook URLs

By default, trigger subscriptions will send events to the URL that you have configured via the dashboard for the associated project.

You can set or change your project's Webhook URL by going to the **Settings** > **ActionKit** page of your dashboard:

<Frame>
  <img alt="" />
</Frame>

You can also override the URL for a specific trigger subscription by passing a `webhookOverride` property to the API when you subscribe:

```http highlight={10-14} theme={null}
POST /projects/{project_id}/trigger-subscriptions

Authorization: Bearer [Paragon User Token]

{
	"type": "SALESFORCE_TRIGGER_RECORD_CREATED",
	"parameters": {
		"recordType": "Opportunity"
	},
	"webhookOverride": {
		"url": "https://example.com",
		"headers": {},
		"metadata": {},
	}
}
```

## Signing secret

Your signing secret is automatically generated when you first save your webhook configuration. You can find it in the **ActionKit** section of your project settings under **Signing Secret**.

To view your signing secret:

1. Navigate to **Settings** > **ActionKit** in your Paragon dashboard.
2. Click **Reveal** next to the **Signing Secret** row.
3. Copy the secret for use in your webhook verification logic.

<Warning>
  Keep your signing secret private. Do not expose it in client-side code or public repositories.
</Warning>

## Webhook Payloads

Every webhook payload has a few standard properties, including a HMAC-SHA256 signature that can be used to validate the trigger payload.

The trigger event data will be available in the `payload` key.

```http Example theme={null}
x-paragon-signature: v1=[signature]

{
  "eventId": "[uuid]",
  "userId": "12345",
  "integration": "salesforce",
  "triggerType": "SALESFORCE_TRIGGER_RECORD_CREATED",
  "triggerSubscriptionId": "[uuid]",
  "credentialId": "[uuid]",
  "projectId": "[uuid]",
  "dateReceived": "2025-10-14T00:00:00Z",
  "payload": {...},
  "triggerSubscriptionMetadata": {...}
}
```

**Headers:**

<ParamField>
  HMAC-SHA256 signature of the webhook JSON body, preceded by the versioning prefix `v1=`. Use this to validate the authenticity of this event as delivered by Paragon, with the project-specific webhook secret found in your project settings.
</ParamField>

**Body:**

<ParamField type="string">
  A unique ID for this event. Use this ID for event deduplication in case Paragon sends multiple requests to your webhook for the same event.
</ParamField>

<ParamField type="string">
  The ID for the Connected User that this trigger fired for. This is the same ID that is passed to the `sub` claim of the Paragon User Token (JWT).
</ParamField>

<ParamField type="string">
  The name of the integration that this trigger fired for.

  **Example:** `salesforce`
</ParamField>

<ParamField type="string">
  The `type` of trigger that fired.

  **Example:** `SALESFORCE_TRIGGER_RECORD_CREATED`
</ParamField>

<ParamField type="object">
  The event payload as received from the trigger. The schema of this object will vary depending on the trigger type. You can get example objects to use as the schema for this trigger with [Get Example Payloads](/actionkit/triggers/api-reference/get-example-payload).
</ParamField>

<Accordion title="Show all properties">
  <ParamField type="uuid">
    The UUID of the trigger subscription that fired.
  </ParamField>

  <ParamField type="uuid">
    The UUID of the user's credential that triggered this event.
  </ParamField>

  <ParamField type="uuid">
    The UUID of the Paragon project.
  </ParamField>

  <ParamField type="string">
    An ISO datetime string of the original date that this event was received. You can use this to sequence events if necessary.
  </ParamField>

  <ParamField type="object">
    If this trigger subscription was created with `metadata` passed in `webhookOverride`, then the metadata will be passed in this field of the incoming webhook body.
  </ParamField>
</Accordion>

## Verifying webhook signatures

Use the `x-paragon-signature` header to confirm that the payload was sent by Paragon and has not been tampered with.

### Verification steps

<Steps>
  <Step title="Extract the signature">
    Read the `x-paragon-signature` header from the incoming request and remove the `v1=` prefix.
  </Step>

  <Step title="Compute the expected signature">
    Create an HMAC-SHA256 hash of the raw JSON request body using your signing secret, then hex-encode the result.
  </Step>

  <Step title="Compare signatures">
    Use a timing-safe comparison to check whether the computed signature matches the signature from the header.
  </Step>
</Steps>

### Example: Node.js

```javascript theme={null}
const crypto = require('crypto');

function verifyWebhookSignature(rawBody, signatureHeader, signingSecret) {
  const signature = signatureHeader.replace(/^v1=/, '');
  const expectedSignature = crypto
    .createHmac('sha256', signingSecret)
    .update(rawBody)
    .digest('hex');

  return crypto.timingSafeEqual(
    Buffer.from(signature, 'hex'),
    Buffer.from(expectedSignature, 'hex'),
  );
}
```

### Example: Python

```python theme={null}
import hmac
import hashlib

def verify_webhook_signature(payload: bytes, signature_header: str, signing_secret: str) -> bool:
    signature = signature_header.removeprefix('v1=')
    expected = hmac.new(
        signing_secret.encode('utf-8'),
        payload,
        hashlib.sha256,
    ).hexdigest()

    return hmac.compare_digest(expected, signature)
```


# User Configuration
Source: https://docs.useparagon.com/actionkit/triggers/user-configuration

Allow users to configure their trigger parameters in your application UI.

If your in-product workflow builder or UI will allow users to configure their own triggers, use the JavaScript SDK or Triggers API to collect user input for trigger parameters such as a Salesforce Record Type or event filter conditions.

## Trigger Parameters

The SDK provides all available Trigger Parameters when you call `paragon.getTriggers`. You can also fetch the same schema directly from [List Available Triggers](/actionkit/triggers/api-reference/list-available-triggers).

Each trigger has a `parameters` field that will provide a list of Paragon-formatted [Input Types](/actionkit/schema-formats#overview) that can be rendered and exposed to your users.

<CodeGroup>
  ```js JavaScript SDK theme={null}
  const response = await paragon.getTriggers("salesforce", {
    // Optional: pass when Multi-Account Authorization.
    selectedCredentialId: "<Credential ID>",
  });

  const triggerDefinitions = response.triggers.salesforce;
  ```

  ```http REST API theme={null}
  GET https://actionkit.useparagon.com/projects/<Paragon Project ID>/triggers?integrations=salesforce

  Authorization: Bearer <Paragon User Token>

  // Optional: pass when using Multi-Account Authorization
  X-Paragon-Credential: <Credential ID>
  ```
</CodeGroup>

```json Response: Trigger definitions highlight={9-21} expandable theme={null}
{
  "triggers": {
    "salesforce": [
      {
        "type": "SALESFORCE_TRIGGER_RECORD_CREATED",
        "triggerModel": "POLLING",
        "title": "New Record",
        "description": "Trigger when a new record is created in Salesforce",
        "parameters": [
          {
            "id": "recordType",
            "type": "ENUM",
            "title": "Record type",
            "required": true,
            "valuesSource": {
              "sourceType": "recordTypes",
              "dependencies": []
            }
          }
        ]
      }
    ]
  }
}
```

The `id` property of each input should be used as the key names of `parameters` when calling [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger). The values should be the input collected from your user.

## Displaying Inputs

Render each trigger parameter based on its `type`, and use `paragon.getSourcesForActionInput` to determine whether the input needs static or dynamic options.

```js JavaScript SDK expandable theme={null}
const inputSources = paragon.getSourcesForActionInput(input);

switch (inputSources.source.type) {
  // Static dropdowns
  case "STATIC_ENUM":
    renderSelectInput({
      input,
      value,
      options: inputSources.source.values,
      onChange,
    });
    break;

  // Dynamic dropdowns
  case "DYNAMIC_DATA_SOURCE":
    const options = await paragon.getFieldOptions({
      integration,
      action: inputSources.source.cacheKey,
      parameters: inputSources.source.dependencies.map((key) => ({
        key,
        source: { type: "VALUE", value: triggerForm.parameters[key] },
      })),
    });
    renderSelectInput({ input, value, options, onChange });
    break;
  default:
    renderPlainInput({ input, value, onChange });
    break;
}
```

For plain inputs, render directly from `input.type`. For example, `TEXT`, `CODE`, `PASSWORD`, and `NUMBER` can be rendered as text inputs; `TEXTAREA` can be rendered as a textarea; `BOOLEAN_INPUT` and `SWITCH` can be rendered as toggles.

### Dropdown inputs

For static dropdowns, `paragon.getSourcesForActionInput` returns a `STATIC_ENUM` source. Render these values directly in your dropdown.

Some inputs require loading dynamic data from the user's connected account. For example, the **Salesforce: New Record** trigger requires an **Object** selection to be made by your user:

<Frame>
  <img alt="Dropdown menu of Salesforce record type options" />
</Frame>

For dynamic dropdowns, `paragon.getSourcesForActionInput` returns a `DYNAMIC_DATA_SOURCE` source. Pass the source to `paragon.getFieldOptions`, along with any dependency values required by `source.refreshDependencies`.

```js JavaScript SDK expandable theme={null}
async function loadDynamicOptions({
  integration,
  source,
  parameterValues,
  search,
  selectedCredentialId,
}) {
  const dependencyKeys = (source.refreshDependencies ?? []).filter(
    (key) => typeof key === "string"
  );

  const dependencies = dependencyKeys.map((key) => ({
    cacheKey: key,
    value: parameterValues[key],
  }));

  const hasDependencies = dependencyKeys.length > 0;
  const dependenciesSatisfied = dependencies.every((item) => Boolean(item.value));

  if (hasDependencies && !dependenciesSatisfied) {
    return [];
  }

  const response = await paragon.getFieldOptions({
    integration,
    source,
    search,
    selectedCredentialId,
    parameters: dependencies.map((dependency) => ({
      key: dependency.cacheKey,
      source: {
        type: "VALUE",
        value: dependency.value,
      },
    })),
  });

  return response.data;
}
```

### Conditional inputs

For `CONDITIONAL` inputs, render a filter builder UI, such as the below:

<Frame>
  <img alt="Filter builder UI" />
</Frame>

The value should be an object with `operator` (`OR` or `AND`) and `conditions` properties; each condition contains the selected `field`, `operator`, and `value`.

```js JavaScript SDK theme={null}
const filterValue = {
  operator: "OR",
  conditions: [
    {
      field: "Name",
      operator: "$stringContains",
      value: "Test",
    },
    {
      field: "Amount",
      operator: "$numberGreaterThan",
      value: "5000",
    },
  ],
};
```

For complex conditional inputs, you can use DNF (Disjunctive Normal Form) to represent the filter value.

<Expandable title="complex condition example">
  This expression represents: Opportunity Amount > 5000 OR (Contact.Title contains "CEO" AND Amount > 1000)

  ```json theme={null}
  {
    "operator": "OR",
    "conditions": [
      {
        "operator": "AND",
        "conditions": [
          {
            "field": "Amount",
            "operator": "$numberGreaterThan",
            "value": "5000",
          },
        ],
      },
      {
        "operator": "AND",
        "conditions": [
          {
            "field": "Contact.Title",
            "operator": "$stringContains",
            "value": "CEO",
          },
          {
            "field": "Amount",
            "operator": "$numberGreaterThan",
            "value": "1000",
          },
        ],
      },
    ],
  }
  ```
</Expandable>

Conditional inputs can provide static `supportedKeys` or a dynamic `supportedKeysSource` for listing out available options for `field`.

When the keys are dynamic, load them the same way you load dynamic dropdown options. Use `supportedOperators` to limit the operators available in your UI, and respect `disableOrCondition` if your filter builder supports OR groups.

```js JavaScript SDK expandable theme={null}
async function getConditionalFields({ integration, input, parameterValues }) {
  if (input.supportedKeys?.length) {
    return input.supportedKeys.map((key) => ({ label: key, value: key }));
  }

  if (!input.supportedKeysSource) {
    return [];
  }

  const response = await paragon.getFieldOptions({
    integration,
    action: input.supportedKeysSource.sourceType,
    parameters: input.supportedKeysSource.dependencies.map((key) => ({
      key,
      source: {
        type: "VALUE",
        value: parameterValues[key],
      },
    })),
  });

  return flattenOptions(response.data);
}
```

Once your user has configured the trigger, send the collected parameter values to [Subscribe to a Trigger](/actionkit/triggers/api-reference/subscribe-to-trigger).

```json Subscribe to a Trigger request body highlight={5-19} theme={null}
{
  "integration": "salesforce",
  "triggerType": "SALESFORCE_TRIGGER_RECORD_CREATED",
  "parameters": {
    "objectName": "Opportunity",
    "recordsFilterFormula": {
      operator: "OR",
      conditions: [
        {
          field: "Name",
          operator: "$stringContains",
          value: "Test",
        },
        {
          field: "Amount",
          operator: "$numberGreaterThan",
          value: "5000",
        },
      ]
    }
  }
}
```

See the resources below for implementation details:

<CardGroup>
  <Card href="/actionkit/schema-formats#overview" title="Input Types">
    Learn more about each Input Type and their UI requirements.
  </Card>

  <Card href="/connect-portal/headless-connect-portal#exposing-user-settings" title="Loading Dynamic Data">
    Learn more about loading dynamic data from your user's account with the SDK.
  </Card>
</CardGroup>


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



Below are all the public functions exposed on the Paragon SDK, which can be accessed as the named `paragon` export from `@useparagon/connect`, and the public endpoints of the Paragon REST API.

Install Paragon's JavaScript SDK with:

<CodeGroup>
  ```bash npm theme={null}
  npm install @useparagon/connect
  ```

  ```bash yarn theme={null}
  yarn add @useparagon/connect
  ```

  ```bash pnpm  theme={null}
  pnpm add @useparagon/connect
  ```

  ```bash bun theme={null}
  bun add @useparagon/connect
  ```
</CodeGroup>

The SDK can be imported in your client-side JavaScript files as a module:

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    import { paragon } from '@useparagon/connect';
    ```
  </Tab>
</Tabs>

<Accordion title="For on-premise users">
  If you are using an [on-premise](/on-premise/hosting-paragon-on-premise) instance of Paragon, you can call the `paragon.configureGlobal` function to point the SDK to use the base hostname of your Paragon instance.

  <Tabs>
    <Tab title="SDK" icon="js">
      ```javascript icon="js" JavaScript theme={null}
      import { paragon } from "@useparagon/connect";

      // If your login URL is https://dashboard.mycompany.paragon.so:
      paragon.configureGlobal({
        host: "mycompany.paragon.so",
      });
      ```
    </Tab>
  </Tabs>
</Accordion>

## SDK Methods

### .authenticate

`paragon.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.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript  theme={null}
    await paragon.authenticate(PROJECT_ID, USER_TOKEN);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="string">
  You can find your project ID in the Overview tab of any Integration
</ParamField>

<ParamField type="string">
  See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
</ParamField>

Once `paragon.authenticate` has been called, you can access the user's integration state with `paragon.getUser`. `paragon.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

Call `paragon.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.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript  theme={null}
    paragon.connect(integrationType, installOptions);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="string">
  Type of integration (i.e. "salesforce", "hubspot", "googledrive")
</ParamField>

<ParamField type="InstallOptions">
  <Expandable title="Optional installOptions">
    <ParamField type="function">
      Callback invoked when an integration is successfully enabled.
    </ParamField>

    <ParamField type="function">
      Callback if an unexpected error occurs.
    </ParamField>

    <ParamField type="enum">
      For integrations that support multiple account types, you can optionally designate a specific `accountType` to skip the account selection dialog.

      Example values: `default`, `sandbox`

      ```javascript icon="js" Example of using accountType theme={null}
      paragon.connect("salesforce", {
        // Only allow production-type Salesforce accounts to connect
        accountType: "default",
      });
      ```
    </ParamField>

    <ParamField type="object">
      For [Field Mapping](/connect-portal/field-mapping) inputs that use Dynamic Application Fields. Keys must match the Application Object Name from the dashboard; values describe application fields and/or loaders for integration object types and fields. See [Passing dynamic fields through the SDK](/connect-portal/field-mapping#passing-dynamic-fields-through-the-sdk).
    </ParamField>

    <ParamField type="string">
      Pass this option to associate a new credential with an identifier from your own system. The `externalId` will be available on the credential object returned by [`paragon.getUser`](/apis/api-reference#getuser).

      This option cannot be used with `selectedCredentialId`, which is used to replace or manage existing connected accounts. Existing credentials currently cannot be updated with an external ID.
    </ParamField>

    <ParamField type="string">
      Used for [Multi-Account Authorization](/apis/api-reference/multi-account-authorization). Pass this option to open the Connect Portal for an existing credential ID and update/manage settings (headful) or to start an install flow to replace an existing credential ID with a new account (with the [Headless Connect Portal](/connect-portal/headless-connect-portal)).
    </ParamField>

    <ParamField type="string">
      Used for [Multi-Configuration](/apis/api-reference/multi-configuration). Pass this option to open the Connect Portal for a specific configuration (unique set of User Settings and Workflow Enablements for a connected credential).
    </ParamField>
  </Expandable>
</ParamField>

This function must be called after the Paragon SDK has completed authentication. You can `await` the Promise returned by [`paragon.authenticate`](#authenticate) 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.

If your integration uses a [Field Mapping](/connect-portal/field-mapping) User Setting, pass the mapping configuration through `installOptions`. For examples, see [Passing dynamic fields through the SDK](/connect-portal/field-mapping#passing-dynamic-fields-through-the-sdk).

You can also connect multiple accounts for the same integration.

<Card title="Multi Account Authorization" href="/apis/api-reference/multi-account-authorization" />

***

### .subscribe

Call `paragon.subscribe` to subscribe to different events and changes from the Paragon SDK. You can find the possible `eventNames` below:

| Event Type                | Usage in `paragon.subscribe` | Usage in `paragon.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 `paragon.connect` only applies to a currently open Connect Portal *locally*.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    paragon.subscribe(eventType, callback);
    ```
  </Tab>
</Tabs>

<ParamField type="string">
  Event type (i.e. "onIntegrationInstall", "onPortalOpen") as seen in the table above
</ParamField>

<ParamField type="(event: Event, user: AuthenticatedConnectUser) => void">
  callback function that triggers on event
</ParamField>

**Examples:**

<CodeGroup>
  ```typescript Integration Enabled / Disabled theme={null}
  type IntegrationInstallEvent = {
    integrationId: string;
    integrationType: VisibleConnectAction;
    credential: Credential;
    credentialId: string;
  };

  // Using global subscribe
  paragon.subscribe(
    "onIntegrationInstall",
    (event: IntegrationInstallEvent, user: AuthenticatedConnectUser) => {
      /* ... */
    }
  );
  ```

  ```typescript Workflow State Changed theme={null}
  type WorkflowStateChangeEvent = {
    integrationId: string;
    workflowId: string;
  };

  // Using global subscribe
  paragon.subscribe(
    "onWorkflowChange",
    (event: WorkflowStateChangeEvent, user: AuthenticatedConnectUser) => {
      /* ... */
    }
  );
  ```

  ```typescript Connect Portal Opened / Closed theme={null}
  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 theme={null}
  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 theme={null}
  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 theme={null}
  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>

***

### .installIntegration

<Info>
  This function should be used only if you are using your [own components](/connect-portal/headless-connect-portal) to show connected integrations and their status, instead of the Connect Portal.

  Otherwise, you can use [the `paragon.connect` function](/apis/api-reference#connect).
</Info>

The `paragon.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.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript  theme={null}
    const { credential } = await paragon.installIntegration(integrationType, installOptions);
    ```
  </Tab>
</Tabs>

<ParamField type="string">
  Type of integration (i.e. "salesforce", "hubspot", "googledrive")
</ParamField>

<ParamField type="InstallOptions">
  <Expandable title="Optional installOptions">
    <ParamField type="function">
      Callback invoked when an integration is successfully enabled.
    </ParamField>

    <ParamField type="function">
      Callback if an unexpected error occurs.
    </ParamField>

    <ParamField type="enum">
      For integrations that support multiple account types, you can optionally designate a specific `accountType` to skip the account selection dialog.

      Example values: `default`, `sandbox`

      ```javascript icon="js" Example of using accountType theme={null}
      paragon.connect("salesforce", {
        // Only allow production-type Salesforce accounts to connect
        accountType: "default",
      });
      ```
    </ParamField>

    <ParamField type="object">
      For [Field Mapping](/connect-portal/field-mapping) inputs that use Dynamic Application Fields. Keys must match the Application Object Name from the dashboard; values describe application fields and/or loaders for integration object types and fields. See [Passing dynamic fields through the SDK](/connect-portal/field-mapping#passing-dynamic-fields-through-the-sdk).
    </ParamField>

    <ParamField type="string">
      Pass this option to associate a new credential with an identifier from your own system. The `externalId` will be available on the credential object returned by [`paragon.getUser`](/apis/api-reference#getuser).

      This option cannot be used with `selectedCredentialId`, which is used to replace or manage existing connected accounts. Existing credentials currently cannot be updated with an external ID.
    </ParamField>

    <ParamField type="string">
      Used for [Multi-Account Authorization](/apis/api-reference/multi-account-authorization). Pass this option to open the Connect Portal for an existing credential ID and update/manage settings (headful) or to start an install flow to replace an existing credential ID with a new account (with the [Headless Connect Portal](/connect-portal/headless-connect-portal)).
    </ParamField>

    <ParamField type="string">
      Used for [Multi-Configuration](/apis/api-reference/multi-configuration). Pass this option to open the Connect Portal for a specific configuration (unique set of User Settings and Workflow Enablements for a connected credential).
    </ParamField>
  </Expandable>
</ParamField>

**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 [`paragon.connect`](/apis/api-reference#connect).

***

### .uninstallIntegration

Call `paragon.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.

<Tabs>
  <Tab title="SDK" icon="js">
    ```typescript JavaScript SDK theme={null}
    await paragon.uninstallIntegration(integrationType);
    ```

    **Arguments:**

    <ParamField type="string">
      The short name for the integration (i.e. "salesforce", "hubspot"). Use the same name as used in `paragon.connect`.
    </ParamField>
  </Tab>

  <Tab title="REST API" icon="terminal">
    ```http icon="terminal" HTTP theme={null}
    GET https://api.useparagon.com/projects/PROJECT_ID/sdk/integrations

    Authorization: Bearer <Paragon User Token>

    // Example Response
    // [ { "id": INTEGRATION_ID, "type": "salesforce"} ]

    DELETE https://api.useparagon.com/projects/PROJECT_ID/sdk/integrations/INTEGRATION_ID

    Authorization: Bearer PARAGON_USER_TOKEN
    ```

    **Arguments:**

    <ParamField type="string">
      You can find your project ID in the Overview tab of any Integration
    </ParamField>

    <ParamField type="string">
      The ID of the integration to disconnect. Retrieve it from the `/sdk/integrations` endpoint.
    </ParamField>

    <ParamField type="string">
      See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
    </ParamField>
  </Tab>
</Tabs>

***

### .getIntegrationMetadata

Call `paragon.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!

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    paragon.getIntegrationMetadata();
    ```
  </Tab>

  <Tab title="REST API" icon="terminal">
    ```http icon="terminal" HTTP theme={null}
    GET https://api.useparagon.com/projects/PROJECT_ID/sdk/metadata

    Authorization: Bearer PARAGON_USER_TOKEN
    ```

    **Arguments:**

    <ParamField type="string">
      You can find your project ID in the Overview tab of any Integration
    </ParamField>

    <ParamField type="string">
      See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
    </ParamField>
  </Tab>
</Tabs>

**Returns:**

<ParamField type="object[]">
  <Expandable title="child properties">
    <ParamField type="string">
      The integration type identifier (e.g., `"salesforce"`, `"hubspot"`).
    </ParamField>

    <ParamField type="string">
      The human-readable display name of the integration.
    </ParamField>

    <ParamField type="string">
      The brand color hex value for the integration.
    </ParamField>

    <ParamField type="string">
      The URL to the integration's icon image.
    </ParamField>
  </Expandable>
</ParamField>

**Example Response:**

```javascript icon="js" JavaScript expandable theme={null}
[
  {
    "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"
  }
]
```

***

### .getIntegrationConfig

Call `paragon.getIntegrationConfig` to get the user-facing descriptions, User Settings, and Workflows associated with any integration.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    paragon.getIntegrationConfig(integrationType);
    ```

    **Arguments:**

    <ParamField type="string">
      An integration type string, like `salesforce` or `slack`.
    </ParamField>

    **Example Response:**

    ```javascript icon="js" JavaScript expandable theme={null}
    {
      "shortDescription": "Send notifications to Slack",
      "longDescription": "Connect your Slack workspace to receive notifications and alerts in Slack. Stay connected to important activity by bringing it all together in your Slack workspace.\n\nOur Slack integration enables you to:\n\n• Receive alerts and notifications in your Slack workspace\n• Notify or DM specific team members based on certain activity",
      "availableUserSettings": [
        {
          "id": "2d5662c9-6750-46c2-8588-2ac904532efb",
          "type": "DYNAMIC_ENUM",
          "title": "Channel",
          "required": false,
          "sourceType": "channels"
        }
      ],
      "availableWorkflows": [
        {
          "id": "2248335c-671c-47e4-b9a0-3641a9f2d301",
          "inputs": [],
          "infoText": "Send a Slack notification when a Task is created",
          "defaultEnabled": false,
          "description": "Send Slack Notification"
        }
      ],
      "hiddenWorkflows": []
    }
    ```
  </Tab>

  <Tab title="REST API" icon="terminal">
    ```http icon="terminal" HTTP theme={null}
    GET https://api.useparagon.com/projects/PROJECT_ID/sdk/integrations/INTEGRATION_TYPE

    Authorization: Bearer PARAGON_USER_TOKEN
    ```

    **Arguments:**

    <ParamField type="string">
      You can find your project ID in the Overview tab of any Integration
    </ParamField>

    <ParamField type="string">
      An integration type string, like `salesforce` or `slack`.
    </ParamField>

    <ParamField type="string">
      See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
    </ParamField>

    **Example Response:**

    ```javascript icon="js" JavaScript expandable theme={null}
    [{
      "id": "2f08e65f-d924-42ab-9618-b6023d82ffbd",
      "projectId": "908f4c5e-6394-46a5-9355-3f729edbd160",
      "customIntegrationId": null,
      "type": "slack",
      "isActive": true,
      "configs": [
        {
          "id": "3ebcc179-a1a6-447f-8dc9-5017f40f08ef",
          "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",
          "description": "Send Updates to Slack",
          "projectId": "908f4c5e-6394-46a5-9355-3f729edbd160",
          "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"
    }]
    ```
  </Tab>
</Tabs>

***

### .getUser

Call `paragon.getUser` to retrieve the currently authenticated user and their connected integration state.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    paragon.getUser();
    ```
  </Tab>

  <Tab title="REST API" icon="terminal">
    ```http icon="terminal" HTTP theme={null}
    GET https://api.useparagon.com/projects/PROJECT_ID/sdk/me

    Authorization: Bearer PARAGON_USER_TOKEN
    ```

    **Arguments:**

    <ParamField type="string">
      You can find your project ID in the Overview tab of any Integration
    </ParamField>

    <ParamField type="string">
      See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
    </ParamField>
  </Tab>
</Tabs>

**Example Response:**

```javascript icon="js" JavaScript expandable theme={null}
{
  authenticated: true,
  userId: "xyz",
  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
    }
  }
}
```

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.

***

### .setUserMetadata

Call `paragon.setUserMetadata` to associate the authenticated user with metadata from your application. This metadata can be accessed with `paragon.getUser` or retrieved over the API.

<Tabs>
  <Tab title="SDK" icon="js">
    ```typescript JavaScript SDK theme={null}
    paragon.setUserMetadata(metadata);
    ```

    **Arguments:**

    <ParamField type="object">
      Metadata object to associate with the authenticated user.
    </ParamField>
  </Tab>

  <Tab title="REST API" icon="terminal">
    ```http icon="terminal" HTTP theme={null}
    PATCH https://api.useparagon.com/projects/PROJECT_ID/sdk/me

    // Headers
    Authorization: PARAGON_USER_TOKEN
    Content-Type: application/json

    // Body
    { ...metadata }
    ```

    **Arguments:**

    <ParamField type="string">
      You can find your project ID in the Overview tab of any Integration
    </ParamField>

    <ParamField type="string">
      See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
    </ParamField>

    <ParamField type="object">
      Metadata object to associate with the authenticated user.
    </ParamField>
  </Tab>
</Tabs>

**Examples:**

<CodeGroup>
  ```typescript JavaScript SDK theme={null}
  paragon.setUserMetadata({
    Name: "Sean V",
    Email: "sean@useparagon.com",
    apiKey: "key_Y0kBVldPFInxK",
  });
  ```

  **Request**

  ```http icon="terminal" HTTP theme={null}
  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>

***

### .updateIntegrationUserSettings

Call `paragon.updateIntegrationUserSettings` to update any integration-level [User Settings](/connect-portal/workflow-user-settings) for your Connected User.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    paragon.updateIntegrationUserSettings(integrationType, userSettingsUpdate, options);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="string">
  An integration type string, like `salesforce`.
</ParamField>

<ParamField type="object">
  A partial update object where the keys are the `id` properties of User Settings objects (which you can get from [`paragon.getIntegrationConfig`](#getintegrationconfig)) and the values are the user's selection for the matching input type.

  Any keys that are not included in the object will not be updated.

  The type for each value will depend on the input type. See [Input Types Reference](/connect-portal/input-types-reference) to see the value type for each input.

  ```json Example theme={null}
  {
    "1f7474a5-8b8e-4c25-8d44-29f20aec3fe4": "general"
  }
  ```
</ParamField>

<ParamField type="CredentialConfigOptions | undefined">
  Optionally specify a Credential and Configuration to target, if using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization) or [Multi-Configuration](/apis/api-reference/multi-configuration).

  <Accordion title="Show child properties">
    <ParamField type="string">
      The Credential ID (a UUID) of the connected account you want to update, if using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization).
    </ParamField>

    <ParamField type="string">
      The Configuration ID (a UUID or an External ID prefixed with `ext:`), if using [Multi-Configuration](/apis/api-reference/multi-configuration).
    </ParamField>
  </Accordion>
</ParamField>

***

### .getDataSourceOptions

Call `paragon.getDataSourceOptions` to get configuration details for **compound** data sources used for dynamic [User Settings types](/connect-portal/headless-connect-portal#exposing-user-settings) in the Headless Connect Portal.

Compound data sources, for Field Mapping and Combo Dropdown inputs, have multiple data sources within them (Field Mappings have both Object Types and Field Names as sources).

To load options for a data source, see [`paragon.getFieldOptions`](#getfieldoptions).

<Info>
  **SDK 2.3.0+:** Consider using [`paragon.getSourcesForInput`](#getsourcesforinput) instead, which provides a simpler way to get all data sources needed for any input type in a single call.
</Info>

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript  theme={null}
    await paragon.getDataSourceOptions(integrationType, sourceType);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="string">
  An integration type string, like `salesforce`.
</ParamField>

<ParamField type="string">
  A source type string, which can be found in the `sourceType` property of a
  User Setting object from [`paragon.getIntegrationConfig`](#getintegrationconfig) or
  from `stage.options` of `PostOptionsStage`.
</ParamField>

**Examples:**

<CodeGroup>
  ```javascript icon="js" JavaScript SDK (Field Mapping) expandable theme={null}
  await paragon.getDataSourceOptions(
    "salesforce",
    "customObjectMapping",
  );

  // Returns:
  {
    "id": "customObjectMapping",
    "type": "FIELD_MAPPER_DATA_SOURCE",
    "title": "Field Mapping",
    "subtitle": "Allows users to define a field mapping",
    "recordSource": {
      "type": "DYNAMIC_DATA_SOURCE",
      "title": "Record Type",
      "cacheKey": "recordTypes",
    },
    "fieldSource": {
      "type": "DYNAMIC_DATA_SOURCE",
      "title": "Field",
      "cacheKey": "cachedFields",
    },
  }
  ```

  ```javascript icon="js" JavaScript SDK (Combo Dropdown) expandable theme={null}
  await paragon.getDataSourceOptions(
    "jira",
    "projectIssueStatusTypeCombo",
  );

  // Returns:
  {
    "id": "projectIssueStatusTypeCombo",
    "type": "COMBO_INPUT_DATA_SOURCE",
    "title": "Issue Status",
    "subtitle": "The stage the issue is at, e.g. To Do or Done",
    "mainInputSource": {
      "type": "DYNAMIC_DATA_SOURCE",
      "cacheKey": "projects",
      "title": "Project",
      "subtitle": "Jira project that issues can be created in",
    },
    "dependentInputSource": {
      "type": "DYNAMIC_DATA_SOURCE",
      "cacheKey": "issueIssueStatusByProject",
      "title": "Issue Status",
      "subtitle": "The stage the issue is at, e.g. To Do or Done",
    }
  }
  ```
</CodeGroup>

***

### .getFieldOptions

Load options from an integration data source for dynamic [User Settings types](/connect-portal/headless-connect-portal#exposing-user-settings) in the Headless Connect Portal, using the Connected User's account.

**`paragon.getFieldOptions` can only be called for data sources with type `DYNAMIC_DATA_SOURCE`** (for dynamic enum input types).

* Compound data sources like `FIELD_MAPPER_DATA_SOURCE` or `COMBO_INPUT_DATA_SOURCE` are composed of `DYNAMIC_DATA_SOURCE`-type sources.

* When rendering Field Mapping or Combo Dropdown inputs, first identify each data source with [`paragon.getSourcesForInput`](#getsourcesforinput) (or [`paragon.getDataSourceOptions`](#getdatasourceoptions)), and use the returned data source configuration to call `paragon.getFieldOptions`. [See a full example.](/connect-portal/headless-connect-portal#exposing-user-settings)

This function supports search and pagination; see the parameters for `fieldOptions` below to learn more.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript SDK (Field Mapping) theme={null}
      await paragon.getFieldOptions(fieldOptions);
    ```

    **Arguments:**

    <ParamField type="FieldOptions">
      <Expandable title="child properties">
        <ParamField type="string">
          An integration type string, like `salesforce`.
        </ParamField>

        <ParamField type="string">
          A source type string, which can be found in the `sourceType` property of a User Setting object from [`paragon.getIntegrationConfig`](#getintegrationconfig) or from `stage.options` of `PostOptionsStage`.

          Either `action` or `source` must be provided.
        </ParamField>

        <ParamField type="DynamicDataSource">
          A `DynamicDataSource` object, as returned by [`paragon.getSourcesForInput`](#getsourcesforinput). When provided, the `cacheKey` of the source is used to identify the data source to load options from.

          Either `action` or `source` must be provided.
        </ParamField>

        <ParamField type="string">
          A user-provided search query for an option. When provided, the data source will return options that match this query.
        </ParamField>

        <ParamField type="string">
          A page cursor to use to load subsequent pages of results. The response of `paragon.getFieldOptions` will provide `nextPageCursor` to use or `null` if there are no more results.
        </ParamField>

        <ParamField type="Parameter[]">
          When loading options for a compound data source (e.g. `fieldSource` of a Field Mapping input or `dependentInputSource` of a Combo Dropdown input), pass parameters with the user's selection from the first input (e.g. the Record Type for Field Mapping).

          <Expandable title="child properties">
            <ParamField type="string">
              The `cacheKey` property of the primary/first input in the compound data sources (e.g. `recordSource` of a Field Mapping input or `mainInputSource` of a Combo Dropdown input).
            </ParamField>

            <ParamField type="string">
              <Expandable title="child properties">
                <ParamField type="const">
                  Set this to `"VALUE"`.
                </ParamField>

                <ParamField type="string">
                  Set this to the `value` property of the user's selection.
                </ParamField>
              </Expandable>
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField type="string">
          If you are using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization) and there may be more than one account connected for a given integration, pass `selectedCredentialId` to load options for the current account.
        </ParamField>
      </Expandable>
    </ParamField>
  </Tab>

  <Tab title="REST API" icon="terminal">
    ```http icon="terminal" HTTP theme={null}
    POST https://api.useparagon.com/projects/PROJECT_ID/sdk/actions

    Authorization: Bearer PARAGON_USER_TOKEN
    Content-Type: application/json

    {
      ...fieldOptions
    }
    ```

    **Arguments:**

    <ParamField type="string">
      You can find your project ID in the Overview tab of any Integration
    </ParamField>

    <ParamField type="string">
      See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
    </ParamField>

    <ParamField type="FieldOptions">
      <Expandable title="child properties">
        <ParamField type="string">
          An integration type string, like `salesforce`.
        </ParamField>

        <ParamField type="string">
          A source type string, which can be found in the `sourceType` property of a User Setting object from [`paragon.getIntegrationConfig`](#getintegrationconfig) or from `stage.options` of `PostOptionsStage`.

          Either `action` or `source` must be provided.
        </ParamField>

        <ParamField type="DynamicDataSource">
          A `DynamicDataSource` object, as returned by [`paragon.getSourcesForInput`](#getsourcesforinput). When provided, the `cacheKey` of the source is used to identify the data source to load options from.

          Either `action` or `source` must be provided.
        </ParamField>

        <ParamField type="string">
          A user-provided search query for an option. When provided, the data source will return options that match this query.
        </ParamField>

        <ParamField type="string">
          A page cursor to use to load subsequent pages of results. The response of `paragon.getFieldOptions` will provide `nextPageCursor` to use or `null` if there are no more results.
        </ParamField>

        <ParamField type="Parameter[]">
          When loading options for a compound data source (e.g. `fieldSource` of a Field Mapping input or `dependentInputSource` of a Combo Dropdown input), pass parameters with the user's selection from the first input (e.g. the Record Type for Field Mapping).

          <Expandable title="child properties">
            <ParamField type="string">
              The `cacheKey` property of the primary/first input in the compound data sources (e.g. `recordSource` of a Field Mapping input or `mainInputSource` of a Combo Dropdown input).
            </ParamField>

            <ParamField type="string">
              <Expandable title="child properties">
                <ParamField type="const">
                  Set this to `"VALUE"`.
                </ParamField>

                <ParamField type="string">
                  Set this to the `value` property of the user's selection.
                </ParamField>
              </Expandable>
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField type="string">
          If you are using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization) and there may be more than one account connected for a given integration, pass `selectedCredentialId` to load options for the current account.
        </ParamField>
      </Expandable>
    </ParamField>
  </Tab>
</Tabs>

**Returns:**

<ParamField type="Option[] | Section[]">
  <Expandable title="child properties">
    `data` will be an Array of either `Option` or `Section` objects, which should be handled by your Dropdown input.

    <Tabs>
      <Tab title="Option">
        <ParamField type="string">
          The human-readable display name to use for this option when displaying
          it to your user.
        </ParamField>

        <ParamField type="string">
          The unique value of this option to save with `paragon.setPreOptions`,
          `paragon.setPostOptions`, `paragon.updateIntegrationUserSettings`, or
          `paragon.updateWorkflowUserSettings`. This value can also be passed as
          `parameters[].source.value` for dependent inputs of compound data
          sources.
        </ParamField>
      </Tab>

      <Tab title="Section">
        <ParamField type="string">
          The title of this section of options.
        </ParamField>

        <ParamField type="Option[]">
          The list of options that should be contained in this section.
        </ParamField>
      </Tab>
    </Tabs>
  </Expandable>
</ParamField>

<ParamField type="object[]">
  This section is an empty array for all input types except for **Default value mapping**, which is only supported by Jira: Issue Field Values.
</ParamField>

<ParamField type="string | null">
  The cursor value to pass as `cursor` for the next page of results.
</ParamField>

**Examples:**

<CodeGroup>
  ```javascript icon="js" JavaScript SDK expandable theme={null}
  await paragon.getFieldOptions({
    integration: "slack",
    action: "channels",
    search: "general",
  });

  // Returns:
  {
    "data": [
      {
        "label": "#general",
        "value": "general"
      },
    ],
    "nestedData": [],
    "nextPageCursor": "dGVhbTpDMDUxWjlNSzk4Vw=="
  }
  ```

  ```javascript icon="js" JavaScript SDK (Field Mapping) expandable theme={null}
  // Load Record Types:
  await paragon.getFieldOptions({
    integration: "salesforce",
    action: "recordTypes", // from `recordSource.cacheKey` of data source options
  });

  // Load Fields: 
  await paragon.getFieldOptions({
    integration: "salesforce",
    action: "cachedFields", // from `fieldSource.cacheKey` of data source options
    parameters: [{
      "key": "recordTypes",
      "source": {
        "type": "VALUE",
        "value": "Task" // The `value` property of the user's input
      }
    }],
  });
  ```

  REST API

  ```http icon="terminal" HTTP theme={null}
  POST https://api.useparagon.com/projects/<Paragon Project ID>/sdk/actions

  Authorization: Bearer <Paragon User Token>
  Content-Type: application/json

  {
    "action": "salesforce",
    "sourceKey": "cachedFields",
    "parameters": [{
      "key": "recordTypes",
      "source": {
        "type": "VALUE",
        "value": "Task"
      }
    }],
    "paginationParameters": {
      "pageCursor": 0,
      "search": ""
    }
  }
  ```
</CodeGroup>

***

### .getSourcesForInput

Call `paragon.getSourcesForInput` to get all the data sources needed to render a dynamic input (e.g. a picklist loaded from integration data from the user's connected account).

The returned data sources can be passed directly to [`paragon.getFieldOptions`](#getfieldoptions) using the `source` parameter to load options for your input, with pagination and search.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    const config = paragon.getIntegrationConfig(integrationType, input);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="string">
  An integration type string, like `salesforce`.
</ParamField>

<ParamField type="Input">
  The input object from `availableUserSettings`, `availableWorkflows[n].inputs`, or `stage.options` of an install flow stage.
</ParamField>

**Returns:**

Returns `null` for inputs that don't require a data source (e.g. text inputs). Otherwise, returns one of the following based on the [Input Type](/connect-portal/input-types-reference) of the input:

<Tabs>
  <Tab title="SingleSource">
    Returned for [`DynamicEnum`](/connect-portal/input-types-reference) and [`CustomDropdown`](/connect-portal/input-types-reference) input types.

    <ParamField type="const">
      `"single"` for SingleSource.
    </ParamField>

    <ParamField type="DynamicDataSource | StaticEnumDataSource">
      The data source for the input. Pass this to [`paragon.getFieldOptions`](#getfieldoptions) using the `source` parameter to load options.
    </ParamField>

    **Example:**

    ```javascript icon="js" DynamicEnum input expandable theme={null}
    const config = paragon.getIntegrationConfig("slack");
    const input = config.availableUserSettings[0];
    // { id: "...", type: "DYNAMIC_ENUM", title: "Channel", sourceType: "channels" }

    const sources = paragon.getSourcesForInput("slack", input);
    // { kind: "single", source: { type: "DYNAMIC_DATA_SOURCE", cacheKey: "channels", ... } }

    if (sources?.kind === "single") {
      const options = await paragon.getFieldOptions({
        integration: "slack",
        source: sources.source,
      });
      // { data: [{ label: "#general", value: "general" }, ...], nextPageCursor: "..." }
    }
    ```
  </Tab>

  <Tab title="FieldMapperSources">
    Returned for [`FieldMapper`](/connect-portal/input-types-reference) input types.

    <ParamField type="const">
      `"fieldMapper"` for FieldMapperSources.
    </ParamField>

    <ParamField type="DynamicDataSource">
      The data source for loading record types. Pass to [`paragon.getFieldOptions`](#getfieldoptions) to load record type options.
    </ParamField>

    <ParamField type="DynamicDataSource">
      The data source for loading fields. Pass to [`paragon.getFieldOptions`](#getfieldoptions) with `parameters` for the selected record type to load available fields.
    </ParamField>

    <ParamField type="DynamicDataSource">
      An optional data source for a dependent input within the field mapping.
    </ParamField>

    <ParamField type="DynamicMappingOptions | DynamicMappingField[]">
      Pre-configured field mapping options, if provided via [`paragon.setDataSources`](#setdatasources).
    </ParamField>

    **Example:**

    ```javascript icon="js" FieldMapper input expandable theme={null}
    const config = paragon.getIntegrationConfig("salesforce");
    const input = config.availableUserSettings[0];
    // { id: "...", type: "FIELD_MAPPER", title: "Map fields", sourceType: "customObjectMapping" }

    const sources = paragon.getSourcesForInput("salesforce", input);
    // { kind: "fieldMapper", recordSource: {...}, fieldSource: {...} }

    if (sources?.kind === "fieldMapper") {
      // Load record types
      const recordTypes = await paragon.getFieldOptions({
        integration: "salesforce",
        source: sources.recordSource,
      });

      // Load fields for a selected record type
      const fields = await paragon.getFieldOptions({
        integration: "salesforce",
        source: sources.fieldSource,
        parameters: [{
          key: sources.recordSource.cacheKey,
          source: { type: "VALUE", value: "Task" },
        }],
      });
    }
    ```
  </Tab>

  <Tab title="ComboSources">
    Returned for [`ComboInput`](/connect-portal/input-types-reference) input types (e.g. Combo Dropdown).

    <ParamField type="const">
      `"combo"` for ComboSources.
    </ParamField>

    <ParamField type="DynamicDataSource">
      The data source for the primary input. Pass to [`paragon.getFieldOptions`](#getfieldoptions) to load main options.
    </ParamField>

    <ParamField type="DynamicDataSource">
      The data source for the dependent input. Pass to [`paragon.getFieldOptions`](#getfieldoptions) with `parameters` for the user's main selection.
    </ParamField>

    **Example:**

    ```javascript icon="js" ComboInput expandable theme={null}
    const config = paragon.getIntegrationConfig("jira");
    const input = config.availableUserSettings[0];
    // { id: "...", type: "COMBO_INPUT", sourceType: "projectIssueStatusTypeCombo" }

    const sources = paragon.getSourcesForInput("jira", input);
    // { kind: "combo", mainInputSource: {...}, dependentInputSource: {...} }

    if (sources?.kind === "combo") {
      // Load main options (e.g. Projects)
      const projects = await paragon.getFieldOptions({
        integration: "jira",
        source: sources.mainInputSource,
      });

      // Load dependent options (e.g. Issue Statuses for a selected Project)
      const statuses = await paragon.getFieldOptions({
        integration: "jira",
        source: sources.dependentInputSource,
        parameters: [{
          key: sources.mainInputSource.cacheKey,
          source: { type: "VALUE", value: "PROJECT-1" },
        }],
      });
    }
    ```
  </Tab>

  <Tab title="DefaultFieldValueSources">
    Returned for [`DynamicComboInput`](/connect-portal/input-types-reference) input types.

    <ParamField type="const">
      `"defaultFieldValue"` for DefaultFieldValueSources.
    </ParamField>

    <ParamField type="DynamicDataSource">
      The data source for the primary input. Pass to [`paragon.getFieldOptions`](#getfieldoptions) to load main options.
    </ParamField>

    <ParamField type="DynamicDataSource">
      The data source for the dependent input. Pass to [`paragon.getFieldOptions`](#getfieldoptions) with `parameters` for the user's main selection.
    </ParamField>

    <ParamField type="DynamicDataSource">
      An optional data source for a variable input.
    </ParamField>

    **Example:**

    ```javascript icon="js" DynamicComboInput expandable theme={null}
    const config = paragon.getIntegrationConfig("salesforce");
    const input = config.availableUserSettings[0];
    // { id: "...", type: "DYNAMIC_COMBO_INPUT", sourceType: "dynamicComboAction" }

    const sources = paragon.getSourcesForInput("salesforce", input);
    // { kind: "defaultFieldValue", mainInputSource: {...}, dependentInputSource: {...}, variableInputSource: {...} }

    if (sources?.kind === "defaultFieldValue") {
      const mainOptions = await paragon.getFieldOptions({
        integration: "salesforce",
        source: sources.mainInputSource,
      });

      const dependentOptions = await paragon.getFieldOptions({
        integration: "salesforce",
        source: sources.dependentInputSource,
        parameters: [{
          key: sources.mainInputSource.cacheKey,
          source: { type: "VALUE", value: mainOptions.data[0].value },
        }],
      });
    }
    ```
  </Tab>
</Tabs>

***

### .setDataSources

Call `paragon.setDataSources` to register custom data sources for dropdown and field mapping inputs when using the [Headless Connect Portal](/connect-portal/headless-connect-portal). This can be used in place of passing `dropdowns` and `mapObjectFields` inline with `paragon.connect`, for Headless Connect Portal implementations.

Data sources can be registered globally (applied to all integrations) or for specific integrations. When an integration-specific source exists, it takes priority over a global source with the same key.

This function should be called once after [`paragon.setHeadless`](#setheadless) and before rendering any inputs.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    paragon.setDataSources(config);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="SetDataSourcesConfig">
  <Expandable title="child properties">
    <ParamField type="Record<string, CustomDropdownField[] | CustomDropdownOptions>">
      Global custom dropdown data sources, keyed by the dropdown `key` identifier. Values can be either a static array of `CustomDropdownField[]` options (objects with `label` and `value` strings), or a `CustomDropdownOptions` object for dynamic loading:

      ```javascript icon="js" Static dropdown options theme={null}
      paragon.setDataSources({
        dropdowns: {
          my_custom_dropdown: [
            { label: "Option A", value: "a" },
            { label: "Option B", value: "b" },
          ],
        },
      });
      ```

      <Expandable title="child properties (CustomDropdownOptions)">
        <ParamField type="(cursor?: string, search?: string) => Promise<{ options: CustomDropdownField[], nextPageCursor: string | null }>">
          A function that returns dropdown options with support for pagination and search. Called by the SDK when options need to be loaded or refreshed.
        </ParamField>

        <ParamField type="boolean">
          If `true`, the dropdown options will be reloaded every time the dropdown is opened. Useful for dependent dropdowns where options depend on other input values. Defaults to `false`.
        </ParamField>

        ```javascript icon="js" Dynamic dropdown with loader expandable theme={null}
        paragon.setDataSources({
          dropdowns: {
            my_dynamic_dropdown: {
              loadOptions: async (cursor, search) => {
                const response = await fetch(`/api/options?cursor=${cursor}&search=${search}`);
                const data = await response.json();
                return {
                  options: data.items,
                  nextPageCursor: data.nextCursor,
                };
              },
            },
          },
        });
        ```
      </Expandable>
    </ParamField>

    <ParamField type="Record<string, DynamicMappingField[] | DynamicMappingOptions | DynamicFieldMappingConfig>">
      Global field mapping data sources, keyed by field mapping name. Values can be one of the following:

      <Expandable title="child properties (DynamicMappingField)">
        **Option 1: `DynamicMappingField[]`** - Static array of mapping options.

        <ParamField type="string">
          The display label for the field.
        </ParamField>

        <ParamField type="string">
          The value identifier for the field.
        </ParamField>
      </Expandable>

      <Expandable title="child properties (DynamicMappingOptions)">
        **Option 2: `DynamicMappingOptions`** — Configurable mapping behavior with static fields.

        <ParamField type="DynamicMappingField[]">
          The list of available fields (objects with `label` and `value` strings).
        </ParamField>

        <ParamField type="string[]">
          Field values that should be selected by default.
        </ParamField>

        <ParamField type="boolean">
          Whether users can remove field mappings.
        </ParamField>

        <ParamField type="boolean">
          Whether users can create new fields.
        </ParamField>
      </Expandable>

      <Expandable title="child properties (DynamicFieldMappingConfig)">
        **Option 3: `DynamicFieldMappingConfig`** — Fully dynamic field mapping with loader functions for fetching object types and fields at runtime.

        <ParamField type="(cursor?: string, search?: string) => Promise<{ options: { label: string, value: string }[], nextPageCursor: string | null }>">
          A loader function to fetch available object types with pagination and search support.
        </ParamField>

        <ParamField type="(params: { objectType: string }, cursor?: string, search?: string) => Promise<{ options: { label: string, value: string }[], nextPageCursor: string | null }>">
          A loader function to fetch available fields for a given object type with pagination and search support.
        </ParamField>

        <ParamField type="object">
          Optional configuration for application-side fields.

          <Expandable title="child properties">
            <ParamField type="{ label: string, value: string }[]">
              The list of application fields available for mapping.
            </ParamField>

            <ParamField type="string[]">
              Field values that should be selected by default.
            </ParamField>

            <ParamField type="boolean">
              Whether users can remove field mappings.
            </ParamField>

            <ParamField type="boolean">
              Whether users can create new fields.
            </ParamField>
          </Expandable>
        </ParamField>

        ```javascript icon="js" Field mapping with BYO loaders expandable theme={null}
        paragon.setDataSources({
          mapObjectFields: {
            myFieldMapping: {
              objectTypes: {
                get: async (cursor, search) => {
                  const response = await fetch(`/api/object-types?cursor=${cursor}&search=${search}`);
                  const data = await response.json();
                  return { options: data.items, nextPageCursor: data.nextCursor };
                },
              },
              integrationFields: {
                get: async ({ objectType }, cursor, search) => {
                  const response = await fetch(
                    `/api/fields?objectType=${objectType}&cursor=${cursor}&search=${search}`
                  );
                  const data = await response.json();
                  return { options: data.items, nextPageCursor: data.nextCursor };
                },
              },
              applicationFields: {
                fields: [
                  { label: "Name", value: "name" },
                  { label: "Email", value: "email" },
                ],
              },
            },
          },
        });
        ```
      </Expandable>
    </ParamField>

    <ParamField type="Record<string, { dropdowns?, mapObjectFields? }>">
      Integration-specific data sources that take priority over global sources. Keyed by integration type (e.g. `"salesforce"`), with the same `dropdowns` and `mapObjectFields` structure.

      ```javascript icon="js" Integration-specific sources expandable theme={null}
      paragon.setDataSources({
        dropdowns: {
          departments: [
            { label: "Engineering", value: "eng" },
            { label: "Sales", value: "sales" },
          ],
        },
        integrationSpecificSources: {
          salesforce: {
            dropdowns: {
              departments: [
                { label: "Engineering", value: "engineering" },
                { label: "Sales", value: "sales-dept" },
                { label: "Marketing", value: "marketing" },
              ],
            },
          },
        },
      });
      ```
    </ParamField>
  </Expandable>
</ParamField>

***

### .enableWorkflow

Call `paragon.enableWorkflow` to turn on a workflow for a user by ID.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript  theme={null}
    paragon.enableWorkflow(workflowId);
    ```

    **Arguments:**

    <ParamField type="string">
      Workflow ID
    </ParamField>
  </Tab>

  <Tab title="REST API" icon="terminal">
    ```http icon="terminal" HTTP theme={null}
    POST https://api.useparagon.com/projects/PROJECT_ID/sdk/workflows/WORKFLOW_ID

    Authorization: Bearer PARAGON_USER_TOKEN
    ```

    **Arguments:**

    <ParamField type="string">
      You can find your project ID in the Overview tab of any Integration
    </ParamField>

    <ParamField type="string">
      Workflow ID
    </ParamField>

    <ParamField type="string">
      See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
    </ParamField>
  </Tab>
</Tabs>

***

### .disableWorkflow

Call `paragon.disableWorkflow` to turn off a workflow for a user by ID.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript  theme={null}
    paragon.disableWorkflow(workflowId);
    ```

    **Arguments:**

    <ParamField type="string">
      Workflow ID
    </ParamField>
  </Tab>

  <Tab title="REST API" icon="terminal">
    ```http icon="terminal" HTTP theme={null}
    DELETE https://api.useparagon.com/projects/PROJECT_ID/sdk/workflows/WORKFLOW_ID

    Authorization: Bearer PARAGON_USER_TOKEN
    ```

    **Arguments:**

    <ParamField type="string">
      You can find your project ID in the Overview tab of any Integration
    </ParamField>

    <ParamField type="string">
      Workflow ID
    </ParamField>

    <ParamField type="string">
      See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
    </ParamField>
  </Tab>
</Tabs>

***

### .updateWorkflowState

Call `paragon.updateWorkflowState` to enable or disable workflows for a user.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    paragon.updateWorkflowState(workflowStateUpdate, options);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="object">
  A partial update object where keys are workflow IDs and values are `true` or `false`. Any workflow IDs not included in this object will not be updated in this call.

  ```javascript icon="js" on Example theme={null}
  {
    "bb89897b-ec2a-4118-b091-c12713c6bffa": true,
    "487c67e1-bc3f-406e-acc4-085f897dc564": false,
  }
  ```
</ParamField>

<ParamField type="CredentialConfigOptions | undefined">
  Optionally specify a Credential and Configuration to target, if using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization) or [Multi-Configuration](/apis/api-reference/multi-configuration).

  <Accordion title="Show child properties">
    <ParamField type="string">
      The Credential ID (a UUID) of the connected account you want to update, if using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization).
    </ParamField>

    <ParamField type="string">
      The Configuration ID (a UUID or an External ID prefixed with `ext:`), if using [Multi-Configuration](/apis/api-reference/multi-configuration).
    </ParamField>
  </Accordion>
</ParamField>

***

### .updateWorkflowUserSettings

Call `paragon.updateWorkflowUserSettings` to update any workflow-level [User Settings](/connect-portal/workflow-user-settings) for your Connected User.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    paragon.updateWorkflowUserSettings(integrationType, workflowId, userSettingsUpdate, options);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="string">
  An integration type string, like `salesforce`.
</ParamField>

<ParamField type="string">
  The ID of the Workflow that the workflow-level User Setting you are modifying belongs to. If you are trying to modify an integration-level User Setting, call [`paragon.updateIntegrationUserSettings`](#updateintegrationusersettings) instead.
</ParamField>

<ParamField type="object">
  A partial update object where the keys are the `id` properties of User Settings objects (which you can get from [`paragon.getIntegrationConfig`](#getintegrationconfig)) and the values are the user's selection for the matching input type.

  Any keys that are not included in the object will not be updated.

  The type for each value will depend on the input type. See [Input Types Reference](/connect-portal/input-types-reference) to see the value type for each input.

  ```json Example theme={null}
  {
    "1f7474a5-8b8e-4c25-8d44-29f20aec3fe4": "general"
  }
  ```
</ParamField>

<ParamField type="CredentialConfigOptions | undefined">
  Optionally specify a Credential and Configuration to target, if using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization) or [Multi-Configuration](/apis/api-reference/multi-configuration).

  <Accordion title="Show child properties">
    <ParamField type="string">
      The Credential ID (a UUID) of the connected account you want to update, if using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization).
    </ParamField>

    <ParamField type="string">
      The Configuration ID (a UUID or an External ID prefixed with `ext:`), if using [Multi-Configuration](/apis/api-reference/multi-configuration).
    </ParamField>
  </Accordion>
</ParamField>

***

### .getCustomWebhookUserManualUrl

If you are using [Custom Webhooks](/resources/custom-webhooks) with a User-Level URL and [Manual Setup](/resources/custom-webhooks#option-2%3A-manual-setup), you can use `paragon.getCustomWebhookUserManualUrl` to construct the user-specific URL that must be registered by your customer in the integration to complete webhook setup.

There is no API endpoint available for this method. However, you can construct the user-specific URL without the JavaScript SDK as described in the [Custom Webhooks docs](/resources/custom-webhooks#user-specific-webhook-target-urls).

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    // Present this value to your user to register this webhook in their account manually
    const webhookUrl = paragon.getCustomWebhookUserManualUrl(workflowId, credentialId);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="string">
  The ID of a Workflow that utilizes this Custom Webhook. If the same Custom Webhook is used in multiple Workflows, any one of these workflows can be used as `workflowId`.
</ParamField>

<ParamField type="string">
  If you are using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization) and there may be more than one account connected for a given integration, pass the `credentialId` to ensure that received events are routed to the correct account.
</ParamField>

***

### .workflow

Call `paragon.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.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    await paragon.workflow(workflowId, options);
    ```

    **Arguments:**

    <ParamField type="string">
      The ID of the workflow to trigger.
    </ParamField>

    <ParamField type="FetchOptions">
      <Expandable title="Optional FetchOptions">
        <ParamField type="object">
          The request body to pass to the workflow trigger.
        </ParamField>
      </Expandable>
    </ParamField>

    **Example:**

    ```javascript icon="js" theme={null}
    paragon.authenticate(PROJECT_ID, PARAGON_USER_TOKEN);

    await paragon.workflow(WORKFLOW_ID, {
      "body": {
        "email": "bowie@useparagon.com",
        "first_name": "Bowie",
        "last_name": "Foo"
      }
    });
    ```
  </Tab>

  <Tab title="REST API" icon="terminal">
    ```http icon="terminal" HTTP theme={null}
    POST https://api.useparagon.com/projects/PROJECT_ID/sdk/triggers/WORKFLOW_ID

    Authorization: Bearer PARAGON_USER_TOKEN
    Content-Type: application/json

    {
      ...options
    }
    ```

    **Arguments:**

    <ParamField type="string">
      You can find your project ID in the Overview tab of any Integration
    </ParamField>

    <ParamField type="string">
      The ID of the workflow to trigger.
    </ParamField>

    <ParamField type="string">
      See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
    </ParamField>

    <ParamField type="FetchOptions">
      <Expandable title="Optional FetchOptions">
        <ParamField type="object">
          The request body to pass to the workflow trigger.
        </ParamField>
      </Expandable>
    </ParamField>

    **Example:**

    ```http icon="terminal" HTTP theme={null}
    POST https://api.useparagon.com/projects/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"
    }
    ```
  </Tab>
</Tabs>

***

### .request

Call `paragon.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`.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    await paragon.request(integrationType, path, requestOptions);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="string">
  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.
</ParamField>

<ParamField type="string">
  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.
</ParamField>

<ParamField type="object">
  Optional request options to include:

  <Expandable title="child properties">
    <ParamField type="object">
      An object representing JSON contents of the request.
    </ParamField>

    <ParamField type="string">
      An HTTP verb such as "GET" or "POST". Defaults to GET.
    </ParamField>

    <ParamField type="object">
      Additional HTTP headers to include in the request.
    </ParamField>
  </Expandable>

  If `requestOptions` is omitted, the SDK issues a `GET` request without a body.
</ParamField>

The function returns a promise for the request output, which will have a shape that varies depending on the integration and API endpoint.

**Examples:**

<CodeGroup>
  ```typescript JavaScript SDK theme={null}
  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 :)
  ```

  ```http icon="terminal" HTTP theme={null}
  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>

***

### .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="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    var eventName = "Contact Created";
    var eventPayload = { "name": "Brandon", "email": "b@useparagon.com" };

    paragon.event(eventName, payload);
    ```

    **Arguments:**

    <ParamField type="string">
      The event name defined in your App Event
    </ParamField>

    <ParamField type="object">
      The event payload that should match the event schema defined in your App Event
    </ParamField>
  </Tab>

  <Tab title="REST API" icon="terminal">
    ```http icon="terminal" HTTP theme={null}
    POST https://api.useparagon.com/projects/PROJECT_ID/sdk/events/trigger

    Authorization: Bearer PARAGON_USER_TOKEN
    Content-Type: application/json

    {
        "name": "Contact Created",
        "payload": {
            "name": "Brandon",
            "email": "b@useparagon.com"
        }
    }
    ```

    **Arguments:**

    <ParamField type="string">
      You can find your project ID in the Overview tab of any Integration
    </ParamField>

    <ParamField type="string">
      See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
    </ParamField>

    <ParamField type="string">
      The event name defined in your App Event
    </ParamField>

    <ParamField type="object">
      The event payload that should match the event schema defined in your App Event
    </ParamField>
  </Tab>
</Tabs>

When sending live events from your application, Paragon will not validate that your event payload matches the defined event schema.

***

### .setHeadless

Call `paragon.setHeadless` to enable or disable Headless mode for the SDK. When headless mode is enabled, the SDK will not render the Connect Portal UI and will instead expose functions for you to build your own UI.

```javascript icon="js" JavaScript theme={null}
paragon.setHeadless(true);
```

This should be called once after SDK initialization. See the [Headless Connect Portal](/connect-portal/headless-connect-portal) guide for more details.

***

## API Only

### `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`)

You can use [`paragon.getIntegrationMetadata`](#getintegrationmetadata) and [`paragon.getIntegrationConfig`](#getintegrationconfig) when using the JavaScript SDK.

```http icon="terminal" HTTP expandable theme={null}
GET https://api.useparagon.com/projects/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",
  "projectId": "908f4c5e-6394-46a5-9355-3f729edbd160",
  "customIntegrationId": null,
  "type": "slack",
  "isActive": true,
  "configs": [
    {
      "id": "3ebcc179-a1a6-447f-8dc9-5017f40f08ef",
      "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",
      "description": "Send Updates to Slack",
      "projectId": "908f4c5e-6394-46a5-9355-3f729edbd160",
      "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"
}]
```

**Arguments:**

<ParamField type="string">
  You can find your project ID in the Overview tab of any Integration
</ParamField>

<ParamField type="string">
  See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
</ParamField>

### `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).

* 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.

```http icon="terminal" HTTP theme={null}
GET https://api.useparagon.com/projects/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"
}]
```

**Arguments:**

<ParamField type="string">
  You can find your project ID in the Overview tab of any Integration
</ParamField>

<ParamField type="string">
  See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
</ParamField>

### `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-users-connect-credentials)).

Alternatively, you can use the SDK to update User Settings or workflow enablements:

* [`paragon.updateIntegrationUserSettings`](/apis/api-reference#updateintegrationusersettings): Update integration-level User Settings.
* [`paragon.updateWorkflowUserSettings`](/apis/api-reference#updateworkflowusersettings): Update workflow-level User Settings.
* [`paragon.updateWorkflowState`](/apis/api-reference#updateworkflowstate): Update workflow enablements.

```http icon="terminal" HTTP theme={null}
PATCH https://api.useparagon.com/projects/PROJECT_ID/sdk/credentials/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": {...}
    }
}
```

**Arguments:**

<ParamField type="string">
  You can find your project ID in the Overview tab of any Integration
</ParamField>

<ParamField type="string">
  The ID of the Connect credential to update. Retrieve it from the [`/sdk/credentials`](/apis/api-reference#get-users-connect-credentials) endpoint.
</ParamField>

<ParamField type="string">
  See [Setup](/getting-started/installing-the-connect-sdk) for how to encode your user token
</ParamField>

<ParamField type="object">
  The configuration object to update. This will replace the existing `config` property entirely, so you must provide the full existing value with your intended changes applied.
</ParamField>

**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.

## Headless Connect installFlow

Use `paragon.installFlow` when implementing the [Headless Connect Portal](/connect-portal/headless-connect-portal) to guide your user through the installation process for an integration.

**InstallFlowStage:**

These are the possible install flow stages received in the `onNext` callback of `InstallFlow` that should be rendered by your app to guide the user through the installation process.

<Tabs>
  <Tab title="AccountTypeStage">
    In the `AccountTypeStage`, the user should be prompted with a list of account types that they can choose from.

    If you want to skip this stage, pass the first account type option (or `"default"`) to `paragon.installFlow.setAccountType` to move to the next stage.

    ```javascript icon="js" Example (Salesforce) theme={null}
    {
      "stage": "accountType",
      "options": [
        { "id": "default", "accountDescription": "Production Account" },
        { "id": "sandbox", "accountDescription": "Sandbox Account"}
      ]
    }
    ```

    <ParamField type="const">
      `"accountType"` for AccountTypeStage.
    </ParamField>

    <ParamField type="AccountType[]">
      The list of account types that the user can choose from.

      <Expandable title="child properties">
        <ParamField type="string">
          The ID of the account type. Pass this to `paragon.installFlow.setAccountType` when the user selects an option.
        </ParamField>

        <ParamField type="string">
          The human-readable description of the account type.
        </ParamField>
      </Expandable>
    </ParamField>
  </Tab>

  <Tab title="PreOptionsStage">
    In the `PreOptionsStage`, the user should be prompted with inputs to collect the necessary details for API key authorization or for the next OAuth stage in the flow.

    ```javascript icon="js" Example (Shopify) theme={null}
    {
      "stage": "preOptions",
      "options": [
        {
          "id": "SHOP_NAME",
          "title": "Enter your Shopify username",
          "subtitle": "Enter your Shopify username, e.g. https://<username>.myshopify.com.",
          "placeholder": "username",
          "type": "TEXT_NO_VARS"
        }
      ]
    }
    ```

    <ParamField type="const">
      `"preOptions"` for PreOptionsStage.
    </ParamField>

    <ParamField type="InputType[]">
      The list of inputs to prompt the user with in this stage. You can see a full list of input types that are used by the Connect Portal and must be rendered by your implementation in [Input Types Reference](/connect-portal/input-types-reference).

      <Expandable title="child properties">
        <ParamField type="string">
          Use the input `id` as the key of the object you pass to [`paragon.setPreOptions`](#installflowsetpreoptions). The value will be the input provided by the user.
        </ParamField>

        <ParamField type="enum">
          The type of this input, which will be one of the inputs in [Input Types Reference](/connect-portal/input-types-reference).
        </ParamField>

        <ParamField type="string">
          The title to display to the user to describe this input.
        </ParamField>

        <ParamField type="string">
          The descriptive text to display to the user to further describe or provide context to this input.
        </ParamField>

        <ParamField type="string">
          The placeholder or example value to display to the user.
        </ParamField>
      </Expandable>
    </ParamField>
  </Tab>

  <Tab title="PostOptionsStage">
    In the `PostOptionsStage`, the user should be prompted with inputs to finalize their account setup after the OAuth flow.

    ```javascript icon="js" Example (Jira) theme={null}
    {
      "stage": "postOptions",
      "credentialId": "987654-56a7-89b1-cd23-456789abcdef",
      "options": [
        {
          "id": "JIRA_CLOUD_ID",
          "type": "DYNAMIC_ENUM",
          "title": "Choose a Jira site to connect.",
          "subtitle": "The Jira site, where all operations will be performed.",
          "sourceType": "getAvailableSites",
          "required": true
        }
      ],
      "done": false
    }
    ```

    <ParamField type="const">
      `"postOptions"` for PostOptionsStage.
    </ParamField>

    <ParamField type="string">
      The ID of the credential that was created during the OAuth flow. Available once the credential has been created, so you can pass it to [`paragon.getFieldOptions`](#getfieldoptions) when loading options for dynamic inputs in this stage.
    </ParamField>

    <ParamField type="InputType[]">
      The list of inputs to prompt the user with in this stage. You can see a full list of input types that are used by the Connect Portal and must be rendered by your implementation in [Input Types Reference](/connect-portal/input-types-reference).

      <Expandable title="child properties">
        <ParamField type="string">
          Use the input `id` as the key of the object you pass to [`paragon.setPostOptions`](#installflowsetpostoptions). The value will be the input provided by the user.
        </ParamField>

        <ParamField type="enum">
          The type of this input, which will be one of the inputs in [Input Types Reference](/connect-portal/input-types-reference).
        </ParamField>

        <ParamField type="string">
          The title to display to the user to describe this input.
        </ParamField>

        <ParamField type="string">
          The descriptive text to display to the user to further describe or provide context to this input.
        </ParamField>

        <ParamField type="string">
          The placeholder or example value to display to the user.
        </ParamField>

        <ParamField type="string">
          The source type of this input, defined for dynamic enum inputs. This value can be passed to [`paragon.getFieldOptions`](#getfieldoptions) to load the options for the input.

          See a walkthrough of implementing dynamic input types in [Exposing User Settings](/connect-portal/headless-connect-portal#exposing-user-settings).
        </ParamField>

        <ParamField type="boolean">
          Whether this input is required.
        </ParamField>
      </Expandable>
    </ParamField>
  </Tab>

  <Tab title="InstructionStage">
    In the `InstructionStage`, the user should be shown instructional content with call-to-action buttons and a finish button to proceed to the next stage.

    ```javascript icon="js" Example (Salesforce) theme={null}
    {
      "stage": "instruction",
      "content": "## Install Package\n\nPlease install the package using the link below.\n\n![Install Image](https://cdn.useparagon.com/image.png \"Install Image\")\n\nAfter installation, click the finish button.",
      "ctas": [
        {
          "type": "link",
          "label": "Install Package",
          "href": "https://example.com/package-install"
        },
        {
          "type": "copyButton",
          "label": "Copy link",
          "copyText": "https://example.com/package-install"
        }
      ],
      "finish": {
        "type": "finishButton",
        "label": "I've installed the package",
        "onClick": Function
      },
      "done": false
    }
    ```

    <ParamField type="const">
      `"instruction"` for InstructionStage.
    </ParamField>

    <ParamField type="string">
      Markdown-formatted content to display to the user. This can include headings, images, and other markdown elements.
    </ParamField>

    <ParamField type="CTA[]">
      An array of call-to-action buttons to display alongside the content. Each CTA can be either a link or a copy button.

      <Expandable title="child properties">
        <Tabs>
          <Tab title="Link">
            <ParamField type="const">
              `"link"` for Link CTAs.
            </ParamField>

            <ParamField type="string">
              The text to display on the link button.
            </ParamField>

            <ParamField type="string">
              The URL to navigate to when the link is clicked.
            </ParamField>
          </Tab>

          <Tab title="CopyButton">
            <ParamField type="const">
              `"copyButton"` for CopyButton CTAs.
            </ParamField>

            <ParamField type="string">
              The text to display on the copy button.
            </ParamField>

            <ParamField type="string">
              The text to copy to the clipboard when the button is clicked.
            </ParamField>
          </Tab>
        </Tabs>
      </Expandable>
    </ParamField>

    <ParamField type="FinishButton">
      The finish button that the user clicks to proceed to the next stage after completing the instructions.

      <Expandable title="child properties">
        <ParamField type="const">
          `"finishButton"` for FinishButton.
        </ParamField>

        <ParamField type="string">
          The text to display on the finish button.
        </ParamField>

        <ParamField type="function">
          The callback function provided by the SDK to execute when the finish button is clicked. When this button is clicked, call `finish.onClick()` to mark the instruction stage as complete.
        </ParamField>
      </Expandable>
    </ParamField>
  </Tab>
</Tabs>

***

### .installFlow\.start

Call `paragon.installFlow.start` to begin an install flow for an integration. [See an example call](/connect-portal/headless-connect-portal#example-install-flow).

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    paragon.installFlow.start(integrationType, options);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="string">
  The integration type string, like `salesforce`.
</ParamField>

<ParamField type="object">
  <Expandable title="child properties">
    <ParamField type="function">
      This callback is called when the install flow is ready to move to the next stage.

      Your app must render the appropriate UI for each stage, so that your user can provide the necessary details in that stage to connect their account.

      <Expandable title="callback arguments">
        <ParamField type="InstallFlowStage">
          The install flow stage for your app to render. See [InstallFlowStage](#installflowstage) for more details.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="function">
      This callback is called when the install flow completes successfully.
    </ParamField>

    <ParamField type="function">
      This callback is called when the install flow fails, with an error object and error context.

      <Expandable title="callback arguments">
        <ParamField type="Error">
          The error object. You can read the `.name` of the error object to identify one of the following error types:

          * `OAuthBlockedError`: The browser blocked the OAuth prompt from appearing. This may require the user to allow popups in their browser settings.
          * `OAuthTimeoutError`: The OAuth prompt took longer than `oauthTimeout` milliseconds (as provided in `options`) to complete.
          * `UserNotAuthenticatedError`: The user is not authenticated with the Paragon SDK. Verify that `paragon.authenticate` has been called before starting the install flow.
          * `NoActiveInstallFlowError`: An install flow function was called, but no install flow is currently active. Call `paragon.installFlow.start` to start an install flow.
          * `HeadlessModeNotEnabledError`: Headless Connect Portal is not enabled. Call `paragon.setHeadless` to enable Headless mode.
          * `IntegrationNotFoundError`: The provided integration type is not found or has [not been enabled](/getting-started/displaying-the-connect-portal#activating-the-integration) in your Paragon project.
        </ParamField>

        <ParamField type="ErrorContext | null">
          The error context object.

          <Expandable title="child properties">
            <ParamField type="InstallFlowStage">
              The stage that the install flow was on when the error occurred.

              **One of**: `accountType`, `preOptions`, `postOptions`, `instruction`.
            </ParamField>
          </Expandable>
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField type="number">
      The number of milliseconds to wait for an OAuth prompt to complete. If the user does not complete the OAuth prompt within this time, the install flow will fail, and the `onError` callback will be called.

      If not provided, there will be no timeout for the OAuth prompt.
    </ParamField>

    <ParamField type="boolean">
      Set to `true` if using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization). This will allow users to connect multiple accounts under one integration type.

      Defaults to `false`.
    </ParamField>

    <ParamField type="string">
      Set this parameter to *replace* an account by a selected Credential ID instead of connecting a new account.

      This can be used to prompt a user to reconnect a credential if authorization has been revoked and the `status` of the credential is `INVALID`.
    </ParamField>

    <ParamField type="string">
      Set this parameter to your Redirect Page URL for integrations like [Google Drive](/resources/integrations/google-drive#setting-up-a-redirect-page-in-your-app).
    </ParamField>
  </Expandable>
</ParamField>

***

### .installFlow\.setAccountType

Call `paragon.installFlow.setAccountType` when the user selects an account type in the `AccountTypeStage`.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    paragon.installFlow.setAccountType(accountType);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="string">
  The account type to set. This should be the `id` property of the Account Type option that the user selected.
</ParamField>

***

### .installFlow\.setPreOptions

Call `paragon.installFlow.setPreOptions` when the user finishes providing inputs in the `PreOptionsStage`.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    await paragon.installFlow.setPreOptions(values);
    ```
  </Tab>
</Tabs>

This returns a Promise that resolves when the values are saved. Upon success, the install flow will move to the next stage and call `onNext`. If there is no stage after the `PreOptionsStage`, the install flow will call `onComplete`.

**Arguments:**

<ParamField type="object">
  The values to set for the inputs in the `PreOptionsStage`.

  This should be an object, where the keys are `id`s of the inputs in the `PreOptionsStage`, and the values are the values that the user provided for each input.

  ```javascript icon="js" Example (Shopify) theme={null}
  {
    "SHOP_NAME": "my-shop"
  }
  ```
</ParamField>

***

### .installFlow\.setPostOptions

Call `paragon.installFlow.setPostOptions` when the user finishes providing inputs in the `PostOptionsStage`.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    await paragon.installFlow.setPostOptions(values);
    ```
  </Tab>
</Tabs>

This returns a Promise that resolves when the values are saved. Upon success, the install flow will be completed and call `onComplete`.

**Arguments:**

<ParamField type="object">
  The values to set for the inputs in the `PostOptionsStage`.

  This should be an object, where the keys are `id`s of the inputs in the `PostOptionsStage`, and the values are the values that the user provided for each input.

  ```javascript icon="js" Example (Jira) theme={null}
  {
    "JIRA_CLOUD_ID": "my-jira-cloud-id"
  }
  ```
</ParamField>

***

### .installFlow\.cancel

Call `paragon.installFlow.cancel` if your user abandons the integration connection process during an active install flow. This function resets the state for `paragon.installFlow` to begin again at another time.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    paragon.installFlow.cancel();
    ```
  </Tab>
</Tabs>

<Info>
  If your user has completed an OAuth connection but has *not* completed required post-OAuth options, this function will remove the credential with status `"PENDING"` automatically by calling `paragon.uninstallIntegration`.

  However, if the page has been refreshed or the SDK has been reloaded *since* the pending credential was connected, you will need to call `paragon.uninstallIntegration` manually to disconnect the pending credential from your user.
</Info>

***

## External File Picker

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)
* [Box](/resources/integrations/box#using-the-box-file-picker)

### .ExternalFilePicker

Construct a new instance of an ExternalFilePicker for an integration given by `integrationType`. Any required JS dependencies do not start loading until [`picker.init`](/apis/api-reference#pickerinit) is called.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    const picker = new paragon.ExternalFilePicker(integrationType, options);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="string">
  Type of integration (i.e. "googledrive", "onedrive", "sharepoint", "box")
</ParamField>

<ParamField type="object">
  <Expandable title="Optional options">
    <ParamField type="string[]">
      An array of MIME types to allow for file selection, e.g. `["application/pdf", "image/jpeg"]`. If `undefined`, all types will be allowed.
    </ParamField>

    <ParamField type="boolean">
      If `true`, allow multiple files to be selected. Default: `false`.
    </ParamField>

    <ParamField type="boolean">
      If `true`, allow folders to be selected. Default: `false`.
    </ParamField>

    <ParamField type="function">
      Called when a Picker successfully appears in the app.
    </ParamField>

    <ParamField type="function">
      Called when a Picker gets closed.
    </ParamField>

    <ParamField type="function">
      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.
    </ParamField>

    <ParamField type="function">
      Called when a Picker gets closed without any files selected.
    </ParamField>
  </Expandable>
</ParamField>

**Example:**

```javascript icon="js" JavaScript theme={null}
const picker = new paragon.ExternalFilePicker("googledrive", {
  allowedTypes: ["application/pdf"],
  allowMultiSelect: false,
  onFileSelect(files) {
    console.log("User picked files", files);
  },
});
```

***

### picker.init

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 `picker.open` and `picker.getInstance`, cannot be called until the Promise returned by `picker.init` is resolved.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    await picker.init(initConfig);
    ```
  </Tab>
</Tabs>

**Arguments:**

<ParamField type="object">
  <Expandable title="child properties">
    <ParamField type="string">
      The developer key required for certain integrations (e.g., Google Drive).
    </ParamField>

    <ParamField type="string">
      Pass to select a specific account to pick files from when using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization).
    </ParamField>

    <ParamField type="string">
      SharePoint only. Optional site URL override (e.g. `https://contoso.sharepoint.com/sites/MySite`). Takes precedence over `siteId` and the connected credential's default site. See [SharePoint File Picker](/resources/integrations/sharepoint#using-the-sharepoint-file-picker) for details.
    </ParamField>

    <ParamField type="string">
      SharePoint only. Optional site ID (e.g. `contoso.sharepoint.com,191d8a17-...`). Resolved to a site URL via Microsoft Graph before opening the picker. Ignored when `siteUrl` is also provided.
    </ParamField>
  </Expandable>
</ParamField>

**Example:**

```javascript icon="js" JavaScript theme={null}
await picker.init({
  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.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    picker.open();
    ```
  </Tab>
</Tabs>

***

### 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.

<Tabs>
  <Tab title="SDK" icon="js">
    ```javascript icon="js" JavaScript theme={null}
    const instance = picker.getInstance();
    ```
  </Tab>
</Tabs>


# JWT Permissions
Source: https://docs.useparagon.com/apis/api-reference/jwt-permissions

Use JWT Permissions to control the credentials and configurations that an authenticated user has access to using the Paragon User Token.

If your Connected Users represent accounts, organizations, or some other *group* of users in your platform, then you may want to control the permissions of the credentials and configurations within that user to only the set that an authenticated user of your application should have access to.

By default, a Paragon User Token grants access to all credentials and configurations within a Connected User (identified by the `sub` field in the JWT).

<Frame>
  <img alt="Diagram illustrating org- vs. user-level tokens" />
</Frame>

You can restrict access to specific credentials and configurations by adding an additional claim on the [Paragon User Token](../../getting-started/installing-the-connect-sdk.md#setup) (JWT) that is passed for an authenticated user in your platform.

You can also use JWT Permissions to prevent certain types of API calls from being made using a given token, for example: Proxy API calls, App Events, Workflow triggers, or ActionKit requests.

## Usage

The claim for JWT Permissions is called `urn:useparagon:connect:permissions` and is structured as an object with keys of [Scopes](#jwt-scopes) (i.e. what to scope a group of permissions/rules to) and values of [Permissions](#jwt-permissions) (i.e. visibility of specific credentials or configurations and the types of operations that are allowed).

Here are some examples of token types that are expressible with JWT Permissions:

<CodeGroup>
  ```json Admin (org-level) theme={null}
  {
    "sub": "<Paragon User ID>",
    "urn:useparagon:connect:permissions": {
      "integration:*": true
    }
  }
  ```

  ```json Restricted to specific accounts (user-level) theme={null}
  {
    "sub": "<Paragon User ID>",
    "urn:useparagon:connect:permissions": {
      "integration:gmail": {
        "credential:abf961e3-12ec-40fe-8aa9-caa5ab162a6a": true
      }
    }
  }
  ```

  ```json Restricted to specific configurations theme={null}
  {
    "sub": "<Paragon User ID>",
    "urn:useparagon:connect:permissions": {
      "integration:*": true,
      "integration:slack": {
        // Applies to all teams
        "credential:*": {
          "permissions": [
            "events"
          ],
          // Applies to all Slack configurations with external ID of
          // "Team A", for all Slack accounts
          "configuration:ext:Team A": [
            "config:write",
            "settings:write"
          ]
        }
      },
      "integration:custom.test": false,
      "integration:hubspot": {
        "credential:*": [
          "config:write"
        ]
      }
    }
  }
  ```

  ```json ActionKit access with restricted integrations theme={null}
  {
    "sub": "<Paragon User ID>",
    "urn:useparagon:connect:permissions": {
      "permissions": [
        "actionkit"
      ],
      "integration:salesforce": {
        "credential:*": true
      },
      "integration:hubspot": {
        "credential:*": true
      }
    }
  }
  ```
</CodeGroup>

<Info>
  **Claims passed in the JWT are not persisted or saved in any way.** They are only used and evaluated for the current API request and should be included with every token that requires permissions control.
</Info>

## JWT Scopes

The following scopes can be used to assign permissions and rules. These scopes are ordered from least specific to most specific.

Permissions designated at more specific scopes will override those inherited from less specific scopes.

<table>
  <thead>
    <tr>
      <th>Scope</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **integration:\***
      </td>

      <td>All integrations</td>
    </tr>

    <tr>
      <td>
        **integration:\[name]**
      </td>

      <td>
        An integration matching a name of \[name] (as passed to
        <code>paragon.connect</code> )
      </td>
    </tr>

    <tr>
      <td>
        **credential:\***
      </td>

      <td>All credentials belonging to an integration</td>
    </tr>

    <tr>
      <td>
        **credential:\[uuid]**
      </td>

      <td>All credentials matching an ID of \[uuid]</td>
    </tr>

    <tr>
      <td>
        **configuration:\***
      </td>

      <td>All configurations belonging to a credential</td>
    </tr>

    <tr>
      <td>
        **configuration:ext:\[id]**
      </td>

      <td>All configurations matching an External ID of \[id]</td>
    </tr>
  </tbody>
</table>

## JWT Permissions

The following permissions can be used to configure API capabilities for a Paragon User Token. These permissions can apply to any of the scopes listed above.

Permissions must be specified as an array, or as a Boolean interpreted as `true` = Allow All, `false` = Deny All.

<table>
  <thead>
    <tr>
      <th>Permission</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **credential:write**
      </td>

      <td>
        Connect a new credential, reconnect an existing credential, or
        disconnect an existing credential
      </td>
    </tr>

    <tr>
      <td>
        **config:write**
      </td>

      <td>Create, modify, or destroy a configuration</td>
    </tr>

    <tr>
      <td>
        **settings:read**
      </td>

      <td>Read User Settings and Workflow Enablement</td>
    </tr>

    <tr>
      <td>
        **settings:write**
      </td>

      <td>Write and read User Settings and Workflow Enablements</td>
    </tr>

    <tr>
      <td>
        **metadata:read**
      </td>

      <td>Read User Metadata</td>
    </tr>

    <tr>
      <td>
        **metadata:write**
      </td>

      <td>Write and read User Metadata</td>
    </tr>

    <tr>
      <td>
        **proxy-api**
      </td>

      <td>Send requests to the Proxy API</td>
    </tr>

    <tr>
      <td>
        **events**
      </td>

      <td>Send App Events</td>
    </tr>

    <tr>
      <td>
        **workflows**
      </td>

      <td>Send Workflow Request triggers</td>
    </tr>

    <tr>
      <td>
        **actionkit**
      </td>

      <td>Send requests to the [ActionKit API](/actionkit/api-reference)</td>
    </tr>
  </tbody>
</table>


# 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 allows Connected Users to connect multiple accounts for the same integration.

For example, a Connected User can connect multiple Google Drive accounts, with each account stored as a separate Credential.

## Supported Products

| Product                                | Supported                                                  |
| -------------------------------------- | ---------------------------------------------------------- |
| [Workflows](/workflows/overview)       | Yes                                                        |
| [ActionKit](/actionkit/overview)       | Yes (via `X-Paragon-Credential` header)                    |
| [Managed Sync](/managed-sync/overview) | Yes (via `credentialId` in request body)                   |
| [Proxy API](/apis/proxy)               | Yes (via `selectedCredentialId` or `X-Paragon-Credential`) |

## Getting Started

**Connecting new accounts**

To get started with Multiple Account Authorizations, you can pass in `allowMultipleCredentials` to `paragon.installIntegration`:

```javascript theme={null}
// 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 to present 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 theme={null}
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 theme={null}
// 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 theme={null}
// 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 [`paragon.getUser`](/apis/api-reference/multi-account-authorization#getuser)) to display multiple connected accounts in your Integrations UI.
* Update references to [`paragon.connect`](/apis/api-reference#connect) (or [`paragon.installIntegration`](/apis/api-reference/multi-account-authorization#installintegration) and [`paragon.uninstallIntegration`](/apis/api-reference/multi-account-authorization#uninstallintegration)) to use the SDK with Multiple Account Authorizations enabled.
* Update references to [`paragon.request`](/apis/api-reference/multi-account-authorization#request) and [`paragon.workflow`](/apis/api-reference/multi-account-authorization#workflow) (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.

## Access Control

If you are using Multi-Account Authorization to enable multiple users within one organization to connect their individual credentials within one Connected User, use JWT Permissions to restrict each user's access to only the accounts they have connected:

<Card title="JWT Permissions" icon="lock" href="/apis/api-reference/jwt-permissions">
  Learn more about implementing JWT Permissions to control access to credentials.
</Card>

## Reference

### .connect

With Multiple Account Authorizations, use `paragon.connect` to present the Connect Portal for an *existing* account for the intended integration. Use [`paragon.installIntegration`](/apis/api-reference/multi-account-authorization#installintegration) 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.

For full documentation of this method, see [`paragon.connect`](/apis/api-reference#connect).

**Example:**

```javascript icon="js" JavaScript theme={null}
// Connect a new account for this integration.
// NOTE: You must use `paragon.installIntegration` rather than `paragon.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"
});
```

***

### .installIntegration

The `paragon.installIntegration` function starts the connection process for a new account of an integration. With Multiple Account Authorizations, pass `allowMultipleCredentials: true` so the function does not throw an error if the user already has this integration installed. You can use the resulting Promise to get the newly created credential.

For full documentation of this method, see [`paragon.installIntegration`](/apis/api-reference#installintegration).

**Example:**

<CodeGroup>
  ```javascript icon="js" Connect a new account theme={null}
  const { credential } = await paragon.installIntegration("googledrive", {
    allowMultipleCredentials: true
  });
  ```

  ```javascript icon="js" Replace an existing account theme={null}
  paragon.installIntegration("googledrive", {
    allowMultipleCredentials: true,
    selectedCredentialId: "0d2cca60-268b-45f1-ac5e-af6aad403d8c"
  });
  ```
</CodeGroup>

***

### .uninstallIntegration

Call `paragon.uninstallIntegration` to disconnect an integration for the authenticated user. With Multiple Account Authorizations, use `selectedCredentialId` (SDK) or the `X-Paragon-Credential` header (API) to select a specific account to disconnect.

For full documentation of this method, see [`paragon.uninstallIntegration`](/apis/api-reference#uninstallintegration).

**Example:**

<CodeGroup>
  ```javascript icon="js" JavaScript theme={null}
  paragon.uninstallIntegration("googledrive", {
    selectedCredentialId: "de06dea8-8680-483c-95ea-cfcf66582c96"
  });
  ```

  ```http icon="terminal" REST API theme={null}
  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>

***

### .getUser

Call `paragon.getUser` to retrieve the currently authenticated user and their connected integration state.

With Multiple Account Authorizations, `paragon.getUser` additionally returns `allCredentials`, an array of connected accounts for a given integration.

For full documentation of this method, see [`paragon.getUser`](/apis/api-reference#getuser).

**Example Response:**

```javascript icon="js" JavaScript expandable theme={null}
{
  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,
          externalId: "my-external-id", // Present if set via .connect() or .installIntegration()
        },
      ],
      configuredWorkflows: {},
      credentialId: "a5e995c2-7709-43fd-9cdf-f759faa52497",
      credentialStatus: "VALID",
      providerId: "1223115691",
      providerData: {},
    },
    shopify: {
      enabled: false,
    },
  },
}
```

***

### .workflow

Call `paragon.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.

With Multiple Account Authorizations, use `selectedCredentialId` (SDK) or the `X-Paragon-Credential` header (API) to select a specific account for which to trigger a workflow. The Credential ID that is used will be recorded for viewing in the [Monitoring Workflows page](/workflows/viewing-workflow-executions).

For full documentation of this method, see [`paragon.workflow`](/apis/api-reference#workflow).

**Example:**

<CodeGroup>
  ```javascript icon="js" JavaScript theme={null}
  // 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"
  });
  ```

  ```http icon="terminal" REST API theme={null}
  POST https://api.useparagon.com/projects/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>

***

### .request

Call `paragon.request` to send an API request to a third-party integration on behalf of one of your users. With Multiple Account Authorizations, use `selectedCredentialId` (SDK) or the `X-Paragon-Credential` header (API) to select a specific account to use with the [Proxy API](/apis/proxy) or [ActionKit](/actionkit/overview).

For full documentation of this method, see [`paragon.request`](/apis/api-reference#request).

**Example:**

<CodeGroup>
  ```javascript icon="js" JavaScript theme={null}
  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"
  });
  ```

  ```http icon="terminal" REST API theme={null}
  POST https://proxy.useparagon.com/projects/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>

***

### picker.init

You can use the Paragon SDK to allow your user to select files from a File Storage integration in your app. After constructing a new instance of the [ExternalFilePicker](/apis/api-reference#externalfilepicker), you can initialize a file picker with the required configuration `initConfig`, including the `selectedCredentialId` for the user.

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 `picker.open` and `picker.getInstance`, cannot be called until the Promise returned by `picker.init` is resolved.

**Example:**

```javascript icon="js" JavaScript theme={null}
await picker.init({
  developerKey: "AIzaS...",
  appId: "457...",
  selectedCredentialId: "de06dea8-8680-483c-95ea-cfcf66582c96"
});
```


# Multi-Configuration
Source: https://docs.useparagon.com/apis/api-reference/multi-configuration

Use the SDK to set up multiple configurations of settings or workflow enablements for one connected account authorization.

Multi-Configuration allows you to use one connected account authorization (1 credential) to set up multiple *configurations* of [User Settings](../../connect-portal/workflow-user-settings/) or [Workflow](/workflows) enablements for your users.

For example, if your Google Drive integration might require you to set up different workflows for different folders that your user wants to watch, Multi-Configuration can provide a separate "instance" of the [Connect Portal](/connect-portal/) to show for each of those folder configurations.

<Warning>
  Configurations currently do not appear in the [Connected Users Dashboard](/monitoring/users).

  Any workflow enablements that are displayed in the Connected Users page represent the default configuration, and values for other configurations can only be viewed and modified with the API at this time.
</Warning>

## Configurations

A **Configuration** is a set of User Settings and Workflow Enablements associated with one connected account (credential), as shown here:

<Frame>
  <img alt="" />
</Frame>

In the above example, User `A` with Google Drive Credential `A` can have $N$ configurations associated with that credential.

* Different sets of Workflows can be enabled / disabled for each configuration.
* Different User Settings can be used for each configuration.
* Configurations can be associated with an **External ID** (an ID that you provide).
  * An External ID which can be used to reference a Configuration(s) *in place of* a UUID, in the following format: `ext:[External ID]`
  * For example, if the configuration is created with `externalId: "Team A"`, it can be addressed in the Paragon User Token as `configuration:ext:Team A`.

## Usage

### Creating and managing configurations

To create a new configuration, call `createConfiguration` with a `credentialId` to attach the configuration to and an optional `externalId` to reference this configuration in the API.

```typescript theme={null}
const config = await paragon.createConfiguration({
    // The credential to create this configuration from
    credentialId: "...",
    // An external ID that can be used to reference this configuration from the API
    externalId: "Team A"
});
// -> { id: "", credentialId: "", settings: {}, configuredWorkflows: {} }
```

The `createConfiguration` call will return a Promise that resolves with the saved configuration object.

After creating a configuration, it will be included in the `paragon.getUser` response under each integration, in both the `allConfigurations` array and within the `configurations` property of each credential object.

```typescript theme={null}
paragon.getUser();
// -> { jira: { allCredentials: [{ configurations }], allConfigurations: [] } }
```

Finally, you can destroy a configuration (removing any User Settings and disabling any workflow enablements for the associated configuration) with `destroyConfiguration`:

```typescript theme={null}
// Destroy a configuration using its external ID
await paragon.destroyConfiguration({
    id: "ext:Team A",  // Configuration ID (use "ext:" prefix for external ID)
    credentialId: "..."  // The credential ID that this configuration belongs to
});

// Or destroy using configuration UUID
await paragon.destroyConfiguration({
    id: "a1304037-d994-40ef-894a-8d6c55f65f7c",  // Configuration UUID
    credentialId: "..."  // The credential ID that this configuration belongs to
});
```

The `destroyConfiguration` method accepts:

* `id` - The configuration ID to destroy. This can be either:
  * A configuration UUID (e.g., `"a1304037-d994-40ef-894a-8d6c55f65f7c"`)
  * An external ID with the `ext:` prefix (e.g., `"ext:Team A"`)
* `credentialId` - The connected account credential ID that this configuration belongs to.

### Presenting the Connect Portal

After creating a configuration, you can present a Connect Portal by passing `selectedConfigurationId`. You can pass a configuration UUID or the external ID prefixed with `ext:`to reference the configuration.

```typescript theme={null}
// Open Connect Portal of this configuration
paragon.connect("jira", {
  selectedConfigurationId: "ext:Team A"
});
```

You can also use Headless Connect Portal functions for managing workflow enablements with the configuration ID:

```typescript theme={null}
// Manage Headless workflow enablements for this configuration
await paragon.enableWorkflow("workflow-id", {
  selectedConfigurationId: config.id
});
await paragon.disableWorkflow("workflow-id", {
  selectedConfigurationId: config.id
});
```

<Tip>
  **Note:** All credentials have a default Configuration included, which will be used if the configuration does not exist or if `selectedConfigurationId` is undefined.
</Tip>

### Calling the API

You can use `selectedConfigurationId` as an option for SDK calls and `X-Paragon-Configuration-Id`for API calls.

```javascript theme={null}
// Send an App Event for this configuration only
await paragon.event("workflow-id", {
  selectedConfigurationId: config.id
});
```

```
POST /sdk/events

X-Paragon-Credential: a1304037-d994-40ef-894a-8d6c55f65f7c
X-Paragon-Configuration-Id: ext:Team A
```

## Access Control

If you are using Multi-Configuration to enable different groups of users (such as teams) within one organization to set up distinct configurations of an integration, you may want to control which authenticated users in your application have visibility to each configuration.

You can use JWT Permissions to encode these visibility controls into your Paragon User Token:

<Card title="JWT Permissions" icon="lock" href="/apis/api-reference/jwt-permissions">
  Learn more abut implementing JWT Permissions to control access to configurations.
</Card>


# 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) 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 the following 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` (optional): 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.
  * `headers`: Additional HTTP headers to include in the request.

  If `requestOptions` is omitted, the SDK issues a `GET` request without a body.

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 theme={null}
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 theme={null}
    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 theme={null}
    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 theme={null}
    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 theme={null}
    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 theme={null}
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 theme={null}
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 alt="" />
</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 theme={null}
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 theme={null}
{
    "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 theme={null}
GET /projects/<Paragon Project ID>/task-history/workflow-executions?userId=test@example.com&status=FAILED

Authorization: Bearer <Paragon API Key>
```

**Response example:**

```json theme={null}
{
    "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 theme={null}
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). |
| status      | String        | Filter executions by a status, for example, `FAILED`. See [Workflow execution statuses](#workflow-execution-statuses) for the full list of supported values.                         |
| 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 theme={null}
{
    "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 theme={null}
{
    "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"
        }
    ]
}
```

### Workflow execution statuses

The `status` field on a workflow execution can be one of the following values.

| Status         | Description                                                                                                                     |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `NOT_STARTED`  | The execution has been queued but has not begun running yet.                                                                    |
| `EXECUTING`    | The execution is currently in progress.                                                                                         |
| `PAUSED`       | The execution is paused until resumed or unblocked manual pause (for example, by endpoint payload, or OAuth authorization.).    |
| `WAITING`      | A less common status for blocked executions awaiting user interaction; executions usually show PAUSED instead.                  |
| `DELAYED`      | The execution is delayed and scheduled to resume at a later time (for example, by a Delay step).                                |
| `RATE_LIMITED` | The execution was paused because a rate limit was reached and will resume once the limit resets.                                |
| `SUCCEEDED`    | The execution finished successfully.                                                                                            |
| `FAILED`       | The execution finished with an error.                                                                                           |
| `CANCELLED`    | The execution was cancelled before it finished (for example, because the workflow was undeployed or the execution was stopped). |

## 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 theme={null}
{
    "isLargeInput": false,
    "isLargeOutput": false,
    "input": {},
    "output": "Error: no auth mechanism defined"
}
```

## 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. |

```json 201: Created theme={null}
// No response body
```


# 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 theme={null}
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 theme={null}
// 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 theme={null}
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 theme={null}
  paragon.setUserMetadata({
      Name: "Sean V",
      Email: "sean@useparagon.com",
      AccountType: "Pro",
  });
  ```

  ```bash REST API theme={null}
  // 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 alt="" />
</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 alt="" />
</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 theme={null}
  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 theme={null}
  // 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 alt="" />
</Frame>

You can check for this condition with the SDK with the `credentialStatus` property. For example:

```js theme={null}
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 theme={null}
    // 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 theme={null}
    GET https://api.useparagon.com/projects/<Project ID>/sdk/integrations

    // Headers
    Authorization: Bearer <Paragon User Token>
    ```

    **Response**

    ```json theme={null}
    [
        { "id": "<Integration ID>", "type": "salesforce", ... },
        {...}
    ]
    ```

    The `<Integration ID>` can be used to disconnect the integration for the user:

    **Request**

    ```bash theme={null}
    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 workflow step executions that can run at the same time across all of your [Connected Users](/billing/connected-users). This is a shared pool of execution capacity for [Workflows](/workflows/overview) for your subscription.

<Check>
  ActionKit and Managed Sync usage are not impacted by the concurrency SLA.
</Check>

For example, if you have a concurrency SLA of 20, Paragon can run up to 20 workflow steps in the background at the same time. Those 20 step executions could come from 20 different workflows, several Connected Users triggering the same workflow, or a single workflow that fans out into many steps.

<Frame>
  <img alt="" />
</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** | - Cloud: **50** step executions <br />- On-premise: Up to **1,000** step executions |

Enterprise customers may contact their Customer Success Manager to configure their Concurrency SLA.

### How concurrency works

When a workflow is triggered, Paragon queues the work to begin the execution and queues each step following until the Workflow is completed.

If concurrency capacity is available, the step begins running. If all concurrency slots are already in use, the step remains queued until another step finishes and a slot becomes available.

**Concurrency is shared across your workflows and Connected Users.** For example, with a concurrency SLA of 20:

* If 12 step executions are running for User A and 8 are running for User B, your subscription is using all 20 slots.
* If another workflow is triggered while those 20 slots are in use, Paragon accepts the new execution but waits to run its next step.
* When one of the running steps finishes, queued work can begin using the freed slot.

<Note>
  Concurrency is separate from your monthly [task usage](/billing/tasks).
  Concurrency controls how many workflow steps can run simultaneously. Task
  usage measures how many billable tasks are completed during your billing
  cycle.
</Note>

### How queued work is prioritized

When a workflow execution is submitted, Paragon assigns it a queue priority. Most workflows are prioritized in the order they arrive, and queued steps later in the same workflow keep that original priority. This means standard workflow executions generally continue moving from start to finish in arrival order as concurrency slots become available.

Request-triggered workflows that include a [Response step](/workflows/triggers/request-trigger#sending-a-response) are treated differently: because the original HTTP request is waiting for Paragon to reach the Response step, these workflows receive a higher priority than standard asynchronous workflows. This helps Paragon return the synchronous response before the request timeout.

Request-triggered workflows without a Response step do not use this higher-priority path; they return `202 Accepted` immediately and continue as standard asynchronous workflow executions.

<Info>
  Priority does not increase your concurrency SLA. It only affects which queued
  step executions are selected next when capacity is available.
</Info>

### High-volume workflow handling

[Fan Out](/workflows/using-fan-out) steps can create many step executions at once because each item in the array runs the steps inside the Fan Out branch. A large Fan Out occurs when the array passed into the Fan Out resolves to **50 or more items**. For example, a workflow that queries 75 new records and then fans out over those records is treated as a large Fan Out.

Paragon treats these Fan Outs differently because one workflow can suddenly create thousands of branch executions. To keep that high-volume work from crowding the standard workflow execution queue, Paragon routes large Fan Out work into a dedicated queue.

Dedicated Fan Out queues help isolate high-volume Fan Out work from other workflow execution queues, but they do not bypass your concurrency SLA. They are still part of the same shared concurrency pool for your subscription.

Dedicated queues receive a concurrency assignment based on the current queue backpressure (in pending/waiting step executions). The Workflow Engine automatically balances available concurrency slots between your project's queues based on backpressure.

For example, if a workflow fans out over 1,000 records and the first step inside the Fan Out is an integration action:

* Paragon will detect a large Fan Out, so the workflow will not run 1,000 integration actions simultaneously.
* Fan Out branch executions will wait in the dedicated Fan Out queue and run as concurrency slots and workers are available.
* Multiple concurrency units may be used if multiple branch executions are running at the same time, capped by your subscription's shared concurrency SLA (shared with work occuring in other workflows).

### What happens if I reach my Concurrency SLA?

When you reach this SLA, Paragon does not reject new workflow executions because of concurrency. New step executions are queued and show as **Not Started** on the [Monitoring](/workflows/viewing-workflow-executions) page, under the Workflows tab. In filters and API responses, this queued state may also appear as `QUEUED` or `NOT_STARTED`.

Paragon accepts and stores all queued executions. They begin running once the number of active step executions drops below your concurrency SLA.

<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 alt="" />
</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 alt="" />
</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 [Monitoring > Workflows](/workflows/viewing-workflow-executions) (see screenshot below).
* All [Proxy API](/apis/proxy) requests are counted as tasks.

<Frame>
  <img alt="" />
</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](/workflows/using-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 on the [Monitoring](/workflows/viewing-workflow-executions) page as a failed workflow. You can [replay stopped workflows](/workflows/viewing-workflow-executions#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>


# Building with Agents
Source: https://docs.useparagon.com/building-with-agents

Use Paragon's Agent Skills directly with your agentic IDE of choice

## Paragon Skill

**The Paragon Skill is used within your coding agent** (Claude Code, Cursor, Codex, OpenCode, etc.) to help you **set up Paragon in your application**.

The Paragon Skill provides your agent with context on how to:

1. **Set up the [Paragon SDK](/getting-started/installing-the-connect-sdk)**.
2. **Embed the [Connect Portal](/connect-portal/connect-portal-customization)**, a prebuilt component to guide your users through integration connection flows.

<Frame>
  <img alt="Paragon Skill in OpenCode" />
</Frame>

After running these setup steps, you'll have everything you need to get started with [ActionKit](/actionkit/overview), [Managed Sync](/managed-sync/overview), and [Workflows](/workflows/overview).

## Getting Started

### Recommended: Installing via the Skills CLI

The `npx skills` CLI by Vercel automatically adds the Paragon Skill for the most popular agentic IDEs.

```bash theme={null}
npx skills add useparagon/paragon-skills
```

Update the Paragon Skill with the following command:

```bash theme={null}
npx skills update
```

### Alternative: Manual Installation

1. Navigate to the `skills/` directory for your agentic IDE of choice, e.g.

   ```
   ~/.cursor/skills/
   ~/.claude/skills/
   ~/.agents/skills/
   ~/.config/opencode/skills/
   ```

2. Clone the [Paragon Skills Repo](https://github.com/useparagon/paragon-skills) in the `skills/` directory:

   ```bash theme={null}
   git clone https://github.com/useparagon/paragon-skills.git
   ```

## Using the Skill

Your agent should naturally detect when the Paragon Skill is needed.

In some cases, it may be useful to reference the skill directly by name (i.e. "Using the Paragon Setup Skill..." or "/paragon-setup-skill").

### Starter Prompts

```markdown Add the Paragon SDK wrap theme={null}
/paragon-setup-skill Look at my app and set up the Paragon SDK, including all dependencies and required setup steps.

I will provide the following environment variables for your reference:
- `PARAGON_PROJECT_ID`: The Paragon Project UUID.
- `PARAGON_SIGNING_KEY`: The Signing Key as a PKCS8-encoded private key.
```

```markdown Build an integration catalog wrap theme={null}
/paragon-setup-skill Build an integration catalog for the integrations defined in my Paragon project.
```

```markdown Add JWT signing theme={null}
/paragon-setup-skill Set up auth for using the Paragon SDK.
```


# API Release Notes
Source: https://docs.useparagon.com/changelog/api

Release notes for new versions of the Paragon REST API.

This page lists all breaking changes for the Paragon REST API. We make a best effort to keep our API endpoints backwards-compatible with existing usage, but in cases where that is not possible, we will provide advanced notice and guidance on how to adapt to the changes.

<Update label="2026-07" description="Scheduled for July 31, 2026">
  ## Standardized ActionKit pagination parameters

  We are standardizing pagination across ActionKit so developers and agents can use one consistent pagination pattern across list and search actions, regardless of whether the underlying provider uses cursors, page numbers, offsets, or skip tokens.

  **Affected API:**

  * [ActionKit Tools API](/actionkit/api-reference)

  **What's changing:**

  **Pagination input parameters**:

  * Paginated ActionKit actions will support `paginationParameters.pageCursor` as the standard way to request the next page of results. Treat this value as an opaque string, even when the underlying integration uses a numeric page number or offset.

  * Actions that support page sizing will support `paginationParameters.limit` as the standard page size parameter.

  <Check>
    **Existing pagination input parameter names will remain supported**

    If your application already passes action-specific pagination input keys (such as `page`, `pageNo`, and `pageNumber`), those requests will continue to work.

    For new implementations, we recommend using `paginationParameters.pageCursor` and, when supported, `paginationParameters.limit`.
  </Check>

  **Pagination response parameters**:

  * Paginated responses will standardize on `nextPageCursor` as a string when another page is available, and `null` when there are no more pages.

  <Note>
    **Breaking change**

    Actions that previously returned `false` or `""` for `nextPageCursor` at the end of pagination will now return `null`.
  </Note>

  ## What do I need to do?

  **Handle the breaking change in response parameters:**

  * If you currently check for `nextPageCursor === false` or `nextPageCursor === ""` to detect the end of pagination, update that logic to handle `nextPageCursor === null`.

  **(Optional) Standardize your pagination code:**

  * For all ActionKit pagination code, pass the returned `nextPageCursor` value into `paginationParameters.pageCursor` on the next request.
  * Treat `nextPageCursor` as an opaque string. Avoid parsing it as a number or calculating the next page value in your application code.

  ## When will these changes be released?

  * Changes to set `nextPageCursor` as `null` will begin on July 31, 2026 and will gradually roll out across all ActionKit integrations. Updates will be propagated to the Tool-specific docs in the [ActionKit Integration Reference](/actionkit/integrations/slack/overview).
  * We recommend updating your application code to handle `nextPageCursor === null` (or falsey values) as a possible condition for the end of pagination during this transition period.
</Update>

<Update label="2026-04" description="Released April 2, 2026">
  ## Custom Integration identifiers are now immutable

  Before this change, changing the display name of a Custom Integration would result in a change in the integration identifier/slug (used in `paragon.connect`) and the Paragraph source path (after a `para pull`). For example, changing "TaskLab" to "Apex Tasks" would result in a change from `custom.tasklab` to `custom.apextasks`.

  **This identifier is now immutable and set at the time your Custom Integration is created.** For existing Custom Integrations, the identifier will be set immutably to the same value it currently has in your project.

  <Check>
    **Existing Custom Integration identifiers are preserved**

    Any hard-coded references you may use to existing Custom Integration identifiers will continue to work as expected, since the identifier has been set immutably to its current value. Any *future* changes to the display name will no longer impact this identifier.
  </Check>

  ## What do I need to do?

  * Treat the `slug` returned by the API as the source of truth for Custom Integrations. If your application already uses the `slug` returned by the API as the source of truth for identifiers, no changes are required.

  * Replace any logic in your application that may derive Custom Integration identifiers from the display name with the `slug` property provided by the API. A published Custom Integration's identifier will no longer change when its display name changes.

  * Upgrade the `@useparagon/connect` SDK to v2.3.1 or later.
    * `@useparagon/connect` SDK versions \< 2.3.1 (which derive the identifier from the integration name) will continue to use name-derived identifiers and work without issue. You can upgrade to v2.3.1 or later to use the current, immutable identifiers.

  * Upgrade `@useparagon/paragraph` to v1.1.1 or later.

  ## When were these changes released?

  * These changes were released on April 2, 2026. Platform versions of >= `v2026.0402` will include this update.
</Update>

<Update label="2025-07" description="Released 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 theme={null}
      {
          "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 theme={null}
      {
          "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 theme={null}
      - 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 were these changes released?

  * These changes were released on July 7, 2025.
</Update>


# Paragraph Release Notes
Source: https://docs.useparagon.com/changelog/paragraph

Release notes for new versions of the Paragraph core libraries and CLI.

### Updating to the latest version

To update your Paragraph project to the latest version, run the following commands in your terminal:

```bash theme={null}
# Update the CLI
npm install -g @useparagon/cli
# Update the core libraries in your project
para install --sync-versions
```

## Release Notes

<Update label="v1.1.11">
  * Fixed an issue where `para build` and `para push` could rewrite Cron trigger intervals that do not evenly divide the schedule unit. Interval schedules are now preserved correctly through pull, build, and push.
  * Fixed an issue where `para pull` generated an invalid `ResourceAuthorizationConfig` import in API resource `config.ts` files, causing TypeScript errors during `para build`. Generated resource configs now only import the symbols they use.
</Update>

<Update label="v1.1.10">
  * Fixed an issue where `para push` could overwrite the published state of a Custom Integration, causing it to disappear from the Connect integrations page. Custom Integrations synced through Paragraph are now always kept published.
  * Fixed an issue where the project picker in `para init --create-from-existing` showed the project title for the Development environment instead of "Development". The picker now labels and orders Development, Staging, and Production to match the dashboard.
</Update>

<Update label="v1.1.9">
  * Fixed an issue where `para pull` exported `bodyType` on GET/DELETE requests for BYO user profile configs and API resource test requests, causing TypeScript errors during `para build`.
</Update>

<Update label="v1.1.8">
  * Added `showWatermark` to custom integration config files, allowing custom integrations to control Connect Portal branding. Running `para pull` no longer drops the `showWatermark` field from regenerated `config.ts` files.
  * Fixed an issue where `objectMapping` was not supported on GitHub user-level triggers (e.g., Issue Created with Organization scope), causing runtime validation errors and TypeScript compilation errors.
</Update>

<Update label="v1.1.7">
  * Fixed an issue where custom webhook trigger type definitions were missing the `rawBody` field, preventing correct typing of the raw webhook request body.
</Update>

<Update label="v1.1.5">
  * Fixed an issue where pressing Escape during integration selection in `para new integration` could incorrectly select an integration instead of canceling.
  * Fixed an issue where `para build` could incorrectly change custom trigger webhook response parameters that read incoming request headers after a pull, build, and push.
</Update>

<Update label="v1.1.4">
  * Updated the Mailgun library types in Function step to the latest version.
</Update>

<Update label="v1.1.3">
  * Added support for the `pdf-lib` library in Function steps.
  * Fixed an issue where `para push` could override the **Apply field mapping** setting on HubSpot workflow trigger steps.
</Update>

<Update label="v1.1.2">
  * Pinned all dependency versions of Paragraph CLI.
</Update>

<Update label="v1.1.1">
  * Added `slug` field to Custom Integrations for consistent naming between the API and CLI. Renaming a Custom Integration's display name no longer affects directory or import paths in Paragraph:

    <Info>
      **Custom Integration identifiers are now immutable**

      Before API version [2026-04](/changelog/api#2026-04), changing the display name of a Custom Integration would result in a change in the integration identifier/slug (used in `paragon.connect`) and the integration source path (after a `para pull`).

      This identifier is now immutable and set at the time your Custom Integration is created.

      For existing Custom Integrations, the identifier is set immutably to the same value it currently has in your project. Upgrading to v1.1.1 will ensure that this immutability is correctly reflected in your Paragraph project.

      Learn more about these changes in the [API Changelog](/changelog/api#2026-04).
    </Info>
  * Fixed type errors with some available Function step libraries (e.g., `libphonenumber`, `ioredis`, `@aws-sdk/client-sqs`).
  * Fixed webhook trigger step output typing so that `triggerStep.output.result` is no longer typed as `unknown`, resolving TypeScript compilation errors in synced and exported code.
</Update>

<Update label="v1.1.0">
  * Added support for OAuth ROPC (Resource Owner Password Credentials) authentication and custom request options (`requestOptions`) in Custom Integrations.

    <Warning>
      **Change in defaults for auth URL parameters**

      Before v1.1.0, Custom Integrations using OAuth automatically included `access_type=offline` as part of the query parameters for the initial authorization URL. This query parameter is no longer included by default.

      If you need to add this parameter (notably, Google requires this parameter for refresh tokens), define it in `requestOptions.authorizationCodeOptions.configuration.queryParams`.

      <Accordion title="Code Example">
        ```ts theme={null}
        // In custom.[integration name]/config.ts
        requestOptions: {
          authorizationCodeOptions: {
            configuration: {
              queryParams: {
                access_type: 'offline',
              },
            },
          },
        },
        ```
      </Accordion>
    </Warning>
  * Fixed `para pull` to include the "Add Basic Auth header" toggle under `requestOptions.accessTokenOptions` for OAuth-type Custom Integrations.
</Update>

<Update label="v1.0.31">
  * Added support for `paragonUtils` and field mapping object sources in Function steps.
  * Fixed an issue where referencing File variables in the "Raw" body option of a Request step could cause file data to incorrectly be stringified after pushing changes from Paragraph.
  * Updated Paragraph's `mysql2` and `form-data` dependencies for improved compatibility.
</Update>

<Update label="v1.0.30">
  * Added support for workflow execution source variables (`workflowExecutionId`, `projectId`, `workflowId`) that can be synced between Paragon and Paragraph using `para pull` and `para push`.
</Update>

<Update label="v1.0.29">
  * Adds support for "Include Client ID and Secret in Token Exchange" option for OAuth 2.0-type Resources.
  * Improves error messaging for deployment failures that occur during `para push`. Error messages will now include workflow and step names for clarity.
</Update>

<Update label="v1.0.28">
  * Adds support for using GraphQL body types in Request steps.
</Update>

<Update label="v1.0.26">
  * Adds support for custom cron expressions for Scheduler triggers.
  * Fixes an issue where using literal array values with `StringIsIn` operators could result in the following error:
    ```
    You can not perform string operation on non-string data type.
    ```
</Update>

<Update label="v1.0.25">
  * Fixes an issue where Request steps with query parameters in the URL and in the `params` object could cause conflicts that lead to parameters being removed after `para push`.
  * Improves variable referencing support by allowing for "bare" references.
    * Previously, variables would need to be interpolated as template strings:
      ```ts theme={null}
      const functionStep = new FunctionStep({
        parameters: {
          key: `${requestStep.output.body}`
        }
      });
      ```
    * Now, they can be referenced directly:
      ```ts theme={null}
      const functionStep = new FunctionStep({
        parameters: {
          key: requestStep.output.body
        }
      });
      ```
  * Adds a generic type parameter for `FunctionStep` to allow for customizable output types.
</Update>

<Update label="v1.0.24">
  * Fixes `Object literal may only specify known properties` errors when pulling a Paragon project that uses a combination dropdown input type in the Connect Portal User Settings.
  * Updates compilation error messaging to reveal more detailed information instead of the following generic errors:
    * `persona.meta.js is not found in project`
    * `Could not found [...]/dist/integrations/[...]/config.js.`
</Update>

<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 2026">
  ## Releasing Triggers API in Beta

  <Frame>
    <img alt="Triggers API" />
  </Frame>

  [Triggers API](/actionkit/triggers) is a single API to subscribe to all of your users' integration events.
  With just one API call, you can subscribe to any of your users' events like Slack mentions, GitHub commits, or Notion updates using Paragon's pre-built collection of triggers and Custom Webhooks.

  📖 Learn more about Triggers API [here](/actionkit/triggers).
</Update>

<Update label="March 2026">
  # Managed Sync Improvements

  ## Multi-Account Authorization support for Managed Sync

  We have released support for Multi-Account Authorization for Managed Sync.
  This allows you to connect multiple accounts of the same integration type for a Connected User and enable individual syncs for each by specifying the relevant credential ID.

  📖 Learn more about Multi-Account Authorization for Managed Sync [here](/managed-sync/sync-api#multi-account-authorization).

  ## MIME-type Filtering for File Syncs

  We have released support for MIME type filtering across all File Storage sync pipelines (e.g. Google Drive, SharePoint, OneDrive). This allows you to restrict synced files to specific content types on both initial and incremental syncs.

  📖 Learn more about MIME type filtering for Google Drive syncs [here](/managed-sync/integrations/googledrive#param-mime-types).

  ## New webhook events for periodic full syncs and errors

  We have released new webhook events to give you greater visibility into the health of your Managed Syncs. The `sync_periodic_full_sync_errored` event fires when a periodic full sync fails to complete successfully, helping you detect and debug these sync failure cases.

  📖 Learn more about Managed Sync webhook events [here](/managed-sync/webhooks).
</Update>

<Update label="February 2026">
  ## Field Mapping in Function Steps

  We have released support for Field Mapping in Function Steps. This gives you full control over mapping values from your application to fields in your integration.
  Take advantage of new options for advance mapping patterns such as mapping an array of objects or handling deeply nested fields.

  ```javascript theme={null}
  // Map 3rd-party objects to your app objects using `mapIntegrationObjects`
  function yourFunction(parameters, libraries) {
    const { paragonUtils } = libraries;
    const { fieldMapping, records } = parameters;

    return paragonUtils.mapIntegrationObjects(fieldMapping, records);
  }
  ```

  📖 Learn more about how to use Field Mapping in Function Steps [here](/connect-portal/field-mapping#using-field-mappings-in-function-steps).
</Update>

<Update label="January 2026">
  ## Paragon is now HIPAA compliant

  <Frame>
    <img alt="Paragon is now HIPAA compliant" />
  </Frame>

  We are pleased to announce that **Paragon is now HIPAA compliant for self-hosted installations**.

  In January, we've implemented:

  * **Fine-Grained User Roles**: Invite collaborators to your Paragon account with project-specific access to only select Release Environments (e.g. Development and Staging only) or to specific projects.
  * **Audit Logs** (available to on-prem environments only): On-prem environments now emit audit logs for dashboard logins, viewing customer data in Monitoring, and changes to sensitive data in your projects.
  * **Access Hardening**: A number of security improvements have been rolled out to our dashboard login and token management endpoints.

  📧 [Contact our success team](mailto:success@useparagon.com) if you're interested in our HIPAA compliance offering.

  ## Improvements to Provider Data for Workflows for 10 Integrations

  We have exposed additional Provider Data fields in Workflows. This includes fields for region IDs in AWS, phone numbers in WhatsApp, Pod IDs in Insightly, and access point references in Adobe Acrobat Sign.

  📖 Learn more about using Provider Data in Workflows [here](/workflows/building-workflows#using-dynamic-data).
</Update>

<Update label="December 2025">
  ## Introducing Triggers API

  <Frame>
    <img alt="Triggers API" />
  </Frame>

  Triggers API is an ActionKit complement that lets you subscribe to webhooks from any integration your users have connected to. With just one API call to the Triggers API subscription endpoint, you can subscribe to any of your users' events like Slack mentions, GitHub commits, or Notion updates.

  👉🏼 Join the beta [here!](https://useparagon.notion.site/2f861d1eb9a880979793e488ac6132db)

  ## New Actions and Triggers for ServiceNow

  We have released new ServiceNow triggers for creating and updating records in ServiceNow. Additionally, we've added support for searching records in your users' ServiceNow accounts.

  📖 Learn more about the new ServiceNow capabilities [here](/resources/integrations/servicenow).

  ## User-Configured OAuth for Outlook

  We have released support for allowing connecting users to provide their own OAuth credentials for their Outlook integrations.

  📖 Learn more about the improvements to the Outlook integration [here](/resources/integrations/outlook).
</Update>

<Update label="November 2025">
  ## New Actions for GitHub, Outlook, Microsoft Teams, and Zendesk

  We have released new actions for fetching files and their changes in GitHub, emails in Outlook, messages in Microsoft Teams, and ticket comments in Zendesk.
  You can now access the following actions when building workflows across these integrations:

  **GitHub**

  * Get Pull Request by Number
  * Get Files Changed in PR
  * Get File

  **Outlook**

  * Get Message by ID

  **Microsoft Teams**

  * List Messages in a Chat

  **Zendesk**

  * Get Ticket Comments

  📖 Learn more about the new [GitHub actions](/resources/integrations/github), [Outlook actions](/resources/integrations/outlook), [Microsoft Teams actions](/resources/integrations/microsoft-teams), and [Zendesk actions](/resources/integrations/zendesk).
</Update>

<Update label="October 2025">
  ## Improvements to Custom Integration Builder (Beta)

  We have released improvements to the Custom Integration Builder, providing additional controls for supporting integrations
  with unorthodox OAuth flows. These authentication improvements are currently in beta and are available to all users.
</Update>

<Update label="September 2025">
  ## Ticketing Integrations for Managed Sync

  We have released support for Ticket Syncs in Managed Sync. With these pipelines, you can now sync Tickets from your users' Support Ticketing workspaces to your app.
  You can now create Ticket Syncs for the following integrations:

  * ClickUp
  * Freshdesk
  * Intercom
  * Monday.com
  * ServiceNow
  * Zendesk

  📖 Learn more about the new Ticketing Sync pipelines and view the schema [here](/managed-sync/api/ticket-schema).
</Update>

<Update label="August 2025">
  ## CRM Integrations for Managed Sync

  We have released several Sync pipelines for CRM Objects in Managed Sync. With these pipelines, you can now build durable, high-volume syncs for Contacts, Companies, Deals, and any Custom Objects
  from your users' CRM accounts. We've released pipelines for the following integrations:

  * Salesforce
  * HubSpot
  * Pipedrive
  * Zoho CRM
  * Dynamics 365 Sales

  📖 Learn more about the new CRM Sync pipelines [here](/managed-sync/api/contact-schema).

  ## Download File Content in ActionKit

  **New in ActionKit:** actions to download files from Google Drive, OneDrive, Box, and more.

  Use the ActionKit file download actions for use cases like on-demand file retrieval for your AI agent or handling files in your workflow builder.
  The following integrations support these new actions:

  * Google Drive
  * Box
  * OneDrive
  * Amazon S3
  * Dropbox
  * Dropbox Sign

  📖 See the [ActionKit](/actionkit/integrations/googledrive/GOOGLE_DRIVE_DOWNLOAD_FILE) docs to see how the Google Drive Download works and find other download actions you're looking for.
</Update>

<Update label="July 2025">
  ## Managed Sync

  <Frame>
    <img alt="Managed Sync" />
  </Frame>

  We have released Managed Sync, a purpose-built product for fully managed high volume data ingestion and permissions.

  Managed Sync includes two key APIs:

  * **Sync API** - easily enable full syncs of customers' 3rd-party data with two API calls. [Learn more about the Sync API](/managed-sync/sync-api).
  * **Permissions API** - check users' access on retrieved data without dealing with the complexities of indexing 3rd-party permissions (for RAG). [Learn more about the Permissions API](/managed-sync/permissions-api).

  📖 Learn more about Managed Sync [here](/managed-sync/overview).

  ## Event Logs in Public Beta

  <Frame>
    <img alt="Event Logs" />
  </Frame>

  We released Event Logs, the first step in providing a comprehensive view of all events that occur in your Paragon instance. Event Logs launched in public beta with visibility into ActionKit requests, Workflow triggers, and Connected User credentials.

  📖 Learn more about Event Logs [here](/monitoring/event-logs).
</Update>

<Update label="June 2025">
  ## Released Headless Connect Portal

  We have released Headless Connect Portal, a new way to display the Connect Portal without the Paragon branding.

  Headless Connect Portal provides fully-managed authentication, so you don't need to worry about managing, storing, or refreshing your customers' credentials. Bring your existing components or design system into your Paragon integrations experience with a suite of
  SDK functions.

  📖 Learn more about Headless Connect Portal [here](/connect-portal/headless-connect-portal).

  ## Field Mapping Expansion

  We have released extensibility improvements to allow developers to create Field Mapping settings for *any* integration in Paragon.

  These improvements provide full control over the Field Mapping inputs allowing you to map *any* record in a Paragon integration against a record in your application.

  📖 Learn more about Field Mapping improvements [here](/connect-portal/field-mapping#passing-dynamic-fields-through-the-sdk).
</Update>

<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 alt="" />
  </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 alt="" />
  </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 `paragon.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 theme={null}
    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 `paragon.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 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 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 alt="" />
    </Frame>

    We recommend giving team members the minimal level of access they need, according to the principle of least privilege. While Admin and Developer 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 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 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 alt="" />
    </Frame>

    ✨ **[Adobe Commerce](/resources/integrations/adobecommerce) Actions!**

    You can now access the following actions when building workflows for Adobe Commerce:

    * 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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

    ✨ **[Adobe Commerce](/resources/integrations/adobecommerce) Integration!**

    You can now connect to your users' Adobe Commerce account to access, create, and update records in their Adobe Commerce stores. Paragon enables you to sync data between your app and your users’ Adobe Commerce. For example, you can create customers or sync orders from Adobe Commerce. Learn more in [our docs](/resources/integrations/adobecommerce).

    <Frame>
      <img 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 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 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 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 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 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 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 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 alt="" />
    </Frame>

    ✨ **Redesigned [Environment Secrets](/workflows/environment-secrets) Manager!**

    <Frame>
      <img 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 records 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 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 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 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

    ✨**`paragon.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 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 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 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 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 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 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 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 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/overview)** in the sidebar of your Paragon Connect dashboard.

    <Frame>
      <img 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 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 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 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 alt="" />
    </Frame>

    As usual, we added bunch of bug fixes and improvements!

    <Frame>
      <img 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 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 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 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 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">
    ## Enhancements

    **✨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 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 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 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>


# SDK Release Notes
Source: https://docs.useparagon.com/changelog/sdk

Release notes for new versions of the Paragon SDK.

### Updating to the latest version

To update your SDK to the latest version, run the following commands in your app or codebase referencing the SDK:

```bash theme={null}
npm install @useparagon/connect@latest
```

## Release Notes

<Update label="v2.5.0">
  **Improvements:**

  * Improved [`paragon.getCustomWebhookUserManualUrl`](/apis/api-reference#getcustomwebhookusermanualurl) to throw clear, actionable errors when an invalid `workflowId` or `connectCredentialId` is passed, instead of producing malformed URLs or generic failures.

  **Fixes:**

  * Fixed `paragon.configureGlobal()` polluting browser history when reconfiguring the Connect SDK iframe.
</Update>

<Update label="v2.4.4">
  **Improvements:**

  * Added `siteUrl` and `siteId` options to the [SharePoint File Picker](/resources/integrations/sharepoint#using-the-sharepoint-file-picker) `init()` call, allowing a single connected account to target different SharePoint sites.
</Update>

<Update label="v2.4.3">
  **Improvements:**

  * Exposed `credentialId` in the `onNext` handler state for [`paragon.installFlow.start`](/apis/api-reference#installflow), so it is available once the credential has been created (e.g. during the `postOptions` stage).

  **Fixes:**

  * Fixed an issue where passing an invalid `accountType` to `paragon.connect` or `paragon.installIntegration` would silently fall back to showing all available authentication options instead of surfacing a clear error.
</Update>

<Update label="v2.4.2">
  **Fixes:**

  * Fixed `installFlow.cancel()` not properly stopping the underlying session polling when cancelling an active OAuth flow.
</Update>

<Update label="v2.4.1">
  **Improvements:**

  * Updated TypeScript types for [`paragon.getUser`](/apis/api-reference#getuser) so that `resources[*].providerData` is now typed and accessible.

  **Fixes:**

  * Fixed concurrent [`paragon.request`](/apis/api-reference#request) proxy GET calls to the same URL failing with a "body stream already read" error.
  * Fixed error propagation in the Connect OAuth popup for Custom Integrations when credential values are empty.
</Update>

<Update label="v2.4.0">
  **Improvements:**

  * Added functions for retrieving available triggers in ActionKit and listing required parameters for rendering with the [Headless Connect Portal](/connect-portal/headless-connect-portal).

  **Fixes:**

  * Fixed requested browser permissions so that copy-to-clipboard inputs correctly write to the user's clipboard.
</Update>

<Update label="v2.3.2">
  **Improvements:**

  * Recategorized `React` as a peer dependency in the Connect SDK to enable better compatibility with React 18+ applications.
  * Updated types for [`paragon.request`](/apis/api-reference#request), so `requestOptions` properties can be omitted when not needed, improving TypeScript ergonomics.

  **Fixes:**

  * Fixed persona metadata key normalization improving SDK efficiency.
</Update>

<Update label="v2.3.1">
  **Fixes:**

  * Fixed Custom Integration identifier handling so the SDK now uses the `slug` returned by the API instead of recomputing one from the integration display name.

  <Info>
    **Custom Integration identifiers are now immutable**

    Before API version [2026-04](/changelog/api#2026-04), changing the display name of a Custom Integration would result in a change in the integration identifier/slug (used in `paragon.connect`) and the integration source path (after a `para pull`).

    This identifier is now immutable and set at the time your Custom Integration is created.

    For existing Custom Integrations, the identifier is set immutably to the same value it currently has in your project. SDK versions \< 2.3.1 will continue to use name-derived identifiers and work without issue. You can upgrade to v2.3.1 or later to use the current, immutable identifiers.

    Learn more about these changes in the [API Changelog](/changelog/api#2026-04).
  </Info>
</Update>

<Update label="v2.3.0">
  **Improvements:**

  * Added [`paragon.setDataSources`](/apis/api-reference#setdatasources) API for centralized configuration of data sources for [Custom Dropdowns](/connect-portal/workflow-user-settings/custom-dropdowns) and [Field Mapping](/connect-portal/field-mapping) inputs in the Headless Connect Portal.
  * Added [`paragon.getSourcesForInput`](/apis/api-reference#getsourcesforinput) resolver to retrieve typed source configurations for inputs, enabling more predictable data source handling with typed discriminators (`SingleSource`, `FieldMapperSources`, `ComboSources`, `DefaultFieldValueSources`).
</Update>

<Update label="v2.2.9">
  **Improvements:**

  * Added support for handling streamed responses in [`paragon.request`](/apis/api-reference#request) proxy requests, enabling proper handling of large file downloads (e.g., from Google Drive).
</Update>

<Update label="v2.2.8">
  **Improvements:**

  * Added `externalId` option to [`paragon.connect`](/apis/api-reference#connect) and [`paragon.installIntegration`](/apis/api-reference#installintegration) for associating credentials with an external identifier. The `externalId` is also available on credential objects returned by [`paragon.getUser`](/apis/api-reference#getuser).

  **Fixes:**

  * Fixed handling of non-ASCII characters in user metadata passed to `paragon.authenticate`. The SDK now properly encodes metadata values, ensuring characters like Unicode text are fully supported.
</Update>

<Update label="v2.2.7">
  **Improvements:**

  * Added `refreshOnOpen` option for custom dropdowns, enabling dropdown values to reload each time the dropdown is opened. This supports dependent dropdown patterns where one dropdown's options change based on another input's value.

  **Fixes:**

  * Fixed Box integration file picker's global CSS styles from leaking into and conflicting with the host application's styles.
  * Fixed misleading error message when calling `paragon.updateWorkflowUserSettings` for workflows that are not deployed.
</Update>

<Update label="v2.2.6">
  **Fixes:**

  * Fixed an issue where the SDK could send the initial request to the wrong server endpoint when restoring state from localStorage before configureGlobal() was called, causing unnecessary requests and errors for customers using custom or on-prem endpoints.
</Update>

<Update label="v2.2.5">
  **Improvements:**

  * Increases the timeout for OAuth connections to complete from 1 minute to 3 minutes.

  **Fixes:**

  * Fixes an issue where the `onComplete` callback to`paragon.installFlow.start` was not always providing the credential details for the account that was connected.
</Update>

<Update label="v2.2.4">
  **Improvements:**

  * Updates the type signature for `picker.init()` to optionally accept a `developerKey` property (required for Google Drive only).
  * Updates the type signature for `paragon.connect` to accept [Custom Dropdowns](/connect-portal/workflow-user-settings/custom-dropdowns) loader functions.
  * Adds support for [Multi-Account Authorization](/apis/api-reference/multi-account-authorization) to `paragon.getFieldOptions`.

  **Fixes:**

  * Fixes an issue that caused stale state to be returned from `paragon.getUser` after calling `paragon.updateIntegrationUserSettings` or `paragon.updateWorkflowUserSettings`.
</Update>

<Update label="v2.2.3">
  **Improvements:**

  * Adds a new `InstructionStage` to the [Headless Connect Portal](/connect-portal/headless-connect-portal) to render instructional text as required by integration install flows (such as Salesforce package installation).

  **Fixes:**

  * Fixes an issue that prevented Dynamic Field Mapping from rendering properly in the headful Connect Portal.
</Update>

<Update label="v2.2.2">
  **Improvements:**

  * Adds support for Shared Drives in the [Google Drive File Picker](/resources/integrations/google-drive#using-the-google-drive-file-picker) as a tab in the picker. You can enable this with the following options:

    ```js theme={null}
    const picker = new paragon.ExternalFilePicker("googledrive", {
      integrationOptions: {
        googledrive: {
          enableSharedDrives: true
        }
      }
    });
    ```

  * Adds support for `allowMultipleCredentials`, `overrideRedirectUrl`, and `selectedCredentialId` install options to the Headless Connect Portal [`InstallFlow`](/apis/api-reference#installflow).
    * **Note**: In previous versions, [Multi-Account Authorization](/apis/api-reference/multi-account-authorization) was automatically enabled for the Headless Connect Portal. The `allowMultipleCredentials: true` option must now be passed to opt-in to Multi-Account Authorization for consistency with other SDK functions.
</Update>

<Update label="v2.2.1">
  **Improvements:**

  * Updates [Google Drive File Picker](/resources/integrations/google-drive#using-the-google-drive-file-picker) MIME type filtering by using the `setSelectableMimeTypes` option in the Google Picker SDK. This change means that all files will *appear* in the view, but only MIME types passed in `allowedTypes` array will be selectable (mirroring the behavior of other file pickers).
  * Adds a new function [`paragon.getCustomWebhookUserManualUrl`](/apis/api-reference#getcustomwebhookusermanualurl) for constructing the URL of user-level [Custom Webhooks](/resources/custom-webhooks). This function can be used to prompt your user to register a Custom Webhook URL in their integration account settings.

  **Fixes:**

  * Fixes the base URL used for the Proxy API when using the SDK for on-prem environments.
</Update>

<Update label="v2.2.0">
  **Improvements:**

  * Improves the security of OAuth connection flows.

  <Warning>
    **For on-prem customers:** This SDK update requires that your instance version has been upgraded to `2025.1028` or later.

    You can verify your current version by visiting the `/infoz` path of your dashboard / login URL. Reach out to your Customer Success Manager to request an instance upgrade.
  </Warning>
</Update>

<Update label="v2.1.4">
  **Fixes:**

  * Fixes a compatibility issue between the SDK using certain Redux libraries by preventing returning internally-managed state in SDK responses.
</Update>

<Update label="v2.1.3">
  **Fixes:**

  * Updates the base URL used for triggering App Events and Workflows from the SDK to the newest service URL.
  * Fixes an issue where `X-Paragon-Credential` was included in outgoing HTTP headers when not explicitly set by the SDK.
</Update>

<Update label="v2.1.2">
  **Improvements:**

  * Adds `paragon.installFlow.cancel` to the [Headless Connect Portal](/connect-portal/headless-connect-portal) API to cancel in-progress installs. [Learn more](/apis/api-reference#installflowcancel)

  **Fixes:**

  * Fixes an issue where `onSuccess` callbacks would not fire for some types of integrations.
  * Fixes types for `paragon.request` to include `selectedCredentialId` for Multi-Account Auth.
  * Fixes an issue where credentials with a non-`VALID` status could not be uninstalled with `paragon.uninstallIntegration`.
</Update>

<Update label="v2.1.1">
  **Improvements:**

  * Adds support for the `user-configured-oauth` authentication type for the Headless Connect Portal.

  **Fixes:**

  * Fixes types for `paragon.installIntegration` to include `selectedCredentialId` in available options.
  * Fixes connection issues for the Headless Connect Portal for certain integrations that have a PreOptionsStage, like Zendesk.
</Update>

<Update label="v2.1.0">
  **Improvements:**

  * Adds support for `oauthTimeout` option to the [`paragon.installFlow.start`](/apis/api-reference#installflowstart) method of the Headless Connect Portal, to specify the number of milliseconds to wait for the OAuth prompt to complete.
  * Adds `OAuthBlockedError` and `OAuthTimeoutError` as possible error types for [`paragon.installFlow.start`](/apis/api-reference#installflowstart) to detect when the OAuth prompt is blocked by the browser or takes longer than expected.
</Update>

<Update label="v2.0.10">
  **Improvements:**

  * Adds a centralized `onError` callback for the [`paragon.installFlow.start`](/apis/api-reference#installflowstart) method of the Headless Connect Portal.

  **Fixes:**

  * Fixes types for `paragon.connect` to include definitions for Custom Dropdowns.
  * Fixes an issue where Multi-Account Authorization could not be used with the [Headless Connect Portal](/connect-portal/headless-connect-portal).
</Update>

<Update label="v2.0.9">
  **Fixes:**

  * Fixes an issue where Multi-Config could not be used correctly when [sending App Events](/apis/api-reference#event) with the SDK.
</Update>

<Update label="v2.0.8">
  **Improvements:**

  * Adds support for Multi-Account Authorization for [File Pickers](/apis/api-reference#externalfilepicker).
</Update>

<Update label="v2.0.7">
  ## New: Field Mapping for all integrations

  You can now define custom Field Mapping inputs for any integration using the SDK.

  Learn more about how to use the new SDK options in the [Field Mapping documentation](/connect-portal/field-mapping#passing-your-own-integration-objects-and-fields).
</Update>

<Update label="v2.0.6">
  **Improvements:**

  * Updates `paragon.request` method to use the new URL changes introduced in the [2025-07 API release](/changelog/api#2025-07).

  **Fixes:**

  * Fixes an issue where the Headless Connect Portal might not progress to the post-OAuth stage when the OAuth prompt is completed.
</Update>

<Update label="v2.0.5">
  **Improvements:**

  * Adds support for [Box](/resources/integrations/box) File Picker.

  **Fixes:**

  * Fixes an issue where `showPortalAfterInstall` option in `paragon.installIntegration` did not correctly prompt the Connect Portal after install.
  * Fixes an issue where the Headless Connect Portal (using `paragon.installIntegration`) intermittently did not show post-OAuth options (such as SharePoint site selection) after the OAuth prompt was completed.
</Update>

<Update label="v2.0.4">
  **Improvements:**

  * Exposes new `CredentialStatus` and `IntegrationMetadata` types from the SDK.
</Update>

<Update label="v2.0.3">
  **Improvements:**

  * Removes call to `/sdk/projects` to improve performance of SDK authentication.
</Update>

<Update label="v2.0.2">
  **Improvements:**

  * Updates return types of Headless Connect Portal function `paragon.getDataSourceOptions` to show all available fields for input sources.
</Update>

<Update label="v2.0.1">
  **Improvements:**

  * Updates `paragon.getFieldOptions` function to make `parameters` field optional.
</Update>

<Update label="v2.0.0">
  ## New: Headless Connect Portal improvements

  We have made major improvements to the Headless Connect Portal which now support all functions of the hosted Connect Portal, including User Settings, Field Mappings, and Workflows.

  See our updated documentation and example implementation [here](/connect-portal/headless-connect-portal).

  ### Breaking changes

  * **There are no breaking changes in this release**. If you are using the Headless Connect Portal in v1.x of the SDK, all existing functionality with `paragon.installIntegration` will be preserved.
  * To opt-in to improvements to the Headless Connect Portal that can utilize more of your own UI components, see our migration guide below.

  ### Migrating from v1 of the Headless Connect Portal

  If you are currently using the Headless Connect Portal in v1.x of the SDK, you can update your implementation to take advantage of the new functions introduced in this release.

  1. Call `paragon.setHeadless` in your implementation to opt in to the new version of the Headless Connect Portal:
     ```js theme={null}
     paragon.setHeadless(true);
     ```
  2. Implement all stages of the authentication flow described in the Headless Connect Portal docs. In v1.x of the SDK, the following stages were handled by the headful Connect Portal appearing and should now be implemented by your own components:
     * Account Type selection (e.g. Salesforce Production vs. Salesforce Sandbox) -- `AccountTypeStage`

     * Pre-OAuth / API Key inputs (e.g. Stripe API Key input, Shopify Store URL) -- `PreOptionsStage`

     * Post-OAuth inputs (e.g. Atlassian site, SharePoint site selection) -- `PostOptionsStage`

     * To implement the above stages, replace `paragon.installIntegration` with `paragon.installFlow.start` (this function will guide you through the above install stages):
     ```js Migrating to installFlow theme={null}
     paragon.installIntegration("salesforce"); // [!code --]
     paragon.installFlow.start("salesforce", { // [!code ++]
         // Handle all stages of the install flow // [!code ++]
     }); // [!code ++]
     ```
</Update>


# 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 alt="Paragon's out-of-the-box Connect Portal" />
</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 alt="" />
</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 alt="" />
</Frame>

<Card title="User Settings" href="/connect-portal/workflow-user-settings" 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" 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 alt="" />
</Frame>

#### Dark

<Frame>
  <img alt="" />
</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 alt="" />
</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 alt="" />
</Frame>

### Workflow Display Options

By clicking on a workflow row, you can edit the display options for that specific workflow:

<Frame>
  <img alt="" />
</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" />

#### 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
"
/>


# 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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>
  <img alt="" />

  <img alt="" />
</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 alt="" />
</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 theme={null}
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 alt="" />
</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 theme={null}
  // objectTypes
  {
    get: async (cursor, search) => {
      return [
        { label: "Contact", value: "contact" },
        { label: "Deal", value: "deal" },
        { label: "Opportunity", value: "opportunity" }
      ]
    }
  }
  ```

  ```ts objectTypes: Paginated Dropdown theme={null}
  // 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 theme={null}
    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 theme={null}
    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 theme={null}
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 alt="" />
</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>
  <img alt="" />
</Frame>

<Frame>
  <img alt="" />
</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 theme={null}
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 alt="" />
</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>
  <img alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</Frame>

### Using Field Mappings in Function Steps

For more advanced use cases, you can pass a Field Mapping configuration into a [Function step](/workflows/functions#using-field-mappings-in-functions) and use the `paragonUtils` library to programmatically transform data. This gives you full control over the transformation — for example, mapping arrays of objects, applying additional logic, or chaining mappings with other operations.

```js theme={null}
function yourFunction(parameters, libraries) {
  const { paragonUtils } = libraries;
  const { fieldMapping, records } = parameters;

  return paragonUtils.mapIntegrationObjects(fieldMapping, records);
}
```

<Card title="Using Field Mappings in Functions" href="/workflows/functions#using-field-mappings-in-functions" />

## 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.

The Headless Connect Portal can be used with your own UI components or design system to make your integrations feel native to the design of your app, while leveraging the SDK for all of the backend details of connecting and configuring your users' integrations.

Headless mode still provides **fully managed authentication**, so you don't need to worry about managing, storing, or refreshing your customers' credentials.

## Example Implementation

Below is an end-to-end example implemented with React and [shadcn/ui](https://ui.shadcn.com/) components (no pre-built Paragon components are used):

<Frame>
  <img alt="" />
</Frame>

We have open-sourced the above implementation in a public repository here:

<Card title="useparagon/connect-headless-example" icon="github" href="https://github.com/useparagon/connect-headless-example">
  An end-to-end implementation example of the Headless Connect Portal using
  React
</Card>

You can use the example implementation or any of its components as a starting point for your application, or read on to learn how to implement it yourself.

## Usage

To implement the Headless Connect Portal, use the SDK to implement the following product surfaces in your app:

* **Integrations Catalog**: Listing all available integrations in a catalog to allow your users to discover integrations and connect their accounts.
* **Integration Install / Uninstall Flow**: Guiding your user through the install stages of any integration, including the OAuth 2.0 flow (if required for the integration)
* **User Settings and Workflow Configuration**: Providing inputs for users to configure [User Settings](/connect-portal/workflow-user-settings) for their integration.

Follow the sections below to learn how to implement each of these product surfaces using the Paragon SDK.

<Info>
  **Have you implemented SDK authentication?**

  The Usage guide below assumes that you have already implemented the basics of SDK authentication described in [Getting Started](/getting-started/installing-the-connect-sdk). All of the functions below should be called *after* SDK authentication is completed.
</Info>

### Enabling Headless Mode

To turn on Headless mode for the SDK, call the `paragon.setHeadless` function:

```js theme={null}
import { paragon } from "@useparagon/connect";

paragon.setHeadless(true);
```

This only needs to be called once after SDK initialization to use the Headless Connect Portal functions.

### Integrations Catalog

In your app's Integrations Catalog or Settings view, list available integrations from your Paragon project to allow your users to discover integrations and connect their accounts:

<Frame>
  <img alt="" />
</Frame>

You can render this view by calling `paragon.getIntegrationMetadata`:

```js theme={null}
paragon.getIntegrationMetadata();
```

Each entry in the returned list will be an object with the integration's display metadata, including the brand name, icon, and accent color:

```js theme={null}
[
  {
    type: "salesforce",
    name: "Salesforce",
    brandColor: "#057ACF",
    icon: "https://cdn.useparagon.com/latest/dashboard/public/integrations/salesforce.svg",
  },
];
```

<Columns>
  <Card
    title="Integrations Catalog Example"
    href="https://github.com/useparagon/connect-headless-example/blob/main/src/components/feature/integration/integration-list.tsx
"
  >
    See our reference implementation of the Integrations Catalog in the example
    repo.
  </Card>

  <Card title="SDK Reference" href="/apis/api-reference#getintegrationmetadata">
    Learn more about `paragon.getIntegrationMetadata` in the SDK Reference.
  </Card>
</Columns>

#### Integration Detail View

As a part of your catalog, you may want to show users additional information when they click on an integration (or inline with the catalog):

<Frame>
  <img alt="Headless Connect Portal modal" />
</Frame>

To get the additional user-facing descriptions and informational text about the integration [configured in your Paragon dashboard](/connect-portal/connect-portal-customization), use [`paragon.getIntegrationConfig`](/apis/api-reference#getintegrationconfig):

```js theme={null}
paragon.getIntegrationConfig("slack");
```

This will return an object with the descriptions, User Settings, and Workflows associated with the integration:

```json Response expandable theme={null}
{
  "shortDescription": "Send notifications to Slack",
  "longDescription": "Connect your Slack workspace to receive notifications and alerts in Slack. Stay connected to important activity by bringing it all together in your Slack workspace.\n\nOur Slack integration enables you to:\n\n• Receive alerts and notifications in your Slack workspace\n• Notify or DM specific team members based on certain activity",
  "availableUserSettings": [
    {
      "id": "2d5662c9-6750-46c2-8588-2ac904532efb",
      "type": "DYNAMIC_ENUM",
      "title": "Channel",
      "required": false,
      "sourceType": "channels"
    }
  ],
  "availableWorkflows": [
    {
      "id": "2248335c-671c-47e4-b9a0-3641a9f2d301",
      "inputs": [],
      "infoText": "Send a Slack notification when a Task is created",
      "defaultEnabled": false,
      "description": "Send Slack Notification"
    }
  ],
  "hiddenWorkflows": []
}
```

<Columns>
  <Card
    title="Integration Detail View Example"
    href="https://github.com/useparagon/connect-headless-example/blob/main/src/components/feature/integration/integration-modal/integration-modal.tsx#L34-L36
"
  >
    See our reference implementation of the Integration Detail View in the
    example repo.
  </Card>

  <Card title="SDK Reference" href="/apis/api-reference#getintegrationconfig">
    Learn more about `paragon.getIntegrationConfig` in the SDK Reference.
  </Card>
</Columns>

#### Displaying Account State

To display your user's account connection status in the Integrations Catalog (for example, showing a "Manage" button instead of a "Connect" button for integrations they have already installed), call `paragon.getUser` to get the user's account state and `paragon.subscribe` to react to state changes.

```js Getting account state with getUser expandable theme={null}
paragon.getUser();

// Returns:
{
  "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 **Manage** button, depending on the value of `user.integrations[integrationType].enabled`.

You can also react to changes in your UI by setting up `paragon.subscribe` handlers:

```js Example component using subscribe() to react to user state changes expandable theme={null}
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]);
}
```

<Card title="SDK Reference" href="/apis/api-reference#getuser">
  Learn more about `paragon.getUser` in the SDK Reference.
</Card>

### Integration Install / Uninstall Flow

Once a user expresses intent to connect their account, guide them through an **Install Flow** using the Paragon SDK:

<Frame>
  <img alt="" />
</Frame>

To implement an Install Flow, your app will need to handle the following stages of the installation process which should take place in your app (the stages used by each integration will vary):

* Account Type selection (e.g. Salesforce Production vs. Salesforce Sandbox) -- `AccountTypeStage`
* Pre-OAuth / API Key inputs (e.g. Stripe API Key input, Shopify Store URL) -- `PreOptionsStage`
* Post-OAuth inputs (e.g. Atlassian site, SharePoint site selection) -- `PostOptionsStage`
* Instructional content (e.g. Salesforce package installation) -- `InstructionStage`

<Info>
  See a full reference of install flow stages and their properties in the [SDK Reference](/apis/api-reference#installflowstage).
</Info>

Any redirection or popup window that is required for OAuth will automatically occur between stages. The SDK will internally manage all state for the popup window and OAuth prompt, but if an error occurs during the install flow, you can receive errors using the `onError` callback and prompt users of any issues.

Begin an Install Flow by calling `paragon.installFlow.start`:

```js theme={null}
paragon.installFlow
  .start(props.integration, {
    onNext: (next) => {
      // Handle next install stage by presenting or updating UI for user input
    },
    onComplete: () => {
      // Installation has completed successfully
    },
    onError: (error, errorContext) => {
      // Handle error messaging
    }
  });
```

After calling `.start`, you may receive required install stages in the `onNext` callback (depending on the specific install flow required by the integration).

To handle each of the install stages in your app, you will need to:

1. Receive the stage details in the `onNext` callback.
2. Render the appropriate UI for your user to provide the necessary details in that stage.
   <Info>
     For the `PostOptionsStage`, refer to [the User Settings docs](#exposing-user-settings) below for help rendering integration-specific dropdown inputs.
   </Info>
3. Update SDK state with the user's inputs by calling one of:
   * [`installFlow.setAccountType`](/apis/api-reference#installflowsetaccounttype)
   * [`installFlow.setPreOptions`](/apis/api-reference#installflowsetpreoptions)
   * [`installFlow.setPostOptions`](/apis/api-reference#installflowsetpostoptions)

#### Example Install Flow

Here's a step-by-step example for how these stages would be implemented for Salesforce account types:

1. **Receive the `AccountTypeStage` in `onNext` handler:**
   ```js theme={null}
   paragon.installFlow.start("salesforce", {
     onNext: (next) => {
       if (next.stage === "accountType") {
         setAccountTypes(next.stage.options);
         // [{ "id": "default", "accountDescription": "Production Account", "scheme": "oauth" }, {...}, {...}]
       }
     },
   });
   ```
2. **Render account type options for your user to select the available types:**
   ```jsx theme={null}
   return accountTypes.map((accountType) => {
     return (
       <Button
         key={accountType.id}
       >
         {accountType.accountDescription}
       </Button>
     );
   });
   ```
   <Frame>
     <img alt="Account Types selector" />
   </Frame>
3. **Update SDK state with the user's inputs:**

   Bind the `onClick` handler for the account type selection buttons to confirm the user's selection and start the OAuth flow.

   ```jsx theme={null}
   return accountTypes.map((accountType) => {
     return (
       <Button
         key={accountType.id}
         onClick={() => paragon.installFlow.setAccountType(accountType.id)} // [!code ++]
       >
         {accountType.accountDescription}
       </Button>
     );
   });
   ```

To implement the other Install Flows, check out our example implementation or SDK Reference:

<Columns>
  <Card title="Integration Install Flow Example" href="https://github.com/useparagon/connect-headless-example/blob/5e32d8b/src/components/feature/integration/integration-modal/integration-modal.tsx#L53-L92">
    See our reference implementation of the Integration Install Flow in the
    example repo.
  </Card>

  <Card title="SDK Reference" href="/apis/api-reference#installflow">
    Learn more about `paragon.installFlow` and all related methods in the SDK Reference.
  </Card>
</Columns>

#### Uninstalling Integrations

When a user requests to disconnect their account, call `paragon.uninstallIntegration` to remove their account:

```js theme={null}
async function onClickUninstall() {
  setUninstalling(true);
  await paragon.uninstallIntegration(props.integration);
  setUninstalling(false);
}
```

This function returns a Promise that resolves when the account has been fully disconnected from Paragon (including any workflows or settings they may have configured).

<Card title="SDK Reference" href="/apis/api-reference#uninstallintegration">
  Learn more about `paragon.uninstallIntegration` in the SDK Reference.
</Card>

### User Settings and Workflow Configuration

After your user has connected an integration, show a Configuration screen with your configured [User Settings](/connect-portal/workflow-user-settings) to customize their integration, like a Salesforce Field Mapping or a Google Drive Folder to sync files from.

If you are using [Workflows](/workflows/overview) and want your users to have controls to opt-in or out of specific Workflows, you can render toggles to enable or disable Workflows.

<Frame>
  <img alt="Google Drive User Settings" />
</Frame>

You can use the [`paragon.getIntegrationConfig`](/apis/api-reference#getintegrationconfig) method to get all the User Settings that you have configured for this integration's Connect Portal:

```js theme={null}
paragon.getIntegrationConfig(type);
```

User Settings will be available as the `availableUserSettings` key of the response.

```json Response focus={2-10} expandable theme={null}
{
  "availableUserSettings": [
    {
      "id": "2d5662c9-6750-46c2-8588-2ac904532efb",
      "type": "DYNAMIC_ENUM",
      "title": "Channel",
      "required": false,
      "sourceType": "channels"
    }
  ],
  "shortDescription": "Send notifications to Slack",
  "longDescription": "Connect your Slack workspace to receive notifications and alerts in Slack. Stay connected to important activity by bringing it all together in your Slack workspace.\n\nOur Slack integration enables you to:\n\n• Receive alerts and notifications in your Slack workspace\n• Notify or DM specific team members based on certain activity",
  "availableWorkflows": [
    {
      "id": "2248335c-671c-47e4-b9a0-3641a9f2d301",
      "inputs": [],
      "infoText": "Send a Slack notification when a Task is created",
      "defaultEnabled": false,
      "description": "Send Slack Notification"
    }
  ],
  "hiddenWorkflows": []
}
```

#### Exposing User Settings

User Settings are inputs that appear during the install or configure stage of the Connect Portal, like the Folder input in the example above. Your implementation should render inputs when:

* Your user is prompted with pre-OAuth options (`PreOptionsStage`)
* Your user is prompted with post-OAuth options (`PostOptionsStage`)
  * For both `PreOptionsStage` and `PostOptionsStage`, User Settings objects can be found in `stage.options`.
* Your user is configuring integration-level or workflow-level [User Settings](/connect-portal/workflow-user-settings)
  * User Settings objects can be found in [`paragon.getIntegrationConfig`](/apis/api-reference#getintegrationconfig), under `availableUserSettings` and `availableWorkflows[n].inputs`.

Some User Settings (such as `SidebarInputType.DynamicEnum` or `SidebarInputType.FieldMapping`) will require you to render a dynamic list of options from the integration (a "data source"). You can use the following functions to help load this list:

* [`paragon.getSourcesForInput`](/apis/api-reference#getsourcesforinput) - Get the data sources needed to render a dynamic input. Returns the appropriate data source objects which can be passed directly to `paragon.getFieldOptions`.
* [`paragon.getFieldOptions`](/apis/api-reference#getfieldoptions) - Load a page of options from a data source to show in a dropdown input.

```js DynamicEnum input expandable theme={null}
let config = paragon.getIntegrationConfig("slack");
let input = config.availableUserSettings[0];
// { id: "...", type: "DYNAMIC_ENUM", title: "Channel", sourceType: "channels" }

let sources = paragon.getSourcesForInput("slack", input);
// { kind: "single", source: { type: "DYNAMIC_DATA_SOURCE", cacheKey: "channels", ... } }

// Load options using the source object:
if (sources?.kind === "single") {
  await paragon.getFieldOptions({
    integration: "slack",
    source: sources.source,
  });
  // { data: [{ label: "#general", value: "general" }, ...], nextPageCursor: "..." }
}
```

For compound inputs like Field Mapping, `paragon.getSourcesForInput` returns all the necessary data sources at once:

```js Field Mapping input expandable theme={null}
let config = paragon.getIntegrationConfig("salesforce");
let input = config.availableUserSettings[0];
// { id: "...", type: "FIELD_MAPPER", title: "Map fields for a Task", sourceType: "customObjectMapping" }

let sources = paragon.getSourcesForInput("salesforce", input);
// { kind: "fieldMapper", recordSource: {...}, fieldSource: {...} }

if (sources?.kind === "fieldMapper") {
  // Load Record Types:
  await paragon.getFieldOptions({
    integration: "salesforce",
    source: sources.recordSource,
  });

  // Load Fields for a selected record type:
  await paragon.getFieldOptions({
    integration: "salesforce",
    source: sources.fieldSource,
    parameters: [{
      key: sources.recordSource.cacheKey,
      source: { type: "VALUE", value: "Task" },
    }],
  });
}
```

You can see a full list of input types that are used by the Connect Portal and must be rendered by your implementation in [Input Types Reference](/connect-portal/input-types-reference). Alternatively, you can start by using our React-based input renderer in our [reference implementation](https://github.com/useparagon/connect-headless-example/blob/main/src/components/feature/integration/integration-modal/components/integration-settings.tsx).

#### Defining Custom Data Sources

If your Connect Portal inputs use [Custom Dropdowns](/connect-portal/workflow-user-settings/custom-dropdowns) or Field Mapping with your own integration or application fields, you can use [`paragon.setDataSources`](/apis/api-reference#setdatasources) to register these data sources with the SDK.

Call `paragon.setDataSources` once after enabling headless mode, before rendering any inputs:

```js theme={null}
paragon.setHeadless(true);

paragon.setDataSources({
  dropdowns: {
    my_custom_dropdown: [
      { label: "Option A", value: "a" },
      { label: "Option B", value: "b" },
    ],
  },
  integrationSpecificSources: {
    salesforce: {
      dropdowns: {
        departments: [
          { label: "Engineering", value: "eng" },
          { label: "Sales", value: "sales" },
        ],
      },
    },
  },
});
```

Data sources registered with `paragon.setDataSources` are automatically resolved by `paragon.getSourcesForInput` and `paragon.getFieldOptions`. Integration-specific sources take priority over global sources when the same key is used.

<Card title="SDK Reference" href="/apis/api-reference#setdatasources">
  Learn more about `paragon.setDataSources` and its configuration options in the SDK Reference.
</Card>

Once user input is collected, you can save the values back to Paragon using one of the following functions, depending on the input's context:

* [`setPreOptions`](/apis/api-reference#installflowsetpreoptions) - Save pre-OAuth options and start the OAuth flow.
* [`setPostOptions`](/apis/api-reference#installflowsetpostoptions) - Save post-OAuth options and complete account connection.
* [`paragon.updateIntegrationUserSettings`](/apis/api-reference#updateintegrationusersettings) - Save integration-level User Settings.
* [`paragon.updateWorkflowUserSettings`](/apis/api-reference#updateworkflowusersettings) - Save workflow-level User Settings.

<Columns>
  <Card title="User Settings Example" href="https://github.com/useparagon/connect-headless-example/blob/main/src/components/feature/integration/integration-modal/components/integration-settings.tsx">
    See our reference implementation of User Settings in the
    example repo.
  </Card>

  <Card title="Input Types Reference" href="/connect-portal/input-types-reference">
    Learn more about the different Input Types to implement in our reference.
  </Card>
</Columns>

#### Exposing Workflow Configuration

<Frame>
  <img alt="Workflow Configuration example" />
</Frame>

In the Configuration tab of the headful Connect Portal, a list of Workflows appears as a list of toggles that users can opt-in or out of. This is not required if you do not use Workflows are your Workflows are set to be [enabled by default](/connect-portal/displaying-workflows#default-to-enabled).

* To render the list of available Workflows, you can use [`paragon.getIntegrationConfig`](/apis/api-reference#getintegrationconfig) and read the `availableWorkflows` key.
* To see what Workflows the user has enabled, you can use [`paragon.getUser`](/apis/api-reference#getuser) and read `user.integrations[].configuredWorkflows[].enabled`.
  ```js Getting Workflow state expandable theme={null}
  paragon.getUser();

  // Response:
  {
    "integrations": {
      "slack": {
        // (other properties excluded for brevity)
        "configuredWorkflows": {
          "7b516f0f-2581-470f-a26d-72dfa7b9b554": {
            "enabled": false,
            "settings": {}
          }
        }
      }
    }
  }
  ```
* To toggle a Workflow on or off for a user, you can use [`paragon.updateWorkflowState`](/apis/api-reference#updateworkflowstate) to pass a partial update object of the Workflows that should be enabled or disabled for a user.
  ```js Updating Workflow state theme={null}
  paragon.updateWorkflowState({
    // [Workflow UUID]: boolean
    "7b516f0f-2581-470f-a26d-72dfa7b9b554": true,
  });
  ```

<Columns>
  <Card title="Workflow Configuration Example" href="https://github.com/useparagon/connect-headless-example/blob/main/src/components/feature/integration/integration-modal/components/workflows.tsx">
    See our reference implementation of User Settings in the
    example repo.
  </Card>

  <Card title="SDK Reference" href="/apis/api-reference#updateworkflowstate">
    Learn more about the `paragon.updateWorkflowState` method in the SDK Reference.
  </Card>
</Columns>

## Multiple Account Authorization

When implementing the Headless Connect Portal for [Multiple Account Authorization](/apis/api-reference/multi-account-authorization), you'll need to update your UI to handle listing multiple connections for a given integration.

You can use `selectedCredentialId` in the following SDK functions to ensure that the right account is used in multi-account setups:

* [`paragon.updateIntegrationUserSettings`](/apis/api-reference#updateintegrationusersettings)
  ```js theme={null}
  paragon.updateIntegrationUserSettings("googledrive", {
    [selectedInput.id]: newValue,
  }, {
    selectedCredentialId: "376910a0-74aa-4e5e-88ab-122a7fb20a56",
  });
  ```

* [`paragon.updateWorkflowUserSettings`](/apis/api-reference#updateworkflowusersettings)
  ```js theme={null}
  paragon.updateWorkflowUserSettings("googledrive", selectedWorkflow.id, {
    [selectedInput.id]: newValue,
  }, {
    selectedCredentialId: "376910a0-74aa-4e5e-88ab-122a7fb20a56",
  });
  ```

* [`paragon.updateWorkflowState`](/apis/api-reference#updateworkflowstate)
  ```js theme={null}
  paragon.updateWorkflowState({
    "7b516f0f-2581-470f-a26d-72dfa7b9b554": true,
  }, {
    selectedCredentialId: "376910a0-74aa-4e5e-88ab-122a7fb20a56",
  });
  ```

* [`paragon.uninstallIntegration`](/apis/api-reference#uninstallintegration)
  ```js theme={null}
  paragon.uninstallIntegration("googledrive", {
    selectedCredentialId: "376910a0-74aa-4e5e-88ab-122a7fb20a56",
  });
  ```

* [`paragon.getFieldOptions`](/apis/api-reference#getfieldoptions)
  ```js theme={null}
  paragon.getFieldOptions({
    integration: "googledrive",
    action: "folders",
    selectedCredentialId: "376910a0-74aa-4e5e-88ab-122a7fb20a56",
  });
  ```

In all of the above, you can get the Credential ID for an account from [`paragon.getUser`](/apis/api-reference#getuser), in `user.integrations[].allCredentials[n].id`.

## SDK Reference

The SDK includes the key functions below that should be used when implementing the Headless Connect Portal. Find more details about each function (including parameter types and return values) in the linked reference page.

* [`paragon.getIntegrationMetadata`](/apis/api-reference#getintegrationmetadata): Returns display and branding information for integrations in your project, including a display name and icon.
* [`paragon.installFlow.start`](/apis/api-reference#installflowstart): 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.installFlow.setAccountType`](/apis/api-reference#installflowsetaccounttype): Sets the account type for an integration being actively installed.
  * [`paragon.installFlow.setPreOptions`](/apis/api-reference#installflowsetpreoptions): Sets the pre-OAuth options for an integration being actively installed.
  * [`paragon.installFlow.setPostOptions`](/apis/api-reference#installflowsetpostoptions): Sets the post-OAuth options for an integration being actively installed.
* [`paragon.uninstallIntegration`](/apis/api-reference#uninstallintegration): Disconnects the user's account.
* [`paragon.getIntegrationConfig`](/apis/api-reference#getintegrationconfig): Returns the configuration for an integration, including its available User Settings and Workflows.
* [`paragon.getUser`](/apis/api-reference#getuser): Returns the current state of the user, with their integrations and account statuses.
* [`paragon.updateIntegrationUserSettings`](/apis/api-reference#updateintegrationusersettings): Updates integration-level User Settings values.
* [`paragon.updateWorkflowUserSettings`](/apis/api-reference#updateworkflowusersettings): Updates workflow-level User Settings values.
* [`paragon.updateWorkflowState`](/apis/api-reference#updateworkflowstate): Enables or disables Workflows for a user.
* [`paragon.setDataSources`](/apis/api-reference#setdatasources): Registers custom data sources for dropdown and field mapping inputs, globally or per-integration. *(SDK 2.3.0+)*
* [`paragon.getSourcesForInput`](/apis/api-reference#getsourcesforinput): Returns the data sources needed to render a specific input, which can be passed directly to `paragon.getFieldOptions`. *(SDK 2.3.0+)*
* [`paragon.getFieldOptions`](/apis/api-reference#getfieldoptions): Returns integration-specific options for dynamic User Settings, such as Dynamic Enum or Field Mapping inputs.
* [`paragon.getDataSourceOptions`](/apis/api-reference#getdatasourceoptions): For compound inputs, returns the configuration for each data source needed to render the input.


# Input Type Reference
Source: https://docs.useparagon.com/connect-portal/input-types-reference

Input types to render in the Connect Portal for User Settings.

## Overview

This is a reference of all of the input types that are used in the Connect Portal for collecting user input for pre-OAuth options, post-OAuth options, or User Settings.

Implement handlers for each input type to ensure that your UI can prompt your users with the right input types when needed by the integration.

<Tip>
  If your app uses React, we recommend starting with our [reference implementation](https://github.com/useparagon/connect-headless-example/blob/main/src/components/feature/serialized-connect-input-picker.tsx), which handles each of the input types below. You can adapt this code for your app or use it as a reference point as you implement.
</Tip>

Some inputs will require loading integration data dynamically using the SDK (for example, loading a list of channels from Slack). See [Exposing User Settings](/connect-portal/headless-connect-portal#exposing-user-settings) for more guidance on loading dynamic data.

## Input Types

<table>
  <thead>
    <tr>
      <th>Input Type</th>
      <th>SidebarInputType Key(s)</th>
      <th>Example (click to expand)</th>
      <th>Used In</th>
      <th>Value Type</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>**Text input**<br />Set the <code>type</code> attribute of the text input based on the input type.</td>
      <td><code>ValueText</code> | <code>Number</code> | <code>Email</code> | <code>URL</code> | <code>Password</code></td>

      <td>
        <img />
      </td>

      <td>
        <ul>
          <li>PreOptionsStage</li>
          <li>PostOptionsStage</li>
          <li>User Settings</li>
        </ul>
      </td>

      <td>`string`</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>ValueTextArea</code></td>

      <td>
        <img />
      </td>

      <td>
        <ul>
          <li>PreOptionsStage</li>
          <li>PostOptionsStage</li>
          <li>User Settings</li>
        </ul>
      </td>

      <td>`string`</td>
    </tr>

    <tr>
      <td>**Switch / toggle input**</td>
      <td><code>BooleanInput</code> | <code>Switch</code></td>

      <td>
        <img />
      </td>

      <td>
        <ul>
          <li>PreOptionsStage</li>
          <li>PostOptionsStage</li>
          <li>User Settings</li>
        </ul>
      </td>

      <td>`boolean`</td>
    </tr>

    <tr>
      <td><strong>Dropdown input</strong></td>
      <td><code>Enum</code> | <code>DynamicEnum</code> | <code>CustomDropdown</code></td>

      <td>
        <img />
      </td>

      <td>
        <ul>
          <li>PreOptionsStage (`Enum` only)</li>
          <li>PostOptionsStage (`Enum` and `DynamicEnum` only)</li>
          <li>User Settings</li>
        </ul>
      </td>

      <td>`string`</td>
    </tr>

    <tr>
      <td>
        <strong>Combo dropdown input</strong><br />
        Dual dropdown input where items for the secondary dropdown are populated based on the input of the primary dropdown.
      </td>

      <td><code>ComboInput</code></td>

      <td>
        <img />
      </td>

      <td>
        <ul>
          <li>PostOptionsStage</li>
          <li>User Settings</li>
        </ul>
      </td>

      <td>[`ComboDropdownValue`](#combodropdownvalue)</td>
    </tr>

    <tr>
      <td>
        <strong>Field mapping input</strong><br />
        Input to map fields between an Object Type in the connected integration and an Object Type in your application.
      </td>

      <td><code>FieldMapper</code></td>

      <td>
        <img />
      </td>

      <td>
        <ul>
          <li>User Settings</li>
        </ul>
      </td>

      <td>[`FieldMappingValue`](#fieldmappingvalue)</td>
    </tr>

    <tr>
      <td>
        <strong>Default value mapping input</strong><br />
        Input to map "default values" for each field of a particular object when it is created by your integration. <br /><br /><strong>Note:</strong> This is currently only supported for the Jira: Issue Field Values input.
      </td>

      <td><code>DynamicComboInput</code></td>

      <td>
        <img />
      </td>

      <td>
        <ul>
          <li>User Settings</li>
        </ul>
      </td>

      <td>[`DefaultValueMapping`](#defaultvaluemappingvalue)</td>
    </tr>
  </tbody>
</table>

## Compound Value Types

Most input types are saved with [`paragon.updateIntegrationUserSettings`](/apis/api-reference#updateintegrationusersettings) or [`paragon.updateWorkflowUserSettings`](/apis/api-reference#updateworkflowusersettings) as `string` or `boolean` values, but more complex inputs have an object value that must be used to save the state of the input.

Below is a reference for those compound value types.

### ComboDropdownValue

<Frame>
  <img />
</Frame>

A combo dropdown input exposes a dual dropdown: the first input is the `mainInput`, and the second input is the `dependentInput`. Both values are saved as strings.

```json Example theme={null}
{
  "mainInput": "JIRATEST",
  "dependentInput": "10005"
}
```

<ParamField type="string">
  The first input in the combo dropdown, for example: the Project input in a Project / Issue Type combo dropdown.
</ParamField>

<ParamField type="string">
  The second input in the combo dropdown, for example: the Issue Type input in a Project / Issue Type combo dropdown.
</ParamField>

### FieldMappingValue

<Frame>
  <img />
</Frame>

A field mapping input is a compound input which has an Object Type selection (which can be a combo dropdown input) and a list of fields mapped by a user between an Integration Object and an Application Object.

```json Example theme={null}
{
  "objectType": "JIRATEST",
  "dependentInput": "10005",
  "mappingType": "STATIC",
  "fieldMappings": {
    "[Application Field Key]": "[Integration Field Key]"
  }
}
```

<ParamField type="string">
  The Integration Object Type that the user selects.
</ParamField>

<ParamField type="string">
  If the Object Type selection is a combo dropdown input (you can determine this by checking for `dependentInputSource` on the Field Mapping input options returned by [`paragon.getDataSourceOptions`](/apis/api-reference#getdatasourceoptions)), this will be the value of the dependent input selected by the user. Otherwise, this key can be omitted.
</ParamField>

<ParamField type="const">
  Set to `"STATIC"`.
</ParamField>

<ParamField type="object">
  An object where the keys are field keys from the Application Object and the values are field keys from the Integration Object. A key/value pair represents a mapping between a field in the Application Object and a field in the Integration Object.
</ParamField>

### DefaultValueMappingValue

<Frame>
  <img />
</Frame>

A default value mapping input is a compound input which has an Object Type selection (which can be a combo dropdown input) and a list of default values for specific fields of the object.

```json Example theme={null}
{
  "mainInput": "JIRATEST",
  "dependentInput": "10005",
  "variableInput": {
    "[Integration Field Key]": "[Default Value]"
  }
}
```

<ParamField type="string">
  The Integration Object Type that the user selects to map default values for.
</ParamField>

<ParamField type="string">
  If the Object Type selection is a combo dropdown input (you can determine this by checking for `dependentInputSource` on the Default Value Mapping input options returned by [`paragon.getDataSourceOptions`](/apis/api-reference#getdatasourceoptions)), this will be the value of the dependent input selected by the user. Otherwise, this key can be omitted.
</ParamField>

<ParamField type="object">
  An object where the keys are field keys from the Integration Object and the values are default values for those fields, as provided by the user.
</ParamField>


# 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 alt="Paragon's out-of-the-box Connect Portal" />
</Frame>

<Card title="Explore the Connect Portal" href="/connect-portal/connect-portal-customization" 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 authentication 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 alt="Paragon's Headless Connect Portal" />
</Frame>

<Card title="Explore the Headless Connect Portal" href="/connect-portal/headless-connect-portal" 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 alt="" />
</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 alt="" />
</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 />
</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 theme={null}
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).

## Pagination and search

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 Example: Custom Dropdown loading Google Drive folders expandable theme={null}
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 (`""`).

### Customizing dropdown refresh

By default, dropdown options are loaded once when the Connect Portal is opened or when the `search` term changes.

If your options change frequently and you want them to reload each time the user opens the dropdown, you can set the `refreshOnOpen` option to `true`:

```javascript theme={null}
paragon.connect("googledrive", {
  dropdowns: {
    drivefolder: {
      refreshOnOpen: true,
      loadOptions: async (cursor, search) => {
        // Options will be reloaded each time the dropdown opens
        // ...
      },
    },
  },
});
```

When `refreshOnOpen` is set to `true`, the `loadOptions` function will be called again each time the user opens the dropdown, ensuring they always see the most up-to-date options.


# 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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" />

<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 the [Monitoring](/monitoring/overview) page, 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 the [Monitoring](/workflows/viewing-workflow-executions) page.

<Frame>
  <img alt="Monitoring page showing workflow executions in Paragon Connect" />
</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 alt="" />
</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 alt="" />
</Frame>

## Managing Projects

To view and manage projects:

1. Click the Project dropdown in the top-left corner.

2. Click "**Manage projects**".

<Frame>
  <img alt="" />
</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 alt="" />
</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 alt="" />
</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 [Developer team member](/managing-account/teams).
* **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 alt="" />
     </Frame>
  2. You will be prompted to select the project that represents your Production Environment.

     <Frame>
       <img alt="" />
     </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 />
</Frame>

Creating a Release brings you to an undeployed Release Preview. An undeployed Release will show the following banner:

<Frame>
  <img alt="" />
</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 alt="" />
  </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 alt="1" />
  </Frame>

* **indicates an Informational Message**, which informs you of any changes that have occurred that will affect existing users of your integration.

  <Frame>
    <img alt="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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
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 alt="" />
</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 alt="" />
</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 alt="" />
</Frame>

## Displaying the Connect Portal in your app

[`paragon.authenticate`](/apis/api-reference#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. You may reference [Installing the Connect SDK](/getting-started/installing-the-connect-sdk#setup) for a detailed explanation on how to use [`paragon.authenticate`](/apis/api-reference#authenticate).

**Example:**

```js theme={null}
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 alt="" />
  </Frame>
</Accordion>

Once [`paragon.authenticate`](/apis/api-reference#authenticate) has been called and the Promise it returns has resolved, you can call [`paragon.connect`](/apis/api-reference#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.

**Example:**

```js theme={null}
paragon.connect("salesforce");
```

You *must* have an integration configured of this `integrationType` for the Portal to appear. Otherwise, this function does nothing.

<Frame>
  <img alt="" />
</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>
  <img alt="" />
</Frame>

<Frame>
  <img alt="" />
</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 [`paragon.getUser`](/apis/api-reference#getuser) 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 or package manager of choice:

<CodeGroup>
  ```bash npm theme={null}
  npm install @useparagon/connect
  ```

  ```bash yarn theme={null}
  yarn add @useparagon/connect
  ```

  ```bash pnpm  theme={null}
  pnpm add @useparagon/connect
  ```

  ```bash bun theme={null}
  bun add @useparagon/connect
  ```
</CodeGroup>

The SDK can be imported in your client-side JavaScript files as a module:

```js theme={null}
import { paragon } from '@useparagon/connect';
```

**For on-premise users:**

If you are using an on-premise instance of Paragon, you can call the `paragon.configureGlobal` function to point the SDK to use the base hostname of your Paragon instance.

```js theme={null}
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 theme={null}
  + 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 alt="" />
</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 theme={null}
{
	// 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 alt="" />
  </Frame>
</Accordion>

```js theme={null}
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 theme={null}
   // 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 theme={null}
   // 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 alt="" />
</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 alt="" />
    </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 theme={null}
    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 alt="" />
    </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 theme={null}
    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 alt="" />
    </Frame>

    This endpoint will generally have a URL like:

    ```js theme={null}
    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 alt="" />
    </Frame>

    4. Call `getToken()` with your template name and pass it to the `paragon.authenticate` method:

    ```js theme={null}
    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 alt="Action Kit Banner Pn" />

**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" 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 alt="Managed Sync Banner Pn" />

**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" 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 alt="Workflows Banner Pn" />

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 extensible - 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" 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 Synced Objects



# Check Access
Source: https://docs.useparagon.com/managed-sync/api/check-access

post /api/permissions/{syncId}/check
Check if a user has access to a specific Synced 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`


# Delete a Sync
Source: https://docs.useparagon.com/managed-sync/api/delete-sync

delete /api/syncs/{syncId}
Delete a Sync for a Connected User, including all associated Synced Objects

This will permanently delete a Sync and all associated Synced Objects.

<Info>
  After deleting a Sync, recreating a Sync with the same integration and `configurationName` will create a new Sync with the same ID.
</Info>


# 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 a file associated with a Synced Object

This endpoint works with the following Synced Objects:

* [File](/managed-sync/api/file-schema): Downloads a synced file from a File Storage integration.
* [Ticket](/managed-sync/api/ticket-schema): Downloads a ZIP archive of a ticket's content and attachments. The archive will include:
  * A Markdown file containing the ticket's properties, content body, and full list of comments
  * A folder of `attachments/` with files that were attached to this ticket


# 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_complete` 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).

<Accordion title="Using Multi-Account Authorization">
  If a user has connected multiple accounts of the same integration type (using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization)), you can specify which account to use for syncing by providing the optional `credentialId` parameter in the request body.

  You can retrieve the list of connected credentials from the `allCredentials` array returned by the [/sdk/me](/apis/api-reference/multi-account-authorization#getuser) endpoint or `paragon.getUser` in the SDK.

  <Info>
    If `credentialId` is not specified and the user has multiple connected accounts, the default credential (the oldest active credential) will be used.
  </Info>
</Accordion>


# Expand Relationships
Source: https://docs.useparagon.com/managed-sync/api/expand

post /api/permissions/{syncId}/expand
Get all users and group relationships associated with an object by role

The Expand endpoint can be used to query relationships in the permissions graph, returning all users and sets of users that have a certain relationship type to a given object. This provides visibility into *why* certain users have access to a file (via direct access, inherited role, group membership, or parent access).

Here's a breakdown of using this endpoint to list all users (and groups) that have a `can_read` relationship to a file.

First, we can call the `/expand` endpoint to query `can_read` relationships to a file ID:

```http theme={null}
POST /api/permissions/{syncId}/expand
{
  "object": "1f2c08ea-c785-54e2-a9b2-c362364e1d23",
  "relation": "can_read"
}
```

This provides a response like:

```json Response expandable theme={null}
{
  "tree": {
    "root": {
      "name": "file:de087147-d851-5f18-ba1f-79e84ff09b0c#can_read",
      "union": {
        "nodes": [
          {
            "name": "file:de087147-d851-5f18-ba1f-79e84ff09b0c#can_read",
            "leaf": {
              "computed": {
                "userset": "file:de087147-d851-5f18-ba1f-79e84ff09b0c#viewer"
              }
            }
          },
          {
            "name": "file:de087147-d851-5f18-ba1f-79e84ff09b0c#can_read",
            "leaf": {
              "computed": {
                "userset": "file:de087147-d851-5f18-ba1f-79e84ff09b0c#editor"
              }
            }
          },
          {
            "name": "file:de087147-d851-5f18-ba1f-79e84ff09b0c#can_read",
            "leaf": {
              "tupleToUserset": {
                "tupleset": "file:de087147-d851-5f18-ba1f-79e84ff09b0c#parent",
                "computed": [
                  {
                    "userset": "file:db847d33-9272-5f4e-87a9-0b7fde41638f#viewer"
                  }
                ]
              }
            }
          },
          {
            "name": "file:de087147-d851-5f18-ba1f-79e84ff09b0c#can_read",
            "leaf": {
              "tupleToUserset": {
                "tupleset": "file:de087147-d851-5f18-ba1f-79e84ff09b0c#space",
                "computed": [
                  {
                    "userset": "space:42d2e50f-2e93-5f14-98c3-911c9a3fdb39#viewer"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}
```

This tells us that the users / groups that can read this file can be found in relations:

1. Users with the `viewer` role explicitly assigned to this file
2. Users with the `editor` role explicitly assigned to this file
3. Users with the `viewer` role to the parent of this file (`file:db847d33-9272-5f4e-87a9-0b7fde41638f`)
4. Users with the `viewer` role to the space to which this file belongs (`space:42d2e50f-2e93-5f14-98c3-911c9a3fdb39`)

We can then query the Expand API again for any of these relations, e.g. the below request for #2 (all editors directly assigned to this file):

```http theme={null}
POST /api/permissions/{syncId}/expand
{
  "object": "1f2c08ea-c785-54e2-a9b2-c362364e1d23",
  "relation": "editor"
}
```


# 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.


# 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 all accessible objects for a user

<Info>
  Responses from this endpoint are limited to 1000 files by default.

  If your use case involves checking permissions against collections of 1000+ files, see our [Permissions API Implementation Guide](/managed-sync/permissions-api#implementing-permissions-api) for guidance on using other available endpoints.
</Info>


# 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 a Synced Object by a specific role

<Info>
  Responses from this endpoint are limited to 1000 users by default.

  If your use case involves checking permissions for 1000+ users per file, see our [Permissions API Implementation Guide](/managed-sync/permissions-api#implementing-permissions-api) for guidance on using other available endpoints.
</Info>


# 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 when pulling synced records returns a stable cursor for the last record of that 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 and resume from it later — for example, when you receive `record_created` or `record_updated` webhooks, or when polling for new changes using a recurring job.

<Accordion title="Pagination and cursor behavior">
  Records from this endpoint are ordered as a change log of creates, updates, and deletes, based on when Paragon last synced each record.

  You can always pass a `cursor` value that you received from the API as `paging.cursor` to catch up on all creates, updates, and deletes that Paragon observed since that page.

  **What if data changes while I am ingesting records from the Initial Sync?**

  If records are created or updated while you are still paging through a large Sync (for example during an initial pull of many files), those changes can appear on later pages of the same pull loop. That includes updates to records you already consumed earlier in the loop, so you can pick up the latest content even when source data changes mid-pull.

  **Can I use a pagination cursor after full or incremental syncs run?**

  Yes, any cursor provided by the API remains valid for resuming from that point at any time later, including after a periodic full sync has run.

  The `latestCursor` returned from the API can change after a full or incremental sync because new or updated records may be available to pull when a sync detects changes. However, you can still pass your saved cursor to continue from where you left off.
</Accordion>


# 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



# Streamed List Objects
Source: https://docs.useparagon.com/managed-sync/api/streamed-list-objects

post /api/permissions/{syncId}/streamed-list-objects
List all accessible objects for a user as a streamed response.

Use this endpoint when a user may have access to more than 1000 objects in a **single** Sync and you are using a pre-filtering approach for your search index. For smaller result sets, the buffered [List Objects](/managed-sync/api/list-objects) endpoint is simpler to consume.

To enumerate accessible objects across **all** of a Connected User's Permission Syncs in a project (for example, Google Drive and SharePoint together), use [Streamed List Objects (All Syncs)](/managed-sync/api/streamed-list-objects-all-syncs) instead.

## Response format

The response is sent as `application/x-ndjson` with `Transfer-Encoding: chunked`. Each line of the response body is a JSON object containing a single `object` field, whose value is the UUID of a Synced Object the user has access to with the specified role:

```text theme={null}
{"object":"a657df3b-17e2-5989-bc5f-13ddb7fdab41"}
{"object":"b842ec1c-2f3a-4a91-9f8d-6cf2b73a1d04"}
{"object":"c91f0a2d-4e58-4b3b-8a1c-7d9e2b0c41ef"}
```

Parse the response one line at a time. Each line is independently valid JSON; the response body as a whole is not.


# Streamed List Objects (All Syncs)
Source: https://docs.useparagon.com/managed-sync/api/streamed-list-objects-all-syncs

post /api/permissions/streamed-list-objects
List all accessible objects across syncs for a user as a streamed response.

Use this endpoint to enumerate every object a principal user can access across all syncs associated with a Connected User.

This is useful when your app connects a user to multiple File Storage syncs, and you want a single list of permitted document IDs to feed into a search or vector index filter.

For queries against a single Sync, use the sync-scoped [Streamed List Objects](/managed-sync/api/streamed-list-objects) endpoint instead.

## Response format

The response is sent as `application/x-ndjson` with `Transfer-Encoding: chunked`. Each line of the response body is a JSON object tagged with the source `syncInstanceId` and `integration`.

Success lines include an `object` field, whose value is the UUID of a Synced Object the user has access to with the specified role:

```text theme={null}
{"syncInstanceId":"3f8a1c2e-9b4d-4e71-a6f2-8d0c5b1e7a93","integration":"googledrive","object":"a657df3b-17e2-5989-bc5f-13ddb7fdab41"}
{"syncInstanceId":"3f8a1c2e-9b4d-4e71-a6f2-8d0c5b1e7a93","integration":"googledrive","object":"b842ec1c-2f3a-4a91-9f8d-6cf2b73a1d04"}
{"syncInstanceId":"91cd4f0a-2e58-4b3b-8a1c-7d9e2b0c41ef","integration":"sharepoint","object":"c91f0a2d-4e58-4b3b-8a1c-7d9e2b0c41ef"}
```

If a specific sync fails to enumerate (for example, its authorization store is temporarily unavailable), a single line with an `error` field is emitted for that sync and the stream continues with the remaining syncs:

```text theme={null}
{"syncInstanceId":"91cd4f0a-2e58-4b3b-8a1c-7d9e2b0c41ef","integration":"sharepoint","error":"Error streaming list-objects"}
```

Parse the response one line at a time. Each line is independently valid JSON; the response body as a whole is not.

## Notes

* Only syncs that belong to the authenticated Connected User and project are queried. Syncs without an authorization store (for example, integrations that do not support Permissions API) are skipped silently.
* Per-sync errors do not abort the stream — inspect each line for an `error` field so that you can retry or surface individual failures without discarding results from successful syncs.


# Ticket
Source: https://docs.useparagon.com/managed-sync/api/ticket-schema

A ticket's metadata in a Ticketing integration.

**Pipeline name for Sync configuration**: `tickets`

To download attached files and comments for a ticket, use the `id` property to request [Download Content](/managed-sync/api/download-content).


# Update a Sync
Source: https://docs.useparagon.com/managed-sync/api/update-sync

patch /api/syncs/{syncId}
Update an existing Sync for a Connected User

Use this endpoint to update an existing Sync. You can change:

* The credential bound to the Sync (`credentialId`) — useful when using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization) and you need to explicitly bind a Sync to a different credential.
* How often Paragon checks for incremental changes (`incrementalAccumulatorFrequency`).

Provide any combination of these fields in the request body. The request must contain at least one field to update.

<Info>
  Updating only `incrementalAccumulatorFrequency` will not trigger a full re-sync. The new frequency takes effect on the next scheduled run.

  Updating `credentialId` to a different credential will start a periodic full sync to reconcile existing synced records with the records accessible in the new account.
</Info>


# 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" 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

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync.

Syncs for Amazon S3 can be created with one of the following configurations:

* **Bucket Sync**: All files in the specified bucket will be synced.
* **Folder Sync**: Only files in the specified folder will be synced (recursively including all subfolders).
* **Sync of specific files**: Only a group of specific files will be synced.

<Tabs>
  <Tab title="Bucket Sync">
    ```json Example theme={null}
    {
        "integration": "amazons3",
        "pipeline": "files",
        "configuration": {
          "bucket": "my-s3-bucket"
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string">
      The S3 bucket name to sync files from.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>

  <Tab title="Folder Sync">
    ```json Example theme={null}
    {
        "integration": "amazons3",
        "pipeline": "files",
        "configuration": {
          "bucket": "my-s3-bucket",
          "subfolder": "documents/"
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string">
      The S3 bucket name to sync files from.
    </ParamField>

    <ParamField type="string">
      A subfolder path within the bucket to limit the Sync scope to.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>

  <Tab title="Sync of specific files">
    ```json Example theme={null}
    {
        "integration": "amazons3",
        "pipeline": "files",
        "configuration": {
          "bucket": "my-s3-bucket",
          "fileIds": ["documents/document1.pdf", "documents/document2.pdf"]
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string">
      The S3 bucket name to sync files from.
    </ParamField>

    <ParamField type="string[]">
      A list of S3 file keys, including the path, to limit the Sync scope to.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>
</Tabs>


# Asana
Source: https://docs.useparagon.com/managed-sync/integrations/asana



## Required Scopes

To configure a Sync for Asana, you need to request the following scopes from your Asana OAuth application:

* `default`

If you are using [granular OAuth scopes](https://developers.asana.com/docs/oauth-scopes):

* `tasks:read`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Asana supports the following Synced Objects:

* [Tickets](/managed-sync/api/ticket-schema)

## Tickets

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a ticket sync.

```json Example theme={null}
{
    "integration": "asana",
    "pipeline": "tickets",
    "configuration": {
      "projectGid": "1234567890"
    }
}
```

**Configuration options:**

<ParamField type="string">
  The GID of the Asana project to sync tasks from. You can find this in the URL when viewing a project in Asana, or prompt your users to select a project from Connect Portal [User Settings](/connect-portal/workflow-user-settings).
</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

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync.

Syncs for Box can be created with one of the following configurations:

* **Global Sync**: All files in the user's Box account will be synced.
* **Folder Sync**: Only files in the specified folder will be synced (recursively including all subfolders by default).
* **Sync of specific files**: Only a group of specific files will be synced.

<Tabs>
  <Tab title="Global Sync">
    ```json Example theme={null}
    {
        "integration": "box",
        "pipeline": "files",
        "configuration": {}
    }
    ```

    **Configuration options:**

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>

  <Tab title="Folder Sync">
    ```json Example theme={null}
    {
        "integration": "box",
        "pipeline": "files",
        "configuration": {
            "folderId": "1234567890"
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string">
      A Box Folder ID to limit the Sync scope to.
    </ParamField>

    <ParamField type="boolean">
      Set to `true` to sync only the direct children of the specified folder, without recursing into subfolders. Defaults to `false`.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>

  <Tab title="Sync of specific files">
    ```json Example theme={null}
    {
        "integration": "box",
        "pipeline": "files",
        "configuration": {
            "fileIds": ["1234567890"]
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string[]">
      A list of Box File IDs to limit the Sync scope to. Up to 300 files can be watched from a single Sync using this option.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>
</Tabs>

## Choosing Files and Folders

You can allow your user to select files from their Box account in your app with the Box File Picker provided by 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 theme={null}
let picker = new paragon.ExternalFilePicker("box", {
    onFileSelect: (files) => {
        // Handle file selection
    },

    // Optional settings:
    integrationOptions: {
        box: {
            // If true, renders the Box picker UI inside an iframe to isolate
            // its styles from your application. Use this option if you experience
            // style conflicts between the Box picker and your app's CSS.
            scopeCSS: true
        }
    }
});

// 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).


# ClickUp
Source: https://docs.useparagon.com/managed-sync/integrations/clickup



## Synced Objects

ClickUp supports the following Synced Objects:

* [Tickets](/managed-sync/api/ticket-schema)

## Tickets

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a ticket sync.

```json Example theme={null}
{
    "integration": "clickup",
    "pipeline": "tickets",
    "configuration": {
      "listId": "89101112"
    }
}
```

**Configuration options:**

<ParamField type="string">
  A ClickUp list to sync tickets from. You can prompt your users to select a List from Connect Portal [User Settings](/connect-portal/workflow-user-settings).
</ParamField>


# 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`
* Required for permissions sync:
  * `read:confluence-content.permission`
  * `read:confluence-space.permission`
  * `read:confluence-groups`
  * `read:email-address:confluence`
  * `read:user: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): Pages in Confluence will be synced as HTML files.
* [Permissions](/managed-sync/permissions-api): Permissions for pages and spaces will be synced, including spaces, groups, and page-level restrictions.

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync.

Syncs for Confluence can be created with one of the following configurations:

* **Space Sync**: All pages in the specified space will be synced.
* **Sync of specific pages**: A group of specific pages and their descendants will be synced.
* **Sync of one page**: A specific page and its descendants will be synced.

<Tabs>
  <Tab title="Space Sync">
    ```json Example theme={null}
    {
        "integration": "confluence",
        "pipeline": "files",
        "configuration": {
            "spaceId": "123456789"
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string">
      A Confluence Space ID to limit the Sync scope to pages within a specific space.
    </ParamField>
  </Tab>

  <Tab title="Sync of specific pages">
    ```json Example theme={null}
    {
        "integration": "confluence",
        "pipeline": "files",
        "configuration": {
            "pageIds": ["987654321"]
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string[]">
      A list of Confluence Page IDs to limit the Sync scope to. All specified pages and their descendants will be synced.
    </ParamField>
  </Tab>

  <Tab title="Sync of one page">
    ```json Example theme={null}
    {
        "integration": "confluence",
        "pipeline": "files",
        "configuration": {
            "pageId": "987654321"
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string">
      A Confluence Page ID to limit the Sync scope to a specific page and its descendants.
    </ParamField>
  </Tab>
</Tabs>


# Contentful
Source: https://docs.useparagon.com/managed-sync/integrations/contentful



## Synced Objects

Contentful supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)
  <p>Contentful entries are synced as Markdown files, with rich text fields converted to Markdown.</p>
  <p>Contentful assets (images, videos, documents, etc.) are synced in their original format.</p>

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync.

```json Example theme={null}
{
    "integration": "contentful",
    "pipeline": "files",
    "configuration": {
        "spaceId": "f163o8lczdw1"
    }
}
```

**Configuration options:**

<ParamField type="string">
  The Contentful Space ID to sync content from.
</ParamField>

<ParamField type="string">
  A Contentful Environment ID to limit the sync to a specific environment. If not specified, the default environment (`master`) will be used.
</ParamField>

<ParamField type="string">
  A locale code (e.g. `en-US`) to use when resolving localized fields. If not specified, the first available locale for each field will be used.
</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`
* `groups.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)
  <p>Dropbox Paper documents will be synced as HTML files.</p>
  <p>All other files will be available in their original format.</p>
* [Permissions](/managed-sync/permissions-api)

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync.

Syncs for Dropbox can be created with one of the following configurations:

* **Global Sync**: All files in the user's Dropbox account will be synced.
* **Folder Sync**: Only files in the specified folder will be synced (recursively including all subfolders by default).
* **Sync of specific files**: Only a group of specific files will be synced.

<Tabs>
  <Tab title="Global Sync">
    ```json Example theme={null}
    {
        "integration": "dropbox",
        "pipeline": "files",
        "configuration": {}
    }
    ```

    **Configuration options:**

    <ParamField type="boolean">
      Set to `true` if using a Dropbox Team account. This will sync group permissions for folders and files.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>

  <Tab title="Folder Sync">
    ```json Example theme={null}
    {
        "integration": "dropbox",
        "pipeline": "files",
        "configuration": {
          "folderId": "/Documents"
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string">
      The folder to limit the Sync scope to. Accepts a Dropbox path (e.g. `/Documents`), a folder ID (e.g. `id:abc123`), or a namespace ID (e.g. `ns:14532919923`).

      <Note>
        For Dropbox Business accounts, paths are resolved relative to the team root namespace by default. Learn more about namespaces in the [Dropbox Team Files guide](https://developers.dropbox.com/dbx-team-files-guide).
      </Note>
    </ParamField>

    <ParamField type="boolean">
      Set to `true` to sync only the direct children of the specified folder, without recursing into subfolders. Defaults to `false`.
    </ParamField>

    <ParamField type="boolean">
      Set to `true` if using a Dropbox Team account. This will sync group permissions for this folder and its children.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>

  <Tab title="Sync of specific files">
    ```json Example theme={null}
    {
        "integration": "dropbox",
        "pipeline": "files",
        "configuration": {
          "fileIds": ["id:4h9kzExampleXYZ987654321", "id:4h9kzExampleXYZ987654322"]
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string[]">
      A list of Dropbox file IDs to limit the Sync scope to.
    </ParamField>

    <ParamField type="boolean">
      Set to `true` if using a Dropbox Team account. This will sync group permissions for this folder and its children.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>
</Tabs>


# Freshdesk
Source: https://docs.useparagon.com/managed-sync/integrations/freshdesk



## Synced Objects

Freshdesk supports the following Synced Objects:

* [Tickets](/managed-sync/api/ticket-schema)

## Tickets

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a ticket sync.

```json Example theme={null}
{
    "integration": "freshdesk",
    "pipeline": "tickets",
    "configuration": {}
}
```

**Configuration options:**

<ParamField type="string">
  A Freshdesk Company ID to limit the Sync scope to tickets from a specific company.

  If not specified, the Sync will ingest all available tickets from the user's Freshdesk account.
</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`

  <Info>
    If you are syncing only user-selected files, you can request the less permissive `https://www.googleapis.com/auth/drive.file` scope.

    This will restrict the sync to only files that the user has selected with the [Google Drive File Picker](#choosing-files-and-folders).
  </Info>
* `https://www.googleapis.com/auth/admin.reports.audit.readonly` (optional - for including link-sharing access in the Permissions Sync)
* `https://www.googleapis.com/auth/admin.directory.group.readonly` (optional - for including group membership in the Permissions Sync)

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)
  <p>Google Docs, Sheets, and Slides will be synced as their Office-compatible equivalent formats:</p>
  * **Docs**: DOCX file
  * **Sheets**: XLSX file
  * **Slides**: PPTX file
  * **Drawings**: PDF file
* [Permissions](/managed-sync/permissions-api)

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync.

Syncs for Google Drive can be created with one of the following configurations:

* **Global Sync**: All files in the user's Google Drive account will be synced.
* **Folder Sync**: Only files in the specified folder will be synced (recursively including all subfolders by default).
* **Sync of specific files**: Only a group of specific files will be synced.

<Tabs>
  <Tab title="Global Sync">
    ```json Example theme={null}
    {
        "integration": "googledrive",
        "pipeline": "files",
        "configuration": {}
    }
    ```

    **Configuration options:**

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>

  <Tab title="Folder Sync">
    ```json Example theme={null}
    {
        "integration": "googledrive",
        "pipeline": "files",
        "configuration": {
            "folderId": "1DBmDMhWTzNapG2sSiu7-u7lkSCJnyC34"
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string">
      A Google Drive Folder ID to limit the Sync scope to.
    </ParamField>

    <ParamField type="boolean">
      Set to `true` to sync only the direct children of the specified folder, without recursing into subfolders. Defaults to `false`.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>

  <Tab title="Sync of specific files">
    ```json Example theme={null}
    {
        "integration": "googledrive",
        "pipeline": "files",
        "configuration": {
            "fileIds": ["1DBmDMhWTzNapG2sSiu7-u7lkSCJnyC34"]
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string[]">
      A list of Google Drive File IDs to limit the Sync scope to.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>
</Tabs>

## Choosing Files and Folders

You can allow your user to select files from their Google Drive account in your app with the Google Drive File Picker provided by the Paragon SDK.

<Frame>
  <img alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
let picker = new paragon.ExternalFilePicker("googledrive", {
    onFileSelect: (files) => {
        // Handle file selection
    },

    // Optional settings:
    integrationOptions: {
        googledrive: {
            // If true, a tab in the Picker appears for browsing Shared Drives
            enableSharedDrives: true,

            // If true, the full folder hierarchy appears in the Picker. Otherwise,
            // all files will appear as a flat list. Defaults to `false`.
            includeFolders: false

            // Set the display mode of the Picker as a thumbnail grid or list of file titles.
            // Defaults to "grid". Thumbnail grid requires either `https://www.googleapis.com/auth/drive` or
            // `https://www.googleapis.com/auth/drive.readonly` scope to appear correctly.
            viewMode: "grid" || "list",
        }
    }
});

// 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).


# Guru
Source: https://docs.useparagon.com/managed-sync/integrations/guru



## Synced Objects

Guru supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)
  <p>Guru cards are synced as HTML files.</p>
  <p>Guru boards are synced as folders with parent/child hierarchy.</p>

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync of Guru cards.

```json Example theme={null}
{
    "integration": "guru",
    "pipeline": "files",
    "configuration": {}
}
```

**Configuration options:**

<ParamField type="string">
  A Guru Collection ID to limit the sync to cards within a specific collection. If not specified, all cards accessible to the authenticated user will be synced.
</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`
* `crm.lists.read` (required if using `listViewId`)

**Companies:**

* `crm.objects.companies.read`
* `crm.schemas.companies.read`
* `crm.lists.read` (required if using `listViewId`)

**Deals:**

* `crm.objects.deals.read`
* `crm.schemas.deals.read`
* `crm.lists.read` (required if using `listViewId`)

**Custom Objects:**

* `crm.objects.custom.read`
* `crm.schemas.custom.read`
* `crm.lists.read` (required if using `listViewId`)

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 theme={null}
{
    "integration": "hubspot",
    "pipeline": "contacts",
    "configuration": {
        "listViewId": "12345",
        "properties": ["firstname", "lastname", "email", "phone", "company"]
    }
}
```

<ParamField type="string">
  A HubSpot List ID to limit the Sync scope to. If not specified, the Sync will ingest all available contacts from the user's HubSpot account.
</ParamField>

<ParamField 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 theme={null}
{
    "integration": "hubspot",
    "pipeline": "companies",
    "configuration": {
        "listViewId": "12345",
        "properties": ["name", "website", "industry"]
    }
}
```

<ParamField type="string">
  A HubSpot List ID to limit the Sync scope to. If not specified, the Sync will ingest all available companies from the user's HubSpot account.
</ParamField>

<ParamField 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 theme={null}
{
    "integration": "hubspot",
    "pipeline": "deals",
    "configuration": {
        "listViewId": "12345",
        "properties": ["firstname", "lastname", "email", "phone", "company"]
    }
}
```

<ParamField type="string">
  A HubSpot List ID to limit the Sync scope to. If not specified, the Sync will ingest all available deals from the user's HubSpot account.
</ParamField>

<ParamField 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 theme={null}
{
    "integration": "hubspot",
    "pipeline": "custom_objects",
    "configuration": {
        "customObjectName": "custom_object_name",
        "listViewId": "12345",
        "properties": ["custom_field_name1", "custom_field_name2"]
    }
}
```

<ParamField type="string">
  The internal name of the object type to sync, e.g. `feedback_submissions`.
</ParamField>

<ParamField type="string">
  A HubSpot List 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 HubSpot account.
</ParamField>

<ParamField 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:

**Files:**

* Read and List articles

**Tickets:**

* Read tickets
* Read and list users and companies

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): Syncs help center articles from Intercom.
* [Tickets](/managed-sync/api/ticket-schema): Syncs tickets from Intercom.

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync of help center articles from Intercom.

```json Example theme={null}
{
    "integration": "intercom",
    "pipeline": "files",
    "configuration": {
        "helpCenterId": "12345"
    }
}
```

**Configuration options:**

<ParamField 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>

## Tickets

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a ticket sync.

```json Example theme={null}
{
    "integration": "intercom",
    "pipeline": "tickets",
    "configuration": {}
}
```

**Configuration options:**

Intercom ticket sync does not require any additional configuration options. The sync will ingest all available tickets from the user's Intercom account.


# Jira
Source: https://docs.useparagon.com/managed-sync/integrations/jira



## Required Scopes

To configure a Sync for Jira, you need to request the following scopes from your Jira OAuth application:

**Tickets:**

* `offline_access`
* `read:jira-user`
* `read:jira-work`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Jira supports the following Synced Objects:

* [Tickets](/managed-sync/api/ticket-schema): Syncs issues from Jira, including issue metadata, comments, and attachments.

## Tickets

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a ticket sync. Jira syncs issues from both **Jira Software** and **Jira Service Management** projects.

```json Example theme={null}
{
    "integration": "jira",
    "pipeline": "tickets",
    "configuration": {
      "projectId": "10001"
    }
}
```

**Configuration options:**

<ParamField type="string">
  The Jira project ID (in numeric format, not the project key) to sync tickets from. You can prompt your users to select a project from Connect Portal [User Settings](/connect-portal/workflow-user-settings).
</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

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync.

```json Example theme={null}
{
    "integration": "microsoftTeams",
    "pipeline": "files",
    "configuration": {
        "teamId": "19:abcd1234567890abcdef1234567890ab@thread.tacv2"
    }
}
```

**Configuration options:**

<ParamField type="string">
  The Microsoft Teams Team ID to sync files from. This is required and specifies which team's files should be synced.
</ParamField>

<ParamField type="string[]">
  An optional array of MIME types to filter synced files. Only files matching the specified MIME types will 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 theme={null}
{
    "integration": "microsoftDynamics",
    "pipeline": "contacts",
    "configuration": {
        "view": {
            "type": "savedquery",
            "id": "00000000-0000-0000-0000-000000000000"
        }
    }
}
```

<ParamField 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 type="string">
      The type of view: either `savedquery` or `userquery`.
    </ParamField>

    <ParamField type="string">
      The ID of the saved query or user query.
    </ParamField>
  </Expandable>
</ParamField>

## Companies

### Sync Configuration Options

```json Example theme={null}
{
    "integration": "microsoftDynamics",
    "pipeline": "companies",
    "configuration": {
        "view": {
            "type": "savedquery",
            "id": "00000000-0000-0000-0000-000000000000"
        }
    }
}
```

<ParamField 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 type="string">
      The type of view: either `savedquery` or `userquery`.
    </ParamField>

    <ParamField type="string">
      The ID of the saved query or user query.
    </ParamField>
  </Expandable>
</ParamField>

## Deals

### Sync Configuration Options

```json Example theme={null}
{
    "integration": "microsoftDynamics",
    "pipeline": "deals",
    "configuration": {
        "view": {
            "type": "savedquery",
            "id": "00000000-0000-0000-0000-000000000000"
        }
    }
}
```

<ParamField 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 type="string">
      The type of view: either `savedquery` or `userquery`.
    </ParamField>

    <ParamField type="string">
      The ID of the saved query or user query.
    </ParamField>
  </Expandable>
</ParamField>

## Custom Objects

### Sync Configuration Options

```json Example theme={null}
{
    "integration": "microsoftDynamics",
    "pipeline": "custom_objects",
    "configuration": {
        "customObjectName": "new_customentity",
        "view": {
            "type": "userquery",
            "id": "11111111-2222-3333-4444-555555555555"
        }
    }
}
```

<ParamField type="string">
  The API name of the Dynamics 365 custom entity to sync, e.g., `new_customentity`.
</ParamField>

<ParamField 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 type="string">
      The type of view: either `savedquery` or `userquery`.
    </ParamField>

    <ParamField type="string">
      The ID of the saved query or user query.
    </ParamField>
  </Expandable>
</ParamField>


# Monday.com
Source: https://docs.useparagon.com/managed-sync/integrations/monday.com



## Synced Objects

Monday.com supports the following Synced Objects:

* [Tickets](/managed-sync/api/ticket-schema)

## Tickets

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a ticket sync.

```json Example theme={null}
{
    "integration": "monday",
    "pipeline": "tickets",
    "configuration": {
      "boardId": "1234567890"
    }
}
```

**Configuration options:**

<ParamField type="string">
  A Monday.com Board to sync tickets from. You can prompt your users to select a Board from Connect Portal [User Settings](/connect-portal/workflow-user-settings).
</ParamField>


# NetSuite
Source: https://docs.useparagon.com/managed-sync/integrations/netsuite



## Required Setup

To configure a Sync for NetSuite, your connecting users will need to configure NetSuite **Token-Based Authentication (TBA)**.

Verify that your App Configuration for your NetSuite integration is set to use this authentication type:

<Frame>
  <img alt="Token-Based Authentication selected for Application Type" />
</Frame>

<Info>
  Paragon's standard NetSuite setup supports three other authentication strategies (Authorization Code, Client Credentials, and Client Credentials with User Certificates), but the NetSuite sync pipeline requires Token-Based Authentication (TBA).

  For details on configuring authentication, see [Connecting to NetSuite](/resources/integrations/netsuite).
</Info>

In Token-Based Authentication, your customers will create an Access Token assigned to a User and Role. The role assigned to the Access Token should be configured as follows:

* Set **Accessible Subsidiaries** to **All** and turn on **Allow Cross-Subsidiary Record Viewing**.
* In Permissions, set:
  * **Lists > Contacts:** at least View
  * **Lists >** \[any List type to sync]: at least View
  * **Setup > SOAP Web Services:** Full
  * **Setup > User Access Tokens:** Full
  * **Setup > Log in using Access Tokens:** Full
  * **Setup > CRM Lists:** at least View
  * **Setup > Other Lists:** at least View

If a saved search you are syncing includes joined fields or related records, the role also needs view access to those record types, such as customers, companies, or custom records. Saved searches used for NetSuite Sync must include the **Internal ID** column.

## Synced Objects

NetSuite supports the following Synced Objects:

* [Contacts](/managed-sync/api/contact-schema)
* [Custom Objects](/managed-sync/api/custom-object-schema)

## Contacts

### Sync Configuration Options

```json Example theme={null}
{
    "integration": "netsuite",
    "pipeline": "contacts",
    "configuration": {
        "savedSearchId": "customsearch_my_contacts"
    }
}
```

<ParamField type="string">
  The ID of a NetSuite saved search to limit the Sync scope to. If not specified, the Sync will ingest all available contacts from the user's NetSuite account.

  The saved search must include the **Internal ID** column for Paragon to identify records.
</ParamField>

## Custom Objects

Use the `custom_objects` pipeline to sync any NetSuite record type that is not natively supported, such as other standard records like `customer`, `vendor`, or `salesOrder`.

### Sync Configuration Options

```json Example theme={null}
{
    "integration": "netsuite",
    "pipeline": "custom_objects",
    "configuration": {
        "recordType": "customer",
        "savedSearchId": "customsearch_my_customers"
    }
}
```

<ParamField type="string">
  The NetSuite record type to sync, e.g., `customer`, `vendor`, `salesOrder`.
</ParamField>

<ParamField type="string">
  The ID of a NetSuite saved search to limit the Sync scope to. If not specified, the Sync will ingest all available records of the configured `recordType` from the user's NetSuite account.

  The saved search must include the **Internal ID** column for Paragon to identify records.
</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)
  <p>
    Notion pages are synced as Markdown files.
  </p>
  * All child pages (including entries of a database) will be synced as distinct files with their `parentId` set to the ID of the parent page or database.
  * Page properties (including database entry properties) are synced to the file's [`customFields`](/managed-sync/api/file-schema) object and are also prepended to the Markdown content as a YAML frontmatter block, so they are available both as structured metadata and as searchable text.
  * The Title property is used as the file name.
  * Pages that have no title will produce a synced file with an empty `fileName`.
  * Attachments and images are represented as links within the page Markdown and must be downloaded separately.

### Page properties

When a Notion page has properties (for example, a database entry with `Status`, `Tags`, or `Owner` columns), each property is extracted into `customFields` on the synced [File](/managed-sync/api/file-schema) and rendered as YAML frontmatter at the top of the Markdown content.

Supported property types include `title`, `rich_text`, `number`, `select`, `multi_select`, `status`, `date`, `checkbox`, `url`, `email`, `phone_number`, `people`, `files`, `created_by`, `created_time`, `last_edited_by`, `last_edited_time`, `formula`, `unique_id`, `relation`, `rollup`, and `verification`. Values are normalized to plain strings, numbers, booleans, or arrays.

Example Markdown content for a database entry with `Status`, `Priority`, and `Owner` properties:

```markdown theme={null}
---
Status: In Progress
Priority: High
Owner: Jane Doe
---

# Page content goes here...
```

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync.

Syncs for Notion can be created with one of the following configurations:

* **Global Sync**: All pages and databases that are granted to the integration at time of authentication will be synced.

  <Warning>
    **Note:** Due to [limitations with Notion's search API](https://developers.notion.com/reference/search-optimizations-and-limitations#limitations), Global Sync is not guaranteed to be exhaustive; newly created or recently modified pages may be missing after the initial sync.

    Any pages not captured will be included when they are updated by the user or in the next scheduled [periodic full sync](/managed-sync/sync-api#sync-lifecycle), which runs every 24 hours.

    You can alternatively use a **Sync of specific pages** to explicitly designate page root(s) based on a user selection, which will guarantee that those pages and their descendants will always be fully synced.
  </Warning>
* **Sync of specific pages**: Only a group of specific pages and their descendants will be synced. Use this option when your users will select pages in your UI to sync from Notion.

  Page-specific syncs use Notion's hierarchy traversal API from the roots specified in `configuration.pageIds`, so all pages under the specified roots are always synced completely.

<Tabs>
  <Tab title="Global Sync">
    ```json Example theme={null}
    {
        "integration": "notion",
        "pipeline": "files",
        "configuration": {}
    }
    ```

    **Configuration options:**

    No configuration options are required for a global Sync.
  </Tab>

  <Tab title="Sync of specific pages">
    ```json Example theme={null}
    {
        "integration": "notion",
        "pipeline": "files",
        "configuration": {
          "pageIds": ["12345678-1234-1234-1234-1234567890ab"]
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string[]">
      A list of Notion Page IDs to limit the Sync scope to. All specified pages and their descendants will be synced.

      **Warning:** The Sync will fail if any of the specified pages were not granted access to your integration when the user connected their account.
    </ParamField>
  </Tab>
</Tabs>


# 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`
* `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

OneDrive supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)
* [Permissions](/managed-sync/permissions-api)

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync.

Syncs for OneDrive can be created with one of the following configurations:

* **Drive Sync**: All files in the specified drive (or the default drive) will be synced.
* **Folder Sync**: Only files in the specified folder will be synced (recursively including all subfolders by default).

<Tabs>
  <Tab title="Drive Sync">
    ```json Example theme={null}
    {
        "integration": "onedrive",
        "pipeline": "files",
        "configuration": {
          "driveId": "b!-RIj2DuyvEyV1T4NlOaMHk8XkS_I8MdFlUCq1BlcjgmhRfAj3-Z8RY2VpuvV_tpd"
        }
    }
    ```

    **Configuration options:**

    <ParamField 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>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>

  <Tab title="Folder Sync">
    ```json Example theme={null}
    {
        "integration": "onedrive",
        "pipeline": "files",
        "configuration": {
          "driveId": "b!-RIj2DuyvEyV1T4NlOaMHk8XkS_I8MdFlUCq1BlcjgmhRfAj3-Z8RY2VpuvV_tpd",
          "folderId": "01ABCDEF2345GHIJKL/XYZ1234567890!123"
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string">
      A OneDrive Drive ID where the folder is located. If not specified, the Sync will use the user's default drive.
    </ParamField>

    <ParamField type="string">
      A OneDrive Folder ID to limit the Sync scope to a specific folder.
    </ParamField>

    <ParamField type="boolean">
      Set to `true` to sync only the direct children of the specified folder, without recursing into subfolders. Defaults to `false`.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>
</Tabs>

## Choosing Files and Folders

You can allow your user to select files from their OneDrive account in your app with the OneDrive File Picker provided by 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 theme={null}
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).


# 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 theme={null}
{
    "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 theme={null}
{
    "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 theme={null}
{
    "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} theme={null}
{
    "integration": "salesforce",
    "pipeline": "contacts",
    "configuration": {
        "listViewId": "00B5g00000AWN0qEAH"
    }
}
```

<ParamField 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 theme={null}
{
    "integration": "salesforce",
    "pipeline": "companies",
    "configuration": {
        "listViewId": "00B5g00000ABC123EAA"
    }
}
```

<ParamField 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 theme={null}
{
    "integration": "salesforce",
    "pipeline": "deals",
    "configuration": {
        "listViewId": "00B5g00000ABC123EAA"
    }
}
```

<ParamField 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 theme={null}
{
    "integration": "salesforce",
    "pipeline": "custom_objects",
    "configuration": {
        "customObjectName": "Product_Catalog__c",
        "listViewId": "00B5g00000XYZ789EAA"
    }
}
```

<ParamField type="string">
  The API name of the Salesforce custom object to sync, e.g., `Product_Catalog__c`.
</ParamField>

<ParamField 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): Syncs knowledge base articles from ServiceNow.
* [Tickets](/managed-sync/api/ticket-schema): Syncs tickets from ServiceNow.

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync of knowledge base articles from ServiceNow.

```json Example theme={null}
{
    "integration": "servicenow",
    "pipeline": "files",
    "configuration": {
        "kbId": "kb_knowledge_base_sys_id_here"
    }
}
```

**Configuration options:**

<ParamField 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>

## Tickets

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a ticket sync.

```json Example theme={null}
{
    "integration": "servicenow",
    "pipeline": "tickets",
    "configuration": {}
}
```

**Configuration options:**

ServiceNow ticket sync does not require any additional configuration options. The sync will ingest all available tickets from the user's ServiceNow account.


# 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`
* `User.Read`
* `Group.Read.All`
* `offline_access`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

<Info>
  If you are using Permissions API, SharePoint requires these scopes to be configured as **Application Permissions** (not Delegated Permissions) in your Azure AD app registration. This requires certificate-based authentication and admin consent.

  Follow the [SharePoint: Using Application Permissions](/resources/integrations/sharepoint#using-application-permissions) setup guide before enabling a sync.
</Info>

## Synced Objects

SharePoint supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)
* [Permissions](/managed-sync/permissions-api)

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync.

Syncs for SharePoint can be created with one of the following configurations:

* **Site Sync**: All files in the specified SharePoint site will be synced.
* **Folder Sync**: Only files in the specified folder will be synced (recursively including all subfolders by default).
* **Sync of specific files**: Only a group of specific files will be synced.

<Tabs>
  <Tab title="Site Sync">
    ```json Example theme={null}
    {
        "integration": "sharepoint",
        "pipeline": "files",
        "configuration": {
            "siteId": "contoso.sharepoint.com,12345678-1234-1234-1234-123456789012,87654321-4321-4321-4321-210987654321"
        }
    }
    ```

    <ParamField type="string">
      The SharePoint Site ID to sync files from. Defaults to the site that the user selected when connecting their SharePoint account in the Connect Portal, if using post-OAuth options.

      <Info>
        If you skip the post-OAuth Site Selection install stage or use `bypassPostOAuthPrompt`, this value must be provided in the Sync configuration.
      </Info>
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>

    <ParamField type="boolean">
      Set to `true` to include each file's SharePoint list item fields (custom columns and library metadata) on the synced [File](/managed-sync/api/file-schema) under `customFields.metadata`. Defaults to `false`. See [File metadata](#file-metadata) for details.
    </ParamField>
  </Tab>

  <Tab title="Folder Sync">
    ```json Example theme={null}
    {
        "integration": "sharepoint",
        "pipeline": "files",
        "configuration": {
            "folderId": "01ABCDEF2345GHIJKL/XYZ1234567890!123",
            "siteId": "contoso.sharepoint.com,12345678-1234-1234-1234-123456789012,87654321-4321-4321-4321-210987654321"
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string">
      The SharePoint Folder ID to sync files from.
    </ParamField>

    <ParamField type="string">
      The SharePoint Site ID to sync files from. Defaults to the site that the user selected when connecting their SharePoint account in the Connect Portal, if using post-OAuth options.

      <Info>
        If you skip the post-OAuth Site Selection install stage or use `bypassPostOAuthPrompt`, this value must be provided in the Sync configuration.

        If the folder given by `folderId` does not belong to the site provided in `siteId` or inferred by the user's site selection, the Sync will fail.
      </Info>
    </ParamField>

    <ParamField type="boolean">
      Set to `true` to sync only the direct children of the specified folder, without recursing into subfolders. Defaults to `false`.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>

    <ParamField type="boolean">
      Set to `true` to include each file's SharePoint list item fields (custom columns and library metadata) on the synced [File](/managed-sync/api/file-schema) under `customFields.metadata`. Defaults to `false`. See [File metadata](#file-metadata) for details.
    </ParamField>
  </Tab>

  <Tab title="Sync of specific files">
    ```json Example theme={null}
    {
        "integration": "sharepoint",
        "pipeline": "files",
        "configuration": {
            "fileIds": ["01ABCDEF2345GHIJKL/XYZ1234567890!456"]
        }
    }
    ```

    **Configuration options:**

    <ParamField type="string[]">
      A list of SharePoint File IDs to limit the Sync scope to.
    </ParamField>

    <ParamField type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>

    <ParamField type="boolean">
      Set to `true` to include each file's SharePoint list item fields (custom columns and library metadata) on the synced [File](/managed-sync/api/file-schema) under `customFields.metadata`. Defaults to `false`. See [File metadata](#file-metadata) for details.
    </ParamField>
  </Tab>
</Tabs>

## File metadata

Synced SharePoint files include additional metadata in the [File](/managed-sync/api/file-schema) `customFields` object:

* **`fullPath`** *(always included)*: The file's full path within its drive, built from the parent folder path and file name (for example, `/drives/<driveId>/root:/Shared Documents/Reports/Q1.pdf`). Use this when you need to display or reason about the location of a file in SharePoint without traversing the folder hierarchy yourself.
* **`metadata`** *(included when `includeMetadata` is `true`)*: A flat object of the file's SharePoint list item fields, including built-in columns and any custom columns defined on the document library. This is fetched per file using the Microsoft Graph `listItem` endpoint, so enabling it adds an extra API call per synced file.

Example synced file with `includeMetadata` enabled:

```json theme={null}
{
  "id": "...",
  "externalId": "01ABCDEF2345GHIJKL/XYZ1234567890!123",
  "name": "Q1-Report.pdf",
  "mimeType": "application/pdf",
  "customFields": {
    "fullPath": "/drives/b!.../root:/Shared Documents/Reports/Q1-Report.pdf",
    "metadata": {
      "Title": "Q1 Financial Report",
      "Department": "Finance",
      "ReviewStatus": "Approved",
      "Modified": "2024-04-01T10:00:00Z"
    }
  }
}
```

<Info>
  If a file does not have an associated list item (for example, items in a
  personal OneDrive context), the `metadata` field is omitted for that file.
</Info>

## Choosing Files and Folders

You can allow your user to select files from their SharePoint account in your app with the SharePoint File Picker provided by 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 theme={null}
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();
```

**Targeting a specific SharePoint site**

By default, the picker opens the site stored on the connected credential. If a single connected account has access to multiple SharePoint sites, pass `siteUrl` or `siteId` to `init()` to open a different site. `siteUrl` takes precedence when both are provided.

```javascript theme={null}
// Target a site by URL
await picker.init({
  siteUrl: 'https://contoso.sharepoint.com/sites/Engineering',
});

// Or target a site by ID (resolved via Microsoft Graph)
await picker.init({
  siteId: 'contoso.sharepoint.com,191d8a17-0000-0000-0000-000000000000',
});

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).


# 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:

**Files:**

* `hc:read`

**Tickets:**

* `tickets:read`
* `organizations:read`
* `users: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): Syncs knowledge base articles from Zendesk.
* [Tickets](/managed-sync/api/ticket-schema): Syncs tickets from Zendesk.

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a file sync of knowledge base articles from Zendesk.

```json Example theme={null}
{
    "integration": "zendesk",
    "pipeline": "files",
    "configuration": {
        "locale": "en-us"
    }
}
```

**Configuration options:**

<ParamField 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>

## Tickets

Send a request to [Enable Sync](/managed-sync/api/enable-a-sync) to start a ticket sync.

```json Example theme={null}
{
    "integration": "zendesk",
    "pipeline": "tickets",
    "configuration": {}
}
```

**Configuration options:**

<ParamField type="string">
  A Zendesk Organization ID to limit the Sync scope to tickets from a specific organization.

  If not specified, the Sync will ingest all available tickets from the user's Zendesk account.
</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`
* `ZohoCRM.settings.fields.READ`
* `ZohoCRM.org.READ` (required if using `backoffAtCreditPercentage`)

**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 theme={null}
{
    "integration": "zohocrm",
    "pipeline": "contacts",
    "configuration": {
        "backoffAtCreditPercentage": 0.8
    }
}
```

<ParamField type="number">
  When set, the sync will pause once the connected Zoho CRM account has consumed the specified percentage of its daily
  API credit allotment, trying again at an hourly frequency until API credits are available again.
  This can help to prevent exhausting API usage limits with large syncs.

  This value can be set between `0.5` (stop at 50% API utilization) and `1.0` (100% API utilization).

  **Note:** The OAuth application must use the `ZohoCRM.org.READ` scope to use this feature.
</ParamField>

## Companies

### Sync Configuration Options

```json Example theme={null}
{
    "integration": "zohocrm",
    "pipeline": "companies",
    "configuration": {
        "backoffAtCreditPercentage": 0.8
    }
}
```

<ParamField type="number">
  When set, the sync will pause once the connected Zoho CRM account has consumed the specified percentage of its daily
  API credit allotment, trying again at an hourly frequency until API credits are available again.
  This can help to prevent exhausting API usage limits with large syncs.

  This value can be set between `0.5` (stop at 50% API utilization) and `1.0` (100% API utilization).

  **Note:** The OAuth application must use the `ZohoCRM.org.READ` scope to use this feature.
</ParamField>

## Deals

### Sync Configuration Options

```json Example theme={null}
{
    "integration": "zohocrm",
    "pipeline": "deals",
    "configuration": {
        "backoffAtCreditPercentage": 0.8
    }
}
```

<ParamField type="number">
  When set, the sync will pause once the connected Zoho CRM account has consumed the specified percentage of its daily
  API credit allotment, trying again at an hourly frequency until API credits are available again.
  This can help to prevent exhausting API usage limits with large syncs.

  This value can be set between `0.5` (stop at 50% API utilization) and `1.0` (100% API utilization).

  **Note:** The OAuth application must use the `ZohoCRM.org.READ` scope to use this feature.
</ParamField>

## Custom Objects

### Sync Configuration Options

```json Example theme={null}
{
    "integration": "zohocrm",
    "pipeline": "custom_objects",
    "configuration": {
        "customObjectName": "Subscriptions",
        "backoffAtCreditPercentage": 0.8
    }
}
```

<ParamField type="string">
  The Zoho module API name to sync, e.g., `Subscriptions`.
</ParamField>

<ParamField type="number">
  When set, the sync will pause once the connected Zoho CRM account has consumed the specified percentage of its daily
  API credit allotment, trying again at an hourly frequency until API credits are available again.
  This can help to prevent exhausting API usage limits with large syncs.

  This value can be set between `0.5` (stop at 50% API utilization) and `1.0` (100% API utilization).

  **Note:** The OAuth application must use the `ZohoCRM.org.READ` scope to use this feature.
</ParamField>


# Monitoring Syncs
Source: https://docs.useparagon.com/managed-sync/monitoring

Review Managed Sync lifecycle, warning, error, and webhook delivery logs in Event Logs.

Managed Sync emits [Event Logs](/monitoring/event-logs) as Syncs run, retry, complete, or fail. These logs help you understand what happened inside Paragon when a Sync changes state, encounters a recoverable integration issue, enters an errored state, or cannot deliver a webhook to your app.

Event Logs complement [Managed Sync Webhooks](/managed-sync/webhooks):

* **Webhooks** notify your application when records change or a Sync needs application-level handling.
* **Event Logs** give your team an operational timeline for debugging and support.

## Viewing Managed Sync Logs

To view Managed Sync logs in the dashboard:

1. Open your Paragon project.
2. Navigate to **Monitoring**.
3. Select **All Logs**.
4. Filter **Type** to **Managed Sync**.

You can further narrow the view with **User ID**, **Integration ID**, **Trace ID**, and **Timestamp** filters. You can also search the log payload for values like a Sync ID, pipeline name, or record ID.

## Log Details

Expanding a Managed Sync log shows the full event context. Common properties include:

| Property      | Description                                                                                                                                   |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `syncId`      | The Sync ID returned by the Sync API. This is the same value shown as `syncInstanceId` in Managed Sync webhook payloads.                      |
| `traceId`     | Groups logs from the same Sync iteration, such as one initial sync, incremental sync, or periodic full sync run.                              |
| `userId`      | The Connected User associated with the Sync.                                                                                                  |
| `integration` | The integration associated with the Sync.                                                                                                     |
| `pipeline`    | The Managed Sync pipeline, such as `files`, `contacts`, or `tickets`.                                                                         |
| `syncEvent`   | The specific Managed Sync event, such as `INITIAL_SYNC_COMPLETED`, `SYNC_RUN_RATE_LIMITED`, or `SYNC_RUN_ERROR`.                              |
| `syncType`    | The Sync lifecycle phase: `INITIAL`, `INCREMENTAL`, `FULL`, `PERMISSION`, or `SINGLE_RECORD`.                                                 |
| `syncStatus`  | The Sync status at the time of the log, such as `ACTIVE`, `IDLE`, `RATE_LIMITED`, or `ERRORED`.                                               |
| `summary`     | Completion counts for successful Sync runs, including created, updated, deleted, total processed, total changes, and duration when available. |
| `error`       | Error context for warning and error logs, including recoverability, HTTP status, error code, and retry metadata when available.               |

```json Example Managed Sync log context expandable theme={null}
{
  "type": "Managed Sync",
  "message": "Incremental sync completed",
  "traceId": "0197a7a4-68c3-7b4f-9f4e-727b1fbf15a0",
  "logContext": {
    "syncId": "163a345e-2dd4-51ff-bcf5-7667de564bb0",
    "userId": "user_01JH448D13EX2BE1SC1GXVT05R",
    "integration": "googledrive",
    "pipeline": "files",
    "syncEvent": "INCREMENTAL_SYNC_COMPLETED",
    "syncType": "INCREMENTAL",
    "syncStatus": "IDLE",
    "summary": {
      "recordsCreated": 2,
      "recordsUpdated": 5,
      "totalChanges": 7,
      "durationMs": 18342
    }
  }
}
```

## Log Types

### Lifecycle Logs

Lifecycle logs show when each Sync phase starts and completes:

* `INITIAL_SYNC_STARTED` and `INITIAL_SYNC_COMPLETED`
* `INCREMENTAL_SYNC_STARTED` and `INCREMENTAL_SYNC_COMPLETED`
* `FULL_SYNC_STARTED` and `FULL_SYNC_COMPLETED`

Use lifecycle logs to confirm that a Sync is progressing, identify how long a Sync run took, and inspect how many records were created, updated, or deleted in a completed run.

### Warning and Retry Logs

Managed Sync automatically retries recoverable failures, including rate limits, timeouts, and temporary integration API errors. These appear as warning-level logs, such as:

* `SYNC_RUN_RATE_LIMITED`
* `SYNC_RUN_WARNING`
* `FULL_SYNC_INTERRUPTED`

Warning logs include `error.recoverability: "RECOVERABLE"` and may include retry details such as `backoffMs`, `nextRetryAt`, `attempt`, and `maxAttempts`.

<Info>
  Rate limits and temporary upstream failures usually do not require application changes. Use these logs to understand delays or repeated retries for a specific Sync, Connected User, or integration.
</Info>

### Error Logs

Error-level logs indicate that a Sync could not continue without intervention. Managed Sync emits error logs for cases such as invalid Sync configuration, duplicate Sync creation, authentication failures, or terminal integration errors.

Common error events include:

* `SYNC_CREATION_FAILED`
* `SYNC_RUN_ERROR`

When a Sync enters an errored state, check the log's `error.errorCode`, `error.httpStatus`, and `error.recoverability` fields. After resolving the underlying issue, you can [re-enable the Sync](/managed-sync/api/reenable-sync).

### Webhook Delivery Logs

Managed Sync emits `SYNC_WEBHOOK_FAILED` when Paragon cannot deliver a Sync webhook to your configured webhook URL. The log is warning-level while Paragon will retry delivery and error-level after retries are exhausted.

Use this event to debug endpoint availability, response status codes, timeouts, and webhook retry behavior. See [Managed Sync webhooks](/managed-sync/webhooks) for webhook configuration and payload details.


# 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 alt="Managed Sync Banner Pn" />
</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
* Operational visibility through [Event Logs](/managed-sync/monitoring) for Sync lifecycle events, warnings, errors, and webhook delivery failures

<Frame>
  <iframe title="YouTube video player" />
</Frame>

## How Managed Sync Works

<Frame>
  <img alt="Sync Setup" />
</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:

```http Query to check if a user has access to File ID "123" theme={null}
POST /api/permissions/{syncId}/check

{
    "user": "youruser@email.com",
    "role": "can_read",
    "object": "[File UUID]"
}

// Response:
{
    "hasAccess": true
}
```

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.

## Supported Integrations

The following File Storage integrations support Permissions API (see the links below for any additional OAuth scopes or configuration parameters you may need to include to enable permissions indexing):

* [Box](/managed-sync/integrations/box)
* [Confluence](/managed-sync/integrations/confluence)
* [Dropbox](/managed-sync/integrations/dropbox)
* [Google Drive](/managed-sync/integrations/googledrive)
* [OneDrive](/managed-sync/integrations/onedrive)
* [SharePoint](/managed-sync/integrations/sharepoint)

## 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 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 alt="Permissions API diagram" />
</Frame>

Depending on the architecture of your app and your indexing requirements, Permissions API can be implemented as a [pre-search filter](#pre-search-filtering), [post-search filter](#post-search-filtering), or in a [hybrid approach](#hybrid-approach) of both to ensure that users can only view documents that they have access to in upstream applications (Google Drive, SharePoint, etc.).

### Pre-search Filtering

<Info>
  **This approach will only scale to a small corpus of documents** (≤ 1000 total).

  If your users will sync more documents, we recommend using a post-filtering or hybrid approach as described below.
</Info>

In pre-filtering, you can use Permissions API to collect a list of document IDs *before* you query your vector database or search index.

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. For result sets that may exceed 1000 objects, use [Streamed List Objects](/managed-sync/api/streamed-list-objects) to consume results incrementally as NDJSON. If a Connected User has multiple Permission Syncs (for example, both Google Drive and SharePoint) and you want a unified list across all of them, use [Streamed List Objects (All Syncs)](/managed-sync/api/streamed-list-objects-all-syncs) — each streamed object is tagged with its source `syncInstanceId` and `integration`:

```http theme={null}
POST /api/permissions/{sync_id}/list-objects

{
  "objectType": "file",
  "user": "user1@example.com",
  "role": "can_read"
}
```

The API will respond with an array of document IDs (`file.id` from the [File schema](/managed-sync/api/file-schema)) that you can use to limit your search index parameters.

<AccordionGroup>
  <Accordion title="Example in Pinecone">
    ```python theme={null}
    index.query(
        vector=[...], 
        top_k=10,
        filter={
            "file_id": {"$in": permitted_doc_ids} 
        }
    )
    ```
  </Accordion>

  <Accordion title="Example in Elasticsearch">
    ```js theme={null}
    {
      "query": {
        "bool": {
          "must": {
            "match": {
              "content": "search text"
            }
          },
          "filter": {
            "terms": {
              "file_id": permitted_doc_ids
            }
          }
        }
      }
    }
    ```
  </Accordion>
</AccordionGroup>

### Post-search Filtering

In post-search filtering, you can use Permissions API to filter the results of your search query to only include documents that the user has access to.

After you receive ranked search results from your vector database, send a request to the [Batch Check Access](/managed-sync/api/batch-check-access) endpoint to check if the current user has access to the result documents by passing a list of IDs:

```http theme={null}
POST /api/permissions/{sync_id}/batch-check

{
  "checks": [
    {
      "object": "doc-1",
      "user": "user:email@example.com",
      "role": "can_read"
    },
     {
      "object": "doc-2",
      "user": "user:email@example.com",
      "role": "can_read"
    }
  ]
}
```

The API will provide a list of objects with a Boolean `allowed` property that will tell you if the current user has access to the file (directly or via a transitive relationship).

You can use this list to filter down the search results from your database and include the accessible documents in your LLM context.

We recommend over-fetching by a factor of at least 2x from your search / vector database to account for scenarios where some relevant documents will not be available to the user.

### Hybrid Approach

You can combine pre-search and post-search filtering techniques to limit the search space upfront for your database queries while ensuring that permissions enforcement is accurate for document sets of >1000 files.

Use coarse-grained pre-search filters to limit the initial search space (removing documents from e.g. different teams or spaces that the user is not assigned to), and use the Permissions API to filter the final results, verifying that the user has access to the documents that are ultimately used in a response.

Some examples of coarse pre-search filters you can use:

* Folder IDs that the user has access to
* Space/Drive IDs that the user has access to
* Group/Team IDs that the user is a member of

This metadata will need to be indexed in your search database at ingestion time so that you can filter the results based on it.

For example, if a user is a part of the Engineering team inside of your app, an organization admin can choose which top-level folders or drives that belong to the Engineering team and should be searchable by other members, during sync setup. When ingesting files from this sync, you will need to include this metadata in the indexed documents so that you can use this as a pre-search filter.

<AccordionGroup>
  <Accordion title="Example in Pinecone">
    ```python theme={null}
    index.query(
        vector=[...], 
        top_k=10,
        filter={
          "team_id": {"$in": ["engineering-team-id"]} 
        }
    )
    ```
  </Accordion>

  <Accordion title="Example in Elasticsearch">
    ```js theme={null}
    {
      "query": {
        "bool": {
          "must": {
            "match": {
              "content": "search text"
            }
          },
          "filter": {
            "terms": {
              "team_id": ["engineering-team-id"]
            }
          }
        }
      }
    }
    ```
  </Accordion>
</AccordionGroup>

After you receive the search results, you can use the [Batch Check Access](/managed-sync/api/batch-check-access) endpoint to filter the result set to the documents that the user has access to.

As in [Post-search Filtering](#post-search-filtering), we recommend over-fetching by a factor of at least 2x from your search / vector database to account for scenarios where some relevant documents will not be available to the user.


# 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 theme={null}
  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} theme={null}
{
    "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>

### Multi-Account Authorization

Managed Sync supports [Multi-Account Authorization](/apis/api-reference/multi-account-authorization). If a user has connected multiple accounts of the same integration type, you can specify which account to use when [enabling a sync](/managed-sync/api/enable-a-sync) by providing the `credentialId` parameter.

You can retrieve the list of connected credentials from the `allCredentials` array returned by the [/sdk/me](/apis/api-reference/multi-account-authorization#getuser) endpoint.

<Info>
  If `credentialId` is not specified and the user has multiple connected accounts for the same integration, the default credential (the oldest active credential) will be used.
</Info>

## 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_complete` [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 default frequency of incremental syncs is every minute. You can [configure this](#configuring-sync-frequency) per-sync with `incrementalAccumulatorFrequency`.
* **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).
  * The default frequency is every 24 hours. This can be configured down to 3 hours in [on-prem environments](/on-premise/hosting-paragon-on-premise) of Paragon.
  * The Sync status will have a `lastPeriodicFullSyncedAt` timestamp in `summary` once the first periodic full sync completes, separate from `lastSyncedAt`.

You can monitor these lifecycle phases in [Event Logs](/managed-sync/monitoring). Managed Sync emits logs when initial syncs, incremental syncs, and periodic full syncs start, complete, retry after recoverable warnings, or enter an errored state.

## 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 theme={null}
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_complete 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_complete` 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.

## Configuring Sync Frequency

You can override the default frequency of the incremental sync when you [Enable a Sync](/managed-sync/api/enable-a-sync) or [Update an Existing Sync](/managed-sync/api/update-sync), using `incrementalAccumulatorFrequency`. This property determines how often Paragon will check for new or updated records from the integration.

Use a lower incremental frequency (longer time value) when freshness is less important than reducing API calls to the underlying integration.

Accepted values:

| Value | Description            |
| ----- | ---------------------- |
| `1m`  | Every minute (default) |
| `5m`  | Every 5 minutes        |
| `10m` | Every 10 minutes       |
| `30m` | Every 30 minutes       |
| `1h`  | Every hour             |
| `3h`  | Every 3 hours          |
| `6h`  | Every 6 hours          |
| `24h` | Every 24 hours         |

```bash Example: Enable a Sync with a 5-minute incremental sync frequency theme={null}
curl -X POST https://sync.useparagon.com/api/syncs \
  -H "Authorization: Bearer $PARAGON_USER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "integration": "googledrive",
    "pipeline": "files",
    "incrementalAccumulatorFrequency": "5m"
  }'
```

You can change the incremental sync frequency at any time using [Update a Sync](/managed-sync/api/update-sync).


# 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 include normalized schemas 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

Synced Objects for Ticketing include normalized schemas for each object type, and the original fields are each ticket are available as `originalRecord`.

Files that are attached to the ticket and comments made in the ticket thread can also be retrieved as an archive file.

* [Ticket](/managed-sync/api/ticket-schema) (`tickets`): A ticket in a customer ticketing system or project management service, including metadata about the ticket's status, priority, and assignee.
  * Comments and attachments related to the ticket can be downloaded as an archive using the [Download Content](/managed-sync/api/download-content) endpoint.

## 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 alt="Syncs > Configuration > Set Webhook URL" />
</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.

Webhook delivery failures are also emitted to [Event Logs](/managed-sync/monitoring#webhook-delivery-logs), where you can inspect retry attempts, HTTP status, and whether Paragon will retry delivery.

## 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 theme={null}
{
	"event": "[event type]",
	"sync": "[integration name]",
	"syncInstanceId": "[ID of Sync]",
	"credentialId": "[ID of credential used]",
	"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 theme={null}
{
  "event": "sync_complete",
  "syncInstanceId": "163a345e-2dd4-51ff-bcf5-7667de564bb0",
  "sync": "googledrive",
  "credentialId": "0aea7d3a-b5f7-4488-890e-d51a5cf4f8f1",
  "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 with a non-recoverable error and cannot continue without intervention. After this event is sent, the Sync `status` field will be set to `ERRORED`.

Paragon only emits `sync_errored` for non-recoverable (permanent) errors. Transient errors like rate limits (HTTP 429), temporary network failures, and expired access tokens are handled automatically by Managed Sync with backoff and retry logic - they do not trigger this webhook, and no action is required on your part.

The most common category of non-recoverable errors is **credential errors**, which occur when the end user's connected credential is no longer valid (for example, the user has revoked access, deleted the credential, or the refresh token has permanently expired). These errors require the end user to reconnect the integration through the [Connect Portal](/connect-portal/overview) before the Sync can resume.

```json Credential error expandable theme={null}
{
  "event": "sync_errored",
  "syncInstanceId": "f543fd08-5d36-56d7-bd5e-8306e82acb16",
  "sync": "googledrive",
  "credentialId": "0aea7d3a-b5f7-4488-890e-d51a5cf4f8f1",
  "user": {
    "id": "user_01JH448D13EX2BE1SC1GXVT05R"
  },
  "error": {
    "code": "PROXY_7300",
    "message": "Credential ID 0aea7d3a-b5f7-4488-890e-d51a5cf4f8f1 is no longer valid or has been deleted."
  }
}
```

Other non-recoverable errors include things like insufficient permissions on the connected account, invalid sync configuration, or an integration being disabled for the project. In all cases, the Sync will remain in the `ERRORED` state until the underlying issue is resolved and the Sync is [re-enabled](/managed-sync/api/reenable-sync).

The `error` object includes a stable `code` field you can use for programmatic handling. See the [error code reference](#error-codes) below for a full list of codes and recommended actions.

### `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 theme={null}
{
  "event": "record_created",
  "syncInstanceId": "163a345e-2dd4-51ff-bcf5-7667de564bb0",
  "sync": "googledrive",
  "credentialId": "0aea7d3a-b5f7-4488-890e-d51a5cf4f8f1",
  "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 theme={null}
{
  "event": "record_updated",
  "syncInstanceId": "163a345e-2dd4-51ff-bcf5-7667de564bb0",
  "sync": "googledrive",
  "credentialId": "0aea7d3a-b5f7-4488-890e-d51a5cf4f8f1",
  "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 theme={null}
{
  "event": "record_deleted",
  "syncInstanceId": "0df4921d-0ac4-5c90-b30e-7a9da9c2d02f",
  "sync": "googledrive",
  "credentialId": "0aea7d3a-b5f7-4488-890e-d51a5cf4f8f1",
  "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 theme={null}
{
  "event": "record_errored",
  "syncInstanceId": "0df4921d-0ac4-5c90-b30e-7a9da9c2d02f",
  "sync": "googledrive",
  "credentialId": "0aea7d3a-b5f7-4488-890e-d51a5cf4f8f1",
  "user": {
    "id": "user_01JH448D13EX2BE1SC1GXVT05R"
  },
  "error": {
    "message": "Request failed with status code 404",
    "recordId": "68c3e715-b466-544f-ba2a-165973d85a58",
    "model": "files"
  }
}
```

## Error Codes

The `error` object in error webhook payloads (including `sync_errored` or `record_errored`) include a stable `code` field alongside the human-readable `message`.

Use this field for programmatically reacting to known error types and taking suggested actions (listed below).

### Credential errors

These errors indicate the user's connected credential is invalid, expired, or has been removed. All credential errors include the message: "Credential ID \<id> is no longer valid or has been deleted."

**Suggested action:** Prompt the end user to re-authenticate the integration through the [Connect Portal](/connect-portal/overview).

<table>
  <thead>
    <tr>
      <th>Code</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td><code>PROXY\_7300</code> <code>PROXY\_7301</code> <code>PROXY\_7306</code> <code>PROXY\_7317</code></td>
      <td>Credential not found (can occur if the credential that the sync is explicitly bound to has been deleted)</td>
    </tr>

    <tr>
      <td><code>PROXY\_7303</code></td>
      <td>Credential is in an invalid state (e.g. revoked or expired)</td>
    </tr>

    <tr>
      <td><code>PROXY\_7311</code></td>
      <td>Credential configuration not found</td>
    </tr>

    <tr>
      <td><code>PROXY\_7325</code></td>
      <td>Credential not found for external ID</td>
    </tr>

    <tr>
      <td><code>PROXY\_01101</code></td>
      <td>Credential could not be decrypted (deleted or corrupted)</td>
    </tr>

    <tr>
      <td><code>PROXY\_11002</code></td>
      <td>Integration is not enabled for this user</td>
    </tr>
  </tbody>
</table>

### Authorization errors

These errors indicate an HTTP-level authorization failure when calling the third-party API. The user's access token may have expired or been revoked, or the user may lack required permissions in the third-party service.

**Suggested action:** Prompt the end user to re-authenticate the integration through the [Connect Portal](/connect-portal/overview).

<table>
  <thead>
    <tr>
      <th>Code</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td><code>PROXY\_401</code></td>
      <td>Third-party API rejected the request as unauthorized</td>
    </tr>

    <tr>
      <td><code>PROXY\_403</code></td>
      <td>Third-party API rejected the request as forbidden (insufficient permissions or scopes)</td>
    </tr>
  </tbody>
</table>

### Configuration errors

These errors indicate a problem with how the sync was configured (for example, a required parameter is missing or invalid, or a referenced resource is no longer available in the third-party service).

**Suggested action:** Check the sync configuration, correct any issues, and recreate the sync.

<table>
  <thead>
    <tr>
      <th>Code</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td><code>10006</code></td>
      <td>A required sync configuration parameter is missing or invalid.</td>
    </tr>

    <tr>
      <td><code>10007</code></td>
      <td><strong>Root resource not found</strong><br />A root resource selected when the sync was created (such as a folder, site, space, or drive) is no longer accessible in the third-party service. This typically means the resource has been deleted, moved, or the end user has lost access to it. Recreate the sync with a valid root resource.</td>
    </tr>
  </tbody>
</table>

### Account limit errors

<table>
  <thead>
    <tr>
      <th>Code</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td><code>10003</code></td>
      <td>The sync has reached its trial record limit.<br />Contact your Customer Success Manager to upgrade your account limits.</td>
    </tr>
  </tbody>
</table>

### System errors

These errors indicate an internal issue with the sync process and do not require action from the end user. Contact Paragon support if the error persists.

<table>
  <thead>
    <tr>
      <th>Code</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td><code>10001</code></td>
      <td><strong>Pipeline does not support permissions</strong><br />The sync attempted a permission-based operation that the integration does not support.</td>
    </tr>

    <tr>
      <td><code>10004</code></td>
      <td><strong>Job stalled more than allowable limit</strong><br />The sync job became unresponsive after multiple retry attempts.</td>
    </tr>

    <tr>
      <td><code>10005</code></td>
      <td><strong>Failed to download content</strong><br />The sync was unable to download file content from the third-party service.</td>
    </tr>

    <tr>
      <td><code>20005</code></td>
      <td><strong>Authorization model not found</strong><br />An internal permissions model required by the sync could not be located.</td>
    </tr>

    <tr>
      <td><code>00000</code></td>
      <td><strong><em>Varies</em></strong><br />An unclassified error occurred. Refer to the <code>message</code> field for details.</td>
    </tr>
  </tbody>
</table>

Error codes prefixed with `PROXY_` that are not listed above indicate a failure from an upstream service. Treat them as unrecoverable and refer to the `message` field for details.


# 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 alt="Account Settings" />
</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 Monitoring pages *only*
* Designate specific users with **Organization Admin** roles to manage global settings, including team member access and billing information
* Invite development contractors and integration partners as **Set by Project** roles to give them isolated access to a separate project for development purposes

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).

  **Organization Admin and Developer 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 alt="" />
</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 alt="" />
</Frame>

## Role Types

### Organization Admin

**Organization Admins have full read/write access to all Paragon projects**. Organization Admins can also exclusively invite new team members and view billing details.

### Developers

Developers are allowed to modify integrations and deploy workflows, but they cannot create new Event Destinations or modify existing Environment Secrets.

| ✓ Developers are allowed to:                                                                                                                                  | ✗ Developers 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 Monitoring 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 workflow executions on the Monitoring page <br /> • Replay failed Workflow Executions from Monitoring | • Create new Projects <br /> • Modify any project details (including Integrations or Workflows) <br /> • View Client IDs or Secrets for Integrations |

### Set by Project

Team Members with the **Set by Project** role can be assigned any of the role types (Admin, Developer, Support) for a specific project(s).

By default, any projects that are not explicitly assigned to **Set by Project**-type team members will not be accessible.

<Frame>
  <img alt="Set by Project users" />
</Frame>


# 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 see integration activity in [Monitoring](/monitoring/overview).

By default, Paragon has [two types of roles](/managing-account/teams#managing-roles-and-permissions) available for projects: **Organization Admin** and **Developer**. *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 alt="" />
</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 alt="" />
</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 alt="" />
</Frame>

## Managing Roles and Permissions

There are three types of roles Team Members can have in your Organization:

| User Permissions                                             | Support\* | Developer | Organization Admin |
| ------------------------------------------------------------ | --------- | --------- | ------------------ |
| View Monitoring                                              | ☑️        | ☑️        | ☑️                 |
| 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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>
  <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 alt="" />
</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 theme={null}
  {
    "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/monitoring/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 theme={null}
  {
    "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 alt="" />
</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 alt="" />
</Frame>

2. Under **Access**, click the **API Keys** settings page.

<Frame>
  <img alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
   </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 alt="" />
</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 alt="" />
   </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 alt="" />
   </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 alt="" />
</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. These logs help to build a complete picture of data moving between your app and your users' integrations.

Event Logs provide visibility into all product areas:

* [Managed Sync](/managed-sync/monitoring): trace a sync from its initial sync through incremental syncs, periodic full syncs, recoverable warnings, and terminal errors.
* [ActionKit](/actionkit/actionkit-logs): trace an ActionKit tool call or trigger event, with each API call logged.
* [Workflows](/workflows/viewing-workflow-executions), including trigger details from Scheduler Triggers, Request Triggers, Custom Webhooks, 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.

You can find your project's Event Logs by navigating to the **Monitoring** tab in the left sidebar and selecting the **All Logs** tab.

<Frame>
  <img alt="" />
</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

The following event types will appear in your Event Logs:

### Platform

<Accordion title="User Credentials">
  Credential refresh events are emitted when we attempt to refresh a user's access tokens.
  We have introduced credential refresh events for select integrations, and plan to expand support over time.

  * Attempted to refresh credential
  * Failed to refresh credential
  * Successfully refreshed credential
</Accordion>

### Workflows

<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>

### ActionKit

<Accordion title="ActionKit">
  ActionKit events are emitted when an ActionKit request is made.

  * Start `{ACTION_NAME}`
  * Completed `{ACTION_NAME}`
  * Failed `{ACTION_NAME}`
</Accordion>

### Managed Sync

<Accordion title="Sync Lifecycle">
  Managed Sync lifecycle logs are emitted when a Sync starts or completes an [initial sync, incremental sync, or periodic full sync](/managed-sync/sync-api#sync-lifecycle). Learn more about [monitoring Managed Sync](/managed-sync/monitoring).

  * Initial sync started
  * Initial sync completed
  * Incremental sync started
  * Incremental sync completed
  * Full sync started
  * Full sync completed
</Accordion>

<Accordion title="Sync Warnings and Errors">
  Managed Sync warning and error logs are emitted when a Sync is rate limited, retries after a recoverable failure, skips a full sync deletion pass, cannot be created, or enters an errored state.

  * Sync rate limited, backing off for `{seconds}` seconds...
  * Sync encountered timeout, backing off for `{seconds}` seconds...
  * Sync warning: `{message}`
  * Full sync interrupted, record deletion was not performed
  * Sync creation failed: Invalid pipeline configuration
  * Sync creation failed: Duplicate sync detected
  * Sync error: Authentication Failed
  * Sync error: `{message}`
</Accordion>

<Accordion title="Sync Webhooks">
  Managed Sync webhook logs are emitted when Paragon cannot deliver a Sync webhook to your configured endpoint. Learn more about [Managed Sync webhooks](/managed-sync/webhooks).

  * Unable to deliver sync webhook
</Accordion>

### Unsupported Events

The following events are not currently supported in Event Logs:

* Task executions and their individual outbound API requests
* 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). Errors surfaced by Event Logs can be
forwarded to your observability tools for increased retention and analysis via Event Destinations.


# Monitoring
Source: https://docs.useparagon.com/monitoring/overview

Track every step of your integration pipeline with observability into user connections, workflow executions, tool calls, and more.

<Frame>
  <img alt="" />
</Frame>

From the moment a user connects their first integration, Monitoring gives you a comprehensive view of your integration's stack in a Paragon project.
Dive deep into your user's lifecycle with detailed logs around user connections, triggers, actions, syncs, and more.

The [Connected Users](/monitoring/users) dashboard is a control panel for your users' integrations and their health. When a user connects an integration on your app,
their connection status will be documented here. See, manage, and debug the state of the connected integrations, enable Workflows, and view associated Triggers from this view.

<Frame>
  <img alt="Connected Users Dashboard Preview" />
</Frame>

## Product-specific Monitoring Views

Products on the Paragon platform each have a dedicated Monitoring view to provide a tailored debugging and observability experience.
Found in the **Monitoring** tab in left sidebar of the dashboard, these views provide chronological timelines across Paragon product events:

* **[All Logs](/monitoring/event-logs)** - Search and filter the atomic logs spanning all events in your Paragon project.
* **[Workflows](/workflows/viewing-workflow-executions)** - Review workflow executions, with step-by-step breakdowns and failure details.
* **[Tools](/actionkit/actionkit-logs)** - Debug and inspect ActionKit tool calls and payloads in real-time.
* **[Triggers](/actionkit/actionkit-logs#trigger-logs)** - Review Triggers API subscription events and payloads in real-time.

## Extend Monitoring to Your Own Observability Stack with APIs

When you need to extend Monitoring to your own observability platforms or get notified in real-time of warnings and errors across your
integration stack, you can use the [Event Destinations](/monitoring/event-destinations) and [Task History API](/apis/task-history).

<Columns>
  <Card title="Discover Event Destinations" href="/monitoring/event-destinations" icon={"send"}>
    Learn more about sending warnings to the services your team uses internally like Slack, Datadog, Sentry, and more.
  </Card>

  <Card title="Discover Task History API" href="/apis/task-history" icon={"book"}>
    Learn more about querying workflows usage and history using the Task History API.
  </Card>
</Columns>


# 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 alt="" />
</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 alt="" />
</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 view the workflow's execution in the [Monitoring > Workflows](/workflows/viewing-workflow-executions) 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 alt="" />
</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 alt="" />
</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 **Workflow executions** section at the bottom of the page.
3. Click the **View All** button to open the Monitoring page filtered to that user.

<Frame>
  <img alt="Connected Users dashboard with workflow executions and View All" />
</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 alt="" />
</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 alt="" />
</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)
* [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

## 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" />

<Card title="Configuring Managed Azure" href="/on-premise/configure/azure" />

<Card title="Configuring Managed GCP" href="/on-premise/configure/gcp" />

#### 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" />

<Card title="Configuring Managed Azure" href="/on-premise/configure/azure" />

<Card title="Configuring Managed GCP" href="/on-premise/configure/gcp" />


# 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 project
* 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>
  <Card title="AWS" href="https://aws.amazon.com/eks/" />

  <Card title="Azure" href="https://learn.microsoft.com/en-us/azure/aks/" />

  <Card title="GCP" href="https://cloud.google.com/kubernetes-engine" />
</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.

<Info>
  **Pricing basis (Feb 5, 2026):** USD list prices in AWS `us-east-1`, Azure `East US`, and GCP `us-central1`. Monthly estimates use `720` hours. Spot prices are illustrative and can change frequently.
</Info>

| Cloud     | Instance  | Instances | \$ / Hour | \$ / Hour (Spot) | \$ / Month | \$ / Month (Spot) |
| --------- | --------- | --------- | --------- | ---------------- | ---------- | ----------------- |
| **AWS**   | t3a.small | 16        | 0.0188    | 0.0089           | \$216.58   | \$102.53          |
| **Azure** | B1s       | 32        | 0.0104    | -                | \$239.62   | -                 |
| **Azure** | D2as v5   | 8         | 0.1010    | 0.0186           | \$581.76   | \$107.14          |
| **GCP**   | e2-small  | 16        | 0.016751  | -                | \$192.97   | -                 |

<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.0180    | \$12.96    | \$25.92               |
| db.t3.medium  | AWS   | 2    | 4           | 0.0720    | \$51.84    | \$103.68              |
| Standard\_B2s | Azure | 2    | 8           | 0.1780    | \$128.16   | \$256.32              |
| db-f1-micro   | GCP   | null | 0.6         | 0.0105    | \$7.56     | \$15.12               |
| db-g1-small   | GCP   | null | 1.7         | 0.0350    | \$25.20    | \$50.40               |

<Info>
  **Pricing basis (Feb 5, 2026):** USD list prices in AWS `us-east-1`, Azure `East US`, and GCP `us-central1`. Monthly estimates use `720` hours. Spot prices are illustrative and can change frequently.
</Info>

<Info>
  GCP also charges for storage and networking. Learn more [here](https://cloud.google.com/sql/docs/postgres/pricing).
</Info>

<Info>
  Azure Database for PostgreSQL Flexible Server pricing is region- and configuration-specific and is best pulled from the Azure pricing calculator for current USD list prices.
</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.237     | \$170.64   | \$341.28              |
| cache.r4.xlarge      | AWS   | 4    | 25.05       | 0.364     | \$262.08   | \$524.16              |
| P1                   | Azure | 0    | 6           | 0.554     | \$398.88   | \$797.76              |
| P3                   | Azure | null | 26          | 2.218     | \$1,596.96 | \$3,193.92            |
| Standard (M2 10 GiB) | GCP   | 0    | 10          | 0.54      | \$388.80   | \$777.60              |
| Standard (M3 35 GiB) | GCP   | null | 35          | 1.61      | \$1,159.20 | \$2,318.40            |

<Info>
  **Pricing basis (Feb 5, 2026):** USD list prices in AWS `us-east-1`, Azure `East US`, and GCP `us-central1`. Monthly estimates use `720` hours. Spot prices are illustrative and can change frequently.
</Info>

You can find more about Redis pricing below.

<CardGroup>
  <Card title="AWS" href="https://aws.amazon.com/elasticache/pricing/" />

  <Card title="Azure" href="https://azure.microsoft.com/en-us/pricing/details/cache/" />

  <Card title="GCP" href="https://cloud.google.com/memorystore/docs/redis/pricing" />
</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/" />


# 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
* 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" />

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 alt="" />
</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>
  <Card title="AWS" href="https://aws.amazon.com/eks/" />

  <Card title="Azure" href="https://learn.microsoft.com/en-us/azure/aks/" />

  <Card title="GCP" href="https://cloud.google.com/kubernetes-engine" />
</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 Monitoring (workflow executions)
* 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" />

<Info>
  Only managed installations (e.g. cloud 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 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 alt="" />
</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 alt="" />
</Frame>

### Postgres

Metrics and alarms include:

* CPU usage
* Memory usage
* Transactions
* Locks
* Conflicts/deadlocks
* Cache hit rate

<Frame>
  <img alt="" />
</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 alt="" />
</Frame>

### Workflow Executions

Metrics and alarms include:

* Workflow executions
* Step executions
* Workflow completion rate

<Frame>
  <img alt="" />
</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 alt="" />
</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" />

<Card title="Configuring Managed Azure" href="/on-premise/configure/azure" />

<Card title="Configuring Managed GCP" href="/on-premise/configure/gcp" />

### Terraform Account

The infrastructure state is managed within [Terraform](https://terraform.io/), a tool for managing infrastructure as code. For 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

The integration infrastructure platform for building native integrations that connect your product with your customers’ 3rd-party SaaS apps.

## Connect Your Users' Integrations

Start using Paragon by embedding Paragon components within your app to manage authentication for any integration.

<Columns>
  <Card title="Set Up Paragon" href="/getting-started/installing-the-connect-sdk">
    Install the Paragon SDK, add integrations, and start connecting users
  </Card>

  <Card title="Install the Paragon Skill" href="/building-with-agents">
    Provide context to your coding agent on how to set up and build Paragon integrations
  </Card>
</Columns>

## Build Integrations Your Way

For different use cases, Paragon has **three primitives** for building integration logic:

<Columns>
  <Card title="ActionKit" href="/actionkit/overview">
    Pre-built integration actions for real-time use cases - Triggers to subscribe to webhook events and Tools for CRUD operations
  </Card>

  <Card title="Managed Sync" href="/managed-sync/overview">
    Data pipelines to sync all of your users' integration data
  </Card>

  <Card title="Workflows" href="/workflows/overview">
    Build integration logic and automations without managing infrastructure
  </Card>
</Columns>

## Full Monitoring & Observability

Monitor every action in Paragon's platform - everything from authentication to credential refreshes to individual tool calls.

<Columns>
  <Card title="Monitoring & Observability" href="/monitoring/overview">
    Every integration event is captured, viewable in Paragon dashboards, and forwardable to your logging platform of choice
  </Card>
</Columns>

## Flexible Hosting

Whether you're looking for a cloud-hosted or on-prem/self-hosted option, Paragon has you covered.

* Use Paragon's **hosted cloud environment**, available in U.S. and E.U. regions
* Deploy Paragon infrastructure **on-prem in your own VPC**
* **Forward deploy** Paragon instances in your customers' cloud environments

<Columns>
  <Card title="Choosing a Hosting Solution" icon="chart-diagram" href="/on-premise/choosing-a-hosting-solution">
    When to use Paragon's cloud offering vs. hosting Paragon in your own VPC
  </Card>

  <Card title="Deploying On-Prem" icon="cloud" href="/on-premise/hosting-paragon-on-premise">
    Deploy Paragon in your private AWS, Azure, or GCP environment
  </Card>
</Columns>


# 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 theme={null}
para build
```

If your build is successful, you will see:

```bash theme={null}
✓ 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 theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
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 alt="" />
</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 theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
import {
  ICustomIntegrationConfig,
  createConfigInputs,
  credentials,
} from '@useparagon/core/integration';

export const inputs = createConfigInputs({});

const config: ICustomIntegrationConfig = {
  name: '',
  description: '',
  accentColor: '#000000',
  authenticationType: '', // oauth | oauth_client_credential | ropc_app | basic
  
  // For OAuth and ROPC
  accessTokenUrl: ``,
  scopes: '',

  // For OAuth only
  authorizationUrl: ``,
  includeClientIdAndSecrets: false,
  usePKCEInCodeExchange: true,
  
  apiBaseUrl: ``,
  testEndpointPath: ``,
  authorization: {
    type: 'bearer',
    token: `${credentials.oauthAccessToken}`,
  },
};

export default config;
```

When defining workflows for Custom Integrations, you can import `ICustomIntegration` from the core library to get started:

```ts theme={null}
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>>,
  ) {
  }
}
```

### Custom Request Options

For OAuth, Client Credentials, and ROPC integrations, you can override the default behavior of each authentication request using `requestOptions`. This is useful when an API deviates from standard OAuth conventions.

The `credentials` object exposed in `@useparagon/core/integration` provides access to values at each stage of the auth flow:

| Property                            | Description                                                |
| ----------------------------------- | ---------------------------------------------------------- |
| `credentials.clientId`              | The OAuth app's client ID                                  |
| `credentials.clientSecret`          | The OAuth app's client secret                              |
| `credentials.oauthAccessToken`      | The user's access token                                    |
| `credentials.authRequest.params`    | Query params from the authorization redirect (e.g. `code`) |
| `credentials.tokenRequest.response` | The token endpoint response body as JSON                   |
| `credentials.savedCredentials`      | Previously saved credentials (e.g. `refresh_token`)        |
| `credentials.username`              | Username (ROPC only)                                       |
| `credentials.password`              | Password (ROPC only)                                       |

```ts Example expandable theme={null}
import {
  ICustomIntegrationConfig,
  credentials,
} from '@useparagon/core/integration';

const config: ICustomIntegrationConfig = {
  // ...
  requestOptions: {
    accessTokenOptions: {
      enabled: true,
      configuration: {
        bodyType: 'x-www-form-urlencoded',
        body: {
          client_id: `${credentials.clientId}`,
          client_secret: `${credentials.clientSecret}`,
          grant_type: 'authorization_code',
          code: `${credentials.authRequest.params.code}`,
        },
      },
    },
    authorizationCodeOptions: {
      enabled: true,
      configuration: {
        queryParams: {
          client_id: `${credentials.clientId}`,
          response_type: 'code',
          scope: `${credentials.scope}`,
          // access_type: 'offline', // required by some providers (e.g. Google) for refresh tokens
        },
      },
    },
    refreshTokenOptions: {
      tokenUrl: `https://auth.example.com/oauth/token`,
      configuration: {
        bodyType: 'x-www-form-urlencoded',
        body: {
          client_id: `${credentials.clientId}`,
          client_secret: `${credentials.clientSecret}`,
          grant_type: 'refresh_token',
          refresh_token: `${credentials.savedCredentials.refresh_token}`,
        },
      },
    },
    saveCredentialsOptions: {
      credentialSchema: {
        access_token: `${credentials.tokenRequest.response.access_token}`,
        refresh_token: `${credentials.tokenRequest.response.refresh_token}`,
      },
    },
  },
};
```


# 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 Monitoring and the Workflow Editor.

## Creating a workflow

You can create a new workflow by running the following CLI command:

```bash theme={null}
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 alt="" />
</Frame>

An example of a simple workflow to sync contacts from Salesforce is below:

```ts theme={null}
/**
 * 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 alt="" />
</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 theme={null}
// 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 theme={null}
{
    // 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 theme={null}
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 theme={null}
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 theme={null}
// 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 theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
// 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 theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
// 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 theme={null}
// 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 alt="Page cover image" />
</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 title="YouTube video player" />
</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 theme={null}
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 theme={null}
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 theme={null}
  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 theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
git clone git@github.com:useparagon/integrations.git
para install
```

## Creating a New Integration

Create a new integration in Paragraph with the CLI:

```bash theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
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 theme={null}
/**
 * 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 theme={null}
/**
 * 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 theme={null}
import taskCreated from '../../../events/newTask';
```

Then, pass this import to the constructor of `EventStep`:

```js theme={null}
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 theme={null}
/**
 * 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 theme={null}
/**
 * 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 theme={null}
/**
 * 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 theme={null}
/**
 * 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 theme={null}
/**
 * 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 theme={null}
/**
 * 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 theme={null}
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 theme={null}
/**
 * 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 theme={null}
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 theme={null}
/**
 * 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 theme={null}
/**
 * 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 alt="" />
</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 theme={null}
  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-action@v3
          with:
            subfolder: 'your-paragraph-project-folder' // Optional, depending on repo structure
            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 theme={null}
  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-action@v1
          with:
            subfolder: 'your-paragraph-project-folder' // Optional, depending on repo structure
            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 alt="" />
</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 alt="" />
</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>
  <Card title="Connect Portal" href="/connect-portal/connect-portal-customization">
    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">
    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>
  <Card title="Monitoring" href="/monitoring/overview">
    View detailed logs for every step in your integration pipeline for all of your customers with the Monitoring page.
  </Card>

  <Card title="Event Destinations" href="/monitoring/event-destinations">
    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, managed on-premise deployments, or other forward-deployed options.

<Card title="Choose your deployment option for Paragon" icon="arrow-right" 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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.
* **User Profile** - Save data about your user’s account after connecting to the integration. The data is then referenceable in the integrations [`providerData`](https://docs.useparagon.com/apis/api-reference#getuser)

<Frame>
  <img alt="" />
</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 alt="" />
</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" 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 theme={null}
// 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 theme={null}
// 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" 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 theme={null}
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 REST API theme={null}
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" 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 alt="" />
</Frame>

### Step 2. Webhook Setup

#### Option 1: API Request Setup

With API Request Setup, a request is sent to programmatically create the webhook when a user enables a Workflow that relies on this trigger.

**To set up and test API Request Setup:**

Configure the following API request parameters that should be used to create the webhook. This information should be found in the provider's webhook API documentation.

* **Webhook Setup Request URL**: The API endpoint that should be used to create the webhook.
* **Webhook Target URL**: Instruct the webhook provider where to send webhook events by referencing `{{settings.webhookURL}}` variable. This variable will resolve to a Paragon-provided webhook URL that will capture events on behalf of your user.
* **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.

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 alt="" />
</Frame>

#### Option 2: Manual Setup

With Manual Setup, either you (the integration developer) or your customer (the connecting user) will manually register a Paragon-provided webhook URL with the integration.

* **For App-Level Triggers**: You must register the Webhook Target URL in the client application settings of the integration you are building in.
  * For example, Custom Webhooks for Zoom can be created by adding the Webhook Target URL to the Zoom Developer Portal under your app's registration. When a user connects Zoom via OAuth to your app, Zoom will start sending events for that user to the Webhook Target URL registered in your app.

* **For User-Level Triggers**: Your customers must register the user-specific Webhook Target URL in their account settings for the integration you are building in.
  * For example, Custom Webhooks for Gong can be created by prompting your customer to register [their user-specific Webhook Target URL](#user-specific-webhook-target-urls) in their Gong account settings.

**To set up and test Manual Setup:**

1. Copy the **Webhook Target URL** that appears in this step.

   <Info>
     For integrations that already have pre-built triggers, the Webhook Target URL is the same as the one you have already configured to listen for events.
   </Info>

2. Paste this URL into your client application settings (for App-Level Triggers) or test account settings (for User-Level Triggers) to register the webhook.

3. Click **Next** in the bottom navigation bar and test receiving events.

4. After verifying that events are received successfully, remove the `/test` path from the Webhook Target URL as configured in client application settings or test account settings.
   <br />
   <br />
   The `/test` path only routes events to the Workflow Editor / Custom Webhook Builder as test data and cannot trigger deployed workflows.

5. For User-Level Triggers: add a prompt in your app to provide users with their Webhook Target URL to register in their account settings for the integration. See [below](#user-specific-webhook-target-urls) for more details on building this URL.

<Frame>
  <img alt="" />
</Frame>

<p>**User-Specific Webhook Target URLs:**</p>

In a frontend app, you can use the [`paragon.getCustomWebhookUserManualUrl`](/apis/api-reference#getcustomwebhookusermanualurl) SDK function to build the user-specific Webhook Target URL:

```javascript JavaScript SDK theme={null}
// Present this value to your user to register this webhook in their account manually
const webhookUrl = paragon.getCustomWebhookUserManualUrl("<Workflow ID>");
```

* Pass the ID of any Workflow that uses this Custom Webhook to this function to get the URL.
* If you are using [Multi-Account Authorization](/apis/api-reference/multi-account-authorization), pass the specific `credentialId` of the integration account that should be used to receive events for this Custom Webhook as the second argument to the function.

Without using the SDK, you can also build this URL manually using the following format:

```yaml theme={null}
https://hermes.useparagon.com/triggers/connect/<Paragon Project ID>/<Integration UUID>/custom-triggers/<Custom Webhook UUID>?id=<Credential ID>

# For on-prem environments:
https://hermes.[On-Prem Base URL]/triggers/connect/<Paragon Project ID>/<Integration UUID>/custom-triggers/<Custom Webhook UUID>?id=<Credential ID>
```

The values for Project, Integration, and Custom Webhook IDs can all be copied directly from the Webhook Target URL value in Step 2 (make sure to remove the `/test` segment of the URL after verifying that you can receive test events).

The Credential ID is the ID of the integration account that the user connected as provided by the [`paragon.getUser` SDK function/API endpoint](/apis/api-reference#getuser) in the `credentialId` property.

#### Customizing the Webhook Response

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 alt="" />
</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 alt="" />
</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 alt="" />
</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>
  <Card title="ActiveCampaign" href="/resources/integrations/activecampaign" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/activecampaign.svg" />

  <Card title="Adobe Acrobat Sign" href="/resources/integrations/adobe-acrobat-sign" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/adobeAcrobatSign.svg" />

  <Card title="Adobe Commerce" href="/resources/integrations/adobecommerce" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/magento.svg" />

  <Card title="Adobe Experience Manager" href="/resources/integrations/adobe-experience-manager" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/adobeexperiencemanager.svg" />

  <Card title="ADP Workforce Now" href="/resources/integrations/adp-workforce-now" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/adpworkforcenow.svg" />

  <Card title="Airtable" href="/resources/integrations/airtable" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/airtable.svg" />

  <Card title="Amazon S3" href="/resources/integrations/amazon-s3" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/amazons3.svg" />

  <Card title="Amplitude" href="/resources/integrations/amplitude" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/amplitude.svg" />

  <Card title="Apollo.io" href="/resources/integrations/apollo-io" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/apolloio.svg" />

  <Card title="Asana" href="/resources/integrations/asana" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/asana.svg" />

  <Card title="Azure DevOps" href="/resources/integrations/azure-devops" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/azuredevops.svg" />

  <Card title="BambooHR" href="/resources/integrations/bamboohr" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/bamboohr.svg" />

  <Card title="BigQuery" href="/resources/integrations/bigquery" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/bigquery.svg" />

  <Card title="Box" href="/resources/integrations/box" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/box.svg" />

  <Card title="Calendly" href="/resources/integrations/calendly" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/calendly.svg" />

  <Card title="ClickUp" href="/resources/integrations/clickup" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/clickup.svg" />

  <Card title="Close" href="/resources/integrations/close" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/close.svg" />

  <Card title="Coda" href="/resources/integrations/coda" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/coda.svg" />

  <Card title="Confluence" href="/resources/integrations/confluence" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/confluence.svg" />

  <Card title="Contentful" href="/resources/integrations/contentful" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/contentful.svg" />

  <Card title="Copper" href="/resources/integrations/copper" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/copper.svg" />

  <Card title="DocuSign" href="/resources/integrations/docusign" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/docusign.svg" />

  <Card title="Dropbox" href="/resources/integrations/dropbox" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/dropbox.svg" />

  <Card title="Dropbox Sign" href="/resources/integrations/dropboxsign" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/dropboxsign.svg" />

  <Card title="Dynamics 365 Business Central" href="/resources/integrations/dynamicsbusinesscentral" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/dynamicsbusinesscentral.svg" />

  <Card title="Dynamics 365 Finance" href="/resources/integrations/dynamics-finance" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/dynamicsfinance.svg" />

  <Card title="Emarsys" href="/resources/integrations/emarsys" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/emarsys.svg" />

  <Card title="Facebook Ads" href="/resources/integrations/facebook-ads" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/facebookAds.svg" />

  <Card title="Facebook Pages" href="/resources/integrations/facebook-pages" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/facebookpages.svg" />

  <Card title="Figma" href="/resources/integrations/figma" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/figma.svg" />

  <Card title="Freshdesk" href="/resources/integrations/freshdesk" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/freshdesk.svg" />

  <Card title="Freshsales" href="/resources/integrations/freshsales" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/freshsales.svg" />

  <Card title="Front" href="/resources/integrations/front" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/front.svg" />

  <Card title="Gainsight" href="/resources/integrations/gainsight" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/gainsight.svg" />

  <Card title="GitHub" href="/resources/integrations/github" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/github.svg" />

  <Card title="Gmail" href="/resources/integrations/gmail" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/gmail.svg" />

  <Card title="Gong" href="/resources/integrations/gong" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/gong.svg" />

  <Card title="Google Ad Manager" href="/resources/integrations/google-ad-manager" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/googleadmanager.svg" />

  <Card title="Google Ads" href="/resources/integrations/googleads" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/googleads.svg" />

  <Card title="Google Analytics" href="/resources/integrations/google-analytics" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/googleanalytics.svg" />

  <Card title="Google Analytics GA4" href="/resources/integrations/googleanalyticsga4" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/googleanalytics.svg" />

  <Card title="Google Calendar" href="/resources/integrations/google-calendar" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/googleCalendar.svg" />

  <Card title="Google Campaign Manager 360" href="/resources/integrations/google-campaign-manager-360" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/googlecampaignmanager.svg" />

  <Card title="Google Docs" href="/resources/integrations/googledocs" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/googledocs.svg" />

  <Card title="Google Drive" href="/resources/integrations/google-drive" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/googledrive.svg" />

  <Card title="Google Search Console" href="/resources/integrations/google-search-console" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/googlesearchconsole.svg" />

  <Card title="Google Sheets" href="/resources/integrations/google-sheets" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/googlesheets.svg" />

  <Card title="Greenhouse" href="/resources/integrations/greenhouse" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/greenhouse.svg" />

  <Card title="Guru" href="/resources/integrations/guru" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/guru.svg" />

  <Card title="Gusto" href="/resources/integrations/gusto" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/gusto.svg" />

  <Card title="Heap" href="/resources/integrations/heap" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/heap.svg" />

  <Card title="Hive" href="/resources/integrations/hive" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/hive.svg" />

  <Card title="HubSpot" href="/resources/integrations/hubspot" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/hubspot.svg" />

  <Card title="iManage" href="/resources/integrations/imanage" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/imanage.svg" />

  <Card title="Insightly" href="/resources/integrations/insightly" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/insightly.svg" />

  <Card title="Intellum" href="/resources/integrations/intellum" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/intellum.svg" />

  <Card title="Intercom" href="/resources/integrations/intercom" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/intercom.svg" />

  <Card title="Jira" href="/resources/integrations/jira" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/jira.svg" />

  <Card title="Keap" href="/resources/integrations/keap" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/keap.svg" />

  <Card title="Klaviyo" href="/resources/integrations/klaviyo" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/klaviyo.svg" />

  <Card title="Lever" href="/resources/integrations/lever" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/lever.svg" />

  <Card title="Linear" href="/resources/integrations/linear" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/linear.svg" />

  <Card title="LinkedIn" href="/resources/integrations/linkedin" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/linkedin.svg" />

  <Card title="LinkedIn Marketing" href="/resources/integrations/linkedinmarketing" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/linkedinmarketing.svg" />

  <Card title="Mailchimp" href="/resources/integrations/mailchimp" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/mailchimp.svg" />

  <Card title="Marketo" href="/resources/integrations/marketo" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/marketo.svg" />

  <Card title="Microsoft Dynamics 365" href="/resources/integrations/microsoft-dynamics-365" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/microsoftDynamics.svg" />

  <Card title="Microsoft Excel" href="/resources/integrations/microsoftexcel" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/microsoftExcel.svg" />

  <Card title="Microsoft Outlook" href="/resources/integrations/outlook" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/outlook.svg" />

  <Card title="Microsoft Teams" href="/resources/integrations/microsoft-teams" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/microsoftTeams.svg" />

  <Card title="Miro" href="/resources/integrations/miro" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/miro.svg" />

  <Card title="Mixpanel" href="/resources/integrations/mixpanel" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/mixpanel.svg" />

  <Card title="Monday" href="/resources/integrations/monday" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/monday.svg" />

  <Card title="Netsuite" href="/resources/integrations/netsuite" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/netsuite.svg" />

  <Card title="Notion" href="/resources/integrations/notion" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/notion.svg" />

  <Card title="OneDrive" href="/resources/integrations/onedrive" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/onedrive.svg" />

  <Card title="OneNote" href="/resources/integrations/onenote" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/onenote.svg" />

  <Card title="OpenAI" href="/resources/integrations/openai" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/openai.svg" />

  <Card title="Eloqua" href="/resources/integrations/eloqua" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/eloqua.svg" />

  <Card title="Oracle Financials Cloud" href="/resources/integrations/oracle-financials-cloud" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/oraclefinancialscloud.svg" />

  <Card title="Outreach" href="/resources/integrations/outreach" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/outreach.svg" />

  <Card title="PagerDuty" href="/resources/integrations/pagerduty" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/pagerduty.svg" />

  <Card title="PandaDoc" href="/resources/integrations/pandadoc" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/pandadoc.svg" />

  <Card title="Pardot" href="/resources/integrations/pardot" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/pardot.svg" />

  <Card title="Pipedrive" href="/resources/integrations/pipedrive" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/pipedrive.svg" />

  <Card title="PowerBI" href="/resources/integrations/powerbi" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/powerbi.svg" />

  <Card title="Productboard" href="/resources/integrations/productboard" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/productboard.svg" />

  <Card title="QuickBooks" href="/resources/integrations/quickbooks" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/quickbooks.svg" />

  <Card title="Quip" href="/resources/integrations/quip" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/quip.svg" />

  <Card title="Ramp" href="/resources/integrations/ramp" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/ramp.svg" />

  <Card title="Sage Accounting" href="/resources/integrations/sage-accounting" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/sageaccounting.svg" />

  <Card title="Sage Intacct" href="/resources/integrations/sage-intacct" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/sageintacct.svg" />

  <Card title="Salesforce" href="/resources/integrations/salesforce" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/salesforce.svg" />

  <Card title="SalesLoft" href="/resources/integrations/salesloft" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/salesloft.svg" />

  <Card title="SAP S/4HANA" href="/resources/integrations/saps4hana" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/saps4hana.svg" />

  <Card title="SAP SuccessFactors" href="/resources/integrations/sapsuccessfactors" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/sapsuccessfactors.svg" />

  <Card title="Segment" href="/resources/integrations/segment" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/segment.svg" />

  <Card title="ServiceNow" href="/resources/integrations/servicenow" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/servicenow.svg" />

  <Card title="SharePoint" href="/resources/integrations/sharepoint" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/sharepoint.svg" />

  <Card title="Shopify" href="/resources/integrations/shopify" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/shopify.svg" />

  <Card title="Shortcut" href="/resources/integrations/shortcut" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/shortcut.svg" />

  <Card title="Slack" href="/resources/integrations/slack" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/slack.svg" />

  <Card title="Snowflake" href="/resources/integrations/snowflake" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/snowflake.svg" />

  <Card title="Stack Overflow Teams" href="/resources/integrations/stackoverflowteams" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/stackoverflowteams.svg" />

  <Card title="Stripe" href="/resources/integrations/stripe" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/stripe.svg" />

  <Card title="Tableau" href="/resources/integrations/tableau" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/tableau.svg" />

  <Card title="TikTok Ads" href="/resources/integrations/tiktokads" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/tiktokads.svg" />

  <Card title="Todoist" href="/resources/integrations/todoist" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/todoist.svg" />

  <Card title="Trello" href="/resources/integrations/trello" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/trello.svg" />

  <Card title="Typeform" href="/resources/integrations/typeform" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/typeform.svg" />

  <Card title="Unleashed" href="/resources/integrations/unleashed" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/unleashed.svg" />

  <Card title="Vanta" href="/resources/integrations/vanta" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/vanta.svg" />

  <Card title="Vimeo" href="/resources/integrations/vimeo" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/vimeo.svg" />

  <Card title="WhatsApp" href="/resources/integrations/whatsapp" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/whatsapp.svg" />

  <Card title="WooCommerce" href="/resources/integrations/woocommerce" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/woocommerce.svg" />

  <Card title="WordPress" href="/resources/integrations/wordpress" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/wordpress.svg" />

  <Card title="Workable" href="/resources/integrations/workable" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/workable.svg" />

  <Card title="Workday" href="/resources/integrations/workday" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/workday.svg" />

  <Card title="Xero" href="/resources/integrations/xero" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/xero.svg" />

  <Card title="Zendesk" href="/resources/integrations/zendesk" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/zendesk.svg" />

  <Card title="Zendesk Sell" href="/resources/integrations/zendesksell" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/zendesksell.svg" />

  <Card title="Zoho CRM" href="/resources/integrations/zohocrm" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/zohocrm.svg" />

  <Card title="Zoho People" href="/resources/integrations/zohopeople" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/zohopeople.svg" />

  <Card title="Zoom" href="/resources/integrations/zoom" icon="https://cdn.useparagon.com/latest/dashboard/public/integrations/zoom.svg" />
</CardGroup>


# ActiveCampaign
Source: https://docs.useparagon.com/resources/integrations/activecampaign

Connect to your users' ActiveCampaign accounts.

<IntegrationsCompatibility />

## Connecting to ActiveCampaign

Your users will need the following information to connect their ActiveCampaign account with your integration built 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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Adobe Experience Manager

Your users will need the following information to connect their Adobe Experience Manager account with your integration built with Paragon Connect:

* Domain
* [Technical Account Details](https://experience.adobe.com/#/cloud-manager/landing.html)

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 theme={null}
// 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.


# Adobe Commerce
Source: https://docs.useparagon.com/resources/integrations/adobecommerce

Connect to your users' Adobe Commerce accounts.

<IntegrationsCompatibility />

## Connecting to Adobe Commerce

Your users will need the following information to connect their Adobe Commerce Platform as a Service (PaaS) instance with your integration built with Paragon Connect:

* Adobe Commerce Store Domain
* Username
* Password

Your users must have admin access to the Adobe Commerce store to connect their account.

Once your users have connected their Adobe Commerce account, you can use the Paragon SDK to access the Adobe Commerce API on behalf of connected users.

<Warning>
  The full Adobe Commerce API is accessible through the Paragon SDK by referencing the `magento` integration type in your request.
</Warning>

See the Adobe Commerce [REST API documentation](https://developer.adobe.com/commerce/webapi/rest) for their full API reference.

Any Adobe Commerce API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript theme={null}
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// Fetch all products
// Use the `magento` integration type to access the full Adobe Commerce API.
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 Adobe Commerce workflows

Once your Adobe Commerce 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 [Adobe Commerce Request](/workflows/requests#making-integration-requests) step to access any of Adobe Commerce's API endpoints without the authentication piece.

When creating or updating records in Adobe Commerce, 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Amazon S3

Your users will need the following information to connect their Amazon S3 account with your integration built with Paragon Connect:

* API Key

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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Amplitude

Your users will need the following information to connect their Amplitude account with your integration built with Paragon Connect:

* Amplitude API Key -- [Found in Amplitude Organization Settings](https://amplitude.com/docs/apis/authentication)

<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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
    </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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 alt="" />
</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>

<Frame>
  <img alt="" />
</Frame>

## 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 theme={null}
// 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 alt="" />
</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 alt="" />
</Frame>


# Azure DevOps
Source: https://docs.useparagon.com/resources/integrations/azure-devops

Connect to your users' Azure DevOps accounts.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 processes 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
// 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

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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 Box File Picker provided by 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 theme={null}
let picker = new paragon.ExternalFilePicker("box", {
    onFileSelect: (files) => {
        // Handle file selection
    },

    // Optional settings:
    integrationOptions: {
        box: {
            // If true, renders the Box picker UI inside an iframe to isolate
            // its styles from your application. Use this option if you experience
            // style conflicts between the Box picker and your app's CSS.
            scopeCSS: true
        }
    }
});

// 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 theme={null}
  await paragon.request('box', '/files/1917222621209/content', {
  	method: 'GET'
  });
  ```

  ```plain REST API theme={null}
  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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Close

Your users will need the following information to connect their Close account with your integration built with Paragon Connect:

* Close API Key

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 theme={null}
// 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 alt="" />
</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.

<IntegrationsCompatibility />

## Connecting to Coda

Your users will need the following information to connect their Coda account with your integration built with Paragon Connect:

* Coda API Token

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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", "/api/v2/pages", {
  method: "GET"
});

// Create a Page
paragon.request("confluence", "/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.


# Contentful
Source: https://docs.useparagon.com/resources/integrations/contentful

Connect to your users' Contentful accounts.

<IntegrationsCompatibility />

## Connecting to Contentful

Your users will need the following information to connect their Contentful account with your integration built with Paragon Connect:

* Content Management API Token

Connecting users can create a Content Management API Token under **Settings > CMA tokens** in Contentful.

<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>

Once your users have connected their Contentful account, you can use the Paragon SDK to access the Contentful Content Management API on behalf of connected users.

See the Contentful [Content Management API reference](https://www.contentful.com/developers/docs/references/content-management-api/) for their full API documentation.

Any Content Management API endpoints can be accessed with the Paragon SDK as shown in this example.

```typescript theme={null}
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// List entries in a space
await paragon.request("contentful", "spaces/<space_id>/entries", {
  method: "GET"
});

// Get a single entry
await paragon.request("contentful", "spaces/<space_id>/entries/<entry_id>", {
  method: "GET"
});
```

## Building Contentful workflows

Once your Contentful account is connected, you use the [Contentful Request](/workflows/requests#making-integration-requests) step to access any of Contentful's Content Management API endpoints without the authentication piece.

When creating or updating records in Contentful, 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.

<IntegrationsCompatibility />

## Connecting to Copper

Your users will need the following information to connect their Copper account with your integration built 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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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 alt="" />
</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.

<IntegrationsCompatibility />

## 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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 campaign
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 alt="" />
</Frame>


# Emarsys
Source: https://docs.useparagon.com/resources/integrations/emarsys

Connect to your users' Emarsys accounts.

<IntegrationsCompatibility />

## Connecting to Emarsys

Your users will need the following information to connect their Emarsys account with your integration built 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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</Frame>


# Facebook Pages
Source: https://docs.useparagon.com/resources/integrations/facebook-pages

Connect to your users' Facebook Pages accounts.

<IntegrationsCompatibility />

## 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 alt="" />
</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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Freshdesk

Your users will need the following information to connect their Freshdesk account with your integration built with Paragon Connect:

* Freshdesk Domain
* API Key

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 theme={null}
// 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.

<IntegrationsCompatibility />

## Setup Guide

### 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.

<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 Freshsales

Your users will need the following information to connect their Freshsales account with your integration built with Paragon Connect:

* Domain
* API Key

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Gainsight

Your users will need the following information to connect their Gainsight account with your integration built with Paragon Connect:

* Access Key
* Instance URL

Users can find their Gainsight API credentials in their [Gainsight account, described here](https://support.gainsight.com/Gainsight_NXT/Connectors/Connectors/API_Integrations/Generate_API_Access_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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## Setup Guide

You will need to create a new GitHub developer application if you don't already have one. Connect either a GitHub App or a GitHub OAuth Application to Paragon Connect.

You can find your GitHub app credentials in your [GitHub Developer Settings.](https://github.com/settings/developers)

You'll need the following information to set up your GitHub App or GitHub OAuth App with Paragon Connect:

* Client ID
* Client Secret

#### GitHub Apps versus GitHub OAuth Applications

[GitHub Apps](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps) are generally preferred over [OAuth apps](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) due to their improved security and scalability. They support fine-grained permissions and allow users to limit access to specific repositories. GitHub Apps can operate on behalf of a user or independently of a user, making them suitable for integrations that should continue functioning even if the original installer leaves an organization.
They also provide a centralized webhook configuration across all accessible repositories and organizations, and benefit from higher, scalable rate limits tied to repository and user counts.

OAuth apps have lower, non-scaling rate limits and use per-repository webhook configuration. An OAuth app is recommended when access to enterprise-level resources is required, or when using [Custom Webhooks](/resources/custom-webhooks), which relies on per-repository or per-organization webhook setup. See [Configuring Webhook Triggers for OAuth Applications](/resources/integrations/github#configuring-triggers-for-an-oauth-application).

**Paragon supports both GitHub Apps and OAuth apps** across the platform. Learn more about the differences between GitHub Apps and OAuth apps [here](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps).

### 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.

5. Under **General > Authorization callback URL**, paste the Redirect URL provided in Step 1.

<Frame>
  <img alt="" />
</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 alt="" />
</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 theme={null}
// 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
* Get Pull Request by Number
* Get Files Changed in PR
* Create Release
* Update Release
* Get Release by ID
* Get Release by Tag Name
* Delete Release
* Get File

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.

### Selecting the appropriate Trigger type

Paragon can receive GitHub events in two different ways. Which one you use depends on the [**type of GitHub integration**](#github-apps-versus-github-oauth-applications) you're building. We'll walk through configuring triggers for **GitHub Apps** and **OAuth Applications** below.

#### Configuring a GitHub App Trigger

All of your users' GitHub events are sent to a single **Webhook URL configured in your GitHub App registration**. Follow the steps below to configure a GitHub App Trigger to use with Paragon.

<Steps>
  <Step title="Add the Webhook URL to your GitHub App">
    Paragon provides a dedicated Webhook URL for your project which can be copied from the integration's settings in Paragon and pasted into the **"Webhook URL"** field in the GitHub App settings.

    <Frame>
      <img alt="GitHub App Webhook URL" />
    </Frame>
  </Step>

  <Step title="(Optional) Add a Webhook Secret to your GitHub App">
    You have the option to specify a Webhook Secret in your GitHub App settings used to verify the authenticity of event data. Author the secret in GitHub and enter the value in the **"Webhook Secret"** field in your Paragon integration's settings.

    <Frame>
      <img alt="GitHub Integration Settings" />
    </Frame>
  </Step>

  <Step title="Select the appropriate Trigger type">
    In your Paragon workflow, choose the corresponding Trigger Event (or configure your own [Custom Webhook](/resources/custom-webhooks)) and select the **"GitHub App"** trigger type.

    <Frame>
      <img alt="GitHub Workflow Settings" />
    </Frame>
  </Step>
</Steps>

#### Configuring Triggers for an OAuth Application

For OAuth Applications in GitHub, Paragon leverages the connected user's OAuth token to manage webhook subscriptions via the GitHub API. This allows Paragon to programmatically create, update, or remove webhook endpoints at the organization or repository level based on the connected user's permissions and the trigger's configuration.

Ensure that the necessary scopes are requested in your GitHub App settings (`repo` for repository hooks or `admin:org_hook` for organization-wide hooks) to set up these subscriptions.

Then in your Paragon workflow, choose the corresponding Trigger Event or configure your own [Custom Webhook](/resources/custom-webhooks), and select either the **"Repository"** or **"Organization"** trigger type.

<Frame>
  <img alt="GitHub Workflow Settings" />
</Frame>

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**

For additional webhook triggers, you can configure webhooks for *any* GitHub webhook event using [Custom Webhooks](/resources/custom-webhooks).


# Gmail
Source: https://docs.useparagon.com/resources/integrations/gmail

Connect to your users' Gmail accounts.

<IntegrationsCompatibility />

## 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 processes 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</Frame>

You can find the full list of Webhook Triggers for Gmail below:

* **Thread Created**
* **Thread Updated**
* **Thread Modified**

## User-Configured OAuth

&#x20;supports [User-Configured OAuth](/resources/user-configured-oauth), which lets your end users connect their own OAuth app instead of the one you've configured for your Paragon integration. This is useful when your customers want to use their own OAuth app for security or scope customization.

To enable this, pass `"user-configured-oauth"` as one of the values in the `accountType` array when launching the install flow:

```js theme={null}
// Allow user-configured OAuth as an option (defaults to hidden)
paragon.installIntegration("gmail", {
  accountType: paragon
    .getAccountTypeOptions("gmail")
    .map((option) => option.id),
});

// Only allow user-configured OAuth accounts to connect
paragon.installIntegration("gmail", {
  accountType: ["user-configured-oauth"],
});
```

See the [User-Configured OAuth reference](/resources/user-configured-oauth) for full details on how it works and what your users will be prompted for.

## 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 theme={null}
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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 processes 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 theme={null}
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.

<IntegrationsCompatibility />

## 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 processes 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 theme={null}
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.

<IntegrationsCompatibility />

## 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 processes 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</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 alt="" />
</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 theme={null}
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.

<IntegrationsCompatibility />

## 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 processes 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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/v5) 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 theme={null}
// 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 theme={null}
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.

<IntegrationsCompatibility />

## 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 processes 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</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 Google Drive File Picker provided by the Paragon SDK.

<Frame>
  <img alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
let picker = new paragon.ExternalFilePicker("googledrive", {
    onFileSelect: (files) => {
        // Handle file selection
    },

    // Optional settings:
    integrationOptions: {
        googledrive: {
            // If true, a tab in the Picker appears for browsing Shared Drives
            enableSharedDrives: true,

            // If true, the full folder hierarchy appears in the Picker. Otherwise,
            // all files will appear as a flat list. Defaults to `false`.
            includeFolders: false

            // Set the display mode of the Picker as a thumbnail grid or list of file titles.
            // Defaults to "grid". Thumbnail grid requires either `https://www.googleapis.com/auth/drive` or
            // `https://www.googleapis.com/auth/drive.readonly` scope to appear correctly.
            viewMode: "grid" || "list",
        }
    }
});

// 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 theme={null}
  // 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 theme={null}
  // 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 theme={null}
  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 title="[Tutorial] Implementing the Google Redirect Page install flow with Paragon" />
</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 theme={null}
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.

<IntegrationsCompatibility />

## 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 processes 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</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 theme={null}
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.

<IntegrationsCompatibility />

## 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 processes 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</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 theme={null}
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.

<IntegrationsCompatibility />

## 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 processes 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 theme={null}
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.

<IntegrationsCompatibility />

## 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 processes 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 need for your application. The available scopes represent different access levels — choose only the ones that match your use case:
  * **Read-Only** (`analytics.readonly`) – Read-only access to Google Analytics data.
  * **Full-Access** (`analytics`) – Full access to Google Analytics data.
  * **Edit-Access** (`analytics.edit`) – Edit access to Google Analytics data.

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 alt="" />
</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 theme={null}
// 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 theme={null}
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.

<IntegrationsCompatibility />

## 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 processes 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 theme={null}
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.

<IntegrationsCompatibility />

## Connecting to Greenhouse

Your users will need the following information to connect their Greenhouse account with your integration built with Paragon Connect:

* Greenhouse API Key

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 theme={null}
// 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 alt="" />
</Frame>

You can find the full list of Webhook Triggers for Greenhouse below:

* **Candidate Created**
* **Candidate Updated**
* **Job Created**
* **Job Updated**


# Guru
Source: https://docs.useparagon.com/resources/integrations/guru

Connect to your users' Guru accounts.

<IntegrationsCompatibility />

## Connecting to Guru

When connecting their Guru account through Paragon Connect, your users pick one of two authentication methods:

* **Guru User Token** - Uses the user's Guru username and API Token to authenticate.
* **Guru Collection Token** - Uses a Guru Collection ID and Collection Token to authenticate.

Paragon prompts for the credentials that match the option they choose.

<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>

Once your users have connected their Guru account, you can use the Paragon SDK to access the Guru API on behalf of connected users.

See the Guru [Developer Network](https://developer.getguru.com/docs) for their full API reference.

Any Guru API endpoints can be accessed with the Paragon SDK as shown in this example.

```typescript theme={null}
// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);
            
// List teams
await paragon.request("guru", "teams", {
  method: "GET"
});

// Get a card with extended metadata
await paragon.request("guru", "cards/<id>/extended", {
  method: "GET"
});

// Search cards
await paragon.request("guru", "search/query?searchTerms=<terms>&maxResults=10", {
  method: "GET"
});
  
```

## Building Guru workflows

Once your Guru account is connected, you use the [Guru Request](/workflows/requests#making-integration-requests) step to access any of Guru's API endpoints without the authentication piece.

When creating or updating records in Guru, you can reference data from previous steps by typing `{{` to invoke the variable menu.


# Gusto
Source: https://docs.useparagon.com/resources/integrations/gusto

Connect to your users' Gusto accounts.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Hive

Your users will need the following information to connect their Hive account with your integration built 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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## Setup Guide

This guide walks you through creating a HubSpot App for testing and development purposes.

Once you have finished your integration and are ready to publish in the HubSpot Marketplace for public distribution, jump to [Publishing your HubSpot App](#publishing-your-hubspot-app).

### Prerequisites

* [Register a HubSpot developer account](https://developers.hubspot.com/) to associate your app with and to create test accounts.
* Install and authenticate the [HubSpot CLI](https://developers.hubspot.com/docs/getting-started/quickstart).

  If you don't already have the HubSpot CLI, install it with the following command (requires [Node.js](https://nodejs.org/)):

  ```bash Install the HubSpot CLI theme={null}
  npm install -g @hubspot/cli
  ```

  After installation, authenticate your developer account:

  ```bash Connect the CLI to your HubSpot account theme={null}
  hs account auth
  ```

### Creating a HubSpot Project

A HubSpot **project** is a local package of configuration files defining features of your app like requested OAuth scopes, allowed redirect URLs, and webhooks.

You will need to create and upload a project to generate an OAuth Client ID and Secret that we can reference in Paragon.

<Steps>
  <Step title="Create a project">
    Start by creating a project with the CLI using the following command:

    ```bash theme={null}
    hs project create \
      --project-base app \
      --distribution marketplace \
      --auth oauth \
      --features webhooks
    ```

    <Tip>
      We recommend (but do not require) checking this project into version control.
    </Tip>

    You will be prompted to choose a name and destination for the project.
  </Step>

  <Step title="Configure scopes and redirect URL">
    Open `src/app/app-hsmeta.json` to update your redirect URLs and scopes:

    ```diff Add Paragon URL theme={null}
    "redirectUrls": [
    - "http://localhost:3000"
    + "http://localhost:3000",
    + "https://passport.useparagon.com/oauth"
    ],
    ```

    ```json Paragon default scopes theme={null}
    "requiredScopes": [
      "oauth",
      "crm.lists.read",
      "crm.lists.write",
      "crm.objects.companies.read",
      "crm.objects.companies.write",
      "crm.objects.contacts.read",
      "crm.objects.contacts.write",
      "crm.objects.custom.read",
      "crm.objects.custom.write",
      "crm.objects.deals.read",
      "crm.objects.deals.write",
      "crm.objects.owners.read",
      "crm.schemas.companies.read",
      "crm.schemas.contacts.read",
      "crm.schemas.custom.read",
      "crm.schemas.deals.read",
      "e-commerce",
      "tickets"
    ],
    ```

    You can adjust the `requiredScopes` or `optionalScopes` to your use case; the only scope **required** for Paragon is the `oauth` scope.

    Learn more about available HubSpot scopes in [their documentation](https://developers.hubspot.com/docs/apps/developer-platform/build-apps/authentication/scopes).
  </Step>

  <Step title="Configure webhooks">
    <Tip>
      If your HubSpot integration does not require webhooks or listening for data changes in Workflows or Triggers, you can skip this step.
    </Tip>

    Paragon provides a webhook Target URL to subscribe your HubSpot app to events in your users' HubSpot instances. Copy this URL from the Settings tab of your HubSpot integration in Paragon:

    <Frame>
      <img alt="" />
    </Frame>

    Then, open `src/app/webhooks/webhooks-hsmeta.json` and add the URL:

    ```diff Update targetUrl in webhooks-hsmeta.json theme={null}
    "settings": {
    - "targetUrl": "https://example.com/webhook",
    + "targetUrl": "https://hermes.useparagon.com/webhook/triggers/...",
      "maxConcurrentRequests": 10
    },
    ```

    Update `subscriptions` with any specific events that you will subscribe to via Workflows or Triggers. See [HubSpot's webhooks documentation](https://developers.hubspot.com/docs/api-reference/latest/webhooks/guide) for available subscription types.

    For details on configuring the `webhooks-hsmeta.json` file, see [HubSpot's project structure documentation for webhooks](https://developers.hubspot.com/docs/apps/developer-platform/add-features/configure-webhooks#project-structure).
  </Step>

  <Step title="Upload your project">
    Upload your HubSpot project to your developer account by saving all changes to project files and running the following command from within the project directory:

    ```bash theme={null}
    hs project upload
    ```

    <Tip>
      Whenever your integration's HubSpot features change (e.g. different scopes or webhooks), you will need to repeat this step to publish a new version of your HubSpot project.
    </Tip>

    After it has succeeded, open the project in the developer account:

    ```bash theme={null}
    hs project open
    ```
  </Step>

  <Step title="Save your OAuth Client ID and Secret">
    In the HubSpot developer account from the project view, click your app's name under Project Components and navigate to **Auth**.

    <Frame>
      <img alt="HubSpot projects view" />
    </Frame>

    Copy the Client ID and Client Secret values from HubSpot and navigate to **Integrations > HubSpot > Configure** in the Paragon dashboard to save your OAuth App credentials.

    <Frame>
      <img alt="Enter HubSpot scopes in Paragon dashboard" />
    </Frame>

    Verify that the list of requested scopes in the **App Configuration** section of Paragon exactly matches the listed scopes in your HubSpot project.
  </Step>
</Steps>

### Setup for Legacy Apps

If you are not yet using HubSpot's project-based framework, follow the below directions to configure your Legacy App in Paragon.

<Accordion title="Configuring HubSpot Legacy Apps">
  ### 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. In **Legacy Apps**, select the app you'd like to use in Paragon.

  4. Under **Auth > Auth settings > Redirect URL**, paste in Paragon Connect's redirect URL found in Step 1.

  <Frame>
    <img alt="" />
  </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 alt="" />
  </Frame>

  ### Add your HubSpot app to Paragon

  Under **Integrations > HubSpot > App Configuration**, 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 alt="" />
  </Frame>
</Accordion>

## 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 theme={null}
// 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 Webhooks to your HubSpot App

Using HubSpot triggers requires you to add webhooks as a feature to your HubSpot App.

To add webhooks to your HubSpot App, follow [Setup > Steps 3 and 4](#:~:text=3-,Configure%20webhooks,-If%20your%20HubSpot) to register Paragon's webhook URL with HubSpot and subscribe to the event types you are listening for.

### Webhooks for Legacy Apps

If you are not yet using HubSpot's project-based framework, follow the instructions below to register Paragon's Target URL in your Legacy App.

<Accordion title="Configuring webhooks for HubSpot Legacy Apps">
  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 alt="" />
  </Frame>

  2. Log in to your [HubSpot developer dashboard](https://developers.hubspot.com/), select your HubSpot developer account, and open your app under **Legacy 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 alt="" />
  </Frame>

  You are now able to **Create subscriptions** against the events you want to subscribe to within HubSpot.
</Accordion>

## Publishing your HubSpot App

<Info>
  **Required for publishing:** In order to list your app on the HubSpot Marketplace, you must implement the following additional features in your integration:

  * [Setting up Redirect Pages](#setting-up-redirect-pages-in-your-app)

  For more information, see [HubSpot's documentation on publishing requirements](https://developers.hubspot.com/docs/apps/developer-platform/list-apps/listing-your-app/app-marketplace-listing-requirements).
</Info>

### Setting up Redirect Pages in your app

Your HubSpot App requires a Redirect Page hosted in **your application** to support an installation flow that begins in the HubSpot Marketplace (i.e., a user searches the HubSpot Marketplace for your app and clicks **Install**).

<Tip>
  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/hubspot.js).
</Tip>

The Redirect Page should be implemented as follows:

* **Allow `X-Frame-Options` for `hubspot.com`.**
  * During the installation process, HubSpot will load your Redirect Page URL in a hidden `iframe` to complete the OAuth exchange.
  * If this is not possible, you will need to use the partner sign-in flow option described [here](https://developers.hubspot.com/docs/apps/developer-platform/list-apps/understand-app-install-flow#understand-the-install-flow-with-partner-sign-in). This will first redirect users to your app directly to begin an installation request (Initial Redirect), rather than using an `iframe` to complete the installation flow.

* **Import the Paragon SDK and authenticate a user.**

  * If the user is not yet logged into your app, we suggest that you redirect to a login form, while preserving the intended URL to redirect to upon successful login. After logging in, your user should see your Redirect Page.

* **Accept and read query parameters**, which will be:

  * `code`: The temporary authorization code to pass to Paragon for completing the OAuth exchange.
  * `returnUrl`: The URL to redirect to after completing the OAuth exchange.

* **Call `paragon.completeInstall` to complete the OAuth exchange** and save a new connected HubSpot account.

  ```javascript Complete the OAuth exchange theme={null}
  const params = new URLSearchParams(window.location.search);

  paragon.completeInstall("hubspot", {
    authorizationCode: params.get("code"),
    redirectUrl: "https://your-app.url/hubspot-redirect-page-path"
  }).then(() => {
    window.location = params.get("returnUrl");
  });
  ```

### Configuring your Redirect Page in your HubSpot App

First, add your production Redirect Page URL to your HubSpot App configuration by modifying your project's `app-hsmeta.json` to include it as an authorized redirect URL:

```diff Add Redirect Page URL theme={null}
"redirectUrls": [
  "http://localhost:3000",
- "https://passport.useparagon.com/oauth"
+ "https://passport.useparagon.com/oauth",
+ "https://your-app.url/hubspot-redirect-page-path"
],
```

Make sure to publish your changes by uploading a new version of the project:

```bash Update HubSpot App theme={null}
hs project upload
```

Next, if you have not already, create an App Listing for your HubSpot Project by navigating to **App Listings** in your HubSpot developer account.

Once viewing your App Listing draft:

* In **Listing Info > Information**, select your Redirect Page URL as the **Install button URL** (you can use a `localhost` URL while testing a draft).
* For **Sign-in configuration**, select "No partner login required, HubSpot OAuth only".

<Frame>
  <img alt="App Listing draft" />
</Frame>

You can test your install flow by clicking **Preview** in the App Listing draft and clicking **Install** in your preview App Listing page.

If your installation succeeds, your Redirect Page is configured correctly!


# iManage
Source: https://docs.useparagon.com/resources/integrations/imanage

Connect to your users' iManage accounts.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Insightly

Your users will need the following information to connect their Insightly account with your integration built 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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</Frame>

6. In the **Permissions** section, tick the boxes for the API permissions your use case will require.

<Info>
  **Note:** Paragon requires the `Read admins` permission for your developer app to successfully connect to user accounts
</Info>

### 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 alt="" />
</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 theme={null}
// 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 alt="" />
</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 alt="" />
</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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</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 alt="" />
</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>

## User-Configured OAuth

&#x20;supports [User-Configured OAuth](/resources/user-configured-oauth), which lets your end users connect their own OAuth app instead of the one you've configured for your Paragon integration. This is useful when your customers want to use their own OAuth app for security or scope customization.

To enable this, pass `"user-configured-oauth"` as one of the values in the `accountType` array when launching the install flow:

```js theme={null}
// Allow user-configured OAuth as an option (defaults to hidden)
paragon.installIntegration("jira", {
  accountType: paragon
    .getAccountTypeOptions("jira")
    .map((option) => option.id),
});

// Only allow user-configured OAuth accounts to connect
paragon.installIntegration("jira", {
  accountType: ["user-configured-oauth"],
});
```

See the [User-Configured OAuth reference](/resources/user-configured-oauth) for full details on how it works and what your users will be prompted for.


# Keap
Source: https://docs.useparagon.com/resources/integrations/keap

Connect to your users' Keap accounts.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Prerequisites

* A Klaviyo Account. You can create a test account [here](https://www.klaviyo.com/).

## Connecting to Klaviyo

Your users will need the following information to connect their Klaviyo account with your integration built with Paragon Connect:

* Klaviyo Private API Key

Users can find their Klaviyo API Keys by visiting the API Keys section of their [Klaviyo Account dashboard](https://www.klaviyo.com/account#api-keys-tab).

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 theme={null}
// 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 alt="" />
</Frame>


# Lever
Source: https://docs.useparagon.com/resources/integrations/lever

Connect to your users' Lever accounts.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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 alt="" />
</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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<Note>
  **Note:** For user-level webhook triggers, the `admin` scope is required in your Paragon App Configuration settings.
</Note>

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.

<IntegrationsCompatibility />

## 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 alt="Connecting your LinkedIn app to Paragon Connect" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.


# Mailchimp
Source: https://docs.useparagon.com/resources/integrations/mailchimp

Connect to your users' Mailchimp accounts.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Prerequisites

* A Marketo Account. You can create a test account [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 the integration.

Users can find their Marketo application credentials by visiting LaunchPoint in the Admin section of their [Marketo Dashboard](https://www.marketo.com/).

* **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 alt="" />
</Frame>

## Connecting to Marketo

Your users will need the following information to connect their Marketo account with your integration built with Paragon Connect:

* Client ID
* Client Secret
* Endpoint URL
* Identity URL

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 theme={null}
// 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 alt="" />
</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 alt="" />
</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.

<IntegrationsCompatibility />

## 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 theme={null}
// 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 alt="" />
</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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" /> *In Azure Portal > App Registrations:* <img alt="" />

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 alt="" />
  </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 alt="" />
</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 theme={null}
// 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
* List Messages in a Chat

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 alt="" />
</Frame>

## Specifying bot tokens with Connect Proxy Requests

When using the [Proxy API](/apis/proxy) with Microsoft Teams, you can control whether requests are made using a **user token** or a **bot token** by including the following header:

```
x-paragon-use-ms-teams-token-type: bot
```

<Info>
  **Note:** The base URL for Microsoft Teams API requests differs depending on the token type being used:

  * **User token** → `https://graph.microsoft.com/v1.0`
  * **Bot token** → `https://smba.trafficmanager.net/`
</Info>

## 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 alt="" />
</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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Mixpanel

Your users will need the following information to connect their Mixpanel account with your integration built 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.

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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Monday.com

Your users will need the following information to connect their Monday.com account with your integration built with Paragon Connect:

* 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**.

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 theme={null}
// 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 alt="" />
</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.

<IntegrationsCompatibility />

## 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.

* **Token-Based Authentication –** your connecting users are required to create a NetSuite role with the required permissions and assign it to a user. **This method is required for using NetSuite with [Managed Sync](/managed-sync/integrations/netsuite).**

#### 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.         |
| Token-Based Authentication                | No limit                                      | Medium effort. Required to create a NetSuite role with the required permissions and assign it to a user. |

### 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 title="YouTube video player" />
</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 supports certificates generated with either RSA or EC (Elliptic Curve) private keys. This will create two files, a `public.pem` and a `private.pem`.

   **RSA (PS256):**

   ```sh theme={null}
   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
   ```

   **EC — choose one of the [NetSuite-supported curves](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_162790605110.html):**

   | Curve        | JWT algorithm | OpenSSL command                                                                                                                      |
   | ------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
   | `prime256v1` | `ES256`       | `openssl req -new -x509 -newkey ec:<(openssl ecparam -name prime256v1) -keyout private.pem -sha256 -out public.pem -nodes -days 730` |
   | `secp384r1`  | `ES384`       | `openssl req -new -x509 -newkey ec:<(openssl ecparam -name secp384r1) -keyout private.pem -sha384 -out public.pem -nodes -days 730`  |
   | `secp521r1`  | `ES512`       | `openssl req -new -x509 -newkey ec:<(openssl ecparam -name secp521r1) -keyout private.pem -sha512 -out public.pem -nodes -days 730`  |

   Paragon automatically detects the key type and curve of the uploaded `private.pem` and signs the JWT with the matching algorithm (`PS256`, `ES256`, `ES384`, or `ES512`).

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 alt="" />
</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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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 alt="" />
</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 OneDrive File Picker provided by 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 theme={null}
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 theme={null}
  await paragon.request('onedrive', '/me/drive/items/<fileId>/content', {
  	method: 'GET'
  });
  ```

  ```bash REST API theme={null}
  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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to OpenAI

Your users will need the following information to connect their OpenAI account with your integration built 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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Oracle Financials Cloud

Your users will need the following information to connect their Oracle Financials Cloud account with your integration built with Paragon Connect:

* App Name
* Scopes Requested

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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
* Get Message by ID

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 alt="" />
</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 alt="" />
</Frame>

You can find the full list of Webhook Triggers for Microsoft Outlook below:

* **Event Created**
* **Event Updated**
* **Event Removed**
* **New Message**

## User-Configured OAuth

&#x20;supports [User-Configured OAuth](/resources/user-configured-oauth), which lets your end users connect their own OAuth app instead of the one you've configured for your Paragon integration. This is useful when your customers want to use their own OAuth app for security or scope customization.

To enable this, pass `"user-configured-oauth"` as one of the values in the `accountType` array when launching the install flow:

```js theme={null}
// Allow user-configured OAuth as an option (defaults to hidden)
paragon.installIntegration("outlook", {
  accountType: paragon
    .getAccountTypeOptions("outlook")
    .map((option) => option.id),
});

// Only allow user-configured OAuth accounts to connect
paragon.installIntegration("outlook", {
  accountType: ["user-configured-oauth"],
});
```

See the [User-Configured OAuth reference](/resources/user-configured-oauth) for full details on how it works and what your users will be prompted for.


# Outreach
Source: https://docs.useparagon.com/resources/integrations/outreach

Connect to your users' Outreach accounts.

<IntegrationsCompatibility />

## 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.

<Frame>
  <img alt="" />
</Frame>

## 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 theme={null}
// 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 alt="" />
</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 alt="" />
</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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to PandaDoc

Your users will need the following information to connect their PandaDoc account with your integration built with Paragon Connect:

* PandaDoc API Key

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</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 theme={null}
 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

<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>

## Connecting to Productboard

Your users will need the following information to connect their Productboard account with your integration built with Paragon Connect:

* Productboard API Key

### Getting a 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.

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</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 alt="" />
</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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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**


# Salesforce
Source: https://docs.useparagon.com/resources/integrations/salesforce

Connect to your users' Salesforce accounts.

<IntegrationsCompatibility />

## Setup Guide

This guide walks you through creating a Salesforce External Client App (ECA) and packaging it as a Second-Generation Managed Package (2GP) for distribution to your users.

<Info>
  If you are currently using a Connected App, see [Migrating from a Connected App](#migrating-from-a-connected-app-to-an-external-client-app) for instructions on adapting to Salesforce's packaging requirements enforced starting in September 2025.
</Info>

### Setting Up Your Salesforce Environment

Before creating your app, you'll need to set up the required Salesforce orgs and enable packaging features.

* **Partner Business Org** (PBO, also referred to as the Dev Hub Org): This is a Salesforce org that is created when you sign up as a Salesforce Partner.
  * You will use this org to create your External Client App, link your Namespace, and publish your Package.
* **Developer Edition Org** (also called a Partner Developer Edition / PDE org if created from the Partner Business Org): This is a Salesforce org for development / testing purposes created from the Salesforce Developer Edition signup or the Environment Hub of your Partner Business Org.
  * You will use this org to create your Namespace only.

<Info>
  **Already have a Partner Business Org with Dev Hub enabled?** Skip to [Creating an External Client App](#creating-an-external-client-app).
</Info>

#### 1. Create a Partner Business Org

[Sign up](https://partners.salesforce.com/pdx/s/trial-org-request?language=en_US) for a trial Partner Business Org.

Within a few minutes of signing up, you will receive an email to set your Salesforce login (note that this is separate from the Partner Community page at `partners.salesforce.com`).

<Warning>
  **Note that the trial is temporary and subject to expiration.**

  While you can test your app end-to-end with the trial Partner Business Org, you can request an active Partner Business Org by logging a case via the Salesforce Partner Community (more information [here](https://help.salesforce.com/s/articleView?id=000380510\&type=1#:~:text=a%20Trial%20PBO.-,How%20to%20request%20a%20PBO%20benefit%3F,-Pre%2Drequisites%3A)). You will first need to enroll in the [AppExchange ISV program](https://www.salesforce.com/en-us/wp-content/uploads/sites/4/documents/partners/readiness/appexchange_isv_onboarding_guide.pdf), which can be done via the Partner Community.
</Warning>

#### 2. Enable Dev Hub and Second-Generation Packaging

In your Partner Business Org:

* Go to **Setup** and search for **Dev Hub** in the Quick Find box.
* Enable the following settings:
  * Enable **Dev Hub**
  * Enable **Unlocked Packages and Second-Generation Managed Packages**
  <Frame>
    <img alt="" />
  </Frame>

<sub>For more details, see [Salesforce's Dev Hub documentation](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/sfdx_pkg_enable_devhub.htm).</sub>

#### 3. Create and Link a Namespace

Namespaces uniquely identify your package components in Salesforce. You'll create the namespace in a Developer Edition Org, then link it to your Partner Business Org.

<Steps>
  <Step title="Create a Developer Edition Org">
    If you don't already have a Developer Edition Org, you can create one from your Partner Business Org:

    1. Open the App Launcher and search for **Environment Hub**.
    2. From the Environment Hub, click **Create Org** and set the following details:
       * **Purpose**: Development
       * **Edition**: Partner Developer

    After creating the org, it will take a few minutes to receive your new login details. Your Developer Edition Org will use a separate domain name from your Partner Business Org.

    <Tip>
      We recommend using separate browser profiles for your Partner Business Org and Developer Edition Org to avoid confusion during setup.
    </Tip>
  </Step>

  <Step title="Create a Namespace">
    **In your Developer Edition Org**:

    1. Go to **Setup > Apps > Packaging > Package Manager**.
    2. Click **Edit** next to the Namespace Prefix field.
    3. Enter your desired namespace and click **Check Availability**, then **Review**.
    4. Click **Save**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step title="Link the Namespace to Your Dev Hub">
    **In your Partner Business Org** (make sure to switch back to this login after creating the namespace):

    1. Open the App Launcher and search for **Namespace Registries**.
    2. Click **Link Namespace**.
    3. When prompted, log in with the Developer Edition Org credentials that created the namespace. The namespace you configured will be displayed after you log in and approve access.

    <Frame>
      <img alt="" />
    </Frame>

    <Tip>
      If the namespace doesn't appear in the list, switch from "Recently Viewed" to **All Namespaces** and try refreshing the page.
    </Tip>
  </Step>
</Steps>

### Creating an External Client App

With your environment set up, you can now create the External Client App (ECA) that will handle OAuth authentication for your integration.

<Steps>
  <Step>
    In your Partner Business Org, go to **Setup** and navigate to **Platform Tools > Apps > External Client Apps > External Client App Manager**.

    Click **New External Client App**.

    <Frame>
      <img alt="" />
    </Frame>
  </Step>

  <Step>
    Fill out the details for your app's name as it will appear to your users during the connection process.

    Make sure to configure the following settings:

    | Setting                         | Value    |
    | ------------------------------- | -------- |
    | **Distribution State**          | Packaged |
    | **API (Enable OAuth Settings)** | Enabled  |
  </Step>

  <Step>
    Under **OAuth Settings**, configure:

    **Callback URL:**

    ```
    https://passport.useparagon.com/oauth
    ```

    <Note>For on-premise installations, use `https://passport.[Your Base URL]/oauth`</Note>

    **OAuth Scopes:** Select the scopes required for your integration. By default, Paragon requests:

    * Access the identity URL service
    * Manage user data via APIs
    * Perform requests at any time

    **Flow Enablement**: Check the box for **Enable Authorization Code and Credentials Flow**. Leave the box for **Require user credentials in the POST body** unchecked.

    <img />
  </Step>

  <Step>
    Click **Save** to create your External Client App.

    See the next section to get your Consumer Key and Consumer Secret from the External Client App and add them to Paragon.
  </Step>
</Steps>

#### Add Your Salesforce App to Paragon

After creating your External Client App, you'll need to enter it Consumer Key and Consumer Secret of your External Client App into Paragon.

<Steps>
  <Step title="Get Your Consumer Key and Consumer Secret from Salesforce">
    In your Partner Business Org, go to **Setup > Platform Tools > Apps > External Client Apps > External Client App Manager** and view your External Client App.

    1. Expand **OAuth Settings**.
    2. Click **Consumer Key and Secret**.
       <Frame>
         <img alt="" />
       </Frame>
    3. Copy the **Consumer Key** and **Consumer Secret**.
  </Step>

  <Step title="Add your Consumer Key and Consumer Secret to Paragon">
    Now, go to the Paragon dashboard to add the Consumer Key and Secret:

    1. Navigate to your Salesforce integration and click **Configure** under the App Configuration section.
    2. Fill in your credentials:

       <Frame>
         <img alt="" />
       </Frame>

       | Field                              | Value                                                                                                                                                                                  |
       | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
       | **Consumer Key**                   | The Consumer Key you copied from your External Client App                                                                                                                              |
       | **Consumer Secret**                | The Consumer Secret you copied from your External Client App                                                                                                                           |
       | **Salesforce Package Install URL** | Leave blank for now. You'll add this in the [Packaging Your App](#packaging-your-app) section below, after you generate your Install URL.                                              |
       | **Permissions**                    | Add any additional permissions you included beyond the defaults from your External Client App. The default scopes will provide the same level of access that the authorizing user has. |

    <Info>
      The **Salesforce Package Install URL** is required to save this configuration, so you can't submit it yet. **Keep this Configure panel open** and don't click **Save** until you've generated your Install URL in the next section, then return here to complete and save it.
    </Info>
  </Step>
</Steps>

### Packaging Your App

To distribute your External Client App to users, you'll create a Second-Generation Managed Package (2GP) using the Salesforce CLI.

<Steps>
  <Step title="Install the Salesforce CLI">
    Install the Salesforce CLI using npm:

    ```bash theme={null}
    npm install -g @salesforce/cli
    ```

    Or see [Salesforce's CLI installation guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm) for other installation methods.
  </Step>

  <Step title="Create a Salesforce Project">
    Create a new Salesforce DX project:

    ```bash theme={null}
    sf project generate --name YourProjectName
    ```
  </Step>

  <Step title="Authorize Your Dev Hub">
    From your project directory, authenticate with your Partner Business Org:

    ```bash theme={null}
    sf org login web --set-default-dev-hub --alias DevHub
    ```

    This will open a browser window for you to log in.
  </Step>

  <Step title="Configure the Namespace">
    Open `sfdx-project.json` in your project and set the `namespace` field to the namespace you created in the previous step:

    ```json theme={null}
    {
      "packageDirectories": [
        {
          "path": "force-app",
          "default": true
        }
      ],
      "namespace": "YOUR_NAMESPACE",
      "sfdcLoginUrl": "https://login.salesforce.com",
      "sourceApiVersion": "59.0"
    }
    ```
  </Step>

  <Step title="Create the Package">
    Create a managed package for your app:

    ```bash theme={null}
    sf package create \
      --name "Your App Display Name" \
      --package-type Managed \
      --path force-app \
      --target-dev-hub DevHub \
      --error-notification-username your-email@example.com
    ```
  </Step>

  <Step title="Retrieve External Client App Metadata">
    Pull your ECA configuration into the project:

    ```bash theme={null}
    sf project retrieve start --metadata ExternalClientApplication ExtlClntAppOauthSettings --target-org DevHub
    ```

    After running these commands, you'll see new files in:

    * `force-app/main/default/externalClientApps/`
    * `force-app/main/default/extlClntAppOauthSettings/`

    <Info>
      If you have multiple External Client Apps and only want to package specific ones, delete the XML files for apps you don't want to include.
    </Info>
  </Step>

  <Step title="Create and Promote a Package Version">
    Create a new package version:

    ```bash theme={null}
    sf package version create \
      --package "Your App Display Name" \
      --installation-key-bypass \
      --wait 15 \
      --code-coverage
    ```

    This command will take a few minutes. Once complete, you'll receive a **Subscriber Package Version ID**. Save this ID for later use.

    Promote the version to released status:

    ```bash Replace YOUR_SUBSCRIBER_PACKAGE_VERSION_ID with your Subscriber Package Version ID: theme={null}
    sf package version promote --package YOUR_SUBSCRIBER_PACKAGE_VERSION_ID --no-prompt
    ```
  </Step>

  <Step title="Get Your Installation Link">
    Using the Subscriber Package Version ID, you can now construct the installation URL for your package at the version you promoted in the last step.

    The installation URL is constructed as follows (for Sandbox accounts, replace `login.salesforce.com` with `test.salesforce.com`):

    ```text Replace YOUR_SUBSCRIBER_PACKAGE_VERSION_ID with your Subscriber Package Version ID: theme={null}
    https://login.salesforce.com/packaging/installPackage.apexp?p0=YOUR_SUBSCRIBER_PACKAGE_VERSION_ID
    ```

    The Connect Portal can automatically guide users through the package installation process prior to connecting their Salesforce account.

    Now, return to the **Configure** panel you left open earlier and paste this URL into the **Salesforce Package Install URL** field. With all three fields (Consumer Key, Consumer Secret, and Install URL) filled in, click **Save** to submit the configuration.

    <Frame>
      <img alt="" />
    </Frame>

    In the Connect Portal, the installation URL will automatically be set to the one matching the account type the user selects.

    <Warning>
      **When changing OAuth scopes in the future**, you must:

      * Retrieve the ECA metadata (Step 6)
      * Create a new package version (Step 7, *this will update the Subscriber Package Version ID*)
      * Update the App Install URL in Paragon (Step 8)

      Users will need to reinstall your package and reconnect their Salesforce account to receive the updated scopes.
    </Warning>
  </Step>
</Steps>

### Testing Your Setup

To validate your setup, ensure that all details are correctly configured in the App Configuration section of your Salesforce integration:

* [Consumer Key and Consumer Secret](#add-your-salesforce-app-to-paragon)
* [Salesforce Package Install URL](#packaging-your-app:~:text=Get%20Your%20Installation%20Link)

Then, open the Connect Portal for Salesforce inside of your app (or click Test Connect Portal in the Salesforce integration) to try a connection flow.

<Warning>
  **You cannot use the same Developer Edition Org that you used to create a Namespace to test package installation.** Use your Partner Business Org or a separate Developer Edition Org to test package installation.
</Warning>

1. The Connect Portal will first prompt you to select a Salesforce Account Type.

   <img />

   * If you are using a Developer Edition Org, select **Production** option. You can only select **Sandbox** for orgs that login with `test.salesforce.com` instead of `login.salesforce.com`.

2. Next, the Connect Portal will provide instructions for installing your package. Click **Install** to begin the process.

   <img />

3. After following the prompts to install the package, click **I've installed the package** to continue.

4. Finally, the Connect Portal will prompt you to connect your Salesforce account. Click **Connect** to continue and authorize your app via an OAuth flow.

## 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 theme={null}
// 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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**

## User-Configured OAuth

&#x20;supports [User-Configured OAuth](/resources/user-configured-oauth), which lets your end users connect their own OAuth app instead of the one you've configured for your Paragon integration. This is useful when your customers want to use their own OAuth app for security or scope customization.

To enable this, pass `"user-configured-oauth"` as one of the values in the `accountType` array when launching the install flow:

```js theme={null}
// Allow user-configured OAuth as an option (defaults to hidden)
paragon.installIntegration("salesforce", {
  accountType: paragon
    .getAccountTypeOptions("salesforce")
    .map((option) => option.id),
});

// Only allow user-configured OAuth accounts to connect
paragon.installIntegration("salesforce", {
  accountType: ["user-configured-oauth"],
});
```

See the [User-Configured OAuth reference](/resources/user-configured-oauth) for full details on how it works and what your users will be prompted for.

## Deprecation of Connected Apps (September 2025)

<Warning>
  The following section only applies to customers who built a Salesforce integration before September 2025. If you are following the [Setup Guide](#setup-guide) for the first time and already have an External Client App and Package, you can ignore everything in this section.
</Warning>

Starting in September 2025, Salesforce began restricting Connected Apps that are not installed (via a package) on a Salesforce organization from being authorized. Connected Apps are deprecated and should be replaced with External Client Apps as explained in the Setup Guide.

This change can result in errors for new users of your Salesforce integration (or existing users trying to re-authorize). The error appears in the OAuth flow as:

> OAUTH\_APPROVAL\_ERROR\_GENERIC: An unexpected error has occurred during authentication. Please try again.

See the [official Salesforce announcement](https://help.salesforce.com/s/articleView?id=005132365\&type=1) for more details.

### For Existing Users of Your Connected App

For existing users of your Salesforce Connected App (users that have connected your before September 2025), **connections will continue to work as expected unless they are prompted to re-authorize at some point in the future.**

If they are prompted to re-authorize, they will see the error referenced above.

To prevent this from happening, instruct your users to contact their Salesforce admin to install your app with the following instructions:

<Accordion title="Installing the Connected App (for existing users)">
  1. In Salesforce, visit **Setup → Apps → Connected Apps → Connected Apps OAuth Usage**:

     <Frame>
       <img alt="" />
     </Frame>

  2. Click **Install** next to your app's name.

     If the Salesforce admin cannot find your app in the list, they will not be able to use your Connected App. See the next section for more details.
</Accordion>

### For New Users of Your Connected App

New users of your Salesforce integration will see an error when authorizing your Connected App through the Connect Portal until they have installed your app.

Instead, follow the [Setup Guide](#setup-guide) from the beginning to set up a new External Client App and package it in a Second-Generation Managed Package (2GP) for new users to connect.

Paragon provides an option to [migrate your Connected App credentials](#migrating-from-a-connected-app-to-an-external-client-app) to a new External Client App without disrupting existing connections (more in the next section).

#### Alternative: Enable Uninstalled App Permission

As an alternative to packaging, you can instruct Salesforce admins to temporarily bypass the new policy and allow your app to authorize without being installed with a package.

<Accordion title="How to Enable Uninstalled App Permission">
  Provide the following instructions to new users of your Salesforce integration:

  1. **Create a Permission Set**
     * Ask an admin of your Salesforce organization to create or edit a permission set for at least one user that should be able to authorize.
     * Click **Setup → Permission Sets**.
     * Click **New** or select an existing permission set.
     * Name your permission set (e.g., "\[Your App's Name] Integration Access").

  2. **Enable Uninstalled App Permission**
     * In the permission set, click **System Permissions**.
     * Click **Edit**.
     * Search for and select **Approve Uninstalled Connected Apps**.
     * Click **Save**.

  3. **Assign Permission Set to Users**
     * Click **Manage Assignments**.
     * Click **Add Assignments**.
     * Select at least one user who needs Salesforce integration access.
     * Click **Assign**.

  4. **Authorize Your Account**
     * Once created, visit the Salesforce integration settings in your app to connect your Salesforce account (the account that was added to the permission set above).

  5. **Install the Connected App**
     * After authorization, ask your Salesforce admin to visit **Setup → Apps → Connected Apps → Connected Apps OAuth Usage**:

       <Frame>
         <img alt="" />
       </Frame>

     * Click **Install** next to your app's name.

  6. **Remove Permission Set (Optional)**
     * Once the Connected App is installed, the Permission Set created above can be removed without impact to your connection.

  After these instructions are followed, both the access/refresh token pair issued during Step 4 and other token pairs issued in subsequent authorizations by other users will work as expected.
</Accordion>

### Migrating from a Connected App to an External Client App

To migrate from using a Connected App to using an External Client App, navigate to your Salesforce integration in the Paragon dashboard and click **Configure**.

If you do not have a Package Install URL set, you will see an option to migrate your app:

<Frame>
  <img alt="" />
</Frame>

Next, you will be prompted to enter new details representing the External Client App you are migrating to. Follow the [Setup Guide](#setup-guide) from the beginning to get all of the details required for this step.

Once you have entered the details, click **Next** to confirm the migration to an External Client App. After the migration is complete:

* The Connected App configuration will become read-only, and any changes to the App Configuration will apply to the new External Client App.
* Your existing users will remain connected to your old Connected App, and their requests, workflows, or syncs will not be disrupted.
* New users of your Salesforce integration will be prompted to install the new External Client App, using the package installation process described in [Testing Your Setup](#testing-your-setup).


# Salesloft
Source: https://docs.useparagon.com/resources/integrations/salesloft

Connect to your users' Salesloft accounts.

<IntegrationsCompatibility />

## 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 alt="Connecting your Salesloft app to Paragon Connect" />
</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 theme={null}
// 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 alt="" />
</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.

<IntegrationsCompatibility />

## Connecting to SAP S/4HANA

Your users will need the following information to connect their SAP S/4HANA account with your integration built with Paragon Connect:

* SAP Host URL
* Username
* Password

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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to SAP SuccessFactors

Your users will need the following information to connect their SAP SuccessFactors account with your integration built 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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Segment

Your users will need the following information to connect their Segment account with your integration built 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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## Setup Guide

Paragon supports two authentication methods for the ServiceNow integration:

* **OAuth 2.0** (recommended): Your users authenticate by using an inbound OAuth application that they create in ServiceNow.
* **Username and Password**: Your users provide their ServiceNow username and password.

You can control the authentication method displayed to your users by specifying the `accountType` when calling [`paragon.connect`](/apis/api-reference#connect).
If omitted, both OAuth and Basic auth methods will be displayed.

<CodeGroup>
  ```js OAuth and Basic theme={null}
  // Opens the Connect Portal with both OAuth and Basic auth options
  paragon.connect("servicenow", {
    accountType: ["oauth, basic"],
  });
  ```

  ```js OAuth theme={null}
  // Opens the Connect Portal defaulting to the OAuth flow without selection
  paragon.connect("servicenow", {
    accountType: "oauth",
  });
  ```
</CodeGroup>

### 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.

Whether testing the OAuth 2.0 connection or the Username and Password connection, you will need to leverage the test account to validate connection and your integration logic.

## Connecting with OAuth 2.0

To connect to ServiceNow with OAuth, your users will need to create an **inbound OAuth application** in their ServiceNow instance.
The steps to create an inbound OAuth application are as follows:

<Frame>
  <img alt="" />
</Frame>

**Creating an Inbound OAuth Application**

<Steps>
  <Step>
    From within your ServiceNow instance, navigate to **All > System OAuth > Application Registry** and click **New**.
  </Step>

  <Step>
    Select **New Inbound Integration Experience**
  </Step>

  <Step>
    Select **OAuth - Authorization Code Grant**
  </Step>

  <Step>
    Fill out the application details and add the Paragon redirect URL to the **Redirect URL** field.

    ```
    https://passport.useparagon.com/oauth
    ```
  </Step>

  <Step>
    Add the **`useraccount`** scope to the application. ServiceNow uses the `useraccount` scope by default to access REST APIs on behalf of the connecting user.
  </Step>

  <Step>
    Click **Save** to create your application. ServiceNow provides you with the **Client ID** and **Client Secret** needed in the next step.
  </Step>
</Steps>

**Completing Connection in the Connect Portal**

Once your users have created an inbound OAuth application in their ServiceNow instance, they can complete the connection in the Connect Portal by clicking **Connect**.

The Connect Portal will prompt your users to enter their ServiceNow Instance URL, Client ID, Client Secret, and Permissions.

## Connecting with Username and Password

To connect to ServiceNow with basic authentication, your users will need to provide:

* **Subdomain**
* **Username**
* **Password**

You can find these values for a developer test account by going to the **User Icon > Manage instance password**.

<Frame>
  <img alt="" />
</Frame>

## Connecting to 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 theme={null}
// 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 alt="" />
</Frame>


# SharePoint
Source: https://docs.useparagon.com/resources/integrations/sharepoint

Connect to your users' SharePoint accounts.

<IntegrationsCompatibility />

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.

### Using Application Permissions

Application Permissions can be used with SharePoint if your integration should make requests as an application (like a service account), rather than in the context of an authenticated user.

Using Application Permissions requires Connected Users to provide organization-wide admin consent for the application, by either:

* Requiring Entra ID administrators to follow the Connect Portal flow and checking "Consent on behalf of your organization" during the authorization flow
* OR directing admins to the `/adminconsent` URL (described below) to explicitly grant admin consent.

<Info>
  If you are only using Delegated Permissions (the default option to use the integration in the context of an authenticated user), you can skip this section and proceed to [Add your SharePoint app to Paragon](#add-your-sharepoint-app-to-paragon).
</Info>

<Steps>
  <Step title="Generate a certificate key pair">
    Locally on your machine, create a self-signed certificate and private key using `openssl`:

    ```bash theme={null}
    openssl req -x509 -newkey rsa:2048 \
      -keyout private-key.pem \
      -out certificate.pem \
      -days 365 -nodes \
      -subj "/CN=ParagonIntegration"
    ```

    This produces two files:

    * `private-key.pem` — the private key (keep this secret, you will provide it to Paragon)
    * `certificate.pem` — the public certificate (you will upload this to Azure AD)
  </Step>

  <Step title="Get the certificate thumbprint">
    Extract the SHA-1 thumbprint in hex format (this matches what Azure portal displays):

    ```bash theme={null}
    openssl x509 -in certificate.pem -fingerprint -sha1 -noout \
      | sed 's/sha1 Fingerprint=//;s/://g'
    ```

    Save the output (a 40-character hex string). You will provide this to Paragon.
  </Step>

  <Step title="Upload the certificate to Azure AD">
    1. In the [Azure Portal](https://portal.azure.com/), navigate to **All Services > App Registrations** and select your application.

    2. Navigate to **Manage > Certificates & secrets** in the sidebar.

    3. Select the **Certificates** tab.

    4. Click **Upload certificate** and select the `certificate.pem` file from Step 1.

    5. Confirm the displayed thumbprint matches the value from Step 2.
  </Step>

  <Step title="Add Application Permissions">
    1. In your app registration, navigate to **API permissions** in the sidebar.

    2. Click **Add a permission** > **Microsoft Graph** > **Application permissions**.

    3. Add the required scopes for your use case. For Managed Sync, add:
       * `Sites.Read.All`
       * `Files.Read.All`
       * `User.Read.All`
       * `Group.Read.All`

    4. Click **Add permissions**.
  </Step>

  <Step title="Grant admin consent">
    A tenant admin must grant consent for the Application Permissions. Direct your admin to visit the following URL in their browser:

    ```
    https://login.microsoftonline.com/{tenant-id}/adminconsent?client_id={client-id}&redirect_uri=https://passport.useparagon.com/oauth
    ```

    * Replace `{tenant-id}` with the Entra ID Directory (tenant) ID (or use `organizations`, if it is not known).
    * Replace `{client-id}` with the Client ID of your App Registration.

    The admin will be prompted to sign in and grant consent for the requested permissions.
  </Step>

  <Step title="Add your certificate to Paragon">
    Continue in the next section to [add your SharePoint app to Paragon](#add-your-sharepoint-app-to-paragon).
  </Step>
</Steps>

### Add your SharePoint app to Paragon

1. Select **SharePoint** from the **Integrations Catalog**.

2. Under **App Configuration > Configure**, fill out your credentials as follows:

   * **Client ID:** Overview > Application (client) ID on your Microsoft app registration.
   * **Client Secret:** The value generated in the **Certificates & secrets** section of your Microsoft app registration.
   * **Permissions:** The scopes you require for your application, as designated in the **API permissions** section of your Microsoft app registration.
     <Info>
       **Note:** You should only add the scopes you've requested in your app registration to Paragon. Any permissions changes will need to be made in both the Azure Portal and Paragon.
     </Info>

3. If you are using [Application Permissions](#using-application-permissions), additionally provide:
   * **Private Key:** The contents of `private-key.pem` from the certificate generation step.
   * **Certificate Thumbprint:** The 40-character SHA-1 hex thumbprint from Azure portal (no colons or spaces).

4. Press the purple "**Save Changes**" button to save your credentials.

<Frame>
  <img alt="" />
</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 theme={null}
// 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 alt="" />
</Frame>

You can find the full list of Webhook Triggers for Sharepoint below:

* **Item Created**
* **Item Updated**
* **File Deleted**
* **Page Modified**

## User-Configured OAuth

&#x20;supports [User-Configured OAuth](/resources/user-configured-oauth), which lets your end users connect their own OAuth app instead of the one you've configured for your Paragon integration. This is useful when your customers want to use their own OAuth app for security or scope customization.

To enable this, pass `"user-configured-oauth"` as one of the values in the `accountType` array when launching the install flow:

```js theme={null}
// Allow user-configured OAuth as an option (defaults to hidden)
paragon.installIntegration("sharepoint", {
  accountType: paragon
    .getAccountTypeOptions("sharepoint")
    .map((option) => option.id),
});

// Only allow user-configured OAuth accounts to connect
paragon.installIntegration("sharepoint", {
  accountType: ["user-configured-oauth"],
});
```

See the [User-Configured OAuth reference](/resources/user-configured-oauth) for full details on how it works and what your users will be prompted for.

## Using the SharePoint File Picker

You can allow your user to select files from their SharePoint account in your app with the SharePoint File Picker provided by 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 theme={null}
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();
```

**Targeting a specific SharePoint site**

By default, the picker opens the site stored on the connected credential. If a single connected account has access to multiple SharePoint sites, pass `siteUrl` or `siteId` to `init()` to open a different site. `siteUrl` takes precedence when both are provided.

```javascript theme={null}
// Target a site by URL
await picker.init({
  siteUrl: 'https://contoso.sharepoint.com/sites/Engineering',
});

// Or target a site by ID (resolved via Microsoft Graph)
await picker.init({
  siteId: 'contoso.sharepoint.com,191d8a17-0000-0000-0000-000000000000',
});

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 theme={null}
  await paragon.request('sharepoint', '/_api/web/GetFileById(<fileID>)/$value', {
  	method: 'GET'
  });
  ```

  ```plain REST API theme={null}
  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.

<IntegrationsCompatibility />

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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
  </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 alt="" />
</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 the [Monitoring > Workflows](/workflows/viewing-workflow-executions) page and verify that your workflow has executed.


# Shortcut
Source: https://docs.useparagon.com/resources/integrations/shortcut

Connect to your users' Shortcut accounts.

<IntegrationsCompatibility />

## Connecting to Shortcut

Your users will need the following information to connect their Shortcut account with your integration built with Paragon Connect:

* Shortcut API Token

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</Frame>

## User-Configured OAuth

&#x20;supports [User-Configured OAuth](/resources/user-configured-oauth), which lets your end users connect their own OAuth app instead of the one you've configured for your Paragon integration. This is useful when your customers want to use their own OAuth app for security or scope customization.

To enable this, pass `"user-configured-oauth"` as one of the values in the `accountType` array when launching the install flow:

```js theme={null}
// Allow user-configured OAuth as an option (defaults to hidden)
paragon.installIntegration("slack", {
  accountType: paragon
    .getAccountTypeOptions("slack")
    .map((option) => option.id),
});

// Only allow user-configured OAuth accounts to connect
paragon.installIntegration("slack", {
  accountType: ["user-configured-oauth"],
});
```

See the [User-Configured OAuth reference](/resources/user-configured-oauth) for full details on how it works and what your users will be prompted for.


# Snowflake
Source: https://docs.useparagon.com/resources/integrations/snowflake

Connect to your users' Snowflake accounts.

<IntegrationsCompatibility />

## Connecting to Snowflake

Your users will need the following information to connect their Snowflake account with your integration built 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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Stack Overflow for Teams

Your users will need the following information to connect their Stack Overflow for Teams account with your integration built 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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 theme={null}
// 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 alt="" />
</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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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 alt="" />
</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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

<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 Unleashed

Your users will need the following information to connect their Unleashed account with your integration built with Paragon Connect:

* **API ID:** Found under Integration > Unleashed API Access in their Unleashed App page.
* **API Key:** Found under Integration > Unleashed API Access in their Unleashed App page.

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.

<Warning>
  **When testing Unleashed with the [Proxy API](/apis/proxy), requests must include an Accept header of `application/json` or `application/xml`** (or omit the header entirely).

  Unleashed [requires](https://apidocs.unleashedsoftware.com/AuthenticationHelp) one of these values and will fail if another value is sent. Request clients like curl or Postman often send a default Accept header such as `*/*`, which will override Paragon's defaults and can cause Unleashed requests to fail. Remove the client's default Accept header or set it explicitly to `application/json` or `application/xml`.

  This does not apply when using `paragon.request` from the SDK, since Paragon sets the correct `Accept` header for you.
</Warning>

Any Unleashed API endpoints can be accessed with the Paragon SDK as shown in this example.

```javascript theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to WhatsApp

Your users will need the following information to connect their WhatsApp account with your integration built 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>

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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to WooCommerce

Your users will need the following information to connect their WooCommerce account with your integration built with Paragon Connect:

* Store URL
* Consumer Key
* Consumer Secret

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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## Connecting to Workable

Your users will need the following information to connect their Workable account with your integration built 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>

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 theme={null}
// 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

<IntegrationsCompatibility />

<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 Workday

Your users will need the following information to connect their Workday account with your integration built with Paragon Connect:

* Subdomain
* Username
* Password
* Tenant Name

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 theme={null}
// 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/v45.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.

<IntegrationsCompatibility />

## 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 alt="" />
</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>

<Frame>
  <img alt="" />
</Frame>

## 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 theme={null}
// 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 alt="" />
</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 alt="" />
</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.

<IntegrationsCompatibility />

## 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 alt="" />
</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>

<Frame>
  <img alt="" />
</Frame>

## 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 theme={null}
// 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
* Get Ticket Comments
* 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 alt="" />
</Frame>

You can find the full list of Webhook Triggers for Zendesk below:

* **New Ticket**
* **Ticket Updated**

## User-Configured OAuth

&#x20;supports [User-Configured OAuth](/resources/user-configured-oauth), which lets your end users connect their own OAuth app instead of the one you've configured for your Paragon integration. This is useful when your customers want to use their own OAuth app for security or scope customization.

To enable this, pass `"user-configured-oauth"` as one of the values in the `accountType` array when launching the install flow:

```js theme={null}
// Allow user-configured OAuth as an option (defaults to hidden)
paragon.installIntegration("zendesk", {
  accountType: paragon
    .getAccountTypeOptions("zendesk")
    .map((option) => option.id),
});

// Only allow user-configured OAuth accounts to connect
paragon.installIntegration("zendesk", {
  accountType: ["user-configured-oauth"],
});
```

See the [User-Configured OAuth reference](/resources/user-configured-oauth) for full details on how it works and what your users will be prompted for.

## 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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>

<Frame>
  <img alt="" />
</Frame>

## 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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</Frame>

4. Select "**Server-based Applications**" as the Client Type:

<Frame>
  <img alt="" />
</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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</Frame>

3. Select "**Server-based Applications**" as the Client Type:

<Frame>
  <img alt="" />
</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 alt="" />
</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 theme={null}
// 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.

<IntegrationsCompatibility />

## 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 alt="" />
</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 alt="" />
</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 theme={null}
// 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 alt="" />
</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 alt="" />
</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" />

* [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)
* paragonUtils

  <Info>
    `paragonUtils` is not an npm library, but a collection of helper functions to use in your Function steps.

    [Learn more about using `paragonUtils` for field mapping](/workflows/functions#transforming-data-with-paragonutils).
  </Info>
* [parquetjs-lite](https://www.npmjs.com/package/parquetjs-lite) (`libraries["parquetjs-lite"]`)

  <Info>
    **Note**: In `parquetjs-lite`,`openFile` methods are disabled for security.

    Use `openBuffer`, `openUrl`, or `openS3` for `ParquetReader`, and `openStream` for `ParquetWriter`.
  </Info>
* [pdf](https://www.npmjs.com/package/html-pdf)
* [pdf-lib](https://www.npmjs.com/package/pdf-lib) (`libraries["pdf-lib"]`)
* [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)


# User-Configured OAuth
Source: https://docs.useparagon.com/resources/user-configured-oauth

Allow your users to authorize integrations with their own OAuth client and customize scopes.

## Overview

User-Configured OAuth allows your users to connect an integration with their **own** OAuth client (Client ID and Client Secret) instead of the OAuth credentials you've configured in Paragon.

This is useful when:

* Your customers have stricter security or compliance requirements that require them to bring their own OAuth app.
* Your customers need to customize OAuth scopes that are requested.
* Your customers want to manage rate limits, audit logs, or app-level settings on their own OAuth app.
* Your customers belong to organizations that only allow connections to internally registered apps.

When User-Configured OAuth is enabled, the Connect Portal prompts the user to enter their own Client ID, Client Secret, and (optionally) scopes during the install flow. Paragon will use those credentials to perform the OAuth handshake and authenticate the user, but otherwise will manage the connection like any other integration.

## Supported Integrations

User-Configured OAuth is currently supported for the following integrations:

* [Gmail](/resources/integrations/gmail#user-configured-oauth)
* [Jira](/resources/integrations/jira#user-configured-oauth)
* [Microsoft Outlook](/resources/integrations/outlook#user-configured-oauth)
* [Salesforce](/resources/integrations/salesforce#user-configured-oauth)
* [SharePoint](/resources/integrations/sharepoint#user-configured-oauth)
* [Slack](/resources/integrations/slack#user-configured-oauth)
* [Zendesk](/resources/integrations/zendesk#user-configured-oauth)

## Enabling User-Configured OAuth

User-Configured OAuth is exposed as an additional **Account Type** on the integration. To offer it to your users, pass an `accountType` array to [`paragon.installIntegration`](/apis/api-reference#installintegration) (or [`paragon.connect`](/apis/api-reference#connect)) listing the account types you want to make available.

```js theme={null}
paragon.installIntegration("zendesk", {
  accountType: ["default", "user-configured-oauth"],
});
```

<Frame>
  <img alt="Account type selection showing user-configured OAuth" />
</Frame>

When more than one account type is provided, the Connect Portal will show an Account Type selection screen so the user can choose between connecting with the default OAuth app you've configured in Paragon and providing their own credentials.

To restrict your integration to **only** support User-Configured OAuth (and skip the account type prompt), pass `"user-configured-oauth"` as the only value:

```js theme={null}
paragon.installIntegration("zendesk", {
  accountType: ["user-configured-oauth"],
});
```

The same option can be passed to `paragon.connect` to launch the Connect Portal with the same behavior:

```js theme={null}
paragon.connect("zendesk", {
  accountType: ["default", "user-configured-oauth"],
});
```

### What your users will be prompted for

After selecting the **User-Configured OAuth** account type, the user will be prompted to enter:

* **Client ID**: The Client ID of their OAuth application.
* **Client Secret**: The Client Secret of their OAuth application.
* **Scopes** (optional): A list of OAuth scopes to request. The default scopes configured for your Paragon integration will be pre-filled in this input, but users can add or remove their own scopes.
* **Redirect URL**: A read-only field showing the redirect URL the user must add to their OAuth application. By default, this is `https://passport.useparagon.com/oauth`.
* Other integration-specific settings may appear in this step if required by the integration.

After saving, Paragon will run the OAuth flow against the user's app and store the resulting credentials, just like any other connected integration.

## Using User-Configured OAuth with the Headless Connect Portal

If you're using the [Headless Connect Portal](/connect-portal/headless-connect-portal), pass the same `accountType` option to `paragon.installFlow.start`:

```js theme={null}
paragon.installFlow.start("zendesk", {
  accountType: ["default", "user-configured-oauth"],
  onNext: (next) => {
    // Render the appropriate UI for the current install stage
  },
  onComplete: () => {
    // Installation has completed successfully
  },
});
```

When `accountType` is an array of more than one value, the install flow will emit an [`AccountTypeStage`](/apis/api-reference#installflowstage) in the `onNext` callback. You can render the available options and call [`paragon.installFlow.setAccountType`](/apis/api-reference#setaccounttype) when the user selects one.

If the user chooses `"user-configured-oauth"`, the install flow will subsequently emit a [`PostOptionsStage`](/apis/api-reference#installflowstage) containing inputs for the Client ID, Client Secret, scopes, and the read-only Redirect URL. See the [Input Types Reference](/connect-portal/input-types-reference) for help rendering these inputs.

<Info>
  User-Configured OAuth requires `@useparagon/connect` **v2.1.1** or higher to be supported by the Headless Connect Portal. See the [SDK changelog](/changelog/sdk) for more details.
</Info>


# 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. Use the IP addresses that correspond to your Paragon instance's region.

<Tabs>
  <Tab title="US Cloud">
    * `18.205.92.162`
    * `18.215.215.164`
    * `34.225.59.94`
    * `44.210.155.28`
    * `52.45.12.206`
    * `54.235.127.238`
  </Tab>

  <Tab title="EU Cloud">
    * `18.153.211.96`
    * `35.158.48.176`
  </Tab>
</Tabs>


# 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 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            | Pro                                                                                                                                           | Enterprise                                                                                                                                                        |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Documentation & SDKs** | ✔                                                                                                                                             | ✔                                                                                                                                                                 |
| **Support Channels**     | Email, Slack                                                                                                                                  | Email, Slack                                                                                                                                                      |
| **Initial Response**     | - **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.


# Run a Real-time Action
Source: https://docs.useparagon.com/tutorials/actionkit-guide/first-action

This tutorial series walks through building a real-time integration feature using ActionKit for webhook events and tool calls

In this tutorial series, we will:

1. Interact with your users' integration data using [ActionKit Tools](/actionkit/overview)

2. React to your users' integration events via webhook subscriptions using [ActionKit Triggers](/actionkit/triggers/overview)

3. Provide an example of an integration feature that uses Triggers to kick off an agent with Tools to write-back data

In this first chapter, we'll set up an integration, allow users to authenticate in your app, and run a real-time action

## Set up your Paragon integration

### Configure your 3rd-party App

The first step is to configure and enable your integration on the Paragon dashboard.

For the purposes of this tutorial, we will be using HubSpot. If you're following along, visit our [HubSpot guide](/resources/integrations/hubspot) to configure your integration.

<Frame>
  <img alt="" />
</Frame>

<Note>
  If you're setting up a different integration, visit our [integration catalog](/resources/integrations) for a full list of integrations and how to set up your 3rd-party app in Paragon.
</Note>

### 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 alt="" />
</Frame>

We will also need your **Paragon Project ID**. You can copy your Project ID by clicking Copy Project ID under the Environment switcher:

<Frame>
  <img alt="" />
</Frame>

Your **Signing Key** and **Project ID** will be used as environment variables in your application.

## Authenticate your users

### Start with the Paragon Skill to embed Paragon in your app

Install the [Paragon Skill](/building-with-agents) in your coding agent for a guided experience.

```bash theme={null}
npx skills add useparagon/paragon-skills
```

The Paragon Skill will steer your agent through [setting up the Paragon SDK](/getting-started/installing-the-connect-sdk) and embedding the [Connect Portal](/connect-portal/connect-portal-customization).

```markdown Add the Paragon SDK wrap theme={null}
/paragon-setup-skill Look at my app and set up the Paragon SDK, including all dependencies and required setup steps.

I will provide the following environment variables for your reference:
- `PARAGON_PROJECT_ID`: The Paragon Project UUID.
- `PARAGON_SIGNING_KEY`: The Signing Key as a PKCS8-encoded private key.
```

Your agent should have set up the following:

1. A server-side route that creates a signed JWT for each of your users

```js expandable theme={null}
 // 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/${process.env.PARAGON_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. Paragon SDK used on your front-end client to authenticate your users

```js theme={null}
await paragon.authenticate(
  process.env.PARAGON_PROJECT_ID,
  SIGNED_JWT
);
```

3. Front-end components to bring up the Connect Portal for users to connect their integrations

```js theme={null}
<button onClick={() => paragon.connect("hubspot")}>
  Connect HubSpot
</button>
```

<Note>
  If you would like to set up Paragon without an agent, see the [setup guide](/getting-started/installing-the-connect-sdk)
</Note>

## Run your first real-time ActionKit Tool

ActionKit's [Tool API](/actionkit/api-reference) gives your agent or app hundreds of pre-built tools that execute real-time actions.

### Get Tools

Get available tools programmatically via the `GET Tools` endpoint.

```js theme={null}
fetch(`https://actionkit.useparagon.com/projects/${process.env.PARAGON_PROJECT_ID}/tools`, {
    method: 'GET',
    headers: {Authorization: `Bearer ${SIGNED_JWT}`}
  }
).then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```json Example response expandable theme={null}
{
  "tools": {
    "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": []
}
```

<Note>
  If you have a specific Tool in mind, you can also visit the [ActionKit docs](/actionkit/overview) to browse every available Tool.
</Note>

### Execute Tool

To execute a tool, run a `POST /tools` call against the ActionKit API with the **tool name** and any **tool parameters**.

```js theme={null}
fetch(`https://actionkit.useparagon.com/projects/${process.env.PARAGON_PROJECT_ID}/tools`, {
  method: 'POST',
  headers: {Authorization: `Bearer ${SIGNED_JWT}`, 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tool: 'HUBSPOT_CREATE_RECORD_CONTACTS',
    parameters: {
      email: 'jack@email.com',
      firstname: 'jack',
      lastname: 'm',
      jobtitle: 'developer',
      company: 'Paragon',
    }
  })
}).then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

And that's all it takes to run any integration action with the Tools API! In the next chapter, we'll be subscribing to HubSpot webhooks through ActionKit's Triggers API.


# Subscribe to Real-time Events
Source: https://docs.useparagon.com/tutorials/actionkit-guide/first-trigger

In this chapter, we'll subscribe to an ActionKit Trigger that sends a webhook whenever a new HubSpot record is created

In the [last chapter](/tutorials/actionkit-guide/first-action), we covered how to run an ActionKit Tool to execute a real-time action, like creating a HubSpot contact.

In this chapter, we'll use the ActionKit's Triggers API to subscribe to a HubSpot webhook subscription.

## Get ActionKit Triggers

Similar to the Tools API, we can get all of the available triggers for a connected user via an API call. For Triggers, we can use the `GET Triggers` endpoint.

```js theme={null}
fetch(`https://actionkit.useparagon.com/projects/${process.env.PARAGON_PROJECT_ID}/triggers`, {
  method: 'GET',
  headers: {Authorization: `Bearer ${SIGNED_JWT}`}
}).then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```json Example response expandable theme={null}
{
  "triggers": {
    "hubspot": [
      {
        "type": "HUBSPOT_RECORD_CREATED",
        "triggerModel": "POLLING",
        "title": "New Record",
        "description": "Trigger when a new record is created in HubSpot",
        "parameters": [
          {
            "id": "recordType",
            "type": "TEXT_NO_VARS",
            "label": "Record Type",
            "required": true
          }
        ]
      }
    ]
  }
}
```

<Note>
  If you have a specific Trigger in mind, you can also visit the [Triggers API docs](/actionkit/triggers/overview) to browse every available Trigger.
</Note>

## Subscribing to a Trigger

For any Trigger, call the `POST /trigger-subscriptions` to subscribe to any of your users' integration events. This webhook subscription **does NOT apply to all of your users** with that connected integration (i.e. you will not receive webhook events from all of your user's with a connected HubSpot account).

Subscribing to a Trigger is done at a connected user level, where you can be specific in configuring subscriptions for every user.

```js theme={null}
fetch(`https://actionkit.useparagon.com/projects/${process.env.PARAGON_PROJECT_ID}/trigger-subscriptions`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${SIGNED_JWT}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    integration: 'hubspot',
    type: 'HUBSPOT_RECORD_CREATED',
    parameters: {recordType: 'Contact'},
    webhookOverride: {
      url: 'https://example.com',
      headers: {},
      metadata: {}
    }
  })
}).then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

## Receiving Webhooks

After subscribing to a Trigger, webhooks are sent to either your default webhook URL (configured in the Paragon Dashboard) OR to the URL specified in the `webhookOverride` parameter.

A useful endpoint for seeing the schema of a webhook payload is the `POST triggers/examples` endpoint. This endpoint returns an example payload that takes into account your user's custom objects and fields they may have in their connected integration.

```js theme={null}
fetch(`https://actionkit.useparagon.com/projects/${process.env.PARAGON_PROJECT_ID}/triggers/examples`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${SIGNED_JWT}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'HUBSPOT_RECORD_CREATED',
    integration: 'hubspot',
    parameters: {recordType: 'Opportunity'}
  })
}).then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```json Example Payload expandable theme={null}
[
  {
    "id": "001xx000003DHP0AAO",
    "name": "Sample Opportunity",
    "amount": 50000,
    "stage": "Prospecting",
    "closeDate": "2025-12-31"
  }
]
```

You should now be able to subscribe to real-time webhook events like new HubSpot records.  In the next chapter, we'll bring both ActionKit Tools and Triggers together and walk through an example of an AI feature that captures HubSpot records in real-time, enriches the data with an LLM, and then writes back the data to HubSpot.


# Full Example of an End-to-End HubSpot Integration
Source: https://docs.useparagon.com/tutorials/actionkit-guide/reactive-integration-example

Let's tie Tools and Triggers together in the context of a reactive AI agent

In this final chapter, we'll build an automated HubSpot agent together. Our HubSpot agent uses:

1. [Triggers](/tutorials/actionkit-guide/first-trigger) to run the agent whenever a new HubSpot record is created
2. [Tools](/tutorials/actionkit-guide/first-action) for the agent to get, create, and update HubSpot data if it's relevant to the user's prompt template.

<img alt="" />

## 1. Authenticate our User and Connect their HubSpot Integration

First we'll generate a Paragon-signed JWT for our user that we'll use client-side with the Paragon SDK.

```typescript server-side function expandable theme={null}
import jwt from "jsonwebtoken";

const PROJECT_ID = process.env.NEXT_PUBLIC_PARAGON_PROJECT_ID!;
const SIGNING_KEY = process.env.PARAGON_SIGNING_KEY!;

export function signParagonToken(userId: string): string {
  const currentTime = Math.floor(Date.now() / 1000);

  return jwt.sign(
    {
      sub: userId,
      aud: `useparagon.com/${PROJECT_ID}`,
      iat: currentTime,
      exp: currentTime + 60 * 60,
    },
    SIGNING_KEY,
    { algorithm: "RS256" }
  );
}
```

Then we can use the Paragon SDK to authenticate and connect our user's HubSpot account.

```typescript calling our backend route to retrieve our JWT before authenticating expandable theme={null}
const res = await fetch("/api/auth/paragon-token", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ userId }),
});
const { token } = await res.json();

await paragon.authenticate(PROJECT_ID, token);
```

```tsx Paragon.connect to bring up the Connect Portal theme={null}
<button onClick={async() => await paragon.connect("hubspot", {})}
  className="w-full rounded-lg bg-orange-500 px-4 py-3 text-sm font-semibold text-white hover:bg-orange-600 transition-colors"
>
  Connect HubSpot
</button>
```

## 2. Let our Users Configure their HubSpot Event Subscription

Using the `GET triggers` endpoint, we can let our users select the type of HubSpot event they'd like their agent to receive.

```typescript Gets the available Triggers for our specific user expandable theme={null}
const PROJECT_ID = process.env.NEXT_PUBLIC_PARAGON_PROJECT_ID!;
const BASE_URL = "https://actionkit.useparagon.com";

async function fetchActionKit(
  path: string,
  userId: string,
  options: RequestInit = {}
) {
  const token = signParagonToken(userId);
  const res = await fetch(`${BASE_URL}${path}`, {
    ...options,
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
      ...options.headers,
    },
  });

  if (!res.ok) {
    const body = await res.text();
    throw new Error(`ActionKit API error ${res.status}: ${body}`);
  }

  return res.json();
}

export async function listAvailableTriggers(
  userId: string,
  integration = "hubspot"
): Promise<Record<string, TriggerDefinition[]>> {
  const data = await fetchActionKit(
    `/projects/${PROJECT_ID}/triggers?integrations=${integration}`,
    userId
  );
  return data.triggers;
}
```

```tsx Use the Triggers response to surface configurations to our user expandable theme={null}
{selectedTrigger.parameters.map((p) => (
  <div key={p.id}>
    <label className="block text-xs font-medium text-zinc-700 dark:text-zinc-400 mb-2 uppercase tracking-wide">
      {p.title} {p.required && <span className="text-red-500">*</span>}
    </label>
    <input type="text"
      value={triggerParams[p.id] ?? ""}
      onChange={(e) =>
        setTriggerParams((prev) => ({
          ...prev,
          [p.id]: e.target.value,
      }))}
      placeholder={p.values ? p.values[0] : p.type}
      className="w-full rounded-md border border-zinc-300 dark:border-zinc-600 bg-white dark:bg-zinc-800 px-3 py-2 text-sm focus:outline-none focus:ring-2 focus:ring-orange-500" />
  </div>
))}
```

After the user selects a Trigger and configures it, we can subscribe to that user's HubSpot events.

```typescript Subscribes to the Trigger theme={null}
// fetchActionKit appends the endpoint on ActionKit's base URL
export async function subscribeToTrigger(
  userId: string,
  integration: string,
  triggerType: string,
  parameters: Record<string, unknown>,
): Promise<TriggerSubscription> {
  const body: Record<string, unknown> = {
    integration,
    type: triggerType,
    parameters,
    webhookOverride: {
      url: process.env.WEBHOOK_ENDPOINT,
    }
  }
  return fetchActionKit(
    `/projects/${PROJECT_ID}/trigger-subscriptions`,
    userId,
    {
      method: "POST",
      body: JSON.stringify(body),
    }
  );
}

```

## 3. Kick Off an Agent with Tools Whenever a New Event Fires

Whenever a new HubSpot event occurs (new record, updated record, deleted record), Triggers will send a webhook to our `process.env.WEBHOOK_ENDPOINT`. That endpoint will kick off an agent with HubSpot Tools for followup work.

In the screenshot above, the custom prompt was:

```markdown theme={null}
When a new HubSpot contact is created, write a personalized email using the 
contact name and their company. Give a 1 sentence pitch on why Paragon's
ActionKit is a good fit for their product, and create a HubSpot engagement.
```

Our automated agent should use the `HUBSPOT_CREATE_ENGAGEMENT` Tool to perform its task.

First let's get pre-built tools for our agent using ActionKit's Tools API.

```typescript Get ActionKit Tools theme={null}
// fetchActionKit appends the endpoint on ActionKit's base URL
export async function listTools(
  userId: string,
  integration = "hubspot"
): Promise<Record<string, ToolDefinition[]>> {
  const data = await fetchActionKit(
    `/projects/${PROJECT_ID}/tools?integrations=${integration}&format=json_schema`,
    userId
  );
  return data.tools;
}
```

Next, we'll format these Tools per Vercel's ai-sdk specifications for their agent (you can format Tools for Vercel, LangChain, or any LLM API directly).

```typescript expandable theme={null}
import { tool, type ToolSet } from "ai";
import { z } from "zod";

async function getHubSpotTools(userId: string): Promise<ToolSet> {
  const toolsMap = await listTools(userId, "hubspot");
  const hubspotTools = toolsMap.hubspot ?? [];

  const tools: ToolSet = {};

  for (const t of hubspotTools) {
    const fn = t.function;
    const toolName = fn.name;

    const paramSchema: Record<string, z.ZodTypeAny> = {};
    if (fn.parameters && typeof fn.parameters === "object") {
      const props = (fn.parameters as { properties?: Record<string, { type?: string; description?: string }> }).properties ?? {};
      const required = (fn.parameters as { required?: string[] }).required ?? [];

      for (const [key, val] of Object.entries(props)) {
        let schema: z.ZodTypeAny = z.string();
        if (val.type === "number" || val.type === "integer") {
          schema = z.number();
        } else if (val.type === "boolean") {
          schema = z.boolean();
        } else if (val.type === "array") {
          schema = z.array(z.string());
        }
        if (!required.includes(key)) {
          schema = schema.optional();
        }
        if (val.description) {
          schema = schema.describe(val.description);
        }
        paramSchema[key] = schema;
      }
    }

    tools[toolName] = tool({
      description: fn.description ?? `HubSpot action: ${toolName}`,
      inputSchema: z.object(paramSchema),
      execute: async (params: Record<string, unknown>) => {
        console.log(`[Agent] Running tool: ${toolName}`, params);
        const result = await runTool(userId, toolName, params);
        return result;
      },
    });
  }

  return tools;
}
```

Now we can provide our ai-sdk agent with the formatted Tools.

```typescript expandable theme={null}
import { generateText, gateway, stepCountIs } from "ai";

export async function runAgent(
  userId: string,
  eventPayload: Record<string, unknown>,
  triggerType: string,
  userPrompt: string
): Promise<string> {
  const hubSpotTools = await getHubSpotTools(userId);
  const toolNames = Object.keys(hubSpotTools);

  const systemPrompt = `You are an AI agent that responds to HubSpot events. You have access to the following HubSpot tools: ${toolNames.join(", ")}.

When a HubSpot event occurs, use the event data along with the user's instructions to decide what actions to take. Call the appropriate tools to fulfill the user's request.

Always explain what you're doing and why. If you cannot fulfill the request with available tools, explain what's missing.

Current event type: ${triggerType}`;

  const eventDescription = `A HubSpot event just fired:
Event Type: ${triggerType}
Event Data: ${JSON.stringify(eventPayload, null, 2)}

User's instruction for this event: ${userPrompt}`;

  const { text } = await generateText({
    model: gateway("openai/gpt-5"),
    system: systemPrompt,
    prompt: eventDescription,
    tools: hubSpotTools,
    stopWhen: stepCountIs(10),
  });

  return text;
}
```

We now have a fully reactive agent that fires around the clock, using:

1. Triggers to "prompt" the agent to work whenever our users have their configured event fire
2. Tools to give our agent integration tools that can write back to the triggered integration or any other Paragon integration


# 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 alt="" />
</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 theme={null}
{
    "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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
npm install @useparagon/connect
```

The SDK can be imported in your client-side JavaScript files as a module:

```js theme={null}
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 theme={null}
{
	// 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.**

[`paragon.authenticate`](/apis/api-reference#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. You may reference [Installing the Connect SDK](/getting-started/installing-the-connect-sdk#setup) for a detailed explanation on how to use [`paragon.authenticate`](/apis/api-reference#authenticate).

```js theme={null}
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 theme={null}
paragon.connect("bamboohr");
```

<Frame>
  <img alt="" />
</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 theme={null}
  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 theme={null}
  // 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 alt="" />
</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 theme={null}
{
    "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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
npm install @useparagon/connect
```

The SDK can be imported in your client-side JavaScript files as a module:

```js theme={null}
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 theme={null}
{
	// 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.**

[`paragon.authenticate`](/apis/api-reference#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. You may reference [Installing the Connect SDK](/getting-started/installing-the-connect-sdk#setup) for a detailed explanation on how to use [`paragon.authenticate`](/apis/api-reference#authenticate).

```js theme={null}
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 theme={null}
paragon.connect("hubspot");
```

<Frame>
  <img alt="" />
</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 theme={null}
  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 theme={null}
  // 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 alt="" />
</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 theme={null}
{
    "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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
npm install @useparagon/connect
```

The SDK can be imported in your client-side JavaScript files as a module:

```js theme={null}
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 theme={null}
{
	// 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.**

[`paragon.authenticate`](/apis/api-reference#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. You may reference [Installing the Connect SDK](/getting-started/installing-the-connect-sdk#setup) for a detailed explanation on how to use [`paragon.authenticate`](/apis/api-reference#authenticate).

```js theme={null}
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 theme={null}
paragon.connect("marketo");
```

<Frame>
  <img alt="" />
</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 theme={null}
  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 theme={null}
  // 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 alt="" />
</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 theme={null}
{
    "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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
npm install @useparagon/connect
```

The SDK can be imported in your client-side JavaScript files as a module:

```js theme={null}
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 theme={null}
{
	// 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.**

[`paragon.authenticate`](/apis/api-reference#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. You may reference [Installing the Connect SDK](/getting-started/installing-the-connect-sdk#setup) for a detailed explanation on how to use [`paragon.authenticate`](/apis/api-reference#authenticate).

```js theme={null}
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 theme={null}
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 theme={null}
  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 theme={null}
  // 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 alt="" />
</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 theme={null}
{
    "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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
npm install @useparagon/connect
```

The SDK can be imported in your client-side JavaScript files as a module:

```js theme={null}
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 theme={null}
{
	// 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.**

[`paragon.authenticate`](/apis/api-reference#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. You may reference [Installing the Connect SDK](/getting-started/installing-the-connect-sdk#setup) for a detailed explanation on how to use [`paragon.authenticate`](/apis/api-reference#authenticate).

```js theme={null}
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 theme={null}
paragon.connect("slack");
```

<Frame>
  <img alt="" />
</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 theme={null}
  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 theme={null}
  // 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 alt="" />
</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 theme={null}
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 theme={null}
// 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 theme={null}
// 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 [`paragon.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 [`paragon.connect`](/apis/api-reference#connect) 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 alt="" />
</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 [`paragon.getUser`](/apis/api-reference#getuser), which returns the current state of the authenticated user from the SDK, including their connected integrations and enabled workflows.

```js theme={null}
// 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 alt="" />
</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 [`paragon.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 theme={null}
// 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 alt="" />
</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 [`paragon.getIntegrationMetadata`](/apis/api-reference#getintegrationmetadata) to get all available integrations in the project with name and icon information.
* You used [`paragon.getUser`](/apis/api-reference#getuser) to get the user's account status.
* You used [`paragon.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>
  <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 alt="" />
</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 alt="" />
</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 theme={null}
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 alt="" />
</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

## 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 alt="Setting up an API Resource in Paragon Connect" />
</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 alt="Choosing Authorization Methods for API Resources in Paragon Connect" />
</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 alt="Configuring OAuth 2.0 for API Resources in Paragon Connect" />
</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 alt="Configuring API Keys for API Resources in Paragon Connect" />
</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 alt="Configuring Request Details for API Resources in Paragon Connect" />
</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 alt="Testing and Finishing API Resources in Paragon Connect" />
</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 theme={null}
    await paragon.connectAction("Resource Name", {
        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 theme={null}
    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 alt="" />
      </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 alt="" />
</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" on the [Monitoring](/workflows/viewing-workflow-executions) page.

**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 on the [Monitoring](/workflows/viewing-workflow-executions#editing-and-replaying) page.


# 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 alt="" />
</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 alt="" />
</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 alt="" />
</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" />

**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 alt="" />
</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 alt="" />
</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 on the [Monitoring > Workflows](/workflows/viewing-workflow-executions) page, 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 alt="" />
</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 alt="" />
</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 Admin to manage Environment Secrets. [Learn more](/managing-account/teams#managing-roles-and-permissions).
</Note>

To set up Environment Secrets:

**1. Click on "Settings" in the sidebar, then click on "Environment Secrets".**

<Frame>
  <img alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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" />

To add a function to your workflow, click the "+" button in the workflow canvas and choose the Function step from the sidebar.

<Frame>
  <img alt="" />
</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 alt="" />
</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 theme={null}
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 alt="" />
</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.

## Using Field Mappings in functions

If you have configured a [Field Mapping User Setting](/connect-portal/field-mapping) for your integration, you can reference the mapping object in a Function step and use the built-in `paragonUtils` library to programmatically transform data between your application format and the integration format.

This is useful when you need more control over the transformation process than the built-in "Apply field mapping" option on triggers provides — for example, when transforming arrays of objects, applying additional logic during the mapping, or chaining mappings with other operations.

### Passing a field mapping to your function

<Frame>
  <img alt="Selecting field mapping variable" />
</Frame>

To use a field mapping in a Function step, pass it as a parameter:

1. In your Function step, add a parameter (e.g. `fieldMapping`).
2. Click the dropdown for the parameter value, navigate to **Connect Portal User Settings**, and select the **Mapping Configuration** for your field mapping.
3. You can then use the field mapping configuration value as `parameters.fieldMapping` in your Function step.

   Pass it to `paragonUtils.mapIntegrationObjects` or `paragonUtils.mapApplicationObjects` to apply the mapping to another value.

### Transforming data with `paragonUtils`

The `paragonUtils` library provides two functions for transforming data using a field mapping configuration:

<Tabs>
  <Tab title="mapIntegrationObjects">
    Transforms an array of **integration objects** into **application objects** using the field mapping. Use this when you receive data from an integration and need to convert it to your application's format.

    <Frame>
      <img alt="mapIntegrationObjects function step" />
    </Frame>

    **Parameters:**

    * `mapping` — The field mapping configuration object passed as a parameter from Connect Portal User Settings.
    * `integrationObjects` — An array of integration objects to transform.

    **Returns:** An array of application objects with fields renamed according to the mapping.

    ```js theme={null}
    function yourFunction(parameters, libraries) {
      const { paragonUtils } = libraries;
      const { fieldMapping, integrationObjects } = parameters;

      const applicationObjects = paragonUtils.mapIntegrationObjects(
        fieldMapping,
        integrationObjects
      );

      return { applicationObjects };
    }
    ```

    For example, if your field mapping maps a property `Subject` (integration field) to `title` (application field), an input of `[{ "Subject": "Buy groceries" }]` would produce `[{ "title": "Buy groceries" }]`.
  </Tab>

  <Tab title="mapApplicationObjects">
    Transforms an array of **application objects** into **integration objects** using the field mapping. Use this when you have data in your application's format and need to convert it for the integration.

    <Frame>
      <img alt="mapApplicationObjects function step" />
    </Frame>

    **Parameters:**

    * `mapping` — The field mapping configuration object passed as a parameter from Connect Portal User Settings.
    * `appObjects` — An array of application objects to transform.

    **Returns:** An array of integration objects with fields renamed according to the mapping.

    ```js theme={null}
    function yourFunction(parameters, libraries) {
      const { paragonUtils } = libraries;
      const { fieldMapping, applicationObjects } = parameters;

      const integrationObjects = paragonUtils.mapApplicationObjects(
        fieldMapping,
        applicationObjects
      );

      return { integrationObjects };
    }
    ```

    For example, if your field mapping maps `title` (application field) to `Subject` (integration field), an input of `[{ "title": "Buy groceries" }]` would produce `[{ "Subject": "Buy groceries" }]`.
  </Tab>
</Tabs>

Both functions support **Static** and **Dynamic** field mapping types. If the mapping or objects array is `null`, `undefined`, or not an array, the functions return an empty array.

## 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 theme={null}
{
  "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 alt="" />
</Frame>

You can see the status of your paused workflow on the [Monitoring > Workflows](/workflows/viewing-workflow-executions) page, 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.

* Confluence
* 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 alt="" />
</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 alt="" />
</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 alt="" />
</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" />

## 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" />


# 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 alt="Workflows Banner Pn" />
</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 alt="Workflow Builder" />
</Frame>

<Card title="Explore the Workflow Builder" href="/workflows/building-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-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 alt="Paragraph" />
</Frame>

<Card title="Explore Paragraph" href="/paragraph/getting-started" 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">
    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">
    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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
{
    "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 alt="" />
   </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 alt="" />
      </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 alt="" />
   </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>
  <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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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 theme={null}
    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 theme={null}
    // 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 alt="" />
</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 alt="" />
</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 view the workflow's execution in the [Monitoring > Workflows](/workflows/viewing-workflow-executions) page.
</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 alt="" />
</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" 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 alt="" />
</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 theme={null}
    // 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 theme={null}
    // 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 alt="" />
</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 alt="" />
</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 theme={null}
{
	"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 theme={null}
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 alt="" />
</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 alt="" />
</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 [Monitoring page](/workflows/viewing-workflow-executions).

* Link to view execution in Monitoring: `https://dashboard.useparagon.com/connect/projects/[Project ID]/monitoring/workflows/[Workflow ID]/executions/[Workflow Execution ID]`

**Example timeout response**

```json theme={null}
{
    "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 alt="" />
</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 alt="" />
</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 Delay
Source: https://docs.useparagon.com/workflows/using-delay

Pause a workflow for a fixed amount of time before continuing.

## Overview

The Delay step pauses a workflow for a fixed amount of time before running the next step. This is useful for scenarios like adding jitter between requests to avoid hitting an integration's rate limits, or waiting a few hours before sending a follow-up email.

To add a Delay to your workflow, click the "+" button in the Workflow Editor and choose Delay from the sidebar. Then, specify how long the workflow should wait before continuing.

<Frame>
  <img alt="" />
</Frame>

## Configuring a Delay

A Delay step takes two parameters:

* **Value**: how long to wait, as a number. This can be a static value or a [dynamic variable](/workflows/using-dynamic-variables) referencing data from a previous step.
* **Unit**: the unit of time for the value: Seconds, Minutes, Hours, or Days.

<Note>
  **Note:** When using Test Step or Test Workflow, Delay steps do not pause for the configured amount of time — they immediately continue the test execution.
</Note>

## Viewing delayed executions

While a workflow execution is paused on a Delay step, it appears with a **Waiting** status on the [Monitoring](/workflows/viewing-workflow-executions) page. Once the delay elapses, execution resumes automatically with the next step in the workflow.

## Billing

Delay steps do not count as [tasks](/billing/tasks). The maximum delay you can configure depends on your billing plan:

| Plan           | Maximum delay |
| -------------- | ------------- |
| **Trial**      | 30 days       |
| **Pro**        | 30 days       |
| **Enterprise** | 366 days      |


# 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 alt="" />
</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 alt="" />
</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 alt="" />
</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 alt="" />
</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>


# Viewing Workflow Executions
Source: https://docs.useparagon.com/workflows/viewing-workflow-executions

Review and debug workflow executions, including step-by-step breakdowns and failure details.

<Frame>
  <img alt="" />
</Frame>

##

Under the **Workflows** tab on the [Monitoring](/workflows/viewing-workflow-executions) page, 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>

## Filtering

Filtering allows you to view the history of specific workflows that meet the criteria you specify while hiding the others.

<Frame>
  <img alt="" />
</Frame>

You can filter workflow executions by:

* **User ID**
* **Status**
  * Queued
  * Running
  * Waiting
  * Success
  * Errored
  * Paused
  * Cancelled
* **Workflow name**
* **Integration name**
* **Date range**

## Detailed task execution

Each row on the Workflows tab includes a step-by-step breakdown of the steps related to the workflow. In this view, the execution detail also shows:

* How long it took your workflow to run
* Number of steps executed
* List of each executed step

<Frame>
  <img alt="" />
</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 alt="" />
</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>

## 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 alt="" />
</Frame>


# 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 theme={null}
// 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 theme={null}
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>
  <img alt="" />
</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 alt="" />
</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 alt="" />
</Frame>