Built-in variables#

Some data reaches the code without any function calls — in ready-made JavaScript variables. The set depends on the block the code runs in.

Contact data#

In all blocks except the "Incoming webhook", the data of the contact the code runs for is available right away. In the "Incoming webhook" it appears once the code finds the contact with a contact lookup function.

The values are strings, including id and bot_id. In the "Incoming webhook", id and bot_id come as numbers, so bring them to one form before comparing: Number(id) === 12345.

If the contact lacks something — a phone, say — the variable does not exist at all, and referring to it stops the code with a ReferenceError. Check such variables with typeof:

if (typeof phone !== 'undefined') {
    setContactVariable('courier_phone', phone);
} else {
    sendMessage('Please leave a phone number for the courier.');
}

In the "Incoming webhook", a few more variables appear after the contact is chosen — also only if the contact has a value:

Contact variables and the bot's global variables do not come as ready-made variables — read them with the getContactVariable and getGlobalVariable functions.

Server response#

In the code of the "HTTP request" block, the server response is in the response object:

The code starts only when the server has responded. If there is no response — the server did not respond within the time in the "Timeout" field or the connection could not be established — the block leaves through the "No response from server" output, and the code does not run. A response with an error code, such as 500, is a normal response: the code runs, so check response.status yourself.

The code runs after the block's other settings: the variables from "Write json response to variables" have already been written by then.

if (response.status !== 200) {
    sendMessage('The delivery service is unavailable right now, please try again later.');
    disableContinue();
} else if (response.data.slots && response.data.slots.length > 0) {
    setContactVariable('next_delivery', response.data.slots[0].time);
} else {
    sendMessage('There are no free delivery slots for today.');
}

Incoming request#

In the code of the "Incoming webhook" block, the incoming request is in the request object:

If the request has no parameters, request.query is an empty object. Check nested fields before using them, so the code does not stop on undefined:

var order = request.data.order;

if (order && order.contact_id && setContactById(order.contact_id)) {
    setContactVariable('order_number', String(order.id));
    sendMessage('Order No. ' + order.id + ' is packed and handed to the courier.');
}

If the sender signs its requests, you can check the signature with the hash_hmac function — using request.body and the signature header.

Sheet rows#

In the code of the "Read rows from Google Sheets" block, the rows found are in sheet.data — an array of rows, where each row is an array of cells.

• sheet.data holds only the rows that passed the block's filters, and no more than set in "Number of records in a message".
• The cells are strings. The first cell of the array is column A.
• The block loads columns up to the rightmost one mentioned in its settings. For the code to get other columns too, call setColumnRange("A:F") with the range you need at the start of the code — the block reads this call before querying the sheet. Google does not send empty cells at the end of a row, so rows may differ in length.
• If no rows are found, the code does not run: the block leaves through the "No records found" output.

setColumnRange("A:C");

var rows = sheet.data;
var total = 0;

for (var i = 0; i < rows.length; i++) {
    total += Number(rows[i][2] || 0);
}

setContactVariable('order_total', total);

Here column C holds the bouquet price, and the code adds up the prices of all rows found.