Cprime Apps has been rebranded as Anova Apps. Please note the only effect is the company name - all of our products’ names, logos, functionalities, support, etc. is exactly the same. The new location to our documentation space is https://anovaapps.atlassian.net.
This feature is available starting with v4.5.0.
Webhooks give you the possibility to run existing SIL scripts from outside of the Jira / Confluence instance, by using a REST/HTTP client and retrieve the results of the run script.
In order for this to be possible, you need the following things:
Creating a SIL script
Example 1 - Getting the Webhooks payload from the calling client and returning custom results and HTTP response code
The format for the return line. If used, it should return
>[, <HTTP status code>];
The first argument can only have the 'true' or 'false' values. 'True' means that the script was run correctly, and 'false' means that the script encountered a problem when it was run.
It is highly recommended that you use valid HTTP status codes.
To define what URI and HTTP method(s) will be used to invoke a specific SIL™ script, use the SIL Webhooks configuration.
- Log in to your Jira as Admin.
- Go to your Administration > Add-ons > CPRIME PLUGINS CONFIGURATION > SIL Webhooks Configuration.
- To create a Webhook entry, click the the Add webhook button.
A screen like the following will appear:
- Fill in the parameters in the form:
- Name - the name of the webhook. This will be used as an identifier for the webhook configuration.
- Methods - the HTTP method (or methods) to bind the webhook to.
- Script - SIL™ script that will run when calling this webhook.
- Synchronized - the sync/async configuration for the webhook.
The difference between synchronous and asynchronous is that the asynchronous Webhook SIL call can't return any results or custom HTTP codes to the caller. This happens because the SIL script run task is added to a list of future tasks to be run, and the HTTP call ends.
With the synchronous option, the call will block until the SIL script run is completed, and the results will be returned to the caller.
- Save the configuration.
After you save the configuration, a new entry like the following one will show up:
The URI column in the table will help you run your newly created webhook. For example if your Jira installation instance is located at , you can run the webhook using the http://localhost/rest/keplerrominfo/refapp/latest/webhooks/mysilwebhook/run address with the selected HTTP method(s).
You can access the webhook configured in this example image using the HTTP methods GET and POST.
Changes are visible immediately and the webhook is ready immediately.
If you configured the Webhook to be available for the GET HTTP method, you can test the webhook in the browser, giving it custom query parameters, and the result could look something like this (the above SIL script was used):
In Power Scripts for Cloud, the prefix for the above link should be the add-on URL (https://pscloud.cprime.com/refapp). Also, the JWT query parameter will be needed, and will be accessible from the SIL webhook script.
More details about how the JWT works are here.
If you can't find out how to generate one by yourself, the easiest way to get one is to open one of our pages from the SIL Manager's Quick Links menu (for example, the SIL Webhooks Configuration) in a new tab and copy it from that URL directly.
Note that you'll have to consider this parameter in your SIL script as well.
WARNING: The JWT will not appear in the URL when opening a page from the Jira Admin side bar menu, only when opening from the quick links.
For the REST/HTTP client to be able to make any Webhooks calls, it needs to be authenticated into the Jira / Confluence instance.
Please refer to the Atlassian Security pages for information on the authentication:
There is no content with the specified labels