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

Property	Type	Required	Description
`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_-]+$`
`function`	`string`	Required if using UI Kit 1.	A reference to the function module that defines the module. Only used in UI Kit 1.
`endpoint`	`string`		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.
`events`	`Array<string>`	Yes	A list of product events that trigger the function or endpoint.
`filter`	Filter	No	A set of options to prevent invoking a function or endpoint.

Filter reference

Property Type Required Description

Property	Type	Required	Description
`ignoreSelf`	`boolean`	Yes	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.

ignoreSelf

boolean

Yes

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