File structure

At its most basic, a custom integration is a ZIP file that contains at least three files:

  • icon.png
  • index.ts
  • manifest.json

Note: Aside from manifest.json, the file names are arbitrary and can be changed.

icon.png

An icon that helps distinguish the integration from other integrations in FL0's UI.

index.ts

A TypeScript file that contains the integration's business logic. FL0 expects this file to contain certain functions that run at certain points in the lifecycle of the integration.

Note: An integration may contain additional TypeScript files depending on the features it supports.

manifest.json

A configuration file for defining the integration's metadata, such as its ID and name, and the integration's features.

To learn more, see Creating a manifest.json file.