flexagon.fd.services.groovy.functions

Class WebhookSlackFunctions

java.lang.Object

flexagon.fd.services.groovy.functions.BaseFunctions

flexagon.fd.services.groovy.functions.SlackFunctions

flexagon.fd.services.groovy.functions.WebhookSlackFunctions

public class WebhookSlackFunctions
extends SlackFunctions

Field Summary

Fields inherited from class flexagon.fd.services.groovy.functions.SlackFunctions

APPROVE_STRING, REJECT_STRING

Fields inherited from class flexagon.fd.services.groovy.functions.BaseFunctions

mExecute, mFLOG, mScriptRef

Constructor Summary

Constructors

Constructor and Description
WebhookSlackFunctions(boolean isExecute, LogFunctions pFLOG)

Method Summary

Modifier and Type	Method and Description
FlexSlackMessage	makePipelineStageCompletedMessage(java.lang.Object pPayload) Creates a PipelineStageCompleted Event message that can be posted via postMessage.
FlexSlackMessage	makeSnapshotCompleteMessage(java.lang.Object pPayload) Creates a SnapshotCompleted Event message that can be posted via postMessage.
FlexSlackMessage	makeTaskCreatedMessage(java.lang.Object pPayload, java.lang.Boolean pAllowInteraction) Creates a TaskCreated Event message that can be posted via postMessage.
FlexSlackMessage	makeWorkflowCompletedMessage(java.lang.Object pPayload, java.lang.Boolean pIncludeErrorData) Creates a WorkflowCompleted Event message that can be posted via postMessage.
void	updateTask(java.lang.Object pSlackPayload, java.lang.Boolean pUpdateInPlace) Approves or rejects a task from an incoming Slack webhook payload.

Methods inherited from class flexagon.fd.services.groovy.functions.SlackFunctions

cleanup, getGroovyKey, getUserFromSlackId, postAttachment, postAttachment, postMessage, postMessage, postSimpleMessage

Methods inherited from class flexagon.fd.services.groovy.functions.BaseFunctions

decryptIntegrationInstance, doSimpleGet, findIntegrationInstanceByCode, getLogFunctions, getServerBaseUrl, setScriptRef

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebhookSlackFunctions

public WebhookSlackFunctions(boolean isExecute,
                             LogFunctions pFLOG)

Method Detail

updateTask

public void updateTask(java.lang.Object pSlackPayload,
                       java.lang.Boolean pUpdateInPlace)
                throws FlexCheckedException

Approves or rejects a task from an incoming Slack webhook payload. This method expects the inbound webhook payload resulting from the makeTaskCreatedMessage formatted message. Works with Approval tasks only.

Parameters:

pSlackPayload - Slack webhook payload resulting from makeTaskCreatedMessage post message.

pUpdateInPlace - Should the original message be updated with this response.

Throws:

FlexCheckedException

Since:

5.4

makeSnapshotCompleteMessage

public FlexSlackMessage makeSnapshotCompleteMessage(java.lang.Object pPayload)
                                             throws FlexCheckedException

Creates a SnapshotCompleted Event message that can be posted via postMessage. This function will infer the event details and format the Slack message accordingly

Parameters:

pPayload - Payload for the Workflow Completed Event. The EVENT.payload key should be used

Throws:

FlexCheckedException

Since:

5.4

makePipelineStageCompletedMessage

public FlexSlackMessage makePipelineStageCompletedMessage(java.lang.Object pPayload)
                                                   throws FlexCheckedException

Creates a PipelineStageCompleted Event message that can be posted via postMessage. This function will infer the event details and format the Slack message accordingly

Parameters:

pPayload - Payload for the Pipeline Stage Completed Event. The EVENT.payload key should be used

Throws:

FlexCheckedException

Since:

5.4

makeTaskCreatedMessage

public FlexSlackMessage makeTaskCreatedMessage(java.lang.Object pPayload,
                                               java.lang.Boolean pAllowInteraction)
                                        throws FlexCheckedException

Creates a TaskCreated Event message that can be posted via postMessage. This function will infer the event details and format the Slack message accordingly

Parameters:

pPayload - Payload for the Task Created Event. The EVENT.payload key should be used

pAllowInteraction - If true, the message will contain interactive buttons to approve/reject the task via inbound webhooks. See the official Events documentation for more information.

Throws:

FlexCheckedException

Since:

5.4

makeWorkflowCompletedMessage

public FlexSlackMessage makeWorkflowCompletedMessage(java.lang.Object pPayload,
                                                     java.lang.Boolean pIncludeErrorData)
                                              throws FlexCheckedException

Creates a WorkflowCompleted Event message that can be posted via postMessage. This function will infer the event details and format the Slack message accordingly

Parameters:

pPayload - Payload for the Workflow Completed Event. The EVENT.payload key should be used

pIncludeErrorData - If the workflow is a failure, should error data be included in the message. Setting this to false can improve performance of messaging.

Returns:

A FlexSlackMessage which can be posted via postMessage

Throws:

FlexCheckedException

Since:

5.4