Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here !


Info
titleAvailability

This routine is available starting with SIL Engine™ 4.15.0.

Syntax

httpBasicAuthHeaderappendToWebhookResponse(username, passwordresponsePart)

Description

Excerpt

Creates Adds an HttpHeader object to be used as Authorization header for a Basic authentication of a userthe response that will be returned to the Webhook caller, as the HTTP body.

Parameters

...

Parameter name

Type

Required

Description

usernameresponsePart

string

Yes

The username.

passwordstringYesThe password.

Return type

HttpHeader

Example

object to be added to the response


Note
titleNOTE

If the responsePart parameter has another type but string, a conversion to string will be attempted.

In this case, this is uncertain what the actual resulting string will look like, or an event if it exists.


Example

Code Block
languagecpp
themeConfluence
//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, 200;

See also

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "http_support"in ( "predefined_structure_types" , "webhooks_configuration" , "webhooks_routines" )
labelsjira_project_routine