This documentation relates to an earlier version of JeraSoft VCS.
View User Guide 3.26 or visit our current documentation home page.
In this article

Section overview

The following section allows configuring and monitoring of hooks for Provisioning API

Provisioning API provides a mechanism for real-time integration with 3rd party systems, including softswitches, gateways, and CRM systems. It calls pre-defined handlers on an occurrence of specific events in the system. The handlers are allowed to modify data, forbid or allow the action or simply process given event.

For detailed information about Provisioning API functionality, go to the APIs section of our User Guide.

To configure handlers and check their call log, go to the Integration > Provisioning API.


The full list of Provisioning API parameters matches with CoreAPI and they are available upon an individual request of your current clients. 

Screenshot: Provisioning section

Column NameDescription
IDHandler's identification number

Priority of handlers execution

NameHandler's title

Description of the handler event


Category of the handler that is used and location. There are two types of handlers that can be used: 

  • HTTP scripts, called via POST requests (used in most cases)
  • Local server scripts, called locally on the server (used in very specific cases)

The list of section functional buttons/icons is as follows:


Allows creating a new handler

Identifies a disabled status of a handler

Identifies an enabled status of a handler

Identifies an archived status of a handler

Allows viewing  details of a target handlers' performance Execution Logs tab for a respective handler

Allows deleting a handler from the system


For a quick switch between enabled and disabled statuses, click on a respective status icon in the section. However, to change archived status, you need to do it from a handler edit form

Advanced Search

Advanced Search drop-down menu, located in the top right corner of the section, is called to facilitate easy access to required informationBy clicking on a red downward arrow  iconthe following drop-down menu is displayed:

Screenshot: Advanced Search drop-down menu


Select from a list of all possible handler events

Handler Type

Indicate a type of handler:

  • script
  • HTTP

Choose a target status:

  • Enabled
  • Disabled
  • Archived

or leave this field blank. In this case, both enabled and disabled handlers will be displayed. This field is empty by default

Creating a New Handler

To start with provisioning, you need to create a handler manually. Click the New Handler button and specify respective parameters in the appeared pop-up window:

Screenshot: Provisioning section/Handler adding form

Field Description


Specify a particular title for a handler

Specify a handler event from the following list:


  • create
  • update
  • delete
  • archive
  • custom fields update
  • balance became >=0
  • balance became <=0
  • create
  • update
  • delete
  • assign
  • activate
  • deactivate
  • renew
  • close 
Email Rates Manager
  • email rates manager import
  • import process failed
  • import process success


Choose the state of the handler:

  • enabled - select it to make a handler active;
  • disabled - select it to unable a handler;
  • archived - select it to archive a handler.


Establish an order of handler performing.
Note: The handler with 1 priority will precede all other handlers in order.

(warning)   Attention

In VCS 3.17.0, to prevent performance degradation and data inconsistency affected by the external side, Before event type has been removed from the section.

Best practice example

There is an example based on http://handler usage.

2. Open the Provisioning section and start creating a handler.

    1. Specify the name, type, and status.
    2. In the Event field, select Clients Create event from the drop-down list.
    3. In the Task field, indicate http:// type and determine the port and method, for example,
    4. Click Apply.

Find an example of the http://handler below:

from flask import Flask, request
import json
app = Flask(__name__)
@app.route("/api", methods=['GET', 'POST'])
def api():
    data = json.loads(
    return json.dumps(data)
if __name__ == "__main__":

(warning)   Attention

To put a handler into action, you need to restart the Cache Manager. To do so, click on the corresponding icon in Task Scheduler section

Execution Logs tab

You can access the details about handler execution in this tab. For more details, check out a related article: Execution Logs


Please note that the Provisioning functionality is experimental and may be changed completely in future releases.

  • No labels