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

Rate this page:

Function

The function module is where the app's behavior is defined. Other modules specify the function module that defines the actions to take.

Properties

PropertyTypeRequiredDescription
keystringYes

A key for the module, which other modules can refer to. Must be unique within the manifest and have a maximum of 23 characters.

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

handlerstringYes

A pointer to the function responsible for handling invocations.

Expected format: file.function

For example, jira.issueCreationTrigger calls the issueCreationTrigger function defined in jira.js in the app's src directory.

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

providersProviders

A list of the providers required by the function.

Example

1
2
modules:
  function:
    - key: main
      handler: index.run

Provider reference

PropertyTypeRequiredDescription
authList<string>Yes

A list of keys referencing authentication providers.

Example

1
2
function:
  - key: google-macro
    handler: index.google_macro
    providers:
      auth:
        - google
  - key: dropbox-macro
    handler: index.dropbox_macro
    providers:
      auth:
        - dropbox

Rate this page: