create

5min

This call creates a trigger. The arguments that must be included in the doc are described below:
Basic parameters
Name
Type
Required
Description
action
string
true
create
group_id
integer
true
The project the product is in
doc
array
false
See doc parameters below
Doc Parameters
Name
Type
Required
Description
reverse_trigger
boolean
false
If the user first meets a trigger condition and then later changes a value so the condition is not met, True will ensure the product is removed from the cart. This is generally the behavior you'd expect, and the default is True.
action
associative array
true
Contains two variables product_id and action_type; see below for more. 
Ex. 
{
"action": {
 product_id: [1, 2, etc...],
 action_type:    
  "show_prod_in_list"
 }
}
product_id
array
true
A list of product id's you'd like the trigger to be set for. 
action_type
string
true
One of four actions the product can take when the trigger condition is met:
add_product_no_show: This adds the product to the user's cart automatically when the conditions are met. Additionally it ensures that users who do not meet the condition can not select the product on the  product selection widget. When adding automatically to a user, this is the most common option. 
show_prod_in_list: The product shows in the product selection widget where the user has the option can select it.
remove_prod_from_list: Ensures that the product does not appear for users to select on the product selection widget.
add_product: This adds the product automatically if they meet the conditions, but also shows the product to users who do not meet the condition on the product selection widget.
conditions
associative array
true
Contains two variables andor and condition_list; see below for more.
Ex.
"conditions": {
 "andor": "and",
 "condition_list": [
  {
   "field_id": "instrument",                                 
   "field_value": "guitar"
  },
  {
   etc...
  }
 ]
}
andor
string
true
When setting a trigger you can include one or more conditions. If adding multiple, "and" means all of the conditions must me true while "or" means that only one of the conditions must be true. Default is "and".
condition_list
array
true
This is an array of associative arrays, each of which describes the trigger condition which must be met. 
To trigger on a field, you include field_id and field_value.
To trigger on a status being applied to a user, you include status_id and action. action only has one argument, "set_status". This is met when a status is applied to a user. 
To trigger on the addition of some other product, include product_id and action. action only has one argument, "product_added". This is met when a product is added to a users cart, either through the API, manually by an admin, or by the user. 
Values are case sensitive.
﻿
﻿
Example
Call
Curl
Python
curl -X POST "https://www.regpack.com/reg/api2/triggers/" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -H "Api-Id: 15263" \
     -H "Api-user: [email protected]" \
     -H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \
     -d '{
    "action": "create",
    "group_id": 1625251,
    "doc": {
        "reverse_trigger": true,
        "action": {
            "product_id": "2767021", 
            "action_type": "add_product_no_show"
        },
        "conditions": {
            "andor": "and",
            "condition_list": [
                {
                    "field_id": "f_349514_4451053", 
                    "field_value": "guitar"
                },
                {
                    "product_id": "2594110", 
                    "action": "product_added"
                },
                {
                    "status_id": "90809", 
                    "action": "set_status"
                }
            ]
        }
    }
}'

curl -X POST "https://www.regpack.com/reg/api2/triggers/" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -H "Api-Id: 15263" \
     -H "Api-user: api_admin@regpacks.com" \
     -H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \
     -d '{
    "action": "create",
    "group_id": 1625251,
    "doc": {
        "reverse_trigger": true,
        "action": {
            "product_id": "2767021", 
            "action_type": "add_product_no_show"
        },
        "conditions": {
            "andor": "and",
            "condition_list": [
                {
                    "field_id": "f_349514_4451053", 
                    "field_value": "guitar"
                },
                {
                    "product_id": "2594110", 
                    "action": "product_added"
                },
                {
                    "status_id": "90809", 
                    "action": "set_status"
                }
            ]
        }
    }
}'
﻿
Response
JSON
{
  "undo_trigger": true,
  "action": {
    "action_vars": {
      "product_id": "1654403"
    },
    "action_type": "add_product_no_show"
  },
  "log_conds": {
    "andor": "and",
    "conditions": [
      {
        "log_ex_id": "field_set_to",
        "vars": {
          "field_id": "f_349514_4451053",
          "field_value": "guitar"
        }
      },
      {
        "log_ex_id": "product_added",
        "vars": {
          "product_id": "745947"
        },
        "multi_id": "multi_product_added_745947"
      },
      {
        "log_ex_id": "set_status",
        "vars": {
          "status_id": "70418"
        },
        "multi_id": "multi_set_status_70418"
      }
    ]
  },
  "text_qv": " <span class=\"fs_wrap\">  <span class=\"filter_name\">Rate Type</span>  <em>is</em>  <span class=\"answer\"><span class=\"val\">Bucket Rate </span></span> <a href=\"javascript;\" class=\"fs_delete\" rel=\"f231\"></a> </span> <span class=\"fs_wrap\">  <span class=\"filter_name\">Administrator License - 12 month - Legacy Price - Business Package</span>  <em>is</em>  <span class=\"answer\"><span class=\"val\">added to user cart</span></span> <a href=\"javascript;\" class=\"fs_delete\" rel=\"multi_product_added_745947\"></a> </span> <span class=\"fs_wrap\">  <span class=\"filter_name\">Status is: Active</span>  <a href=\"javascript;\" class=\"fs_delete\" rel=\"multi_set_status_70418\"></a> </span>",
  "ui_obj": [
    {
      "trigger_id": "mongo_text_search",
      "vars": [
        {
          "rate_type": "guitar"
        }
      ]
    },
    {
      "trigger_id": "product_logs",
      "multi_id": "multi_product_added_745947",
      "vars": [
        {
          "log_ex_id": "product_added"
        },
        {
          "trigger_vars": "{\"product_id\":\"745947\"}"
        }
      ]
    },
    {
      "trigger_id": "set_status_log",
      "vars": [
        {
          "log_ex_id": "set_status"
        },
        {
          "trigger_vars": "{\"status_id\":\"70418\"}"
        }
      ]
    }
  ],
  "group_id": "1625251",
  "_id": "100906231_1656649",
  "creation_date": {
    "sec": 1729011822,
    "usec": 42000
  },
  "trig_action_cond_level": "parent_condition_child_condition_child_action",
  "success": true
}

{
  "undo_trigger": true,
  "action": {
    "action_vars": {
      "product_id": "1654403"
    },
    "action_type": "add_product_no_show"
  },
  "log_conds": {
    "andor": "and",
    "conditions": [
      {
        "log_ex_id": "field_set_to",
        "vars": {
          "field_id": "f_349514_4451053",
          "field_value": "guitar"
        }
      },
      {
        "log_ex_id": "product_added",
        "vars": {
          "product_id": "745947"
        },
        "multi_id": "multi_product_added_745947"
      },
      {
        "log_ex_id": "set_status",
        "vars": {
          "status_id": "70418"
        },
        "multi_id": "multi_set_status_70418"
      }
    ]
  },
  "text_qv": " <span class=\"fs_wrap\">  <span class=\"filter_name\">Rate Type</span>  <em>is</em>  <span class=\"answer\"><span class=\"val\">Bucket Rate </span></span> <a href=\"javascript;\" class=\"fs_delete\" rel=\"f231\"></a> </span> <span class=\"fs_wrap\">  <span class=\"filter_name\">Administrator License - 12 month - Legacy Price - Business Package</span>  <em>is</em>  <span class=\"answer\"><span class=\"val\">added to user cart</span></span> <a href=\"javascript;\" class=\"fs_delete\" rel=\"multi_product_added_745947\"></a> </span> <span class=\"fs_wrap\">  <span class=\"filter_name\">Status is: Active</span>  <a href=\"javascript;\" class=\"fs_delete\" rel=\"multi_set_status_70418\"></a> </span>",
  "ui_obj": [
    {
      "trigger_id": "mongo_text_search",
      "vars": [
        {
          "rate_type": "guitar"
        }
      ]
    },
    {
      "trigger_id": "product_logs",
      "multi_id": "multi_product_added_745947",
      "vars": [
        {
          "log_ex_id": "product_added"
        },
        {
          "trigger_vars": "{\"product_id\":\"745947\"}"
        }
      ]
    },
    {
      "trigger_id": "set_status_log",
      "vars": [
        {
          "log_ex_id": "set_status"
        },
        {
          "trigger_vars": "{\"status_id\":\"70418\"}"
        }
      ]
    }
  ],
  "group_id": "1625251",
  "_id": "100906231_1656649",
  "creation_date": {
    "sec": 1729011822,
    "usec": 42000
  },
  "trig_action_cond_level": "parent_condition_child_condition_child_action",
  "success": true
}
﻿
﻿

Name	Type	Required	Description
action	string	true	create
group_id	integer	true	The project the product is in
doc	array	false	See doc parameters below

Name	Type	Required	Description
reverse_trigger	boolean	false	If the user first meets a trigger condition and then later changes a value so the condition is not met, True will ensure the product is removed from the cart. This is generally the behavior you'd expect, and the default is True.
action	associative array	true	Contains two variables product_id and action_type; see below for more. Ex. { "action": { product_id: [1, 2, etc...], action_type: "show_prod_in_list" } }
product_id	array	true	A list of product id's you'd like the trigger to be set for.
action_type	string	true	One of four actions the product can take when the trigger condition is met: add_product_no_show: This adds the product to the user's cart automatically when the conditions are met. Additionally it ensures that users who do not meet the condition can not select the product on the product selection widget. When adding automatically to a user, this is the most common option. show_prod_in_list: The product shows in the product selection widget where the user has the option can select it. remove_prod_from_list: Ensures that the product does not appear for users to select on the product selection widget. add_product: This adds the product automatically if they meet the conditions, but also shows the product to users who do not meet the condition on the product selection widget.
conditions	associative array	true	Contains two variables andor and condition_list; see below for more. Ex. "conditions": { "andor": "and", "condition_list": [ { "field_id": "instrument", "field_value": "guitar" }, { etc... } ] }
andor	string	true	When setting a trigger you can include one or more conditions. If adding multiple, "and" means all of the conditions must me true while "or" means that only one of the conditions must be true. Default is "and".
condition_list	array	true	This is an array of associative arrays, each of which describes the trigger condition which must be met. To trigger on a field, you include field_id and field_value. To trigger on a status being applied to a user, you include status_id and action. action only has one argument, "set_status". This is met when a status is applied to a user. To trigger on the addition of some other product, include product_id and action. action only has one argument, "product_added". This is met when a product is added to a users cart, either through the API, manually by an admin, or by the user. Values are case sensitive.

Updated 05 Nov 2024

Did this page help you?

Triggers

Projects