Skip to main content
Altcraft Docs LogoAltcraft Docs Logo
User guide iconUser guide
Developer guide iconDeveloper guide
Admin guide iconAdmin guide
English
  • Русский
  • English
Login
    Getting StartedAdministrator documentationFunctional characteristics
      Technology descriptionarrow
    • Architecture OverviewComponent Description
        Deployment schemesarrow
      • Basic schemeFail-safe schemeTypical Placement in Infrastructure
    System requirements
      Admin Panelarrow
      • Account areaarrow
        • Accountsarrow
        • Account UsersAccount Virtual SendersAccount Database Indexes
        TariffsExternal data configurationLDAPTasksSchedule JobsGlobal Stop ListsWebversion Store Policies
        Settingsarrow
      • Databases
          Accessarrow
        • AdminsAPI tokens
        Notifiers
          MTAarrow
        • Default rulesRetry rulesLock rulesBounce patternsStrategiesKeysISPsPools
      Nodes
        Sendersarrow
      • EmailSMSEvent generatorIntegration with Altcraft Cloud SMTPIntegration with Sendsay
        Reportsarrow
      • Audit JournalData Usage
        Toolsarrow
      • ARF decoderURL decoderSMID decoderLicense
      Platform installationarrow
    • Automatic installationManual installationRunning the platform in a Docker container
      Platform configurationarrow
    • Configuration fileDomain settingsLDAP access configurationSending Email via SMTP relayPixel and push domain configurationCluster and Replication SetupSystem notifications configurationProcesses UNIX sockets configurationHTTPS ConfigurationMigrating from MongoDB Community Edition to Percona Server for MongoDBAdding sender IP addressesDeduplication request settingsPostgreSQL database for Market dataProxy server settingsKeycloak Integration with AltcraftGetting HTTP service statusesConfiguring MongoDB log rotation
        Configuration of system constants and directoriesarrow
      • Filtering bot actionsDirectory of gender markers
      Custom Channelsarrow
    • Creating a Channel
        Pipelinesarrow
      • MessageScheduleListenerModerateStop
          Pipesarrow
        • HTTP RequestPackUnpackEventerSchedulerSelectorSQLStore SetStore GetLogResultError
      External Objects (Entities)Templating LanguageSending FilesPresets (Field Sets)DebuggingTechnical Limitations
      Platform maintenancearrow
    • Personnel requirementsPlatform maintenance processesPlatform updatingBackup and recoveryTransferring the platform to a new serverCreating, deleting, and populating tables for statistics in ClickHouseUsing the aktool utilityUsers and directories engaged by the platformPlatform service monitoringProcess and mailing monitoring via Prometheus
      Extraarrow
    • System page customizationSend Message IDClickHouse History Migration GuideInstructions for migrating history to ClickHouseUtility for importing push subscriptions to Firebase projectUtility for importing push subscriptions to Firebase projectENS: настройка интеграции
    Processing HTTP/HTTPS traffic
      Administrator APIarrow
      • Accounts admin apiarrow
        • Restricted accessarrow
        • Account Activation and DeactivationAccount Freeze and Unfreeze
        Get accounts listAdd a new accountDelete the account
        Account usersarrow
      • Update an Existing AccountAdd a new userDelete a userGet a list of usersSending a Welcome Email
        Nodesarrow
      • Synchronize node MTA configurationGet nodes listGet node MTA statusActivate node MTADeactivate node MTA
        Senders admin apiarrow
      • Create or update AKMTA senderGet AKMTA sender informationAssign account to senderGet senders listDelete senderRestore sender
          Sender queuearrow
        • Get sender queue informationHold sender queueRelease sender queueClear sender queue
        Virtual sendersarrow
      • Get virtual senders listGet virtual sender informationCreate virtual senderUpdate virtual senderClone virtual senderDelete virtual sender
    Documentation Archive
  • Custom Channels
  • Pipelines
  • Pipes
  • Result

Result

caution

Available only in Pipelines of External Objects (entities) operations.

Result is a Pipe for finalizing the result of a synchronous External Object operation Pipeline. The result is returned to the platform interface and displayed to the user.

Features​

  • An empty result is not an error.
  • Result does not have to be the last Pipe in the chain — after finalizing the result, you can execute additional logic (for example, close a session).
  • A Pipeline can contain multiple Result pipes, but none of them should be a child of another Result (the result is finalized only once per branch).
  • The result must be an object or an array of objects.

Parameters​

FieldTypeRequiredDescription
pathstringNoPath to the field from which the result is taken. Supports templating. If not specified — the result is taken from $in.data
caution

To return an array or an object, use the $# prefix. The $ prefix will return the value as a string, which will cause an error.

Possible Errors​

  • params.path is specified, but the format is incorrect or the field is not found
  • params.path is not specified, and the data key is missing in $in

Examples​

Correct Example​

$#in.data.categories contains an array of objects:

{
"id": 10,
"type": "result",
"params": {
"path": "$#in.data.categories"
}
}

Result from an SQL Query​

When used with the SQL pipe, the query result is available in $in.sql_query. Use the $# prefix to preserve the original type (object or array):

{
"id": 300,
"type": "result",
"params": {
"path": "$#in.sql_query"
}
}

This pattern is used in all External Objects operations with SQL: Read, List, Create, Update, Delete.

Last updated on Jul 21, 2026
Previous
Log
Next
Error
  • Features
  • Parameters
  • Possible Errors
  • Examples
    • Correct Example
    • Result from an SQL Query
© 2015 - 2026 Altcraft, LLC. All rights reserved.