API Reference

Authorization

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

For AI Agents

Actions Reference

API Reference

Authorization

Endpoints

List Actions

Run Action

ActionKit

For AI Agents

API Reference

Actions Reference

​Authorization

​Endpoints

​List Actions

​Run Action

Authorization

Endpoints

List Actions

Run Action