Get Action by ID - HoopAI Help Center

GET

conversation-ai

agents

{agentId}

actions

{actionId}

Get Action by ID

curl --request GET \
  --url https://services.leadconnectorhq.com/conversation-ai/agents/{agentId}/actions/{actionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'

{
  "data": {
    "id": "actionId123",
    "name": "Trigger Workflow",
    "type": "triggerWorkflow",
    "details": {
      "workflowIds": [
        "workflow123",
        "workflow456"
      ],
      "triggerCondition": "When user requests appointment",
      "triggerMessage": "Workflow triggered successfully"
    },
    "agentId": "agentId123"
  },
  "success": true
}

Authorizations

Authorization

string

header

required

Access Token or Private Integration Token

Headers

Version

enum<string>

required

API Version

Available options:

2021-04-15

Path Parameters

actionId

string

required

The unique identifier of the action ID Attached to the agent

agentId

string

required

Response

Success

data

object

required

Action details

Show child attributes

success

boolean

required

Success status of the request

Example:

true

Last modified on March 7, 2026

List Actions for an Agent

Update Action

Get Action by ID

curl --request GET \
  --url https://services.leadconnectorhq.com/conversation-ai/agents/{agentId}/actions/{actionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'

{
  "data": {
    "id": "actionId123",
    "name": "Trigger Workflow",
    "type": "triggerWorkflow",
    "details": {
      "workflowIds": [
        "workflow123",
        "workflow456"
      ],
      "triggerCondition": "When user requests appointment",
      "triggerMessage": "Workflow triggered successfully"
    },
    "agentId": "agentId123"
  },
  "success": true
}