Serverless functions are an integral part of the Forge platform, enabling developers to create custom, scalable applications that interact and extend seamlessly with Atlassian's suite of apps. Functions underpin many other foundational capabilities of the platform, including UI backend resolvers, Atlassian app events, and more.

Platform pricing resources

Learn more about Forge’s pricing structure, allowances, and billing by visiting Forge platform pricing.

Estimate your app’s monthly costs using the cost estimator, which lets you model usage and see potential charges.

Basic usage

Creating a function

Dependencies

The following dependency should be installed at the top-level directory of your app:

1
2
npm i @forge/api@latest

File structure

The following directory and function entry point file should be added to your app /src folder:

1
2
/src
  /functions
    /index.js

Handler

The following function handler should be defined in the /src/functions/index.js file:

1
2
export const handler = (...args) => {
  console.log(args);
  // Do something
}

See Arguments for the schema of ...args.

Manifest definition

The following function should be declared in the app manifest:

1
2
modules:
  function:
    - key: my-function
      handler: index.handler

The function key is my-function, while the directory name is functions. These do not need to match. The key is a unique identifier used to reference this function from other modules (see example below). The handler specifies the file and function to execute: index.handler refers to the handler function exported from index.js in the /src/functions/ directory.

Attaching a function to a module

To enable your function to run, it needs to be attached to a module via the app manifest. For example, a scheduled trigger that uses the function key we defined above:

1
2
modules:
  scheduledTrigger:
    - key: example
      function: my-function # References the function with key: my-function
      interval: hour # Runs hourly

See common modules for a complete list of backend entry points.