WebSocket Endpoint

Use the WebSocket endpoint when a workflow uses WebSocket messages and the run should still report the tracked transaction outcome. Available on Business and Enterprise plans.

What this page helps you do

Use the WebSocket endpoint when a workflow uses WebSocket messages and the run should still report the tracked transaction outcome. Available on Business and Enterprise plans.

Who this is for

Teams defining the transport-specific source or destination side of a correlated transaction.

Prerequisites

A stable tracking field shared between the producer side and the consumer or completion side

By the end

A transport definition that matches the transaction you need to measure.

Run the quick start Understand transactions

Use this page when

Use this page when WebSocket Endpoint is the source or destination side of the transaction and you need the documented endpoint fields before wiring the scenario.

Visual guide

Transaction diagram showing source action, handoff, downstream processing, and completion. — The settings on this page only make sense when the workflow is treated as one transaction from source action to downstream completion.

Guide

Delegate Backed

The WebSocket endpoint is delegate backed. Your test code owns connection, send, receive, authentication, and message framing while LoadStrike handles scenario execution, tracking, reporting, and plan validation.

Connection Shape

Set Url, optional Subprotocols, ConnectTimeout, and CloseTimeout so the endpoint definition remains self-describing even though the connection work lives in your callback. Url must use ws:// or wss://.

Tracking Extraction

TrackingField and optional GatherByField use the same header or JSON selector rules as HTTP, broker, and delegate endpoints. Keep the tracked value stable in message headers or body fields.

Plan Gate

The WebSocket endpoint is available on Business and above.

Endpoint definition samples

Use these samples to see how WebSocket Endpoint is represented as a source or destination endpoint before you attach it to a correlated scenario.

If you run these examples locally, add a valid runner key before execution starts. Set it with WithRunnerKey("...") or the config key LoadStrike:RunnerKey.

WebSocket Endpoint

using LoadStrike;
using LoadStrike.CrossPlatform;
using LoadStrike.CrossPlatform.Delegates;
using LoadStrike.CrossPlatform.WebSockets;

var payloadBuilder = new TrackingPayloadBuilder();
payloadBuilder.SetBody("{\"trackingId\":\"ord-1001\",\"status\":\"completed\"}");

var endpoint = new WebSocketEndpointDefinition
{
    Name = "orders-websocket",
    Mode = TrafficEndpointMode.Consume,
    TrackingField = TrackingFieldSelector.Parse("json:$.trackingId"),
    Url = "wss://realtime.example.com/orders",
    Subprotocols = ["orders.v1"],
    ConsumeAsync = (onMessage, _) =>
    {
        onMessage(new ConsumedMessage
        {
            Payload = payloadBuilder.Build()
        });
        return Task.CompletedTask;
    }
};

_ = endpoint;

package main

import (
    "context"

    loadstrike "loadstrike.com/sdk/go"
)

var webSocketEndpoint = &loadstrike.EndpointSpec{
    Kind:          "WebSocket",
    Name:          "orders-websocket",
    Mode:          "Consume",
    TrackingField: "json:$.trackingId",
    WebSocket: &loadstrike.WebSocketEndpointOptions{
        URL:          "wss://realtime.example.com/orders",
        Subprotocols: []string{"orders.v1"},
        Consume: func(_ context.Context, onMessage func(loadstrike.EndpointConsumeEvent) error) error {
            return onMessage(loadstrike.EndpointConsumeEvent{
                TrackingID: "ord-1001",
                Payload: loadstrike.TrackingPayload{
                    Body: map[string]any{"trackingId": "ord-1001", "status": "completed"},
                },
            })
        },
    },
}

import java.util.Map;

import com.loadstrike.runtime.LoadStrikeCorrelation.TrackingFieldSelector;
import com.loadstrike.runtime.LoadStrikeCorrelation.TrackingPayload;
import com.loadstrike.runtime.LoadStrikeTransports;
import com.loadstrike.runtime.LoadStrikeTransports.ConsumedMessage;
import com.loadstrike.runtime.WebSocketEndpointDefinition;

var endpoint = new WebSocketEndpointDefinition();
endpoint.name = "orders-websocket";
endpoint.mode = LoadStrikeTransports.TrafficEndpointMode.Consume;
endpoint.trackingField = TrackingFieldSelector.parse("json:$.trackingId");
endpoint.url = "wss://realtime.example.com/orders";
endpoint.subprotocols = java.util.List.of("orders.v1");
endpoint.consumeAsync = () -> {
  var message = new ConsumedMessage();
  message.payload = new TrackingPayload(
      Map.of(),
      Map.of("trackingId", "ord-1001", "status", "completed"),
      (String) null);
  return message;
};

from loadstrike_sdk import WebSocketEndpointDefinition

endpoint = WebSocketEndpointDefinition(
    name="orders-websocket",
    mode="Consume",
    tracking_field="json:$.trackingId",
    url="wss://realtime.example.com/orders",
    subprotocols=["orders.v1"],
    consume_async=lambda on_message: on_message({
        "Payload": {"Body": {"trackingId": "ord-1001", "status": "completed"}}
    }),
)

import { WebSocketEndpointDefinition } from "@loadstrike/loadstrike-sdk";

const endpoint = new WebSocketEndpointDefinition({
  Name: "orders-websocket",
  Mode: "Consume",
  TrackingField: "json:$.trackingId",
  Url: "wss://realtime.example.com/orders",
  Subprotocols: ["orders.v1"],
  ConsumeAsync: async (onMessage) => {
    await onMessage({ payload: { body: { trackingId: "ord-1001", status: "completed" } } });
  }
});

void endpoint;

const { WebSocketEndpointDefinition } = require("@loadstrike/loadstrike-sdk");

const endpoint = new WebSocketEndpointDefinition({
  Name: "orders-websocket",
  Mode: "Consume",
  TrackingField: "json:$.trackingId",
  Url: "wss://realtime.example.com/orders",
  Subprotocols: ["orders.v1"],
  ConsumeAsync: async (onMessage) => {
    await onMessage({ payload: { body: { trackingId: "ord-1001", status: "completed" } } });
  }
});

void endpoint;

WebSocket endpoint fields and parameters

Name

Required endpoint identifier. It appears in correlation tables, sink exports, and troubleshooting messages, so choose a stable descriptive name.

Mode

Choose Produce when LoadStrike should create traffic, or Consume when it should listen for downstream traffic. Run mode validation checks that the selected mode matches the source or destination role.

TrackingField

Selector that extracts the correlation id from a header or JSON body. It is normally required, but can be omitted when UseLoadStrikeTraceIdHeader is true so LoadStrike uses header:loadstrike-trace-id for generated source traffic. Selector prefixes such as header: and json: are parsed case-insensitively, but the header name or JSON path segments after the prefix must match exact casing. The extracted value is matched case-sensitively by default unless TrackingFieldValueCaseSensitive is turned off on the tracking configuration.

GatherByField

Optional destination-only selector used for grouped correlation reports. It follows the same selector-casing rules as TrackingField. Group values are grouped case-sensitively by default unless GatherByFieldValueCaseSensitive is turned off on the tracking configuration.

AutoGenerateTrackingIdWhenMissing

Defaults to true. When the source payload does not already contain the tracked id, LoadStrike can inject one so the generated traffic still produces a correlation key.

UseLoadStrikeTraceIdHeader

Defaults to false. When true and TrackingField is omitted, produced source messages receive a loadstrike-trace-id header with a GUID value. Consume-mode source endpoints and CorrelateExistingTraffic runs do not inject this header; they only observe it if the existing traffic already contains it.

PollInterval

Controls how often a consumer-style endpoint polls for new messages. The value must stay greater than zero whenever you set it explicitly.

MessageHeaders

Optional headers that are written with produced traffic and also influence tracking extraction when the selector targets headers. Header names are preserved exactly as you set them, and header selectors later match using that same exact casing.

MessagePayload

Optional object or body value sent by producer-style endpoints. This is the payload your scenario is actually placing on the wire.

MessagePayloadType

Optional type hint used when JSON selectors need typed parsing. Leave it unset when dynamic JSON parsing is enough.

JsonSettings / JsonConvertSettings

Optional serializer settings for System.Text.Json or Newtonsoft.Json. Use them only when the payload shape or naming strategy requires custom parsing behavior.

ContentType

Optional explicit content type for custom payload handling. This is most helpful for delegate-style transports or non-default HTTP body shapes.

Url

Required absolute ws:// or wss:// URL used by your WebSocket callback.

Subprotocols

Optional WebSocket subprotocol names used during connection setup.

ConnectTimeout

Maximum connection setup time. It must be greater than zero when configured.

CloseTimeout

Maximum shutdown time. It must be greater than zero when configured.

ProduceAsync / ConsumeAsync

Required callback for the selected endpoint mode. Produce sends tracked messages; Consume observes tracked messages.

ConnectionMetadata

Optional free-form dictionary for connection hints, tenant routing, or diagnostics.

Matching docs

What this page helps you do

What this page helps you do

Who this is for

Prerequisites

By the end

Use this page when

Visual guide

Guide

Delegate Backed

Connection Shape

Tracking Extraction

Plan Gate

Endpoint definition samples

WebSocket Endpoint

WebSocket endpoint fields and parameters

Related category and article pages

Event-driven load testing

Distributed load testing

Examples