Action parameters

This article describes how to set up webhook connector actions.

Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see Manage Connectors.

After adding the connector, configure the following settings:

  • Basic Authentication - Username
    Enter username if API endpoint requires basic authentication
  • Basic Authentication - Password
    Enter password if API endpoint requires basic authentication

Click Done when you are finished configuring the connector.

Action Settings - Parameters and Options

Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu.

The following section describes how to set up parameters and options for each action.

Action - Send Event Data via HTTP Request

Parameters

Parameter Description
Method Required. select request method. If GET is selected, the event data is delivered as a JSON URL-encoded query string parameter with the data key.
URL Required. Provide URL to submit request to. Template Support: reference template name to generate URL from template.
URL Parameters Provide parameters to append to URL. Template Support: reference template name to generate parameter value from template.
Headers Map HTTP header values to header names. Template Support: reference template name to generate header value from template.
Cookies Map cookie values to cookie names. Cookies are added as single HTTP header value. For example: Cookie: name1=value1; name2=value2. Template Support: reference template name to generate cookie value from template.
Body Content Type Select available type or provide custom value. All types are UTF-8 encoded and added as a header. For example: Content-Type: text/plain; charset=UTF-8. Content type is required if body data is provided.
Template Variables Provide template variables as data input for templates. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example, items.name. Nested template variables are typically built from data layer list attributes.
Templates Provide templates to be referenced in either URL, URL Parameter, Header, or Body Data. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}}. When using OAuth, the template variable {{webhook_access_token}} refers to the token returned by the authentication request.
Print Attribute Names If attribute names are updated, the names in the payload reflects the update.
Redirection Allow redirection only if the method is GET.

Action - Send Visitor Data via HTTP Request

Parameters

Parameter Description
Method Required. Select request method. If GET is selected, the visitor data is delivered as a JSON URL-encoded query string parameter with the data key.
URL Required. Provide URL to submit request to. Template Support: reference template name to generate URL from template.
URL Parameters Provide parameters to append to URL. Template Support: reference template name to generate parameter value from template.
Headers Map HTTP header values to header names. Template Support: reference template name to generate header value from template.
Cookies Map cookie values to cookie names. Cookies are added as single HTTP header value. For example: Cookie: name1=value1; name2=value2 Template Support: reference template name to generate cookie value from template.
Body Content Type Select available type or provide custom value. All types are UTF-8 encoded and are added as a header. For example: Content-Type: text/plain; charset=UTF-8 Content type is required if body data is provided.
Template Variables Provide template variables as data input for templates. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name Nested template variables are typically built from data layer list attributes.
Templates Provide templates to be referenced in either URL, URL Parameter, Header, or Body Data. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}} When using OAuth, the template variable {{webhook_access_token}} refers to the token returned by the authentication request.
Include Current Visit Data Check this box if you want to include current visit data.
Print Attribute Names If attribute names are updated, the names in the payload reflect the update.
Redirection Allow redirection only if the method is GET.

Action - Send Customized Data via HTTP Request (Advanced)

If your custom request requires a complex payload, such as nested JSON or XML, you will use the Templates option to construct a payload in the format needed by the vendor’s endpoint. For more information on using templates for custom requests, see Send Custom Request - Template Variables Guide.

Parameters

Parameter Description
Method Required. Select request method. For more information, see Webhook Send Custom Request Guide.
URL Required. Provide URL to submit request to. Template Support: reference template name to generate URL from template.
URL Parameters Optional. Provide parameters to append to URL. Template Support: reference template name to generate parameter value from template.
Headers Map HTTP header values to header names. Template Support: reference template name to generate header value from template.
Cookies Map cookie values to cookie names. Cookies are added as single HTTP header value. For example: Cookie: name1=value1; name2=value2 Template Support: reference template name to generate cookie value from template.
Body Content Type Select available type or provide custom value. All types are UTF-8 encoded and are added as a header. For example: Content-Type: text/plain; charset=UTF-8 Content type is required if body data is provided.
Body Data Provide data to construct message body. Template Support: reference template name to generate body data from template. Map values to names if body content type is multipart/form-data or application/x-www-form-urlencoded, otherwise reference template name and select only the Body option.
Template Variables Provide template variables as data input for templates. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name Nested template variables are typically built from data layer list attributes.
Templates Provide templates to be referenced in either URL, URL Parameter, Header. or Body Data. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}} When using OAuth, the template variable {{webhook_access_token}} refers to the token returned by the authentication request.

Action - Send Batched Customized Data via HTTP Request (Advanced)

If your custom request requires a complex payload, such as nested JSON or XML, you will use the Templates option to construct a payload in the format needed by the vendor’s endpoint. For more information on using templates for custom requests, see Send Custom Request - Template Variables Guide.

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three thresholds is met:

  • Maximum number of requests: 100
  • Maximum time since oldest request: 60 minutes
  • Maximum size of requests: 16 MB

Parameters

Parameter Description
Method Required. Select request method. For more information, see Webhook Send Custom Request Guide.
URL Required. Provide URL to submit request to. Template Support: reference template name to generate URL from template.
Body Content Type Select available type or provide custom value. All types are UTF-8 encoded and are added as a header. For example: Content-Type: text/plain; charset=UTF-8 Content type is required if body data is provided.
Body Data Provide data to construct message body. Template Support: reference template name to generate body data from template. Map values to names if body content type is multipart/form-data or application/x-www-form-urlencoded, otherwise reference a template name and select only the Body option.
Prefix A non-repeating portion of the request that precedes Body Data. The JSON array prefix is the opening bracket character ([). Map Custom [ to Prefix. For example:
[ { "editable_in_signup": false, "displayed_for_customers": true }, { "editable_in_signup": true, "displayed_for_customers": true } ]
Joiner A character or string that separates individual data items in Body Data. The JSON objects joiner is the comma (,). Map Custom , to Joiner. For example:
[ { "editable_in_signup": false, "displayed_for_customers": true }, { "editable_in_signup": true, "displayed_for_customers": true } ]
Suffix A non-repeating portion of the request that follows Body Data. The JSON array prefix is the closing bracket character (]). Map Custom ] to Suffix. For example:
[ { "editable_in_signup": false, "displayed_for_customers": true }, { "editable_in_signup": true, "displayed_for_customers": true } ]
Record Count Maximum Maximum record count.
Time To Live (minutes) Time to live, in minutes.
URL Parameters Provide parameters to append to URL. Template Support: reference template name to generate parameter value from template.
Headers Map HTTP header values to header names. Template Support: reference template name to generate header value from template.
Cookies Map cookie values to cookie names. Cookies are added as single HTTP header value. For example: Cookie: name1=value1; name2=value2. Template Support: reference template name to generate cookie value from template.
Template Variables Provide template variables as data input for templates. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name Nested template variables are typically built from data layer list attributes.
Templates Provide templates to be referenced in either URL, URL Parameter, Header, or Body Data. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}} When using OAuth, the template variable {{webhook_access_token}} refers to the token returned by the authentication request.

Event Data JSON

The expected JSON payload for events includes all of the standard attributes that are part of the event, as well as additional attributes that are native to the platform that sent the event. For example, events received from a website include DOM and cookie attributes, and events received from a mobile device include device and carrier attributes.

Event data JSON object format example:

{
    "account": "tealium",
    "profile": "main",
    "env": "prod",
    "data": {
        "dom": {
            "referrer": "",
            "domain": "tealium.com",
            "title": "Tealium | Customer Data Hub and Enterprise Tag Management",
            "query_string": "",
            "url": "http://tealium.com/",
            "pathname": "/"
        },
        "udo": {
            "tealium_event": "page_view",
            "page_name": "Tealium | Customer Data Hub and Enterprise Tag Management",
            "page_type": "home",
            "device_type": "desktop"
        },
        "firstparty_tealium_cookies": {
            "trace_id": "",
            "s_fid": "3EF757DF6253B144-0D0194366CD4479B",
            "utag_main_ses_id": 1383677957942,
            "s_cc": "true",
            "utag_main__st": 1383678970903,
            "TID": "2cff51e585ed4a5a9330324d5dbc6bb7",
            "s_sq": "[[B]]"
        }
    },
    "post_time": 1500999541000,
    "useragent": "PostmanRuntime/6.1.6",
    "event_id": "1a1ee055-1456-46f8-ab4d-779628c05dd4",
    "visitor_id": "1a1ee055145646f8ab4d779628c05dd4"
}

Visitor Data JSON

The expected JSON payload for visitors includes all of the applicable Visitor attributes for that visitor. The data object is organized by attribute type. If an attribute is not assigned it does not appear in the visitor object. The data for the current visit is also included under the current_visit key.

Visitor data JSON object format example:

{
    "metrics": {
        "Weeks since first visit": 0.0,
        "Lifetime visit count": 1.0,
        "Lifetime event count": 1.0,
        "Total direct visits": 1.0
    },
    "dates": {
        "Last visit": 1500999541000,
        "last_visit_start_ts": 1500999541000,
        "First visit": 1500999541000
    },
    "properties": {
        "profile": "main",
        "visitor_id": "1a1ee055145646f8ab4d779628c05dd4",
        "account": "tealium"
    },
    "flags": {
        "Is Registered": false
    },
    "audiences": [
        "New Users"
    ],
    "badges": [
        "Product Browser"
    ],
    "preloaded": false,
    "creation_ts": 1500999541000,
    "_id": "1a1ee055145646f8ab4d779628c05dd4",
    "_partition": 0,
    "shard_token": 0,
    "current_visit": {
        "metrics": {
            "Event count": 1.0
        },
        "dates": {
            "Visit start": 1500999541000,
            "last_event_ts": 1500999541000
        },
        "properties": {
            "Active browser type": "Chrome",
            "Active operating system": "MacOS",
            "Active browser version": "53",
            "Active platform": "browser",
            "Active device": "other"
        },
        "flags": {
            "Direct visit": true
        },
        "property_sets": {
            "Active devices": [
                "other"
            ],
            "Active browser versions": [
                "53"
            ],
            "Active operating systems": [
                "MacOS"
            ],
            "Active platforms": [
                "browser"
            ],
            "Active browser types": [
                "Chrome"
            ]
        },
        "creation_ts": 1500999541000,
        "_id": "9a20caf81d4adc55cfb958da81a513feff62e3324e9f840ed8bf28ca8a39a37d",
        "shard_token": 0,
        "_dc_ttl_": 60000,
        "total_event_count": 1,
        "events_compressed": false
    },
    "_dctrace": [
        "local_visitor_processor_visitor_processor"
    ],
    "new_visitor": true,
    "audiences_joined_at": {
        "tealium_main_101": 1500999542434
    }
}

Was this page helpful?

This page was last updated: January 7, 2023