Segment Integration — ModuleX AI

Field	Description	Required	Format
Write Key	Your Segment source Write Key from app.segment.com	Yes	`xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

alias — Associate one user identity with another in Segment

Parameters

string

required

Previous unique identifier for the user

string

Unique identifier for the user in your database

object

Dictionary of extra context about the message such as IP address or locale

object

Dictionary of destinations to either enable or disable

string

ISO 8601 timestamp of when the message occurred (e.g. 2022-04-08T17:32:11.318Z)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "AliasOutput",
  "type": "object"
}

group — Associate an identified user with a group in Segment

Parameters

string

required

Unique identifier for the group in your database

string

Unique identifier for the user. Either user_id or anonymous_id is required.

string

Pseudo-unique substitute for a User ID when no absolute identifier is available

object

Free-form dictionary of traits of the group such as name or plan

object

Dictionary of extra context about the message such as IP address or locale

object

Dictionary of destinations to either enable or disable

string

ISO 8601 timestamp of when the message occurred (e.g. 2022-04-08T17:32:11.318Z)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "GroupOutput",
  "type": "object"
}

identify — Identify a user and record traits about them in Segment

Parameters

string

Unique identifier for the user. Either user_id or anonymous_id is required.

string

Pseudo-unique substitute for a User ID when no absolute identifier is available

object

Free-form dictionary of traits of the user such as email or name

object

Dictionary of extra context about the message such as IP address or locale

object

Dictionary of destinations to either enable or disable

string

ISO 8601 timestamp of when the message occurred (e.g. 2022-04-08T17:32:11.318Z)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "IdentifyOutput",
  "type": "object"
}

page — Record a page view on your website in Segment

Parameters

string

Unique identifier for the user. Either user_id or anonymous_id is required.

string

Pseudo-unique substitute for a User ID when no absolute identifier is available

string

Name of the page being viewed

object

Free-form dictionary of properties of the page such as url and referrer

object

Dictionary of extra context about the message such as IP address or locale

object

Dictionary of destinations to either enable or disable

string

ISO 8601 timestamp of when the message occurred (e.g. 2022-04-08T17:32:11.318Z)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "PageOutput",
  "type": "object"
}

screen — Record a screen view in your mobile app in Segment

Parameters

string

Unique identifier for the user. Either user_id or anonymous_id is required.

string

Pseudo-unique substitute for a User ID when no absolute identifier is available

string

Name of the screen being viewed

object

Free-form dictionary of properties of the screen

object

Dictionary of extra context about the message such as IP address or locale

object

Dictionary of destinations to either enable or disable

string

ISO 8601 timestamp of when the message occurred (e.g. 2022-04-08T17:32:11.318Z)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "ScreenOutput",
  "type": "object"
}

track — Track an event that a user has performed in Segment

Parameters

string

required

Name of the action the user has performed

string

Unique identifier for the user. Either user_id or anonymous_id is required.

string

Pseudo-unique substitute for a User ID when no absolute identifier is available

object

Free-form dictionary of properties of the event such as revenue

object

Dictionary of extra context about the message such as IP address or locale

object

Dictionary of destinations to either enable or disable

string

ISO 8601 timestamp of when the message occurred (e.g. 2022-04-08T17:32:11.318Z)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    }
  },
  "required": [
    "success"
  ],
  "title": "TrackOutput",
  "type": "object"
}

Using

Providers

Building

Tools

Segment Integration for AI Agents & Workflows

Overview

Authentication

Write Key

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Databricks

Google Tag Manager

Microsoft Power BI

Links

​Overview

​Authentication

​Write Key

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Databricks

Google Tag Manager

Microsoft Power BI

​Links

Overview

Authentication

Write Key

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links