Versions Compared

Key

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

<ac:structured-macro ac:name="table-plus" ac:schema-version="1" data-layout="default">
<ac:parameter ac:name="applyColStyleToCell

...

">true</ac:parameter>
<ac:parameter ac:name="heading">0</ac:parameter>
<ac:parameter ac:name="columnTypes">s,s,s,

...

s</ac:parameter>
<ac:parameter ac:name="multiple">false</ac:parameter>
<ac:parameter ac:name="columnAttributes">style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,</ac:parameter>
<ac:parameter ac:name="enableSorting

...

Syntax

...

appendToWebhookResponse(responsePart)

...

Package

...

Alias

...

Pkg Usage

Description

...

">false</ac:parameter>
<ac:rich-text-body>
<table data-layout="default">
<colgroup>

<col style="width: 76.0px;" />
<col style="width: 410.0px;" />
<col style="width: 99.0px;" />
<col style="width: 141.0px;" />

</colgroup>
<tbody>
<tr>
<td>
<p><strong>Syntax</strong></p>
</td>
<td>
<p>appendToWebhookResponse(responsePart)</p>
</td>
<td>
<p><strong>Package</strong></p>
</td>
<td>
<p></p>
</td>
</tr>
<tr>
<td>
<p><strong>Alias</strong></p>
</td>
<td>
<p></p>
</td>
<td>
<p><strong>Pkg Usage</strong></p>
</td>
<td>
<p></p>
</td>
</tr>
</tbody>
</table>
</ac:rich-text-body>
</ac:structured-macro>
<h2>Description</h2>
<ac:structured-macro ac:name="excerpt" ac:schema-version="1" data-layout="default">
<ac:parameter ac:name="hidden">true</ac:parameter>
<ac:rich-text-body>
Adds an object to the response that will be returned to the Webhook caller, as the HTTP body.

...

Adds
</ac:rich-text-body>
</ac:structured-macro>
<p>Adds an object to the response that will be returned to the Webhook caller, as the HTTP body.

Parameters

...

</p>
<h2>Parameters</h2>
<ac:structured-macro ac:name="table-plus" ac:schema-version="1" data-layout="default">
<ac:parameter ac:name="applyColStyleToCell">true</ac:parameter>
<ac:parameter ac:name="columnTypes">s,s,s,

...

Parameter name

...

Type

...

Required

...

Description

...

responsePart

...

String

...

Yes

...

The object to be added to the response

Return Type

None

Example

...

languagejs

...

s</ac:parameter>
<ac:parameter ac:name="heading">0</ac:parameter>
<ac:parameter ac:name="multiple">false</ac:parameter>
<ac:parameter ac:name="enableSorting">false</ac:parameter>
<ac:rich-text-body>
<table data-layout="default">
<colgroup>
<col style="width: 170.0px;" />
<col style="width: 97.0px;" />
<col style="width: 108.0px;" />
<col style="width: 305.0px;" />
</colgroup>
<tbody>
<tr>
<th>
<p>Parameter name</p>
</th>
<th>
<p>Type</p>
</th>
<th>
<p>Required</p>
</th>
<th>
<p>Description</p>
</th>
</tr>
<tr>
<td>
<p>responsePart</p>
</td>
<td>
<p>String</p>
</td>
<td>
<p>Yes</p>
</td>
<td>
<p>The object to be added to the response</p>
</td>
</tr>
</tbody></table>
</ac:rich-text-body>
</ac:structured-macro>
<h2>Return Type</h2>
<p><strong>None</strong></p>

<h2>Example</h2>

<ac:structured-macro ac:name="code" ac:schema-version="1">
<ac:parameter ac:name="language">js</ac:parameter>
<ac:plain-text-body>
<![CDATA[//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,

...

1234;]]>
</ac:plain-text-body>
</ac:structured-macro>

<p><ac:structured-macro ac:name="noteIf the responsePart " ac:schema-version="1">
<ac:rich-text-body>
<p>If the <strong>responsePart</strong> parameter has another type but string, a conversion to string will be attempted.

See also

Filter by label (Content by label)showLabelsfalsemax25showSpacefalsecqllabel </p>
</ac:rich-text-body>
</ac:structured-macro></p>
<h2>See also</h2>
<p><ac:structured-macro ac:name="contentbylabel" ac:schema-version="4" data-layout="default">
<ac:parameter ac:name="showLabels">false</ac:parameter>
<ac:parameter ac:name="max">25</ac:parameter>
<ac:parameter ac:name="showSpace">false</ac:parameter>
<ac:parameter ac:name="cql">label = "webhook_routine" and space = currentSpace ( )</ac:parameter>
<ac:parameter ac:name="labelsarray_routines">array_routines</ac:parameter>
</ac:structured-macro></p>