Segment

List all users in the workspace. Args: - count: Number of users to return (default: 20) - cursor: Pagination cursor - format: Response format ('json' or 'markdown') Returns: Paginated list of users.

Get details for a specific user. Args: - userId: The user ID (required) Returns: User details.

Delete users from the workspace. WARNING: This action is irreversible. Args: - userIds: Array of user IDs to delete (required) Returns: Confirmation of deletion.

List all user groups in the workspace. Args: - count: Number of groups to return (default: 20) - cursor: Pagination cursor - format: Response format ('json' or 'markdown') Returns: Paginated list of user groups.

Get details for a specific user group. Args: - groupId: The group ID (required) Returns: User group details.

Create a new user group. Args: - name: Group name (required) Returns: The created user group.

Update a user group. Args: - groupId: The group ID (required) - name: New group name (required) Returns: The updated user group.

Delete a user group. WARNING: This action is irreversible. Args: - groupId: The group ID (required) Returns: Confirmation of deletion.

Add users to a user group. Args: - groupId: The group ID (required) - emails: Array of user emails to add (required) Returns: Confirmation of addition.

Remove users from a user group. Args: - groupId: The group ID (required) - emails: Array of user emails to remove (required) Returns: Confirmation of removal.

List all pending invites. Args: - count: Number of invites to return (default: 20) - cursor: Pagination cursor - format: Response format ('json' or 'markdown') Returns: Paginated list of invites.

Send invites to new users. Args: - emails: Array of email addresses to invite (required) Returns: Confirmation of invites sent.

Cancel pending invites. Args: - emails: Array of email addresses to cancel (required) Returns: Confirmation of invites cancelled.

List all labels in the workspace. Labels are used to organize and filter resources. Args: - count: Number of labels to return (default: 20) - cursor: Pagination cursor - format: Response format ('json' or 'markdown') Returns: Paginated list of labels.

Create a new label. Args: - key: Label key (required) - value: Label value (required) - description: Label description Returns: The created label.

Delete a label. WARNING: This action is irreversible. Args: - key: Label key (required) - value: Label value (required) Returns: Confirmation of deletion.

List regulations (deletion/suppression requests) for a source. Args: - sourceId: The source ID (required) - count: Number to return (default: 20) - cursor: Pagination cursor - format: Response format ('json' or 'markdown') Returns: Paginated list of regulations.

Create a regulation (deletion/suppression request) for a source. Use this for GDPR/CCPA compliance to delete or suppress user data. Args: - sourceId: The source ID (required) - regulationType: Type of regulation (DELETE, SUPPRESS, etc.) - subjectType: Type of subject (USER_ID, etc.) - subjectIds: Array of subject IDs to regulate Returns: The created regulation.

Get details for a regulation. Args: - regulationId: The regulation ID (required) Returns: Regulation details including status.

Delete a regulation request. Args: - regulationId: The regulation ID (required) Returns: Confirmation of deletion.

List audit events for the workspace. Audit events track changes made to workspace resources. Args: - count: Number to return (default: 20) - cursor: Pagination cursor - resourceId: Filter by resource ID - resourceType: Filter by resource type - format: Response format ('json' or 'markdown') Returns: Paginated list of audit events.

Get details for the current workspace. Returns: Workspace details including ID, name, and slug.

Browse the sources catalog. Lists all available source types that can be created. Args: - count: Number of sources to return (default: 20) - cursor: Pagination cursor - format: Response format ('json' or 'markdown') Returns: Paginated list of source types.

Get metadata for a source type. Args: - sourceMetadataId: The source metadata ID (required) Returns: Source type metadata including description, logos, and categories.

Browse the destinations catalog. Lists all available destination types that can be created. Args: - count: Number of destinations to return (default: 20) - cursor: Pagination cursor - format: Response format ('json' or 'markdown') Returns: Paginated list of destination types.

Get metadata for a destination type. Args: - destinationMetadataId: The destination metadata ID (required) Returns: Destination type metadata including description, supported methods, and actions.

Browse the warehouses catalog. Lists all available warehouse types (Snowflake, BigQuery, Redshift, etc.). Args: - count: Number of warehouses to return (default: 20) - cursor: Pagination cursor - format: Response format ('json' or 'markdown') Returns: Paginated list of warehouse types.

Get metadata for a warehouse type. Args: - warehouseMetadataId: The warehouse metadata ID (required) Returns: Warehouse type metadata including description and logos.

List all destinations in the workspace. Returns a paginated list of destinations configured in your workspace. Args: - count: Number of destinations to return (default: 20) - cursor: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: Paginated list of destinations with their IDs, names, types, and enabled status.

Get details for a specific destination. Args: - destinationId: The destination ID (required) - format: Response format ('json' or 'markdown') Returns: Destination details including settings, metadata, and configuration.

Create a new destination connected to a source. Args: - sourceId: The source ID to connect (required) - metadataId: The destination catalog ID (use segment_get_destinations_catalog) - name: Display name for the destination (required) - settings: Destination-specific settings - enabled: Whether the destination is enabled (default: true) Returns: The created destination object.

Update an existing destination. Args: - destinationId: The destination ID to update (required) - name: New display name - enabled: Enable or disable the destination - settings: Updated destination-specific settings Returns: The updated destination object.

Delete a destination. WARNING: This action is irreversible. Args: - destinationId: The destination ID to delete (required) Returns: Confirmation of deletion.

List subscriptions for a destination. Subscriptions define which events are sent to an Actions destination. Args: - destinationId: The destination ID (required) - format: Response format ('json' or 'markdown') Returns: List of subscriptions for the destination.

Get a specific subscription for a destination. Args: - destinationId: The destination ID (required) - subscriptionId: The subscription ID (required) Returns: The subscription details.

Create a subscription for a destination. Args: - destinationId: The destination ID (required) - name: Subscription name (required) - actionId: The action ID (required) - trigger: FQL trigger expression (required) - enabled: Whether enabled (default: true) - settings: Action-specific settings Returns: The created subscription.

Update a destination subscription. Args: - destinationId: The destination ID (required) - subscriptionId: The subscription ID (required) - name: New name - enabled: Enable or disable - trigger: New FQL trigger expression - settings: Updated settings Returns: The updated subscription.

Delete a destination subscription. Args: - destinationId: The destination ID (required) - subscriptionId: The subscription ID (required) Returns: Confirmation of deletion.

List filters for a destination. Filters control which events are sent to a destination. Args: - destinationId: The destination ID (required) - format: Response format ('json' or 'markdown') Returns: List of filters for the destination.

Create a filter for a destination. Filters can drop events, sample events, or modify properties. Args: - sourceId: The source ID (required) - destinationId: The destination ID (required) - title: Filter title (required) - ifClause: FQL condition expression (required) - actions: Array of filter actions (required) - enabled: Whether enabled (default: true) - description: Filter description Returns: The created filter.

Update a destination filter. Args: - destinationId: The destination ID (required) - filterId: The filter ID (required) - title: New title - ifClause: New FQL condition - actions: New filter actions - enabled: Enable or disable - description: New description Returns: The updated filter.

Delete a destination filter. Args: - destinationId: The destination ID (required) - filterId: The filter ID (required) Returns: Confirmation of deletion.

List all Engage spaces in the workspace. Spaces are Engage workspaces that contain audiences and computed traits. Args: - count: Number of spaces to return (default: 20) - cursor: Pagination cursor - format: Response format ('json' or 'markdown') Returns: Paginated list of spaces.

Get details for a specific Engage space. Args: - spaceId: The space ID (required) Returns: Space details.

List all audiences in an Engage space. Audiences are dynamic groups of users based on conditions. Args: - spaceId: The space ID (required) - count: Number of audiences to return (default: 20) - cursor: Pagination cursor - format: Response format ('json' or 'markdown') Returns: Paginated list of audiences.

Get details for a specific audience. Args: - spaceId: The space ID (required) - audienceId: The audience ID (required) - format: Response format ('json' or 'markdown') Returns: Audience details including definition and status.

Deploy a function to make it available for use. Args: - functionId: The function ID (required) Returns: The deployed function.

Create a new audience in an Engage space. Args: - spaceId: The space ID (required) - name: Audience name (required) - definition: Audience definition with query and type - description: Description - enabled: Whether enabled (default: true) Returns: The created audience.

Update an existing audience. Args: - spaceId: The space ID (required) - audienceId: The audience ID (required) - name: New name - definition: New definition - description: New description - enabled: Enable or disable Returns: The updated audience.

Delete an audience. WARNING: This action is irreversible. Args: - spaceId: The space ID (required) - audienceId: The audience ID (required) Returns: Confirmation of deletion.

List all computed traits in an Engage space. Computed traits are dynamically calculated user properties. Args: - spaceId: The space ID (required) - count: Number of traits to return (default: 20) - cursor: Pagination cursor - format: Response format ('json' or 'markdown') Returns: Paginated list of computed traits.

Get details for a specific computed trait. Args: - spaceId: The space ID (required) - traitId: The computed trait ID (required) - format: Response format ('json' or 'markdown') Returns: Computed trait details.

Create a new computed trait. Args: - spaceId: The space ID (required) - name: Trait name (required) - definition: Trait definition with query and type - description: Description - enabled: Whether enabled (default: true) Returns: The created computed trait.

Update an existing computed trait. Args: - spaceId: The space ID (required) - traitId: The computed trait ID (required) - name: New name - definition: New definition - description: New description - enabled: Enable or disable Returns: The updated computed trait.

Delete a computed trait. WARNING: This action is irreversible. Args: - spaceId: The space ID (required) - traitId: The computed trait ID (required) Returns: Confirmation of deletion.

List all functions in the workspace. Functions are custom JavaScript code that can transform or filter data. Args: - count: Number of functions to return (default: 20) - cursor: Pagination cursor from previous response - resourceType: Filter by type (DESTINATION, INSERT_DESTINATION, SOURCE) - format: Response format ('json' or 'markdown') Returns: Paginated list of functions.

Get details for a specific function. Args: - functionId: The function ID (required) - format: Response format ('json' or 'markdown') Returns: Function details including code, settings, and deployment status.

Create a new function. Args: - displayName: The function display name (required) - code: JavaScript code for the function (required) - resourceType: Type of function (DESTINATION, INSERT_DESTINATION, SOURCE) - description: Description of the function - settings: Array of setting definitions Returns: The created function.

Update an existing function. Args: - functionId: The function ID (required) - displayName: New display name - code: New JavaScript code - description: New description - settings: Updated setting definitions Returns: The updated function.

Delete a function. WARNING: This action is irreversible. Args: - functionId: The function ID (required) Returns: Confirmation of deletion.

List all Reverse ETL models. Reverse ETL models sync data from warehouses back to destinations. Args: - count: Number of models to return (default: 20) - cursor: Pagination cursor - format: Response format ('json' or 'markdown') Returns: Paginated list of Reverse ETL models.

Get details for a specific Reverse ETL model. Args: - modelId: The model ID (required) - format: Response format ('json' or 'markdown') Returns: Reverse ETL model details including query and schedule.

List all destinations connected to a source. Args: - sourceId: The source ID (required) - format: Response format ('json' or 'markdown') Returns: List of destinations connected to the source.

Create a new Reverse ETL model. Args: - sourceId: The warehouse source ID (required) - name: Model name (required) - query: SQL query to extract data (required) - queryIdentifierColumn: Column to use as unique identifier (required) - description: Model description - enabled: Whether enabled (default: true) - scheduleStrategy: Schedule strategy (e.g., 'PERIODIC') - scheduleConfig: Schedule configuration (e.g., { intervalMinutes: 60 }) Returns: The created Reverse ETL model.

Update a Reverse ETL model. Args: - modelId: The model ID (required) - name: New name - query: New SQL query - description: New description - enabled: Enable or disable - scheduleStrategy: New schedule strategy - scheduleConfig: New schedule configuration Returns: The updated Reverse ETL model.

Delete a Reverse ETL model. WARNING: This action is irreversible. Args: - modelId: The model ID (required) Returns: Confirmation of deletion.

Manually trigger a Reverse ETL sync. Args: - modelId: The model ID (required) - subscriptionId: The subscription ID (required) Returns: Confirmation that sync was triggered.

List all sources in the workspace. Returns a paginated list of sources. Use the cursor from the response to fetch the next page. Args: - count: Number of sources to return (default: 20) - cursor: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: Paginated list of sources with their IDs, names, slugs, and enabled status.

Get details for a specific source. Args: - sourceId: The source ID (required) - format: Response format ('json' or 'markdown') Returns: Source details including ID, name, slug, write keys, metadata, and settings.

Create a new source in the workspace. Args: - slug: Unique slug for the source (required) - name: Display name for the source (required) - catalogId: The source catalog ID (use segment_get_sources_catalog to find IDs) Returns: The created source object.

Update an existing source. Args: - sourceId: The source ID to update (required) - name: New display name - enabled: Enable or disable the source Returns: The updated source object.

Delete a source from the workspace. WARNING: This action is irreversible. All data associated with the source will be deleted. Args: - sourceId: The source ID to delete (required) Returns: Confirmation of deletion.

Get schema settings for a source. Schema settings control how Segment validates tracking data. Args: - sourceId: The source ID (required) Returns: Schema settings including track, identify, and group settings.

Update schema settings for a source. Args: - sourceId: The source ID (required) - settings: Schema settings object Returns: Updated schema settings.

Add labels to a source for organization and filtering. Args: - sourceId: The source ID (required) - labels: Array of {key, value} label objects Returns: The updated source object.

List all warehouses connected to a source. Args: - sourceId: The source ID (required) - format: Response format ('json' or 'markdown') Returns: List of warehouses connected to the source.

Create a new write key for a source. Write keys are used to authenticate tracking API requests. Args: - sourceId: The source ID (required) Returns: The new write key.

Remove a write key from a source. WARNING: This will invalidate the write key and any systems using it will stop working. Args: - sourceId: The source ID (required) - writeKey: The write key to remove (required) Returns: Confirmation of removal.

List all tracking plans in the workspace. Tracking plans define the expected schema for your tracking data. Args: - count: Number of tracking plans to return (default: 20) - cursor: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: Paginated list of tracking plans.

Get details for a specific tracking plan. Args: - trackingPlanId: The tracking plan ID (required) - format: Response format ('json' or 'markdown') Returns: Tracking plan details including name, description, and type.

Create a new tracking plan. Args: - name: The tracking plan name (required) - type: Type of tracking plan (default: 'LIVE') - description: Description of the tracking plan Returns: The created tracking plan.

Update an existing tracking plan. Args: - trackingPlanId: The tracking plan ID (required) - name: New name - description: New description Returns: The updated tracking plan.

Delete a tracking plan. WARNING: This action is irreversible. Args: - trackingPlanId: The tracking plan ID (required) Returns: Confirmation of deletion.

List rules in a tracking plan. Rules define the expected schema for events, traits, and properties. Args: - trackingPlanId: The tracking plan ID (required) - format: Response format ('json' or 'markdown') Returns: List of rules in the tracking plan.

Update rules in a tracking plan. Args: - trackingPlanId: The tracking plan ID (required) - rules: Array of rule objects with key, type, and jsonSchema Returns: Confirmation of update.

Connect a source to a tracking plan. Once connected, events from the source will be validated against the tracking plan. Args: - trackingPlanId: The tracking plan ID (required) - sourceId: The source ID to connect (required) Returns: Confirmation of connection.

Disconnect a source from a tracking plan. Args: - trackingPlanId: The tracking plan ID (required) - sourceId: The source ID to disconnect (required) Returns: Confirmation of disconnection.

List sources connected to a tracking plan. Args: - trackingPlanId: The tracking plan ID (required) - format: Response format ('json' or 'markdown') Returns: List of sources connected to the tracking plan.

Get details for a specific transformation. Args: - transformationId: The transformation ID (required) - format: Response format ('json' or 'markdown') Returns: Transformation details including rules and configuration.

Identify a user and record their traits. The Identify call lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them. Args: - userId: The unique ID for the user (required) - traits: Object of user traits (email, name, plan, etc.) - anonymousId: Anonymous ID if userId is not available - context: Additional context (ip, userAgent, etc.) Returns: Confirmation that the identify call was sent.

Track an event that a user has performed. The Track call records actions your users perform. Every action triggers an "event", which can have associated properties. Args: - userId: The unique ID for the user (required) - event: The name of the event (required) - properties: Object of event properties - anonymousId: Anonymous ID if userId is not available - context: Additional context (ip, userAgent, etc.) Returns: Confirmation that the track call was sent.

Track a page view on a website. The Page call lets you record page views on your website, along with optional information about the page being viewed. Args: - userId: The unique ID for the user (required) - name: Name of the page - category: Category of the page - properties: Additional page properties (url, referrer, etc.) - anonymousId: Anonymous ID if userId is not available - context: Additional context Returns: Confirmation that the page call was sent.

Track a screen view in a mobile app. The Screen call lets you record whenever a user sees a screen of your mobile app. Args: - userId: The unique ID for the user (required) - name: Name of the screen - category: Category of the screen - properties: Additional screen properties - anonymousId: Anonymous ID if userId is not available - context: Additional context Returns: Confirmation that the screen call was sent.

Associate a user with a group (company, organization, account, etc.). The Group call lets you associate an identified user with a group. A group could be a company, organization, account, project, or team. Args: - userId: The unique ID for the user (required) - groupId: The unique ID for the group (required) - traits: Group traits (name, industry, employees, etc.) - anonymousId: Anonymous ID if userId is not available - context: Additional context Returns: Confirmation that the group call was sent.

Create an alias between two user identities. The Alias call lets you merge two user identities. This is useful when a user signs up and you want to merge their anonymous browsing history with their new identity. Args: - userId: The new user ID (required) - previousId: The previous user ID or anonymous ID (required) - context: Additional context Returns: Confirmation that the alias call was sent.

Send a batch of tracking events. The Batch call lets you send multiple identify, track, page, screen, group, and alias events in a single request for higher performance. Args: - batch: Array of event objects, each with a "type" field - context: Shared context for all events - integrations: Control which integrations receive the events Returns: Confirmation that the batch was sent.

List all transformations in the workspace. Transformations modify events as they flow through Segment. Args: - count: Number of transformations to return (default: 20) - cursor: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: Paginated list of transformations.

Create a new transformation. Args: - sourceId: The source ID (required) - name: Transformation name (required) - ifClause: FQL condition for when to apply (required) - newEventName: New event name to use - enabled: Whether enabled (default: true) - destinationMetadataId: Apply to specific destination - propertyRenames: Array of {oldName, newName} for renaming properties - fqlDefinedProperties: Array of {fql, propertyName} for computed properties Returns: The created transformation.

Update an existing transformation. Args: - transformationId: The transformation ID (required) - name: New name - ifClause: New FQL condition - newEventName: New event name - enabled: Enable or disable - propertyRenames: Updated property renames - fqlDefinedProperties: Updated computed properties Returns: The updated transformation.

Delete a transformation. WARNING: This action is irreversible. Args: - transformationId: The transformation ID (required) Returns: Confirmation of deletion.

List all warehouses in the workspace. Returns a paginated list of data warehouses (Snowflake, BigQuery, Redshift, etc.). Args: - count: Number of warehouses to return (default: 20) - cursor: Pagination cursor from previous response - format: Response format ('json' or 'markdown') Returns: Paginated list of warehouses with their IDs, names, types, and enabled status.

Get details for a specific warehouse. Args: - warehouseId: The warehouse ID (required) - format: Response format ('json' or 'markdown') Returns: Warehouse details including settings, metadata, and connection info.

Create a new warehouse. Args: - metadataId: The warehouse catalog ID (use segment_get_warehouses_catalog) - settings: Warehouse-specific settings (credentials, database, schema, etc.) - name: Display name for the warehouse - enabled: Whether the warehouse is enabled (default: true) Returns: The created warehouse object.

Update an existing warehouse. Args: - warehouseId: The warehouse ID to update (required) - name: New display name - enabled: Enable or disable the warehouse - settings: Updated warehouse-specific settings Returns: The updated warehouse object.

Delete a warehouse. WARNING: This action is irreversible. Args: - warehouseId: The warehouse ID to delete (required) Returns: Confirmation of deletion.

Connect a source to a warehouse. This enables data from the source to be synced to the warehouse. Args: - warehouseId: The warehouse ID (required) - sourceId: The source ID to connect (required) Returns: Confirmation of connection.

Disconnect a source from a warehouse. Args: - warehouseId: The warehouse ID (required) - sourceId: The source ID to disconnect (required) Returns: Confirmation of disconnection.

List all sources connected to a warehouse. Args: - warehouseId: The warehouse ID (required) - format: Response format ('json' or 'markdown') Returns: List of sources connected to the warehouse.