...
Webhooks gives the user the possibility to run existing SIL scripts, from outside of the JIRA Jira/Confluence instance, by using a REST/HTTP client, and retrieve the results of the script run.
In order for this to be possible, we need 2 things:
...
Almost any SIL script can be used, but the two Webhooks specific SIL routines make this getWebhookPayload and appendToWebhookResponse are the ones that make this feature powerful (getWebhookPayload, appendToWebhookResponse).
Example 1 - Getting the Webhooks payload from the calling client and returning custom results and HTTP response code:
...
To create a Webhook entry, click the "Add webhook".
Fill the form with the desired Webhook name, the HTTP Method that will be used to trigger this webhook, the path to the desired script to be invoked, and weather or not the invocation should be Synchronous or not.
| Warning | ||||
|---|---|---|---|---|
| ||||
At the moment only the Microsoft Active Directory is supported, though it might work with other systems too (for example works with OpenDS). However, we are eagerly waiting for requests to extend this functionality to different LDAP servers. |
NOTE: The difference between creating a 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 is run, and the results will be returned to the caller.
...
Changes are visible immediately.
Default LDAP
You can mark the default LDAP server by clicking the Make Default icon. Only one LDAP may be configured as default. This setting was necessary to obey the backward compatibility rules. Since the LDAP routines have received one optional extra parameter that represents the LDAP configuration name, to make old programs run without modifications, we added the default LDAP (or primary LDAP). This default LDAP is used when that parameter in the LDAP calls is missing.
Of course, only one LDAP configuration may be marked as default.
...
| title | Warning |
|---|
...
Webhooks Authentication
Fore the REST/HTTP client to be able to make any Webhooks calls, it needs to be authenticated into the Jira/Confluence instance.
Please see the official Atlassian Security pages:
- https://developer.atlassian.com/server/jira/platform/basic-authentication/
- https://developer.atlassian.com/cloud/confluence/basic-auth-for-rest-apis/