Triggers API

Available Endpoints

Endpoints

GET/api/v1/triggers

GET/api/v1/triggers/{id}

PUT/api/v1/triggers/{id}

DELETE/api/v1/triggers/{id}

The Trigger Object

id string

System-generated unique identifier

created_at string

Created at in specified timezone

created_at_string string

Created at formatted as human-readable string

created_at_utc string

Created at in UTC

description string

Short description for the trigger

event string

Event type that activates this trigger

groups array

Permission groups for this trigger

hook_id string

Hook identifier for the trigger

icon object

Icon configuration for the trigger

object string

Object type identifier

on boolean

Whether the trigger is enabled

processed_count integer

Number of times this trigger has been processed

title string

Display title for the trigger

data_input_schema array

Data input schema for the trigger

Trigger Object

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
  "id": "01980228-a93d-7c3b-97e9-aeba6a285cf1",
  "created_at": "2025-07-13T01:01:15-04:00",
  "created_at_string": "Jul 13, 2025 01:01 am EDT",
  "created_at_utc": "2025-07-13T05:01:15Z",
  "data_input_schema": [
    {
      "variable": "user_name",
      "data_path": "user['primary']['name']",
      "display_label": "User name",
      "format": null,
      "groups": [],
      "list_values_variable": null,
      "object": "data_type",
      "required": true,
      "source": "trigger",
      "type": "String",
      "value": null
    },
    {
      "variable": "zip_code",
      "data_path": "addresses[0]['zip']",
      "display_label": "Zip code",
      "format": null,
      "groups": [],
      "list_values_variable": null,
      "object": "data_type",
      "required": true,
      "source": "trigger",
      "type": "String",
      "value": null
    },
    {
      "variable": "title",
      "data_path": "title",
      "display_label": "Title",
      "format": null,
      "groups": [],
      "list_values_variable": null,
      "object": "data_type",
      "required": true,
      "source": "trigger",
      "type": "String",
      "value": null
    }
  ],
  "description": "A new lead signs up",
  "event": "new_lead",
  "groups": [],
  "hook_id": "f8be405c-b163-4d45-9718-6c1eb1c15ef3",
  "icon": {},
  "object": "trigger",
  "on": true,
  "processed_count": 0,
  "title": "New Lead"
}