Goose Test

A package to speed up the process of creating serverless bots for Workplace.

Installation

npm install -g goose_test

Usage

goose_create NAME_OF_YOUR_BOT

This will start to download all the requiere files for your bot, this process includes:

• Download from git the necessary files (You'll need your git username and password).
• Install the yarn dependencies.
• Prompt you for some AWS data that will later be converted to environment variables.

Once the installation is completed you will be ask to source the environment variables and deploy your project.

cd NAME_OF_YOUR_BOT && source deployments/deployment.env && ./deployments/deploy.sh

After Deploy for the first time

You need to set your webhook endpoint on your custom integration. These are the required permissions that need to be granted

• Read user email
• Message any member
• Manage group content

In Configure Webhooks's Page tab set the webhook endpoint printed above for webhook that should look similar to:

endpoints:
  GET - https://abcde12345.execute-api.us-east-1.amazonaws.com/dev/webhook

The verify token is the one you set in deployment/my_environment.env file and check the following subscription fields:

• messages
• messaging_postback

When the webhook is set you can text your bot on Workplace chat and it'll be able to answer you

Templates

To test templates you'll need to replace current email with yours in deployments/user.json

$ gedit deployments/user.json

To list the available templates you'll need to run:

goose_list_templates

This are the current templates:

• sendTextMessageTemplate
• sendGenericTemplate
• sendButtonTemplate
• sendListTemplate
• sendQuickReplyTemplate
• sendCarouselTemplate
• addUsersDynamodbTableTemplate

To add a template you'll need to run:

goose_add_template NAME_OF_THE_TEMPLATE

After installing a template it will be added to your serverless file. If you want to test the new function you need to first deploy the changes and then invoke the function, you will recive instructions on how to do this after adding a new template.