Create a script

Scripts let you add more advanced interactions to your chatbot, such as:

• Saving, resetting, and retrieving variable values.
• Starting different passages based on variable values, business hours, or values from a data store.
• Interacting with other platforms such as Shopify.
• Sending messages with dynamic content or custom Quick Replies.
• Using guardrails and sending messages to the chatbot log.
• Sending emails.

Message limits

Chatbot scripts can send a maximum of one message to the user per script. Any subsequent messages you try to send within the same script will not be sent to the user. You can add multiple script bubbles to a passage if you need to send more than one dynamic message to a user.

Timezones and locales

You can use moment.js to manage timezone-aware dates and times, but chatbot scripts can't set a global moment.js timezone or locale: timezones and locales must be set within each script.

To set the timezone or locale in a chatbot script:

1. Instantiate a moment object with the timezone and locale you want to use.
2. Use that moment object within your script instead of the usual moment instance.

//Instantiate the moment object with the timezone and locale
const getMoment = (time) => moment(time).tz('Australia/Melbuourne').locale('en-au');

//Use the instantiated object
const current = getMoment();

console.log(getMoment().toLocaleString());
console.log(getMoment(current).set({h:8}).toLocaleString());
console.log(getMoment(current).set({h:17}).toLocaleString());
console.log(getMoment(current).isoWeekday());

//Always end your chatbot script execution with done();
done();

Ending script execution

Wherever the script has finished executing, you must call the done() method to tell the chatbot to return to the conversation flow.
See done(err).

Chatbot methods

Chatbot scripts are written in JavaScript, with some additional libraries provided within the platform (see Provided libraries). The chatbot also provides methods for most chatbot activities you can accomplish within the inGenious AI platform: