Bitbucket modules
Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

Trigger

The trigger module invokes a function when a product event, app lifecycle event, or data security policy event is fired. For example, as the result of an issue being created in Jira.

Properties

PropertyTypeRequiredDescription
key

string

Yes

A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

functionstring

A reference to the function module that defines the behavior.

Required if no endpoint is specified.

endpointstring

A reference to the endpoint that specifies the remote back end that receives the event if you are using Forge remote to integrate with a remote back end.

Required if no function is specified.

eventsArray<string>YesA list of product events that trigger the function or endpoint.
filterFilterNoA set of options to prevent invoking a function or endpoint.

Filter reference

PropertyTypeRequiredDescription
ignoreSelfbooleanYes

Ignore self-generated events.

For example, an app updates an issue and ignores the avi:jira:updated:issue event that is generated by this operation.

Note that currently ignoreSelf only works with Jira events.

Example

1
2
modules:
  trigger:
    - key: ignore-self-trigger
      function: main
      events:
        - avi:jira:updated:issue
      filter:
        ignoreSelf: true
  function:
    - key: main
      handler: index.run

Rate this page: