Home

Awesome

Actions on Google: Webhook Boilerplate

This sample demonstrates the base webhook required for building Actions on Google for use on Google Assistant -- using the Node.js client library and deployed on Cloud Functions for Firebase.

Setup Instructions

Select only one of the options below.

Option 1: Add to Dialogflow

Select the button below and follow prompts to create a new agent:

Webhook Boilerplate

Option 2: Dialogflow Console and Firebase CLI

Prerequisites

  1. Node.js and NPM
    • We recommend installing using NVM
  2. Install the Firebase CLI
    • We recommend using version 6.5.0, npm install -g firebase-tools@6.5.0
    • Run firebase login with your Google account

Configuration

Actions Console

  1. From the Actions on Google Console, New project (this will become your Project ID) > Create project > under More options > Conversational
  2. From the top navigation menu under Develop > Actions (left nav) > Add your first action > BUILD (this will bring you to the Dialogflow console) > Select language and time zone > CREATE.
  3. From the left menu > select Intents > Default Welcome Intent, scroll down to the end of the page and under Fulfillment > Enable Webhook > Save.
    • This will allow you to have the welcome intent be a basic webhook intent to test.

Firebase Deployment

  1. On your local machine, in the functions directory, run npm install
  2. Run firebase deploy --project {PROJECT_ID} to deploy the function
    • To find your Project ID: In Dialogflow console under Settings ⚙ > General tab > Project ID.

Dialogflow Console

  1. Return to the Dialogflow Console > select Fulfillment > Enable Webhook > Set URL to the Function URL that was returned after the deploy command > SAVE.
    Function URL (dialogflowFirebaseFulfillment): https://${REGION}-${PROJECT_ID}.cloudfunctions.net/dialogflowFirebaseFulfillment
    
    • The URL from the firebase deploy output should match the above format. If it doesn't, you can find the correct URL in Firebase > (Your project) > Develop > Functions > Dashboard > Trigger (something like https://us-central1-<...>.cloudfunctions.net/<yourActionName>).
  2. From the left navigation menu, click Integrations > Integration Settings under Google Assistant > Enable Auto-preview changes > Test to open the Actions on Google simulator then say or type Talk to my test app.

Running this Sample

References & Issues

Make Contributions

Please read and follow the steps in the CONTRIBUTING.md.

License

See LICENSE.

Terms

Your use of this sample is subject to, and by using or downloading the sample files you agree to comply with, the Google APIs Terms of Service.