Skip to content

Latest commit

 

History

History

slack

Folders and files

NameName
Last commit message
Last commit date

parent directory

..

test

test

 
 

README.md

README.md

 
 

manifest.yaml

manifest.yaml

 
 

package.json

package.json

 
 

server.js

server.js

 
 

README.md

Slack Integration for Dialogflow CX

Setup

Prerequisites

  • Follow the instructions on the main README file in the root directory of this repository.

  • Create and add your GCP service account key to the current folder.

  • Create a Slack APP

    • Create or sign in to your Slack account.

    • Go to https://api.slack.com/apps.

    • Click on the 'Create New App' button.

      • Choose 'From an app Manifest'.
      • Pick a workspace for the app.
      • Copy and paste the code in the manifest.yaml file to the YAML section and edit the display_information as you like. Make sure to fill in the request_url in the event_subscription after deploying your integration.
      • Click next and then click create.
      • Install the app to your chosen Workspace.
      • At the top of server.js, uncomment and replace the variables slackSigningSecret with the Signing Secret from 'Basic Information' and slackToken with the OAuth Token from 'Install App'.

Deploying the Integration Using Cloud Run

In your local terminal, change the active directory to the repository’s root directory.

Run the following command to save the state of your repository into GCP Container Registry. Replace PROJECT-ID with your agent’s GCP Project ID.

gcloud builds submit --tag gcr.io/PROJECT-ID/dialogflow-slack

Deploy your integration to Cloud Run using the following command. Replace PROJECT_ID with your agent’s GCP project Id, and DIALOGFLOW_SERIVCE_ACCOUNT with the Service Account which you acquired in the Service Account Setup step of the main README file.

gcloud beta run deploy --image gcr.io/PROJECT_ID/dialogflow-slack --service-account DIALOGFLOW_SERVICE_ACCOUNT --memory 1Gi
  • When prompted for a target platform, select a platform by entering the corresponding number (for example, 1 for Cloud Run (fully managed)).
  • When prompted for a region, select a region (for example, us-central1).
  • When prompted for a service name hit enter to accept the default.
  • When prompted to allow unauthenticated invocations press y.
  • Copy the URL given to you, and update the event_subscription url in manifest.yaml, or if updating an existing Slack App, update the Request URL in found in Event Subscriptions.

More information can be found in Cloud Run documentation.

You can view a list of your active integration deployments under Cloud Run in the GCP Console.

Testing the Integration

  • You have now completed all the necessary steps and can test your integration.
  • To test rich messages you have to first input in the custom payload for your agent:
    • To do this first click "Add dialogue option" in a fulfillment editing panel.
    • Then copy and paste the bottom code and edit it to include your chosen elements in the blocks.
      • { "blocks": [ {...} ] }
    • For more information on the layouts for rich messages on Slack, please visit https://api.slack.com/messaging/composing/layouts.
  • There are two ways to test the integration:
    • Directly instant message the integration through the Slack App you created.
    • Install your Slack App on a channal and mention the name of the Slack App (Ex: @appName) in your message.