Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
1. Description
They are The 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:
- Creation tool (Fig.1(1));
- Refresh button (Fig.1(2));
- Registry (Fig.1(3));
- Pagination (Fig.1(4)).
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.
Fig. 2. Hook modal window
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 schema will be processed at 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)). Include Page Refresh button Refresh button
1.3. Registry
The registry is a list of entries of existing objects in this partitionsection, each of which consists of a set of fields:
- Checkbox;
- Event;
- Flow schema;
- State;
- Editing tool;
- 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 schema will will be processed at 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
The Hook modal window opens (Fig. 2) after clicking the edit button ().
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
Include Page Pagination Pagination
Tip |
---|
You can see options for webhooks here. |
2. Opportunities
2.1. Add a Hook to the Queue
Goal | Add Hook to the Queue |
---|---|
Preconditions |
| |
Steps |
|
Result | The modal window closes. Data saved. The entry has been added to the registry. |
2.2. Remove a Hook from
athe Queue
Goal | Remove a Hook from |
---|
the Queue | |
---|---|
Preconditions |
| |
Steps |
|
Result | The Hook has been removed from the registry. |
2.3. Edit a Hook in
athe Queue
Goal | Edit a Hook in |
---|
the Queue | |
---|---|
Preconditions |
| |
Steps |
|
Result | The modal window closes. Data saved. |
Table of Contents |
---|