The items explained below are the component parts of the ckbk standard. They allow the triggers, conditions and actions to correctly reference variables, fields and identifiers. These allow Recipes to make comparisons and data assignments on a simple level thereby providing the building blocks to more complex automations.
nextTriggerTime
"data": {
"nextTriggerTime": 1577899800
}
Description Sets the absolute time that the Recipe should be triggered.
Links
Parameters Set to a single Unix timestamp value
scheduleType
"data": {
"scheduleType": "WEEKLY"
}
Description Sets the unit of frequency of a recurring Recipe trigger.
Links
Parameters Set to a string within:
DAILY WEEKLY
###repeatFrequency
"data": {
"repeatFrequency": 1
}
Description Sets the number frequency of a recurring Recipe trigger.
Links
Parameters Set to an Integer value
dayOfWeek
"data": {
"dayOfWeek": "MONDAY"
}
Description The day that the Recurring Trigger should recur on if set to WEEKLY.
Links
Parameters Set to a string within:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
hourOfDay
"data": {
"hourOfDay": 9
}
Description Is the hour that the Recipe should be triggered.
Links
Parameters Set to a whole Integer value within 0 and 23.
minuteOfHour
"data": {
"minuteOfHour": 0
}
Description Is the minute value that the Recipe should be triggered, either on the hour (:00) or on the half hour (:30).
Links
Parameters Set to an Integer value within:
- 0
- 30
callingRecipeIds
"data": {
"callingRecipeIds": [
22
]
}
Description Is set for a Recipe that is triggered by another Recipe. The stored value is simply the numerical id of the Recipe that triggers this Recipe.
Links
Parameters Set to a whole Integer value.
messageContainsText
"data": {
"messageContainsText": "Contains these words"
}
Description Holds the contents of the text to compare to.
Links
Parameters Set to a String.
prefixText
"data": {
"prefixText": "Begins with this text"
}
Description Holds the contents of the text to compare to the start of any given field.
Links
Parameters Set to a String.
numberContainsText
"data": {
"numberContainsText": "555"
}
Description Holds the contents of the number to compare any given field.
Links
Parameters Set to a whole Integer value.
interactionIdentifier
"data": {
"interactionIdentifier": "${trigger.sourceNumber}"
}
Description Holds the reference to the object that a Condition is testing against.
Links
- MessageTextReceivedWithinPeriodRule
- MessageTextSentWithinPeriodRule
- MissedCallReceivedWithinPeriodRule
- timeUnits
- timeUnitType
Parameters Set to a String which can refer to specific variables.
timeUnits
"data": {
"timeUnits": "2"
}
Description Sets the amount of time as used by other variables.
Links
- MessageTextReceivedWithinPeriodRule
- MessageTextSentWithinPeriodRule
- MissedCallReceivedWithinPeriodRule
- timeUnitType
Parameters Set to a whole Integer value.
timeUnitType
"data": {
"timeUnitType": "days"
}
Description Sets the unit of time as used by other variables.
Links
- MessageTextReceivedWithinPeriodRule
- MessageTextSentWithinPeriodRule
- MissedCallReceivedWithinPeriodRule
- timeUnits
Parameters Set to a string within:
- minutes
- hours
- days
groupName
"data": {
"groupName": "Friends"
}
Description Holds the named value of a reference to a Group.
If, on import of a cookbook set, a reference to a Group exists but does not in the target workspace then a Group with specified name will be created in order to be used by the recipes.
Links
Parameters Any String value.
connectionName
"data": {
"connectionName": "Alex's Modem"
}
Description Holds the named value of a reference to a Connection.
Links
Parameters Any String value.
customFieldName
"data": {
"customFieldName": "friends"
}
Description Holds the named value of a reference to a Contact’s Custom Field.
Links
Parameters Any String value
valueToCompare
"data": {
"valueToCompare": true
}
Description Holds the value that will be compared to a String or Boolean field.
Links
Parameters Any String value, or unquoted Boolean value:
- true
- false
stringToCompare
"data": {
"stringToCompare": "10"
}
Description Holds the value that will be compared to a String or Integer field.
Links
Parameters Any String value.
operator
"data": {
"operator": "LESS_THAN"
}
Description Is an operator that is used to compare values against each other.
Links
Parameters A String value within:
- LESS_THAN
- GREATER_THAN
- EQUALS
tagName
"data": {
"tagName": "custom tag"
}
Description Holds a reference to a Tag.
Links
Parameters Any String value.
messageText
"data": {
"messageText": "Message content ${sender_name}"
}
Description Holds the value of a message that could be sent.
Links
Parameters Any String value.
recipients
"data": {
"recipients": {
"contacts": [
"+123456789"
],
"groups": [
"Friends"
],
"smartGroups": [
"Kenyans"
],
"addresses": [
"${trigger.sourceNumber}"
]
}
}
Description Holds an array of different target recipients for an Action. There are four sets of values; Contacts, Groups, Smart Groups and addresses.
Links
Parameters Four arrays named:
- contacts
- groups
- smartGroups
- addresses
contacts
"data": {
"recipients": {
"contacts": [
"+123456789"
]
}
}
Description Holds a set of directly referenced Contacts through their address, usually phone number.
Links
Parameters Any array of String values.
groups
"data": {
"recipients": {
"groups": [
"Friends"
]
}
}
Description Holds a set references to Groups.
Links
Parameters Any array of String values.
smartGroups
"data": {
"recipients": {
"smartGroups": [
"Kenyans"
]
}
}
Description Holds a set references to Smart Groups.
Links
Parameters Any array of String values.
addresses
"data": {
"recipients": {
"addresses": [
"${trigger.sourceNumber}"
]
}
}
Description Holds a set variables stored for when executed in an Action.
Links
Parameters Any array of String values.
fieldName
"data": {
"fieldName": "notes"
}
Description Holds the named value of a reference to a Contact record’s field.
Links
Parameters Any String value within:
- “name”
- “mobile”
- “email”
- “notes”
- “addToNotes”
- a reference to a custom field’s name
fieldValue
"data": {
"fieldValue": ""
}
Description Holds the value that will be set to a field or variable.
Links
Parameters Any String value.
operation
"data": {
"operation": "SET_TRUE"
}
Description Is an operation that is used to set values from one set of fields to another. There are three Boolean operations available; TOGGLE which inverts the value of the field (true->false, false->true), SET_TRUE which overwrites the value with a true Boolean value, and SET_FALSE which overwrites the value with a false Boolean value. There are also three Integer operations; SET_TO which overwrites the current value of the target, INCREMENT which adds 1 to the current value (assumes initial value to be 0 if blank), and DECREMENT which subtracts 1 from the current value (assumes initial value to be 0 if blank).
Links
Parameters A String value within:
- TOGGLE
- SET_TRUE
- SET_FALSE
- INCREMENT
- DECREMENT
- SET_TO
recipeToTriggerId
"data": {
"recipeToTriggerId": 459,
}
Description References the ID of a recipe.
Links
Parameters A integer value.
0 Comments