references/job-catalog

When building an official integration (in the Trigger.dev monorepo) you should use the job-catalog to test your integration. This collection of reference jobs is useful for creating docs as well as testing.

1. Getting setup

You can follow the README to get setup. It explains how to add a new Job as well.

2. Adding your package

You’ll need to add your integration to the package.json file:

{
  ...
  "dependencies": {
    "@trigger.dev/mynewapi": "workspace:*",
  }
  ...
}

And to the tsconfig.json file:

{
  ...
  "compilerOptions": {
    ...
    "paths": {
      ...
      "@trigger.dev/mynewapi": [
        "../../integrations/mynewapi/src/index"
      ],
      "@trigger.dev/mynewapi/*": [
        "../../integrations/mynewapi/src/*"
      ]
    }
  }
}

3. Adding your Jobs

Create a new file in src that uses all the features of your integration. The Typeform one is a useful reference that has Tasks and Triggers.

Was this page helpful?