Functions | Docs

Text

Function	Summary
`APPEND`	Joins two or more pieces of text together.
`BYTESIZE`	Counts the number of bytes in a string.
`CAPITALIZE`	Makes the first character of text uppercase and converts the remaining characters to lowercase.
`DEFAULT`	Allows you to specify a fallback in case a value doesn’t exist. Returns the fallback value if the input is `null`, `false`, an empty text value or an empty array.
`DOWNCASE`	Makes each character in text lowercase.
`ESCAPE`	Escapes text by replacing characters with escape sequences (e.g. so that the text can be used in a URL)
`ESCAPE_ONCE`	Escapes text without changing existing escaped entities.
`FORCE_ARRAY`	If the supplied argument is an array it returns it, otherwise wraps it in an array
`HTML_DECODE`	Converts escaped characters in text to HTML syntax characters, e.g. `<élan>` becomes `<élan>`.
`HTML_ENCODE`	Escapes HTML syntax characters in text, e.g. `<élan>` becomes `<élan>`.
`INCLUDES`	Returns `TRUE` if target (which can be text, an object or an array) includes value, otherwise returns `FALSE`.
`INDEX_OF`	Returns the index of the specified term within the provided string or array. With arrays you provide a LAMBDA as the second argument.
`IS_BLANK`	Returns true if a value is falsy ie. `FALSE`, `""`, `[]`, `{}`, `NULL`, and false otherwise
`IS_EMPTY`	Returns true if a value is empty ie. `""`, `[]`, `{}` and false otherwise
`LAST_INDEX_OF`	Returns the last index of the specified term within the provided string or array. With arrays you provide a LAMBDA as the second argument.
`LEGACY_STRINGIFY`	Converts an object parameter to a legacy String representation.
`LEVENSHTEIN_DISTANCE`	Compute the Levenshtein distance between two strings.
`LSTRIP`	Removes all whitespace (tabs, spaces, and newlines) from the beginning of text. Does not affect spaces between words.
`MATCH`	Returns true if text contains the regex expression regex_to_match and false otherwise.
`NEWLINE_TO_BR`	Replaces every newline (\n) with an HTML line break (<br>).
`PLURALIZE`	Outputs the singular or plural version of text based on the value of a number.
`PREPEND`	Adds the specified text to the beginning of the other text.
`REGEX_EXTRACT`	Returns an array of all the regex matches on the input text.
`REGEX_REPLACE`	Replaces every occurrence of a regex match in text with the second argument.
`REMOVE`	Removes every occurrence of the specified sub-text from text.
`REMOVE_FIRST`	Removes the first occurrence of the specified sub-text from text.
`REPLACE`	Replaces every occurrence of the search text with the replacement text.
`REPLACE_FIRST`	Replaces the first occurrence of the search text with the replacement text.
`RSTRIP`	Removes all whitespace (tabs, spaces, and newlines) from the right side of text.
`SIZE`	Returns the number of characters in text or the number of elements in an array.
`SLICE`	Returns 1 or `length` characters from a piece of text, beginning at the `start_index`.
`SPLIT`	Divides the input text into an array using the delimiter as a separator
`STRIP`	Removes all whitespace (tabs, spaces, and newlines) from both the left and right side of text. It does not affect spaces between words.
`STRIP_HTML`	Removes any HTML tags from text.
`STRIP_NEWLINES`	Removes any newline characters (line breaks) from text.
`TEXT`	Converts the passed value to text.
`TO_SNAKE_CASE`	Turn input text into snake case.
`TRANSLITERATE`	Replaces non-ASCII characters with an ASCII approximation, or if none exists, a replacement character: “?”.
`TRUNCATE`	Shorten text down to the number of characters passed as a parameter. If the number of characters specified is less than the length of the text, `...` is appended to the text and is included in the character count.
`TRUNCATEWORDS`	Shortens text down to the number of words passed as the argument. If the specified number of words is less than the number of words in the text, `...` is appended to the text.
`UPCASE`	Makes each character in text uppercase.
`URL_DECODE`	Decodes text that has been encoded as a URL or by `URL_ENCODE`.
`URL_ENCODE`	Converts any URL-unsafe characters in the given text into percent-encoded characters.
`UUID`	Generates a universally unique identifier (UUID)

TRUE/FALSE

Function	Summary
`AND`	Returns `TRUE` if all arguments are truthy, otherwise returns `FALSE`.
`DEFAULT`	Allows you to specify a fallback in case a value doesn’t exist. Returns the fallback value if the input is `null`, `false`, an empty text value or an empty array.
`IF`	If `condition` is `TRUE` returns second argument, if `FALSE` returns `null` or the third argument.
`IS_BLANK`	Returns true if a value is falsy ie. `FALSE`, `""`, `[]`, `{}`, `NULL`, and false otherwise
`NOT`	Returns the logical opposite of the supplied param.
`OR`	Returns true if any of the arguments are truthy, otherwise returns false.

Numbers

Function	Summary
`ABS`	Returns the absolute value of a number.
`ACOS`	Computes the arc cosine of x (in radians), returning a number between 0 and π
`ASIN`	Computes the arc sine of x (in radians), returning a number between -π/2 and π/2
`AT_LEAST`	Limits a number to a minimum value.
`AT_MOST`	Limits a number to a maximum value.
`CEIL`	Rounds the input up to the nearest whole number.
`COS`	Computes the cosine of x (in radians), returning a number between -1 and 1
`DIVIDED_BY`	Divides a number by the specified number.
`FLOOR`	Rounds a number down to the nearest whole number.
`IS_BLANK`	Returns true if a value is falsy ie. `FALSE`, `""`, `[]`, `{}`, `NULL`, and false otherwise
`MAX`	Returns the argument with the highest numeric value. Can either be called with a single argument which must be an array or multiple arguments
`MIN`	Returns the argument with the lowest numeric value. Can either be called with a single argument which must be an array or multiple arguments.
`MINUS`	Subtracts a number from another number.
`MODULO`	Returns the remainder of a division operation.
`NUMBER`	Converts the passed value to a number.
`PLUS`	Adds a number to another number.
`RANDOM`	Returns a random number in the range specified.
`ROUND`	Rounds an input number to the nearest whole number or, if precision is specified, to that number of decimal places.
`SIN`	Computes the sine of x (in radians), returning a number between -π/2 and π/2
`SQRT`	Computes the square root of a given number
`SUM`	Sums the elements in an array of numbers.
`TIMES`	Multiplies a number by another number.

Arrays

Function	Summary
`ARRAY`	Returns an Array with each of the arguments as a member.
`CHUNK_ARRAY`	Chunks an array into arrays with chunk_size elements. The last chunk may contain less than chunk_size elements.
`COMPACT`	Removes any `null` values from an array.
`CONCAT`	Concatenates (joins together) two or more arrays.
`COUNTIF`	Returns the count of all elements in an array that are equal to the comparison argument.
`DEFAULT`	Allows you to specify a fallback in case a value doesn’t exist. Returns the fallback value if the input is `null`, `false`, an empty text value or an empty array.
`DELETE`	Deletes an item from an array at a given index.
`DIFFERENCE`	Returns an array of items that appear in the first array but not in the second array
`FILTER`	Takes an array or an object as well as a lambda function or an array of values to keep. If the input is an array, it returns a new array with all the values that match the lambda function or are in the array of values to keep. If the input is an object, it returns a new object with all the key-value pairs with values that match the lambda function or are in the array of values to keep.
`FIND`	Returns the first element in the array for which the lambda returns true.
`FIRST`	Returns the first element of an array.
`FLATTEN`	Turn nested arrays into a single 1 dimensional array
`INCLUDES`	Returns `TRUE` if target (which can be text, an object or an array) includes value, otherwise returns `FALSE`.
`INDEX_OF`	Returns the index of the specified term within the provided string or array. With arrays you provide a LAMBDA as the second argument.
`INSERT`	Inserts an item into an array at a given index.
`INTERSECTION`	Returns the intersection between two arrays.
`IS_BLANK`	Returns true if a value is falsy ie. `FALSE`, `""`, `[]`, `{}`, `NULL`, and false otherwise
`IS_EMPTY`	Returns true if a value is empty ie. `""`, `[]`, `{}` and false otherwise
`JOIN`	Combines the elements in an array into a single text value using the argument as a separator.
`LAST`	Returns the last element of an array.
`LAST_INDEX_OF`	Returns the last index of the specified term within the provided string or array. With arrays you provide a LAMBDA as the second argument.
`MAP`	Creates an array by extracting the values of a named property from an array of objects.
`PUSH`	Adds one or more items to the end of an array.
`RANDOM_ELEMENT`	Select a random element from an array.
`RANGE`	Returns an array of numbers with the first value equal to `start` and the last value equal to `end`.
`REJECT`	Takes an array or an object as well as a lambda function or an array of values to remove. If the input is an array, it returns a new array with all the values that do not match the lambda function or are not in the array of values to remove. If the input is an object, it returns a new object with all the key-value pairs with values that do not match the lambda function or are not in the array of values to remove.
`REVERSE`	Reverses the order of the elements in an array.
`ROTATE`	Rotates the elements in an array by any number of steps.
`SHUFFLE`	Shuffles all the elements in an array
`SIZE`	Returns the number of characters in text or the number of elements in an array.
`SLICE_ARRAY`	Returns the remainder of the array (or `length` elements of the array, if specified), beginning at the `start_index`.
`SORT`	Sorts elements in an array by a property of an element in the array (case-sensitive).
`SORT_NATURAL`	Sorts elements in an array by a property of an element in the array (case-insensitive).
`SUM`	Sums the elements in an array of numbers.
`UNION`	Returns the union between two arrays.
`UNIQ`	Removes any duplicate elements in an array.
`WHERE`	Selects all the elements in an array where the key has the given value.

Objects

Function	Summary
`DEEP_MERGE`	Creates a new object by recursively merging two or more objects together. Where there are key collisions that last value is used.
`FILTER`	Takes an array or an object as well as a lambda function or an array of values to keep. If the input is an array, it returns a new array with all the values that match the lambda function or are in the array of values to keep. If the input is an object, it returns a new object with all the key-value pairs with values that match the lambda function or are in the array of values to keep.
`FLATTEN_JSON`	Flattens nested JSON into a new object with a single layer of key/value pairs. Default key separator is a period or full stop (`.`)
`GET`	Get the value in object at the specified path.
`INCLUDES`	Returns `TRUE` if target (which can be text, an object or an array) includes value, otherwise returns `FALSE`.
`IS_BLANK`	Returns true if a value is falsy ie. `FALSE`, `""`, `[]`, `{}`, `NULL`, and false otherwise
`IS_EMPTY`	Returns true if a value is empty ie. `""`, `[]`, `{}` and false otherwise
`JSONPATH`	Evaluates objects using JSONPath expressions. JSONPath expressions support wildcards, filters, and slices. See JSONPath or the Online Evaluator for more information. More examples of how to use JSONPATH can be seen in our Story Library
`KEYS`	Returns an array of keys present in the object.
`MERGE`	Creates a new object by merging two or more objects together.
`OBJECT`	Returns an object with keys and values as specified.
`REJECT`	Takes an array or an object as well as a lambda function or an array of values to remove. If the input is an array, it returns a new array with all the values that do not match the lambda function or are not in the array of values to remove. If the input is an object, it returns a new object with all the key-value pairs with values that do not match the lambda function or are not in the array of values to remove.
`REMOVE_KEY`	Removes the specified key from an object. Path is a dot separated path to the object, you can escape dots using backslash
`SET_KEY`	Sets an object key to a value. If the key already exists, it will be overwritten. Nested keys can be specified using dot notation.
`UNFLATTEN_JSON`	Transforms a single layer of key/value pairs into a nested JSON structure. Default key separator is a period or full stop (`.`)

Dates/Times

Function	Summary
`DATE`	Takes a date, represented by a string, an integer, or a DATE_PARSE object, and returns a formatted string representation. The output format is defined in ruby strftime syntax. Optionally, the output timezone can be specified with values from the tz database. Natural language parsing is handled by chronic.
`DATE_PARSE`	Parses a date and returns an object representation. Fields include the iso8601 and unix timestamp representations and numerical breakdowns. Useful for parsing dates that would be otherwise ambiguous, like 01/02/2023, before passing them to DATE to be formatted. The date is parsed based on the format string, which uses the ruby strptime syntax. If format is omitted, DATE_PARSE attempts to guess the format. Optionally, the timezone can be specified with values from the tz database. Natural language parsing is handled by chronic.
`DAY`	Returns the day of the month for the specified date.
`HOUR`	Returns the hour of the day for the specified date.
`MINUTE`	Returns the minute of the hour for the specified date.
`MONTH`	Returns the month of the year for the specified date.
`NOW`	Returns the current date and time.
`SECOND`	Returns the second of the minute for the specified date.
`TODAY`	Returns the current date
`UNIX_TIMESTAMP`	Returns the current unix timestamp, i.e. the number of seconds since midnight on 1 January 1970
`YEAR`	Returns the year for the specified date.

Hashing/Signing

Function	Summary
`AES_DECRYPT`	Decrypts text using AES-256-CBC The input must be Base64 encoded. An initialization vector can optionally be passed as a third argument.
`AES_ENCRYPT`	Encrypts text using AES-256-CBC The output is Base64 encoded. An initialization vector can optionally be passed as a third argument.
`GENERATE_RSA_KEYS`	Generates a pair of public and private keys using the RSA encryption algorithm. The key size can be either 2048 or 4096, and the default is 2048.
`HMAC_SHA1`	Converts text into a SHA-1 hash using a hash message authentication code (HMAC).
`HMAC_SHA1_BASE64`	Converts text into a Base64 encoded SHA-1 hash using a hash message authentication code (HMAC).
`HMAC_SHA256`	Converts text into a SHA-256 hash using a hash message authentication code (HMAC).
`HMAC_SHA256_BASE64`	Converts text into a Base64 encoded SHA-256 hash using a hash message authentication code (HMAC).
`JWT_SIGN`	Creates a JSON Web Token from the input claim set using either RS256 (default), HS256 or ES256.
`MD5`	Calculates the hex encoded MD5 hash of some text.
`MD5_BASE64`	Calculates the Base64 encoded MD5 hash of text.
`RSA_DECRYPT`	Decrypts encrypted data using a public key.
`RSA_ENCRYPT`	Encrypts data using a private key.
`SHA1`	Calculates the sha1 hash of text.
`SHA256`	Calculates the sha256 hash of text, expressed in hex.
`SHA256_BASE64`	Calculates the sha256 hash of the text, expressed in base64.
`SHA512`	Calculates the sha512 hash of text.

Data Parsing/Conversion

Function	Summary
`BASE64URL_DECODE`	Decode URL-safe Base64 encoded text.
`BASE64URL_ENCODE`	Encode text to URL-safe Base64 encoded text.
`BASE64_DECODE`	Decode Base64 encoded text.
`BASE64_ENCODE`	Encode text using the Base64 encoding algorithm.
`CSV_PARSE`	Parses CSV-formatted text with auto-detection of the delimiter character and parses output into an array of arrays.
`CSV_PARSE_TO_OBJECTS`	Parses CSV-formatted text with auto-detection of the delimiter character and parses output into an array of objects.
`EML_PARSE`	Takes text containing EML (RFC822) content and parses out information such as `to`, `from`, `subject`, `attachments`, etc.
`GUNZIP`	Decompresses from a gzip. If there are multiple files in the archive the results are concatenated.
`GZIP`	Compresses a single file with gzip
`HCL_PARSE`	Parses Hashicorp Configuration Language (HCL) text
`HEX_PARSE`	Converts hexadecimal text into the text or data it represents
`JSON_PARSE`	Parses escaped JSON text. If used in a formula field, it will return a JSON object; if used inside a text field it will return unescaped JSON text.
`LDIF_PARSE`	Parse text from a LDAP Data Interchange Format (LDIF) file into an object
`MSG_PARSE`	Takes the contents of an .msg file (Outlook item/email) and parses out information such as `to`, `from`, `subject`, `attachments`, etc. Output is consistent with `EML_PARSE`.
`NEAT_JSON`	Formats and "pretty prints" an object in JSON.
`OBJECTS_TO_CSV`	Parses an array of objects with the same keys into CSV-formatted text. Headers are optional, if none are provided the keys of the first object are used.
`PARQUET_PARSE`	Parses Parquet data into an array of objects.
`PARSE_URL`	Returns an object that representing the parsed url
`TO_CSV`	Convert an array of arrays into CSV-formatted text.
`TO_HEX`	Converts text or data into hexadecimal text.
`TO_JSON`	Convert an object into JSON text.
`TO_XML`	Converts an object into XML, root element name is optional.
`TO_YAML`	Converts an object into YAML
`UNZIP`	Extracts files from a ZIP archive.
`VALUES`	Returns all the values of an object.
`XML_PARSE`	Takes text containing XML and parses to an object
`YAML_PARSE`	Takes text containing YAML and parses to an object
`ZIP`	Creates a ZIP archive containing a given file or files. If the optional password parameter is present then the archive will be password protected. Can also accept an array of file objects as its first argument. File object must contain either contents or base64encoded contents, a file name and optionally can specify the created_at date in ISO8601 format.

IP Addresses

Function	Summary
`IN_CIDR`	Checks if an IP address is in a given CIDR block.
`IS_IP_ADDRESS`	Checks if a text value is a valid IP address

Lambdas

Function	Summary
`COUNTIF`	Returns the count of all elements in an array that are equal to the comparison argument.
`FILTER`	Takes an array or an object as well as a lambda function or an array of values to keep. If the input is an array, it returns a new array with all the values that match the lambda function or are in the array of values to keep. If the input is an object, it returns a new object with all the key-value pairs with values that match the lambda function or are in the array of values to keep.
`FIND`	Returns the first element in the array for which the lambda returns true.
`LAMBDA`	Creates a custom, reusable function. The last argument is the calculation you want to perform, all previous arguments are the parameters for this calculation
`MAP_LAMBDA`	Return an array that is the result of calling lambda with each element of the input array.
`REDUCE`	Allows for turning an array into a single value.
`REJECT`	Takes an array or an object as well as a lambda function or an array of values to remove. If the input is an array, it returns a new array with all the values that do not match the lambda function or are not in the array of values to remove. If the input is an object, it returns a new object with all the key-value pairs with values that do not match the lambda function or are not in the array of values to remove.

Story Metadata

Function	Summary
`PROMPT`	Emit a URL that when visited will cause the current action to emit a new event. Text is optional, if provided will be available in the status field of the emitted event.
`STORY_RUN_GUID`	Returns the GUID of the currently executing story run.
`STORY_RUN_LINK`	Returns a link to the currently executing story run.

Other

Function	Summary
`TYPE`	Outputs the type (class) of the specified value.

Strings

Function Summary

Function	Summary
`RANDOM_STRING`	Returns a string of random characters. The function takes three optional arguments: length, mode, and custom. length determines the length of the string (default 16). mode determines the type of characters in the string. The options are "alphanumeric", "custom", "hex", "letters", "numbers" (default "alphanumeric"). The custom_characters argument is only used when mode is set to "custom". It is a string of characters that will be used to generate the random string.

RANDOM_STRING

Returns a string of random characters. The function takes three optional arguments: length, mode, and custom.

length determines the length of the string (default 16).

mode determines the type of characters in the string. The options are "alphanumeric", "custom", "hex", "letters", "numbers" (default "alphanumeric").

The custom_characters argument is only used when mode is set to "custom". It is a string of characters that will be used to generate the random string.