Web Service Connector

Configure the ScriptRunner Web Service Connector

The ScriptRunner service provides a REST API via the configured IP port for the Web Service Connector. The Web Service Connector can be used to start actions.

Third party systems can use this Connector to start ScriptRunner actions via web packages.

An action started via Web Service Connector is no different from an action started in an ScriptRunner app. After the action is finished, the execution is logged in ScriptRunner.
In the report, reason displays the corresponding Web service connector as the trigger,
started by displays the user who sent the Web request.


To use of the ScriptRunner Web Service Connector, the connector must be licensed.
The license key can be requested via email to ScriptRunner Support (support@scriptrunner.com). 

Update-AsrLicense -Key 'licence key' -Restart

Configure the Web Service Connector

In the ScriptRunner Admin App, connectors can be created, edited, deleted, enabled or disabled.

A Web Service Connector specifies an external system that is allowed to issue Web Service requests to the ScriptRunner REST API, triggering ScriptRunner Action execution from the external system.

The external system is identified by the source IP address of the REST request.

You can disable a Web Service Connector to temporarily block access from the respective system. A disabled Web Service Connector also does not consume a Web Service Connector license.

The IP address, of the calling source system with the Web service client, is configured first.
Only REST calls from this IP address are accepted by the connector. A separate connector for the IP source address is required for each system.

The authorization for calling the connector is determined by the delegation. On the source system, the Web service client is configured that a valid and authorized REST call can be executed with a JSON data object.

Start the action from the third party system

If the source system executes a REST call to the Web Service Connector, the Connector first checks for the IP source address. If this is valid, the authentication check is then run. If the authentication is valid, the transmitted data is extracted.

Before the action is started, it is determined whether it is allowed to be started by the connector. If so, the valid parameters are passed to the action and it starts.

The unique ID of the action execution is returned to the source system so that it can retrieve the results and reports of the action.

This page has been automatically translated and may contain grammatical errors or inaccuracies