Overview

ActionKit allows you to call one-off Integration Actions for your users (like Salesforce: Create Record or Google Drive: Get Files), without building and deploying specific workflows.

The 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

ActionKit can also be used to allow your users to configure their own automations in your app using available Actions or to build UI components in your app powered by Actions, like displaying a table of Salesforce opportunities or a dropdown to select Jira projects.

Getting Started

Need help getting started with ActionKit? Schedule a personalized onboarding with our Product team here.

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

1. Add the Paragon SDK to your app

See Installing the 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.

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

ActionKit Playground: an open-source sandbox to test chatting with an agent that has access to ActionKit tools
Hosted Demo Environment: an in-browser implementation of the SDK to test connecting accounts to your integrations

2. Activate an ActionKit integration in your Paragon project

You can add and configure an integration by visiting the Catalog page in your Paragon dashboard (see Adding Integrations).

See 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.

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.

Once an account is connected, you can start testing the API described below 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 with any LLM that supports tool/function calling.

Base URL

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

For on-premise instances

Authentication

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

Authorization: Bearer [Paragon User Token]

This is the same token that you used to call .authenticate with the Paragon SDK. See examples in Installing the SDK.

Endpoints

List Actions

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

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

URL

GET /actions

Parameters

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

Output

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

Example response

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

Run Action

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

URL

POST /actions

Request body

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

Example response

Note: Responses will vary by integration provider. Paragon returns the API response of the last request that was used to run this Action.

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

Example Error

ActionKit

Building with ActionKit

Reference

Getting Started

1. Add the Paragon SDK to your app

2. Activate an ActionKit integration in your Paragon project

3. Connect an account

Usage

Endpoints

List Actions

Run Action

ActionKit

Building with ActionKit

Reference

​Getting Started

​1. Add the Paragon SDK to your app

​2. Activate an ActionKit integration in your Paragon project

​3. Connect an account

​Usage

​Endpoints

​List Actions

​Run Action

Getting Started

1. Add the Paragon SDK to your app

2. Activate an ActionKit integration in your Paragon project

3. Connect an account

Usage

Endpoints

List Actions

Run Action