Deploy a Workplace Endpoint

Description

With the implementation of a Workplace Endpoint you can easily connect your Workplace Chat Bot with COGNIGY.AI.

This tutorial covers the necessary steps for creating and connecting a Workplace Endpoint. If you want to get information about assigning a Flow to the Endpoint and setting up the Data Management see Endpoints.

Three Step Preparation Process

1 Create a Workplace on Workplace
2 Create a Custom Integration in the Admin Panel. For more information, read Facebook Help Center and Workplace Custom Integrations
3 Create and Configure a Workplace Endpoint on COGNIGY.AI

1 Create a Workplace

Location: workplace.com

1.1 Admin Panel


Log into your Workplace Account with Admin rights. Then on your landing page click on the Admin Panel entry in the left navigation menu (see Figure 1.1)

Figure 1.1: Menu Entry for the Admin PanelFigure 1.1: Menu Entry for the Admin Panel

Figure 1.1: Menu Entry for the Admin Panel

2 Create a Custom Integration

Requirements
Workplace Admin Account Permissions
Workplace Advanced Pricing Plan

2.1 Add new Custom Integration


First, you've to log into your Facebook account. Then, after getting redirected, click on Manage Apps (see Figure 2.1a) and select Add a New App (see Figure 2.1b)

Figure 2.1a: Menu entry for Manage Custom IntegrationsFigure 2.1a: Menu entry for Manage Custom Integrations

Figure 2.1a: Menu entry for Manage Custom Integrations

In the Integrations overview page, click on the Create Custom Integration button to set up a new connection.

Figure 2.1b: Custom Integrations OverviewFigure 2.1b: Custom Integrations Overview

Figure 2.1b: Custom Integrations Overview

A prompt opens for creating a new Custom Integration (see Figure 2.1c). Create it by entering the necessary information in the requested fields.

Figure 2.1c: Create New App PromptFigure 2.1c: Create New App Prompt

Figure 2.1c: Create New App Prompt

Afterward, submit everything by clicking on the Create button in the bottom-right corner.

2.2 Add Messaging permission


After creating the Facebook App you'll see an overview of the available configurations. Select the Message any member permission to allow writing text messages to Workplace users. (see Figure 2.2)

Figure 2.2: Message any member permissionFigure 2.2: Message any member permission

Figure 2.2: Message any member permission

2.3 Get Tokens


If you're on the overview page of your Custom Integration, go to the Integration Details (see Figure 2.3a).

Figure 2.3a: Integration DetailsFigure 2.3a: Integration Details

Figure 2.3a: Integration Details

In order to proceed, store the following required information:

App ID
Access Token

Now you good to go to step 3 and set up the Messenger Enpoint with COGNIGY.AI.

3 Create and Configure a Workplace Endpoint

Location: COGNIGY.AI

Requirements
App ID
Access Token

3.1 Create a Messenger Enpoint


First you have to create an Endpoint of the type Messenger (see Figure 3.1).

Figure 3.1: Workplace Endpoint Creating PromptFigure 3.1: Workplace Endpoint Creating Prompt

Figure 3.1: Workplace Endpoint Creating Prompt

3.2 Configure the Workplace Endpoint


Expand the Workplace Setup panel (see Figure 3.2) and paste the saved Page Access Token into the corresponding field.

Figure 3.2: Workplace Setup PanelFigure 3.2: Workplace Setup Panel

Figure 3.2: Workplace Setup Panel

๐Ÿ“˜

Optional Secret Validation

You can add an optional security layer and verify for every message that it was actually sent from Workplace. To do this, add your App ID and App Secret in the corresponding fields in your Endpoint Workplace Setup.

3.3 Get the Endpoint URL


Move to the top of the Endpoint Configuration page and copy the Endpoint URL which is displayed above the General Settings (see Figure 3.3).

Figure 3.3: Endpoint URLFigure 3.3: Endpoint URL

Figure 3.3: Endpoint URL

Final Step: Connect Your Workplace Custom Integration to the Endpoint

Requirements
Endpoint URL

Switch back to your Workplace Custom Integration and there to the settings page of the Custom Integration. Scroll to the Configure Webhooks section and click on Add callback URL (see Figure 4.1):

  • a Callback URL
  • a Verify Token
Figure 4.1: Webhooks SetupFigure 4.1: Webhooks Setup

Figure 4.1: Webhooks Setup

As the Callback URL paste in the Endpoint URL which you gathered in step 3.3.

The Verify Token is by default cognigy123 but it depends on the installation of your COGNIGY.AI platform (for further information please contact the technical support). Press Verify and save to continue.

Finally add the required permissions to allow sending text messages:

  • mention
  • message_deliveries
  • messages
  • messaging_postbacks
  • message_reads

You should be all set up to use the Workplace Endpoint you've created with a Flow of your choice.


Did this page help you?