raiseEvent

Syntax

raiseEvent(event_name, issue, user)

Description

Triggers an event to be processed by listeners.

Parameters

Parameter name

Type

Required

Description

event name

String

Yes

Name of the event to be triggered, as it appears in the Administration->Events section.

issue key

String

Yes

Key of the issue that will raise the event.

user name

String

Yes

User name of the user who will generate the event.

Return type

boolean (true/false)

A "true" return value means that the specified event was triggered successfully. A "false" value means that there was a problem and you should investigate this further by consulting the logs.

Example

Example 1

Returns "true" if the event was triggered for the issue PRJ-231 by the current user and "false" if the event wasn't triggered.

Example 2

Returns "true" if the event was triggered for the current issue by the user "Admin" and "false" if the event wasn't triggered.

See also