---
title: "Get Trigger"
method: GET
path: "/trigger-actions/{id}"
tags: ["Trigger Actions"]
---

# Get Trigger

`GET /trigger-actions/{id}`

## Request

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

## Path parameters

- `id` string, required

## Response `200`

- TriggerAction
  - `created_at` string, date-time, required: The date and time at which the resource was created.
  - `updated_at` string, date-time, required: The date and time at which the resource was last updated.
  - `id` string, required: The primary key of the resource.
  - `client_id` string, required
  - `user_id` string, required
  - `trigger` 'message.posted.to.channel' | 'schedule', required
  - `actions` SubscriptionAction[]
    - `action_id` 'run_ai_prompt' | 'send_channel_message_reminder', required: What is the action to perform
    - `entity_type` 'ai_prompt' | 'channel_reminder': What is the entity_type to perform the action on (required when entity_id is provided)
    - `entity_id` string: What is the entity_id to perform the action on (required when entity_type is provided)
    - `metadata` ActionMetadata
      - `conversation_id` string: The conversation/channel ID where the reminder message should be sent
      - `send_as_bot` boolean: Whether the message should be sent as a bot. If true, bot_user_id should be provided
      - `message` string: The message text to send. Either message or from_message_id must be provided
      - `links` string[]: Array of links to be attached to the message
  - `filters` SubscriptionFilter[]
    - `key` string, required: What is the key to filter the data before sending to the webhook
    - `value` union, required: Must match `operator`: use a string or number for "eq" and "ne"; use a non-empty array only for "in".
      - string
      - number
      - string[]
    - `operator` 'eq' | 'ne' | 'in', required: What is the operator to filter the data
  - `run_on_short_message` boolean: Defines if Trigger Action should run on short message
  - `rrule` string: RRULE string for SCHEDULE triggers

## Other responses

- `403`
- `404`

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)