Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

1. Description

They are This section is designed to add hooks Hooks to the queueQueue. Hooks are used during integration if webitel Webitel needs to send data to another system for some event.

Present in all types of queues.

It consists of the following elements:

  1. Creation tool (Fig.1(1));
  2. Refresh button (Fig.1(2));
  3. Registry (Fig.1(3));
  4. Pagination (Fig.1(4)).

Image RemovedImage Added

Fig. 1. Hooks tab

1.1. Creation tool 

Click the add button to add a new hook (Fig.1(1)). 

After clicking the add button, the Hook modal window opens (Fig. 2). It consists of the Event and Flow fields and the Save and Close buttons.

Image Removed

Fig. 2. Hook modal window

Include Page
Creation tool - Hooks (Queue)
Creation tool - Hooks (Queue)

1.1.1. Event

It is used to select an event. When you click on the Event field, a drop-down list opens, from which an event is selected. 

There are such events:

  • Joined;
  • Answered;
  • Offering;
  • Bridged;
  • Missed;
  • Leaving;
  • Processing;
  • Active.

1.1.2. Flow schema 

Here it is indicated which flow Flow schema will be processed at for the specified event. 

When you click on the field, a drop-down list opens from which the flow Flow schema is selected. If the required flow Flow schema is not in the drop-down list, use the field as a search field.

How to create a new flow can Flow schema can be found here.

1.2. Refresh button

Include Page
Refresh button
Refresh button
(Fig.1 (2)).

1.3. Registry

The registry is a list of entries of existing objects in this section, each of which consists of a set of fields:

  1. Checkbox;
  2. Event;
  3. Flow schema;
  4. State;
  5. Editing tool;
  6. Removal tool.

1.3.1. Checkbox

Use Used to select one or more entries. An additional removal tool appears after selecting one or more entries. Information about the number of records selected for deletion appears when you hover over this tool.

1.3.2. Event

This displays the event's name that needs to send data to another system.

1.3.3. Flow schema  

It displays which flow Flow schema will be processed at for the specified event.

1.3.4. State

A switch that is responsible for enabling and disabling the hook Hook by the position:

Image Removed Image Added - the hook Hook is enabled;

Image RemovedImage Added- the hook Hook is disabled.

1.3.5. Editing tool

The Hook modal window opens (Fig. 2) after clicking the edit button (Image Removed).

Include Page
Editing tool - Hooks (Queue)
Editing tool - Hooks (Queue)

1.3.6. Removal tool

It is used to remove the hook from the registry entriesHook. After you click the remove button (Image RemovedImage Added), the hook entry Hook is removed.

1.4. Pagination

Include Page
Pagination
Pagination

Tip

You can see options for webhooks  webhooks here

2. Opportunities

2.1. Add a

hook

Hook to the

queue

Queue

Goal

Add

hook

Hook to the

queue

Queue

Preconditions
  1. Access to the Admin application;
  2. Access to the Queues section in the Admin application;
  3. Permission to create
,
  1. or edit
,
  1. in the Queues section;
  2. The presence of a
queue
  1. Queue or the creation of a new one.

Steps


  1. Click on the add button (Fig.1(1)). The

Hook
  1. Add hook modal window opens.

  2. Click on the Event field. A
dropdown
  1. drop-down list of existing events opens.
  2. Select the required event. The
dropdown
  1. drop-down list is closed.
  2. Click on the Flow schema field. A
dropdown
  1. drop-down list of existing
flows
  1. Flows schema opens.
  2. Select the required
flow
  1. Flow schema. The
dropdown
  1. drop-down list is closed. The Save button becomes active.
  2. Click on the Save button.

Result

The modal window closes. Data saved. The entry has been added to the registry.  

2.2. Remove a

hook

Hook from

a queue

the Queue

Goal

Remove a

hook

Hook from

a queue

the Queue

Preconditions
  1. Access to the Admin application;
  2. Access to the Queues section in the Admin application;
  3. Permission to create
,
  1. or edit
,
  1. in the Queues section;
  2. The presence of a
queue
  1. Queue or the creation of a new one;
  2. At least one
hook record
  1. Hook entry.

Steps


  1. Find the
hook
  1. Hook entry you want to remove.
  2. Click on the delete button -
Image Removed
  1. Image Added.

Result

The
hook
Hook has been removed from the registry.

2.3. Edit a

hook

Hook in

a queue

the Queue

Goal

Edit a

hook

Hook in

a queue

the Queue

Preconditions
  1. Access to the Admin application;
  2. Access to the Queues section in the Admin application;
  3. Permission to create
,
  1. or edit
,
  1. in the Queues section;
  2. The presence of a
queue
  1. Queue or the creation of a new one;
  2. At least one
hook record
  1. Hook entry.

Steps


  1. Find the entry for the
hook
  1. Hook you want to change
  2. Click the edit button-
Image Removed
  1. Image Added.  The
Hook
  1. Edit hook modal window opens.
  2. Enter the necessary changes. The Save button becomes active.
  3. Click on the Save button.

Result

The modal window closes. Data saved.



Table of Contents