Trigger Actions

List Triggers

get/trigger-actions

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/trigger-actions
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Query parameters

skipnumber
limitnumber nullable

Max number of results allowed per page is: 100

direction'older' | 'newer' nullable
datestring
conversation_idstring

Conversation ID to filter trigger actions by. If provided, returns all trigger-action records that have at least one action matching this conversation_id. The entire trigger-action record is returned intact, including all actions (even those that do not match the conversation_id).

Response

total_resultsnumber required

Example response

{
  "results": [
    {
      "actions": [
        {
          "action_id": "run_ai_prompt",
          "entity_type": "ai_prompt",
          "metadata": {
            "conversation_id": "channel_123",
            "send_as_bot": true,
            "message": "Daily standup reminder!",
            "links": [
              "https://pxassets.s3.us-east-2.amazonaws.com/images/v2/logo.png",
              "https://pxassets.s3.us-east-2.amazonaws.com/images/v2/Personal+CarbonLink.svg",
              "https://www.youtube.com/watch?v=36Tn5cektlg"
            ]
          }
        }
      ],
      "filters": [
        {
          "key": "name",
          "operator": "eq"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.