Webhooks summary

...

Webhooks summary

...

...

...

In order for this to be possible, we you need 2 the following things:

1. Create a SIL script.
2. Configure a webhook to run that SIL script.

Creating a SIL script

Almost You can use almost any SIL script can be used, but the two Webhooks specific SIL routines getWebhookPayload and appendToWebhookResponse are the ones that make this feature powerfulespecially powerful with this feature.

Example 1 - Getting the Webhooks payload from the calling client and returning custom results and HTTP response code

...

Code Block
language cpp theme Eclipse firstline 16 linenumbers trueConfluence
//getting the REST/HTTP call input parameters: WebhookPayload httpRequestPayload = getWebhookPayload(); //getting the used HTTP method: string httpMethod = httpRequestPayload.httpMethod;//This can be something like "GET", "POST", "PUT" etc. //getting the http request payload (body): string httpPayload = httpRequestPayload.payload; //getting the http query parameters: WebhookParam[] httpQueryParams = httpRequestPayload.queryParams; string firstQueryParamName = httpQueryParams[0].name; string firstQueryParamValue = httpQueryParams[0].values[0]; //sending the response back to the caller: appendToWebhookResponse("http method:"); appendToWebhookResponse(httpMethod); appendToWebhookResponse("payload:"); appendToWebhookResponse(httpPayload); appendToWebhookResponse("firstQueryParamName:"); appendToWebhookResponse(firstQueryParamName); appendToWebhookResponse("firstQueryParamValue:"); appendToWebhookResponse(firstQueryParamValue); //returning a custom HTTP status code: return true, 1234200;

The format for the return line, if . If used, it should be return <true|false>[, <Custom HTTP <HTTP status code>];
The first argument can only have the values 'true' or 'false' values. 'True' means that the script was run was correctly, and 'false' means that the script encountered a problem when it was run.

Note
title NOTE
It is highly recommended that you use valid HTTP status codes.

Webhooks

...

configuration

To define what URI and HTTP method(s) will be used to invoke a specific SIL™ script, use the SIL Webhooks Configuration should be used. The page is located under configuration.

1. Log in to your Jira as Admin.
2. Go to your Administration > Add-ons

...

1. > CPRIME PLUGINS CONFIGURATION > SIL Webhooks Configuration.
2. To create a Webhook entry, click the the

...

1. Add webhook

...

1. button.
   A screen like the following will appear:
   
   Image Added
   
   
2. Fill in the parameters in the form

...

1. :
   • 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.

   Note
   title NOTE
   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.

...

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

Image Removed

Parameters:

• Directory - the directory type. Only MS Active Directory is supported at the moment. If you have other LDAP type, ask for support.
• Name - the LDAP configuration name, unique.
• Base DN - the base DN, used as a root for that LDAP.
• User / Password - the LDAP user and the password (it is not usually a single word, but a string like shown above).

There are also two optional parameters:

• Connection time-out, self explanatory
• Use cache - if checked, it will cache the records. Use it for better performance, but it may not reflect exactly what's in the LDAP database.

Click the Test button to test the configuration validity. Any errors are reported back into the page dialog, allowing you to adjust your configuration until the connection is established successfully.

Once added, the LDAP configurations can be edited, removed and tested from the same page:

Image Removed

Changes are visible immediately.

Webhooks Authentication

...

1. 
   

2. Save the configuration.
   After you save  the configuration, a new entry like the following one will show up:
   
   Image Added
   
   The URI column in the table will help you run your newly created webhook. For example if your Jira installation instance is located at http://localhost, 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):

Image Added

Webhooks authentication

For the REST/HTTP client to be able to make any Webhooks calls, it needs to be authenticated into the Jira / Confluence instance.

Please see refer to the official Atlassian Security pages for information on the authentication:

1. https://developer.atlassian.com/server/jira/platform/basic-authentication/
2. https://developer.atlassian.com/cloud/confluence/basic-auth-for-rest-apis/

See also

...

Filter by label (Content by label)
showLabels false showSpace false cql label in ( "predefined_structure_types" , "webhooks_routines" ) labels jira_project_routine