Hooks (Inbound Queue)

Owned by Olesya Tantsyura
Last updated: Jun 04, 2024
4 min read

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)).

Fig. 1. Hooks tab

1.1. Creation tool 

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

(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

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:

- the Hook is enabled;

- the Hook is disabled.

1.3.5. Editing tool

1.3.6. Removal tool

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

1.4. Pagination

You can see options for webhooks here. 

2. Opportunities

2.1. Add a Hook to the Queue

Goal

Add Hook to the Queue

Goal

Add Hook to the Queue

Preconditions

  1. Access to the Admin application;

  2. Access to the Queues section in the Admin application;

  3. Permission to create or edit in the Queues section;

  4. The presence of a Queue or the creation of a new one.

Steps

 

  1. Click on the add button (Fig.1(1)). The Add hook modal window opens.

  2. Click on the Event field. A drop-down list of existing events opens.

  3. Select the required event. The drop-down list is closed.

  4. Click on the Flow schema field. A drop-down list of existing Flows schema opens.

  5. Select the required Flow schema. The drop-down list is closed. The Save button becomes active.

  6. 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 from the Queue

Goal

Remove a Hook from the Queue

Goal

Remove a Hook from the Queue

Preconditions

  1. Access to the Admin application;

  2. Access to the Queues section in the Admin application;

  3. Permission to create or edit in the Queues section;

  4. The presence of a Queue or the creation of a new one;

  5. At least one Hook entry.

Steps

 

  1. Find the Hook entry you want to remove.

  2. Click on the delete button -

    .

Result

The Hook has been removed from the registry.

2.3. Edit a Hook in the Queue

Goal

Edit a Hook in the Queue

Goal

Edit a Hook in the Queue

Preconditions

  1. Access to the Admin application;

  2. Access to the Queues section in the Admin application;

  3. Permission to create or edit in the Queues section;

  4. The presence of a Queue or the creation of a new one;

  5. At least one Hook entry.

Steps

 

  1. Find the entry for the Hook you want to change

  2. Click the edit button-

    .  The Edit hook modal window opens.

  3. Enter the necessary changes. The Save button becomes active.

  4. Click on the Save button.

Result

The modal window closes. Data saved.