Destination Function Template

Base template to deploy your next destination function with

1. Click Use This Template above (If Segment PS, add to Segment Services Engineering Organization

Setup Steps

1. nvm use (to get the right version of NodeJS)
   • If needed, install nvm
2. npm install (to install npm dependencies)

To Test

npm run test

• The Buildkite pipeline also runs tests before deploying
• Tests are created in src/index.test.js

To Deploy via Buildkite

The pipeline is defined in .buildkite/pipeline.yml. It installs dependencies, runs tests, then deploys the function to the target environment via scripts/deployDestinationFunction.js.

1. Create a Buildkite pipeline pointed at this repo (GitHub webhook + a queue with connected agents). On the twilio-primary-default cluster, use a live general-purpose queue such as general-001 — the default queue is paused and has no agents, so jobs sent there hang in "queuing".
2. Create the Function in your Segment Workspace.
3. Create a Public API Token to allow for deploying.
4. Store the deploy secrets in AWS Secrets Manager as a single JSON secret and let the pipeline read them at deploy time by assuming an IAM role via the Buildkite OIDC provider (no static keys, no Buildkite-stored secrets):
   • Secret segment/destination-function-template (region us-west-2, account 058449100246) with shape:

     { "FUNCTION_ID": "dfn_...", "PUBLIC_API_TOKEN": "..." }

   • IAM role twilio-internal_destination-function-template is assumed by the aws-assume-role-with-web-identity plugin; its trust policy is scoped to this pipeline's slug and it may only read this one secret.
   • The deploy step sources .buildkite/fetch-secrets.sh to load them. See the internal "Assuming IAM Roles" guide to reproduce this for a new function repo (new secret + new role scoped to the new slug).

Deploying to multiple environments

The pipeline deploys feature branches to DEV automatically. To promote to QA/PROD:

1. Uncomment the QA/PROD block and deploy steps in .buildkite/pipeline.yml.
2. Push your changes.
3. On a main build, unblock the Release to QA (then Release to PROD) step in the Buildkite UI to promote the deploy. The target environment is selected via the DEPLOY_ENV variable on each step.

Tooling Included

1. Jest for code testing
2. Prettier for code formatting
3. ESLint for code linting
4. Buildkite pipeline for function deploy
5. Husky for commit validation