Webhook actions and parameters

Actions

The following actions are available for all HTTP-based webhook connectors, regardless of the authentication type.

To use a webhook to send data to a JDBC-compatible database, see Webhook JDBC.

Send Event Data via HTTP Request

Parameter	Description
Method	(Required) Select the request method: `GET`, `POST`, `PUT`, `DELETE`, or `PATCH`. 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	(Optional) Provide parameters to append to URL. Template Support: reference template name to generate parameter value from template.
Headers	(Optional) Map HTTP header values to header names. Template Support: reference template name to generate header value from template.
Cookies	(Optional) 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	(Optional) 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	(Optional) Provide template variables as data input for templates. For more information, see Connector template variables. Name nested template variables with the dot notation. For example: `items.name` Nested template variables are typically built from data layer list attributes.
Templates	(Optional) Provide templates to be referenced in either URL, URL Parameter, Header, or Body Data. For more information, see About connector templates. 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.

Send Visitor Data via HTTP Request

Parameter	Description
Method	(Required) Select the request method: `GET`, `POST`, `PUT`, `DELETE`, or `PATCH`. 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	(Optional) Provide parameters to append to URL. Template Support: reference template name to generate parameter value from template.
Headers	(Optional) Map HTTP header values to header names. Template Support: reference template name to generate header value from template.
Cookies	(Optional) 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	(Optional) 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	(Optional) Provide template variables as data input for templates. For more information, see Connector template variables. Name nested template variables with the dot notation. For example: `items.name` Nested template variables are typically built from data layer list attributes.
Templates	(Optional) Provide templates to be referenced in either URL, URL Parameter, Header, or Body Data. For more information, see About connector templates. 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 With Visitor Data	Add the current visit data to the payload. This includes event visit data if Exclude Current Visit Event Data isn’t selected.
Exclude Current Visit Event Data	Exclude event data from the 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.

Send Customized Data via HTTP Request (Advanced)

If your custom request requires a complex payload, such as nested JSON or XML, use the Templates option to construct a payload in the format needed by the vendor’s endpoint. For more information, see Connector template variables.

Parameter	Description
Method	(Required) Select the request method: `GET`, `POST`, `PUT`, `DELETE`, or `PATCH`.
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	(Optional) Map HTTP header values to header names. Template Support: reference template name to generate header value from template.
Cookies	(Optional) 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	(Optional) 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	(Optional) 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	(Optional) Provide template variables as data input for templates. For more information, see Connector template variables. Name nested template variables with the dot notation. For example: `items.name` Nested template variables are typically built from data layer list attributes.
Templates	(Optional) Provide templates to be referenced in either URL, URL Parameter, Header, or Body Data. For more information, see About connector templates. 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.
Redirection	Allow redirection only if the method is GET.

Send Batched Data via HTTP Request

Batch limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

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

Parameters

Parameter	Description
Method	(Required) Select the request method: `GET`, `POST`, `PUT`, `DELETE`, or `PATCH`.
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	(Optional) Map HTTP header values to header names. Template Support: reference template name to generate header value from template.
Cookies	(Optional) 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	(Optional) 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	(Optional) Provide template variables as data input for templates. For more information, see Connector template variables. Name nested template variables with the dot notation. For example: `items.name` Nested template variables are typically built from data layer list attributes.
Templates	(Optional) Provide templates to be referenced in either URL, URL Parameter, Header, or Body Data. For more information, see About connector templates. 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	Select this checkbox if you want to include current visit data.
Exclude Current Visit Event Data	Exclude event data from the 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.
Timeout	Set the maximum time (in seconds) the system will wait for batch actions to complete when sending data through `HTTP` requests. The minimum value is `1` and the maximum value is `10`.

Send Batched Customized Data via HTTP Request (Advanced)

Batching is ignored when using Trace.

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
Time since oldest request (Time to Live, TTL): Between 1 and 60 minutes
Maximum size of requests: 16 MB

Parameters

Parameter	Description
Method	(Required) Select the request method: `GET`, `POST`, `PUT`, `DELETE`, or `PATCH`.
URL	(Required) Provide URL to submit request to. Template Support: reference template name to generate URL from template.
Body Content Type	(Optional) 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	(Optional) 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	(Optional) Provide parameters to append to URL. Template Support: reference template name to generate parameter value from template.
Headers	(Optional) >Map HTTP header values to header names. Template Support: reference template name to generate header value from template.
Headers	(Optional) Map HTTP header values to header names. Template Support: reference template name to generate header value from template.
Template Variables	(Optional) Provide template variables as data input for templates. For more information, see Connector template variables. Name nested template variables with the dot notation. For example: `items.name` Nested template variables are typically built from data layer list attributes.
Templates	(Optional) Provide templates to be referenced in either URL, URL Parameter, Header, or Body Data. For more information, see About connector templates. 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.
Timeout	Set the maximum time (in seconds) the system will wait for batch actions to complete when sending data through `HTTP` requests. The minimum value is `1` and the maximum value is `10`.

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
    }
}