Add a New Event

Procedure


Step 1

In the Management Portal navigation bar, choose New Digital Channels to launch the default console.

Step 2

Choose Groups > Events and Rules.

Step 3

Click Add New Event on the top-right corner of the screen.

The Configure Events page appears.
Step 4

Enter the Name of the event.

Step 5

Enter the URL in the given fields. The system calls this URL when the event is triggered.

Step 6

Choose one of the following methods:

  • Get

  • Put

  • Post

  • Patch

  • Delete

Step 7

Set the type of response format in the Expected Response Format field to JSON.

Step 8

Check the Wait for Response check box which disables retriggering the same event until a response is received from the target system.

Step 9

Check the Display Response on Chat Console check box to enable the agent to see the target system response in the chat console.

Step 10

You can choose to pass the payload using either Key Value Pair or Custom Payload.

If you choose the Key Value Pair radio button, the key value pair settings appear on the screen.

Check the Form Encode Request Body check box to pass form encoded parameters in the request body. Otherwise, you can configure the parameters and pass them in the API requests.

Step 11

To add parameters, follow these steps:

  1. Click Add Param.

    The Add Parameter pop-up window appears.
  2. Choose Header/Query Param/Request Body from the Pass Through drop-down list.

  3. Enter the Parameter Name.

  4. Check the Mandatory Parameter check box if the system must use this parameter when triggering an event.

  5. Choose the Value from the drop-down list.

  6. When you choose the Custom Param as the value from the list, choose one of these radio buttons:

    • Allow agent to enter value manually: This option allows the agent to enter the values manually before calling an external URL to post the data.

    • Allow agent to choose from a set of predefined values: This option allows the agent to choose preconfigured values before calling an external URL to post the data. When you choose this radio button, a text box appears on the screen. Enter the predefined values in the text box.

  7. Click the respective radio button and click Add to save the parameters.

  8. Use the Edit and Delete icons respectively to edit and delete the parameters.

Step 12

Click the Custom Payload radio button to pass the payload in JSON format.

The parameters should prefix with @@ and close in curly {} braces in the data field.

Step 13

Enter Key and Value details to pass them in the header.

Step 14

Click Save Changes.