Source Functions

Source functions allow you to gather data from any third-party applications without worrying about setting up or maintaining any infrastructure.

All functions are scoped to your workspace, so members of other workspaces cannot view or use them.

Create a source function

1. From your workspace, go to Connections > Catalog and click the Functions tab.
2. Click New Function.
3. Select Source as the function type and click Build.

After you click Build, a code editor appears. Use the editor to write the code for your function, configure settings, and test the function’s behavior.

Code the source function

Source functions must have an onRequest() function defined. This function is executed by Segment for each HTTPS request sent to this function’s webhook.

async function onRequest(request, settings) {
  // Process incoming data
}

The onRequest() function receives two arguments:

• request - an object describing the incoming HTTPS request.
• settings - set of settings for this function.

Request processing

To parse the JSON body of the request, use the request.json() method, as in the following example:

async function onRequest(request) {
  const body = request.json()
  console.log('Hello', body.name)
}

Use the request.headers object to get values of request headers. Since it’s an instance of Headers, the API is the same in both the browser and in Node.js.

async function onRequest(request) {
  const contentType = request.headers.get('Content-Type')
  const authorization = request.headers.get('Authorization')
}

To access the URL details, refer to request.url object, which is an instance of URL.

async function onRequest(request) {
  // Access a query parameter (e.g. `?name=Jane`)
  const name = request.url.searchParams.get('name')
}

Sending messages

You can send messages to the Segment API using the Segment object:

async function onRequest(request) {
  Segment.identify({
    userId: 'user_id',
    traits: {
      name: 'Jane Hopper'
    }
  })

  Segment.track({
    event: 'Page Viewed',
    userId: 'user_id',
    properties: {
      page_name: 'Summer Collection 2020'
    }
  })

  Segment.group({
    groupId: 'group_id',
    traits: {
      name: 'Clearbit'
    }
  })

  Segment.set({
    collection: 'products',
    id: 'product_id',
    properties: {
      name: 'Nike Air Max'
    }
  })
}

Identify

Use Identify calls to connect users with their actions, and to record traits about them.

Segment.identify({
  userId: 'user_id',
  traits: {
    name: 'Jane Hopper'
  }
})

The Segment.identify() method accepts an object with the following fields:

• userId - Unique identifier for the user in your database.
• anonymousId - A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier.
• traits - Object with data about or related to the user, like name or email.
• context - Object with extra information that provides useful context, like locale or country.

Track

Track calls record actions that users perform, along with any properties that describe the action.

Segment.track({
  event: 'Page Viewed',
  userId: 'user_id',
  properties: {
    page_name: 'Summer Collection 2020'
  }
})

The Segment.track() method accepts an object with the following fields:

• userId - Unique identifier for the user in your database.
• anonymousId - A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier.
• properties - Object with data that is relevant to the action, like product_name or price.
• context - Object with extra information that provides useful context, like locale or country.

Group

Group calls associate users with a group, like a company, organization, account, project, or team.

Segment.group({
  groupId: 'group_id',
  traits: {
    name: 'Clearbit'
  }
})

The Segment.group() method accepts an object with the following fields:

• groupId - Unique identifier for the group in your database.
• traits - Object with data that is relevant to the group, like group_name or team_name.
• context - Object with extra information that provides useful context, like locale or country.

Page

Page calls record whenever a user sees a page of your website, along with any other properties about the page.

Segment.page({
  name: 'Shoe Catalog',
  properties: {
    url: 'https://myshoeshop.com/catalog'
  }
})

The Segment.page() method accepts an object with the following fields:

• userId - Unique identifier for the user in your database.
• anonymousId - A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier.
• name - Name of the page.
• properties - Object with information about the page, like page_name or page_url.
• context - Object with extra information that provides useful context, like locale or country.

Screen

Screen calls record when a user sees a screen, the mobile equivalent of Page, in your mobile app.

Segment.screen({
  name: 'Shoe Feed',
  properties: {
    feed_items: 5
  }
})

The Segment.screen() method accepts an object with the following fields:

• userId - Unique identifier for the user in your database.
• anonymousId - A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier.
• name - Name of the screen.
• properties - Object with data about the screen, like screen_name.
• context - Object with extra information that provides useful context, like locale or country.

Alias

The Alias call merges two user identities, effectively connecting two sets of user data as one.

Segment.alias({
  previousId: 'old-email@example.com',
  userId: 'new-email@example.com'
})

The Segment.alias() method accepts an object with the following fields:

• previousId - Previous unique identifier for the user.
• userId - Unique identifier for the user in your database.
• anonymousId - A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier.

Set

The Set call uses the object API to save object data to your Redshift, BigQuery, Snowflake, or other data warehouses supported by Segment.

Segment.set({
  collection: 'products',
  id: 'product_id',
  properties: {
    name: 'Nike Air Max 90',
    size: 11
  }
})

The Segment.set() method accepts an object with the following fields:

• collection - A collection name, which must be lowercase.
• id - An object’s unique identifier.
• properties - An object with free-form data.

Runtime and dependencies

On March 26, 2024, Segment is upgrading the Functions runtime environment to Node.js v18, which is the current long-term support (LTS) release.

This upgrade keeps your runtime current with industry standards. Based on the AWS Lambda and Node.js support schedule, Node.js v16 is no longer in Maintenance LTS. Production applications should only use releases of Node.js that are in Active LTS or Maintenance LTS.

All new functions will use Node.js v18 starting March 26, 2024.

For existing functions, this change automatically occurs as you update and deploy an existing function. Segment recommends that you check your function post-deployment to ensure everything’s working. Your function may face issues due to the change in sytax between different Node.js versions and dependency compatibility.

Functions do not currently support importing dependencies, but you can contact Segment Support to request that one be added.

The following dependencies are installed in the function environment by default.

• atob v2.1.2 exposed as atob
• aws-sdk v2.488.0 exposed as AWS
• btoa v1.2.1 exposed as btoa
• fetch-retry exposed as fetchretrylib.fetchretry
• form-data v2.4.0 exposed as FormData
• @google-cloud/automl v2.2.0 exposed as google.cloud.automl
• @google-cloud/bigquery v5.3.0 exposed as google.cloud.bigquery
• @google-cloud/datastore v6.2.0 exposed as google.cloud.datastore
• @google-cloud/firestore v4.4.0 exposed as google.cloud.firestore
• @google-cloud/functions v1.1.0 exposed as google.cloud.functions
• @google-cloud/pubsub v2.6.0 exposed as google.cloud.pubsub
• @google-cloud/storage v5.3.0 exposed as google.cloud.storage
• @google-cloud/tasks v2.6.0 exposed as google.cloud.tasks
• hubspot-api-nodejs exposed as hubspotlib.hubspot
• jsforce v1.11.0 exposed as jsforce
• jsonwebtoken v8.5.1 exposed as jsonwebtoken
• libphonenumber-js exposed as libphonenumberjslib.libphonenumberjs
• lodash v4.17.19 exposed as _
• mailchimp marketing exposed as mailchimplib.mailchimp
• mailjet exposed as const mailJet = nodemailjet.nodemailjet;
• moment-timezone v0.5.31 exposed as moment
• node-fetch v2.6.0 exposed as fetch
• oauth v0.9.15 exposed as OAuth
• @sendgrid/client v7.4.7 exposed as sendgrid.client
• @sendgrid/mail v7.4.7 exposed as sendgrid.mail
• skyflow exposed as skyflowlib.skyflow
• stripe v8.115.0 exposed as stripe
• twilio v3.68.0 exposed as twilio
• uuidv5 v1.0.0 exposed as uuidv5.uuidv5
• winston v2.4.6 exposed as const winston = winstonlib.winston
• xml v1.0.1 exposed as xml
• xml2js v0.4.23 exposed as xml2js

• zlib v1.0.5 exposed as zlib.zlib

  
  uuidv5 is exposed as an object. Use uuidv5.uuidv5 to access its functions. For example:

    async function onRequest(request, settings) {
         uuidv5 = uuidv5.uuidv5;
         console.log(typeof uuidv5);
  
          //Generate a UUID in the default URL namespace
          var urlUUID = uuidv5('url', 'http://google/com/page');
          console.log(urlUUID);
  
          //Default DNS namespace
          var dnsUUID = uuidv5('dns', 'google.com');
          console.log(dnsUUID);
      }
  

  zlib’s asynchronous methods inflate and deflate must be used with async or await. For example:

  zlib = zlib.zlib;  // Required to access zlib objects and associated functions
  async function onRequest(request, settings) {
    const body = request.json();
  
    const input = 'something';
  
    // Calling inflateSync method
    var deflated = zlib.deflateSync(input);
  
    console.log(deflated.toString('base64'));
  
    // Calling inflateSync method
    var inflated = zlib.inflateSync(new Buffer.from(deflated)).toString();
  
    console.log(inflated);
  
    console.log('Done');
    }
  

The following Node.js modules are available:

• crypto Node.js module exposed as crypto.
• https Node.js module exposed as https.

Other built-in Node.js modules aren’t available.

For more information on using the aws-sdk module, see how to set up functions for calling AWS APIs.

Caching

Basic cache storage is available through the cache object, which has the following methods defined:

• cache.load(key: string, ttl: number, fn: async () => any): Promise<any>
  • Obtains a cached value for the provided key, invoking the callback if the value is missing or has expired. The ttl is the maximum duration in milliseconds the value can be cached. If omitted or set to -1, the value will have no expiry.
• cache.delete(key: string): void
  • Immediately remove the value associated with the key.

Some important notes about the cache:

• When testing functions in the code editor, the cache will be empty because each test temporarily deploys a new instance of the function.
• Values in the cache are not shared between concurrently-running function instances; they are process-local which means that high-volume functions will have many separate caches.
• Values may be expunged at any time, even before the configured TTL is reached. This can happen due to memory pressure or normal scaling activity. Minimizing the size of cached values can improve your hit/miss ratio.
• Functions that receive a low volume of traffic may be temporarily suspended, during which their caches will be emptied. In general, caches are best used for high-volume functions and with long TTLs. The following example gets a JSON value through the cache, only invoking the callback as needed:

const ttl = 5 * 60 * 1000 // 5 minutes
const val = await cache.load("mycachekey", ttl, async () => {
    const res = await fetch("http://echo.jsontest.com/key/value/one/two")
    const data = await res.json()
    return data
})

Create settings and secrets

Settings allow you to pass configurable variables to your function, which is the best way to pass sensitive information such as security tokens. For example, you might use settings as placeholders to use information such as an API endpoint and API key. This way, you can use the same code with different settings for different purposes. When you deploy a function in your workspace, you are prompted to fill out these settings to configure the function.

First, add a setting in Settings tab in the code editor:

Click Add Setting to add your new setting.

You can configure the details about this setting, which change how it’s displayed to anyone using your function:

• Label - Name of the setting, which users see when configuring the function.
• Name - Auto-generated name of the setting to use in function’s source code.
• Type - Type of the setting’s value.
• Description - Optional description, which appears below the setting name.
• Required - Enable this to ensure that the setting cannot be saved without a value.
• Encrypted - Enable to encrypt the value of this setting. Use this setting for sensitive data, like API keys.

As you change the values, a preview to the right updates to show how your setting will look and work.

Click Add Setting to save the new setting.

Once you save a setting, it appears in the Settings tab for the function. You can edit or delete settings from this tab.

Next, fill out this setting’s value in Test tab, so that you can run the function and check the setting values being passed.

Note, this value is only for testing your function.

Now that you’ve configured a setting and filled in a test value, you can add code to read its value and run the function:

async function onRequest(request, settings) {
  const apiKey = settings.apiKey
  //=> "super_secret_string"
}

When you deploy a source function in your workspace, you are prompted to fill out settings to configure the source. You can access these settings later by navigating to the Source Settings page for the source function.

Test the source function

You can test your code directly from the editor in two ways: either by receiving real HTTPS requests through a webhook, or by manually constructing an HTTPS request from within the editor.

The advantage of testing your source function with webhooks is that all incoming data is real, so you can test behavior while closely mimicking the production conditions.

Note that Segment has updated the webhook URL to api.segmentapis.com/functions. To use webhooks with your function:

• You must generate a public API token.
• For POST calls, you’ll need to use this API token in the header.

Testing source functions with a webhook

You can use webhooks to test the source function either by sending requests manually (using any HTTP client such as cURL or Insomnia) or by pasting the webhook into an external server that supports webhooks (such as Slack).

From the source function editor, copy the webhook URL from the “Auto-fill via Webhook” dialog. To trigger the source function, send the request using the POST method, with the Content-Type header set to application/json or application/x-www-form-urlencoded.

Testing source functions manually

You can also manually construct the headers and body of an HTTPS request right inside the editor and test with this data without using webhooks.

Save and deploy the function

Once you finish building your source function, click Configure to name it, then click Create Function to save it.

Once you do that, the source function appears on the Functions page in your workspace’s catalog.

If you’re editing an existing function, you can Save changes without updating instances of the function that are already deployed and running.

You can also choose to Save & Deploy to save the changes, and then choose which already-deployed functions to update with your changes. You might need additional permissions to update existing functions.

Source functions logs and errors

Your function might encounter errors that you missed during testing, or you might intentionally throw errors in your code (for example, if the incoming request is missing required fields).

If your function throws an error, execution halts immediately. Segment captures the incoming request, any console logs the function printed, and the error, and displays this information in the function’s Errors tab. You can use this tab to find and fix unexpected errors.

Functions can throw an Error or custom Error, and you can also add additional helpful context in logs using the console API. For example:

async function onRequest(request, settings) {
  const body = request.json()
  const userId = body.userId

  console.log('User ID is', userId)

  if (typeof userId !== 'string' || userId.length < 8) {
    throw new Error('User ID is invalid')
  }

  console.log('User ID is valid')
}

Error types

• Bad Request: is any error thrown by your code not covered by the other errors.
• Invalid Settings: A configuration error prevented Segment from executing your code. If this error persists for more than an hour, contact Segment Support.
• Message Rejected: Your code threw InvalidEventPayload or ValidationError due to invalid input.
• Unsupported Event Type: Your code doesn’t implement a specific event type (for example, onTrack()) or threw an EventNotSupported error.
• StatusCode: 429, TooManyRequestsException: Rate Exceeded: Rate limit exceeded. These events will be retried when the rate becomes available.
• failed calling Tracking API: the message is too large and over the maximum 32KB limit: Segment’s Tracking API can only handle API requests that are 32KB or smaller. Reduce the size of the request for Segment to accept the event.
• Retry: Your code threw RetryError indicating that the function should be retried.

Segment only attempts to run your source function again if a Retry error occurs.

Managing source functions

Source functions permissions

Functions have specific roles which can be used for access management in your Segment workspace.

Access to functions is controlled by two permissions roles:

• Functions Admin: Create, edit, and delete all functions, or a subset of specified functions.
• Functions Read-only: View all functions, or a subset of specified functions.

You also need additional Source Admin permissions to enable source functions, connect destination functions to a source, or to deploy changes to existing functions.

Editing and deleting source functions

If you are a Workspace Owner or Functions Admin, you can manage your source function from the Functions tab in the catalog.

Connecting source functions

From the Functions tab, click Connect Source and follow the prompts to set it up in your workspace.

Once configured, find the webhook URL - either on the Overview or Settings → Endpoint page.

Copy and paste this URL into the upstream tool or service to send data to this source.

OAuth 2.0

Source function FAQs

What is the retry policy for a webhook payload?

Segment retries invocations that throw RetryError or Timeout errors up to six times. After six attempts, the request is dropped. The initial wait time for the retried event is a random value between one and three minutes. Wait time increases exponentially after every retry attempt. The maximum wait time between attempts can reach 20 minutes.

I configured RetryError in a function, but it doesn’t appear in my source function error log.

Retry errors only appear in the source function error logs if the event has exhausted all six retry attempts and, as a result, has been dropped.

What is the maximum payload size for the incoming webhook?

The maximum payload size for an incoming webhook payload is 512 KiB.

What is the timeout for a function to execute?

The execution time limit is five seconds, however Segment strongly recommends that you keep execution time as low as possible. If you are making multiple external requests you can use async / await to make them concurrently, which will help keep your execution time low.

Does Segment alter incoming payloads?

Segment alphabetizes payload fields that come in to deployed source functions. Segment doesn’t alphabetize payloads in the Functions tester. If you need to verify the exact payload that hits a source function, alphabetize it first. You can then make sure it matches what the source function ingests.

Does the source function allow GET requests?

GET requests are not supported with a source function. Source functions can only receive data through POST requests.

Can I use a Source Function in place of adding a Tracking Pixel to my code?

No. Tracking Pixels operate client-side only and need to be loaded onto your website directly. Source Functions operate server-side only, and aren’t able to capture or implement client-side tracking code. If the tool you’re hoping to integrate is server-side, then you can use a Source Function to connect it to Segment.