WebVisit

Overview

Technical name: WebVisit · ActionType: 14

Use WebVisit for a visit to a web experience. The Intelligent Tag can collect available browser context; server integrations submit the agreed destination and identity signals.

Open in REST Explorer

Requirements and Inputs

Input	Applicability
ActionKeyToken	Required: an ActionKey provisioned for WebVisit (14).
Landing URL (419) / supported URL parameter	Provide the web destination context. If supplied in multiple places, keep the values consistent.
UAIID (92) and known identity signals	Conditional: use available, authorized identity information; do not fabricate an identity when it is unavailable.

All requests use the shared User Action endpoint. Provisioning determines required identity and destination signals. Optional fields are defined in Action Fields.

Request Examples

Replace YOUR_ACTION_KEY with the correctly provisioned token. The first example shows the basic shape for this context; add all signals required by your integration. These examples do not provision an action or guarantee a production-valid identity.

Basic request

{
  "ActionKeyToken": "YOUR_ACTION_KEY",
  "Values": [
    {
      "SignalValueType": 419,
      "DataType": 0,
      "UnitType": 0,
      "Value": "https://brand.example.com/product",
      "OptionIDs": {}
    }
  ]
}

With additional context

{
  "ActionKeyToken": "YOUR_ACTION_KEY",
  "Values": [
    {
      "SignalValueType": 419,
      "DataType": 0,
      "UnitType": 0,
      "Value": "https://brand.example.com/product",
      "OptionIDs": {}
    },
    {
      "SignalValueType": 92,
      "DataType": 0,
      "UnitType": 0,
      "Value": "EXAMPLE_UAIID",
      "OptionIDs": {}
    },
    {
      "SignalValueType": 47,
      "DataType": 0,
      "UnitType": 0,
      "Value": "buyer@example.com",
      "OptionIDs": {}
    },
    {
      "SignalValueType": 403,
      "DataType": 0,
      "UnitType": 0,
      "Value": "example-web-001",
      "OptionIDs": {}
    }
  ]
}

Expected Result

The shared response may contain Result, correlation identifiers, and configured signals. Read the returned values according to the configured model and product. Do not assume every action returns an IH Score or the same response fields.

See the response contract and API Results and Errors. An HTTP response or accepted event alone does not prove downstream delivery or a business outcome.

Processing and Feedback

Let the configured default web experience remain usable while a result is unavailable. Use the Intelligent Tag and Page Plan for browser rendering; a WebVisit result alone is not a Page Plan. Correlate subsequent outcomes with the same session rules.

When reporting an observed outcome, use Disposition (19) and its correlation rules. Never reuse a different ActionType ActionKey as an outcome key.

Delivery and Troubleshooting

This guide documents API submission. Use only other delivery methods explicitly provisioned for your integration. If a request fails, verify the API key, the exact ActionKey type, required signal values, and the actual HTTP and API result. Review retry/correlation behavior before resubmitting after a timeout.