Skip to main content

StageTriggeredMessageRead

A message automatically sent when a lead enters a specific pipeline stage. Scheduled by a background worker after the stage change.

idIdrequired

Unique numeric identifier of the record.

product_idProduct Idrequired

ID of the product (workspace) that owns this record. Most endpoints scope access by product.

stage_idStage Idrequired

ID of the pipeline stage.

agent_idAgent Idrequired

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

is_activeIs Activerequired

Whether the trigger is active.

config objectrequired

The trigger configuration (delay and message source).

delay_minutesDelay Minutes

Minutes to wait after the stage change before sending.

Default value: 0
source objectrequired

Specifies the content of a message to send, by reference to exactly one source — raw text, a prompt, a prepared message, a WABA template, or file(s).

text object
anyOf
string
prompt_id object
anyOf
integer
prompt_version_id object
anyOf
integer
prepared_message_id object
anyOf
integer
waba_template_id object
anyOf
integer
file_idsinteger[]
caption object
anyOf
string
created_atdate-timerequired

Creation time (UTC, ISO 8601).

StageTriggeredMessageRead
{
  "id": 0,
  "product_id": 0,
  "stage_id": 0,
  "agent_id": 0,
  "is_active": true,
  "config": {
    "delay_minutes": 0,
    "source": {
      "text": "string",
      "prompt_id": 0,
      "prompt_version_id": 0,
      "prepared_message_id": 0,
      "waba_template_id": 0,
      "file_ids": [
        0
      ],
      "caption": "string"
    }
  },
  "created_at": "2024-07-29T15:51:28.071Z"
}