NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Segment

segment

Twilio Segment is a customer data platform that helps businesses collect, clean, and control their customer data.

AnalyticsMarketing AutomationWeb del proveedor
Acciones
16
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (16)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Labels to SourceSEGMENT_ADD_LABELS_TO_SOURCEAcción

Tool to add existing labels to a Source. Use when you have the source ID and want to tag it with metadata labels.

Parámetros de entrada

  • labelsobject[]Obligatorio

    List of labels to associate with the Source. Must include at least one label.

  • sourceIdstringObligatorio

    ID of the Source (1-255 characters)

Parámetros de salida

  • dataobjectObligatorio

    Envelope containing the response labels.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Segment AliasSEGMENT_ALIASAcción

Tool to alias a previous user ID to a new user ID. Use when merging anonymous and known identities.

Parámetros de entrada

  • userIdstring

    New known unique identifier for the user.

  • contextobject

    Additional context (e.g., ip, locale).

  • timestampstring

    ISO-8601 timestamp for the event; server time used if omitted.

  • previousIdstringObligatorio

    Previous unique identifier for the user.

  • anonymousIdstring

    Anonymous identifier for the user.

  • integrationsobject

    Per-destination enable/disable controls.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Batch Segment Analytics EventsSEGMENT_BATCHAcción

Tool to send multiple analytics calls in a single batch request. Use when you want to reduce HTTP overhead by batching Identify/Track/Page/Screen/Group calls into one request.

Parámetros de entrada

  • batchobject[]Obligatorio

    Array of analytics calls (identify, track, page, screen, or group). Each item must include 'type' and required fields per call type.

  • contextobject

    Optional top-level context merged into each call's context.

  • writeKeystring

    Segment write key; required when using Bearer authentication.

  • integrationsobject

    Optional top-level integrations merged into each call's integrations.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete SourceSEGMENT_DELETE_SOURCEAcción

Tool to delete a Segment Source. Use when you need to permanently remove a Source by its ID after confirmation.

Parámetros de entrada

  • sourceIdstringObligatorio

    The Source ID. Length 1–255 characters.

Parámetros de salida

  • dataobjectObligatorio

    Envelope for deletion result.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Daily Per Source API Calls UsageSEGMENT_GET_DAILY_PER_SOURCE_API_CALLS_USAGEAcción

Tool to fetch daily API call counts per source for a given period. Use when you need daily breakdown of API usage by source after determining the reporting period.

Parámetros de entrada

  • periodstringObligatorio

    Start of the usage period in ISO-8601 format (YYYY-MM-DD), e.g. '2021-02-01'.

  • paginationobject

    Pagination parameters for querying source daily API calls usage.

Parámetros de salida

  • dataobjectObligatorio

    Response data containing source usage records and pagination info.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get DestinationSEGMENT_GET_DESTINATIONAcción

Tool to retrieve a Destination by ID. Use when you need to fetch the full configuration of a Segment Destination instance by its unique identifier. Falls back US→EU public API and legacy app endpoint; returns minimal envelope on legacy HTML or parse errors.

Parámetros de entrada

  • destinationIdstringObligatorio

    The destination’s unique ID.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Segment GroupSEGMENT_GROUPAcción

Tool to associate an identified user with a group via Segment HTTP Tracking API. Use when grouping users with traits.

Parámetros de entrada

  • traitsobject

    Free-form dictionary of group traits (e.g., name, industry, employees).

  • userIdstring

    Unique user identifier. Exactly one of 'userId' or 'anonymousId' must be provided.

  • contextobject

    Additional contextual information (e.g., ip, locale, device).

  • groupIdstringObligatorio

    Unique identifier for the group.

  • writeKeystring

    Write key for authentication if not using OAuth Bearer token.

  • timestampstring

    ISO-8601 timestamp when the event occurred; if omitted, server time is used.

  • anonymousIdstring

    Pseudo-unique ID for anonymous users. Exactly one of 'userId' or 'anonymousId' must be provided.

  • integrationsobject

    Per-destination enable/disable controls (case-sensitive keys).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Segment IdentifySEGMENT_IDENTIFYAcción

Tool to identify a user and set/update traits via Segment HTTP Tracking API.

Parámetros de entrada

  • traitsobject

    Free-form dictionary of user traits (e.g., email, name, plan).

  • userIdstring

    Unique user identifier. Exactly one of 'userId' or 'anonymousId' must be provided.

  • contextobject

    Additional contextual information (e.g., ip, locale, device).

  • writeKeystring

    Write key for authentication if not using Basic or OAuth headers.

  • messageIdstring

    Unique id for deduplication; Segment auto-generates one if omitted.

  • timestampstring

    ISO-8601 timestamp when the identification occurred; if omitted, server time is used.

  • anonymousIdstring

    Pseudo-unique ID for anonymous users. Exactly one of 'userId' or 'anonymousId' must be provided.

  • integrationsobject

    Per-destination enable/disable controls (case-sensitive keys).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Connected Warehouses From SourceSEGMENT_LIST_CONNECTED_WAREHOUSES_FROM_SOURCEAcción

Tool to list warehouses connected to a Source. Use when you need to retrieve warehouses for a given source ID.

Parámetros de entrada

  • sourceIdstringObligatorio

    ID of the Source to retrieve warehouses for.

  • paginationobjectObligatorio

    Pagination parameters for the request.

Parámetros de salida

  • dataobjectObligatorio

    Response data containing warehouses and pagination details.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Delivery Metrics Summary from DestinationSEGMENT_LIST_DELIVERY_METRICS_SUMMARY_FROM_DESTINATIONAcción

Get an event delivery metrics summary from a Destination. Primary attempt uses Segment Public API; fallback to legacy app host if needed. On HTML fallback responses, returns a minimal valid envelope to maintain contract.

Parámetros de entrada

  • endTimestring

    Filter events that happened before this time (ISO-8601). Defaults to now.

  • sourceIdstringObligatorio

    Source id linked to the destination

  • startTimestring

    Filter events that happened after this time (ISO-8601). Defaults depend on granularity.

  • granularitystringenum

    Granularity of the metrics aggregation

    DAYHOURMINUTE
  • destinationIdstringObligatorio

    Destination identifier

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Schema Settings in SourceSEGMENT_LIST_SCHEMA_SETTINGS_IN_SOURCEAcción

Retrieve schema configuration settings for a Source.

Parámetros de entrada

  • sourceIdstringObligatorio

    ID of the Source

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Segment Page ViewSEGMENT_PAGEAcción

Tool to record a page view via Segment HTTP Tracking API. Use when sending page views with optional page name and properties.

Parámetros de entrada

  • namestring

    Name of the page. Optional.

  • userIdstring

    Unique user identifier. Exactly one of 'userId' or 'anonymousId' must be provided.

  • contextobject

    Additional contextual information (e.g., ip, locale, device).

  • writeKeystring

    Write key for authentication if not using Basic or Bearer auth in headers.

  • messageIdstring

    Unique id for deduplication; Segment auto-generates one if omitted.

  • timestampstring

    ISO-8601 timestamp when the event occurred; if omitted, server time is used.

  • propertiesobject

    Free-form dictionary of page properties (e.g., path, url).

  • anonymousIdstring

    Pseudo-unique ID for anonymous users. Exactly one of 'userId' or 'anonymousId' must be provided.

  • integrationsobject

    Per-destination enable/disable controls (case-sensitive keys).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove Source Write KeySEGMENT_REMOVE_SOURCE_WRITE_KEYAcción

Tool to remove a write key from a Source. Use when you need to revoke an existing write key for security or rotation.

Parámetros de entrada

  • sourceIdstringObligatorio

    The unique identifier of the Source.

  • writeKeystringObligatorio

    The write key to remove from the Source.

Parámetros de salida

  • dataobjectObligatorio

    Envelope containing removal status.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Segment Screen EventSEGMENT_SCREENAcción

Tool to record a mobile app screen view. Use when tracking screen views in a mobile app via Segment HTTP Tracking API.

Parámetros de entrada

  • namestring

    Name of the screen.

  • userIdstring

    Unique user identifier. Exactly one of 'userId' or 'anonymousId' must be provided.

  • contextobject

    Additional contextual information (e.g., ip, locale, device).

  • writeKeystring

    Write key for authentication if not using Basic or OAuth headers.

  • timestampstring

    ISO-8601 timestamp when the screen event occurred; if omitted, server time is used.

  • propertiesobject

    Free-form dictionary of screen properties.

  • anonymousIdstring

    Pseudo-unique ID for anonymous users. Exactly one of 'userId' or 'anonymousId' must be provided.

  • integrationsobject

    Per-destination enable/disable controls (case-sensitive keys).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Segment Track EventSEGMENT_TRACKAcción

Tool to record a custom user event via Segment HTTP Tracking API. Use when sending events to Segment with valid identity.

Parámetros de entrada

  • eventstringObligatorio

    Name of the action performed (e.g., 'Item Purchased').

  • userIdstring

    Unique user identifier. Exactly one of 'userId' or 'anonymousId' must be provided.

  • contextobject

    Additional contextual information (e.g., ip, locale, device).

  • writeKeystring

    Write key for authentication if not using Basic or OAuth headers.

  • timestampstring

    ISO-8601 timestamp when the event occurred; if omitted, server time is used.

  • propertiesobject

    Free-form dictionary of event-specific properties (e.g., revenue).

  • anonymousIdstring

    Pseudo-unique ID for anonymous users. Exactly one of 'userId' or 'anonymousId' must be provided.

  • integrationsobject

    Per-destination enable/disable controls (case-sensitive keys).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update SourceSEGMENT_UPDATE_SOURCEAcción

Tool to update a Source's metadata and settings. Use when you need to modify an existing Source after confirming its ID.

Parámetros de entrada

  • namestring

    Human-readable name for the Source (displayName).

  • slugstring

    Slug that identifies the Source (config name).

  • enabledboolean

    Whether the Source can send data.

  • settingsobject

    Key-value settings specific to the Source type; see Sources catalog for required options.

  • sourceIdstringObligatorio

    The Source ID. Length 1–255 characters.

Parámetros de salida

  • dataobjectObligatorio

    Envelope for the updated Source.

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not