1. Description

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

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 schema 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 schema will be processed for the specified event. 

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

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

1.2. Refresh button

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

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 schema will be processed for the specified event.

1.3.4. State

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

Image Removed Image Added - the Hook is enabled;

Image RemovedImage Added- the Hook is disabled.

1.3.5. Editing tool

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

1.3.6. Removal tool

It is used to remove the Hook. After you click the remove button (Image RemovedImage Added), the Hook is removed.

1.4. Pagination

2. Opportunities

2.1. Add a Hook to the Queue

2.2. Remove a Hook from the Queue

Goal	Remove a Hook from the Queue
Preconditions	Access to the Admin application; Access to the Queues section in the Admin application; Permission to create or edit in the Queues section; The presence of a Queue or the creation of a new one; At least one Hook entry.
Steps	Find the Hook entry you want to remove. Click on the delete button -

Image Removed

Image Added.
Result	The Hook has been removed from the registry.

2.3. Edit a Hook in the Queue

Goal	Edit a Hook in the Queue
Preconditions	Access to the Admin application; Access to the Queues section in the Admin application; Permission to create or edit in the Queues section; The presence of a Queue or the creation of a new one; At least one Hook entry.
Steps	Find the entry for the Hook you want to change Click the edit button-

Image Removed

Image Added.  The

Hook

Edit hook modal window opens. Enter the necessary changes. The Save button becomes active. Click on the Save button.
Result	The modal window closes. Data saved.