Impulse Variables

Top Level Variables

These are the variables which are always available to liquid templates (unless otherwise specified) The following object shows the top level variables available to call using liquid templates.

{
    "sourceEndpointId": "<Source endpoint id for transaction>"
    "destinationEndpointId": "<Destination endpoint id for content delivery, only availble for apply on read>"
    "contentType": "<Source content type for transaction>"
    "content": {<Content variable>}
    "category": {<Category variable (only when category tag is used)>}
    "domain": {<Domain variable (only when domain tag is used)>}
    "folder": {<Folder variable (only when folder tag is used)>}
    "language": {<Language variable (only when language tag is used)>}
    "relationship": {<Relationship variable (only when relationship tag is used)>}
    "tag": {<Tag variable (only when tag tag is used)>}
}

Content

The following objects show the content variables available to call using liquid templates.

single value If there is no language support in the connector:

{
    "id": "<content id value>" 
    "fields": {
        "<field unique name>": {
            "value": <If field only has a single value. Attribute type based on field type.>
            "value": [<If field has multiple values. Attribute type based on field type.>]
            "fieldType": "<Motation field type>"
            "system": {<system properties of field>}
            "relationSystem": {<system relationship properties of relationship field>}
        }
    } 
    "language": "<language id value>" 
}

If there is language support in the connector:

{
    "<language id value>": {
        "id": "<content id value>" 
        "fields": {
            "<field unique name>": {
                "value": <If field only has a single value. Attribute type based on field type.>
                "value": [<If field has multiple values. Attribute type based on field type.>]
                "fieldType": "<Motation field type>"
                "system": {<system properties of field>}
                "relationSystem": {<system relationship properties of relationship field>}
            }
        } 
        "language": "<language id value>" 
    }
}

Category

Category variables are only available if the category tag is used.

The following object shows the category variables available to call using liquid templates.

{
    "<category id value>": {
        "name": "<category name>"
        "children": ["<Array of child categories>"]
        "system": {<system properties of category>}
    }
}

Domain

Domain variables are only available if the domain tag is used.

The following object shows the domain variables available to call using liquid templates.

{
    "<domain id value>": {
        "name": "<domain name>"
        "URI": "<domain URI>"
        "active": <boolean for if domain is active>
        "description": "<description for domain>"
        "systemDomain": "<boolean for if domain is a system domain>"
        "defaultDomain": "<boolean for if domain is a default domain>"
        "keywords": ["<Array of keywords>"]
        "aliases": ["<Array of aliases>"]
        "system": {<system properties of domain>}
    }
}

Folder

Folder variables are only available if the folder tag is used.

The following object shows the folder variables available to call using liquid templates.

{
    "<folder id value>": {
        "path": "<folder path>"
        "domainId": "<domain id where folder exists>"
        "domainName": "<domain name where folder exists>"
        "system": {<system properties of folder>}
    }
}

Language

Language variables are only available if the language tag is used.

The following object shows the language variables available to call using liquid templates.

{
    "<language id value>": {
        "name": "<language name>"
        "code": "<language code>"
        "countryName": "<language country name>"
        "countryCode": "<language country code>"
        "system": {<system properties of language>}
    }
}

Relationship

Relationship variables are only available if the relationship tag is used.

The following object shows the relationship variables available to call using liquid templates.

{
    "<relationship id value>": {
        "definition1FieldId": "<relationship definition 1 field id>"
        "definition2FieldId": "<relationship definition 2 field id>"
        "definition1FieldName": "<relationship definition 1 field name>"
        "definition2FieldName": "<relationship definition 2 field name>"
        "cardinality": "<Motation cardinality of relationship>"
        "definition1Id": "<relationship definition 1 id>"
        "definition2Id": "<relationship definition 2 id>"
        "system": {<system properties of relationship>}
    }
}

Tag

Tag variables are only available if the tag tag is used.

The following object shows the tag variables available to call using liquid templates.

{
    "<tag id value>": {
        "name": "<tag name>"
        "domainId": "<tag domain id where tag exists>"
        "domainName": "<tag domain name where tag exists>"
        "system": {<system properties of tag>}
    }
}