Skip to main content
GET
/
trigger
/
list
List all chatbot triggers
curl --request GET \
  --url https://api.wppfy.com/trigger/list \
  --header 'token: <api-key>'
[
  {
    "type": "agent",
    "agent_id": "<string>",
    "id": "<string>",
    "active": true,
    "quickReply_id": "<string>",
    "ignoreGroups": true,
    "lead_field": "lead_name",
    "lead_operator": "equals",
    "lead_value": "<string>",
    "priority": 1,
    "wordsToStart": "<string>",
    "responseDelay_seconds": 10,
    "owner": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
token
string
header
required

Response

List of triggers returned successfully

​
type
enum<string>
default:agent
required

Tipo do trigger:

  • agent - aciona um agente de IA
  • quickreply - aciona respostas rápidas predefinidas
Available options:
agent,
quickreply
​
agent_id
string
required

ID do agente de IA. Obrigatório quando type='agent'

​
id
string

Identificador único do trigger. Se definido, você irá editar ou deletar o trigger. Se vazio, um novo trigger será criado.

​
active
boolean
default:true

Define se o trigger está ativo e disponível para uso. Triggers inativos não serão executados pelo sistema.

​
quickReply_id
string

ID da resposta rápida. Obrigatório quando type='quickreply'

​
ignoreGroups
boolean
default:true

Define se o trigger deve ignorar mensagens de grupos

​
lead_field
enum<string>

Campo do lead usado para condição do trigger

Available options:
lead_name,
lead_fullName,
lead_email,
lead_personalid,
lead_status,
lead_tags,
lead_notes,
lead_isTicketOpen,
lead_field01,
lead_field02,
lead_field03,
lead_field04,
lead_field05,
lead_field06,
lead_field07,
lead_field08,
lead_field09,
lead_field10,
lead_field11,
lead_field12,
lead_field13,
lead_field14,
lead_field15,
lead_field16,
lead_field17,
lead_field18,
lead_field19,
lead_field20
​
lead_operator
enum<string>

Operador de comparação para condição do lead:

  • equals - igual a
  • not_equals - diferente de
  • contains - contém
  • not_contains - não contém
  • greater - maior que
  • less - menor que
  • empty - vazio
  • not_empty - não vazio
Available options:
equals,
not_equals,
contains,
not_contains,
greater,
less,
empty,
not_empty
​
lead_value
string

Valor para comparação com o campo do lead. Usado em conjunto com lead_field e lead_operator

​
priority
integer<int64>
default:1

Prioridade do trigger. Quando existem múltiplos triggers que poderiam ser acionados, APENAS o trigger com maior prioridade será executado. Se houver múltiplos triggers com a mesma prioridade mais alta, um será escolhido aleatoriamente.

​
wordsToStart
string

Palavras-chave ou frases que ativam o trigger. Múltiplas entradas separadas por pipe (|). Exemplo: olá|bom dia|qual seu nome

​
responseDelay_seconds
integer<int64>
default:10

Tempo de espera em segundos antes de executar o trigger

​
owner
string

Identificador do proprietário do trigger

​
created
string<date-time>

Data e hora de criação

​
updated
string<date-time>

Data e hora da última atualização