Extension Control API

Overview

The Extension Control API, also referred to as Control Signals, is designed for advanced users and integrations that manage LinkedIn outreach across one or more accounts.

The API allows you to remotely trigger selected functions that would normally be initiated through the Dux-Soup or STACKED user interface.

The Extension Control API was originally developed when Dux-Soup operated exclusively as a browser extension. As Dux-Soup and STACKED have evolved, some Control Signals are now supported across multiple environments, while others remain specific to the Dux-Soup extension or Cloud environment.

Support varies by Control Signal and product environment. Check the compatibility note for each signal before implementing it.

How Control Signals work

Control Signals instruct the connected Dux-Soup or STACKED environment to perform a specific action.

If the target account is not currently connected, a signal waits for up to 1 minute to be delivered. If the target does not become available within that time, the signal is discarded.

Control Signals can be delivered even when Remote Control is disabled for the user. They are not affected by Planner or Throttling settings.

Extension Reload

Force the extension to restart and reload its configuration. Any automation currently running will be interrupted and stopped.

URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/signal
HTTP method: POST
HTTP body: a JSON object with the following parameters, in addition to the required fields.

Parameter

signal

"extensionReload"

This signal is intended for Dux-Soup extension environments in Dux-Soup Turbo and Dux-Soup Cloud plans. For example, it can be used to force configuration changes such as license key updates.

Bridge Check

Forces the Message Bridge to check for new messages or connections.

URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/signal
HTTP method: POST
HTTP body: a JSON object with the following parameters, in addition to the required fields.

Parameters

signal	"bridgeCheck"
params	{
	boxname	Name of the Message box to check. Possible values are: "regularinbox", "salesnavinbox" and "connections" ( mandatory, String )
	daysback	Start checking for messages from this number of days in the past (optional, Number)
	}

This signal applies to Dux-Soup Turbo and Cloud, as well as STACKED.

Data Reset

Clear the captured profile data that is stored in the browser.

URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/signal
HTTP method: POST
HTTP body: a JSON object with the following parameters, in addition to the required fields.

Parameter

signal

"dataReset"

This signal applies to the Dux-Soup browser extension only.

Batch Enroll

Trigger bulk enrollment of LinkedIn profiles into a campaign using a LinkedIn search URL.

URL: https://app.dux-soup.com/xapi/remote/control/{{USERID}}/signal
HTTP method: POST
HTTP body: a JSON object with the following parameters, in addition to the required fields.

Parameters

signal	"batchEnroll"
params	{
	searchurl	LinkedIn search results URL to enroll profiles from. The URL must be a recognised LinkedIn results page (mandatory, String ).
	campaignid	Campaign ID to enroll profiles into. If not provided, the default campaign will be used (optional, String).
	maxenrolls	Maximum number of profiles to enroll from the search results (optional, Number).
	target	Specifies where the signal should run: "local" for the Dux-Soup Turbo or Dux-Soup Cloud extension and STACKED local, or "cloud" for a Dux-Soup Cloud or STACKED cloud session. (mandatory, String)
	}

This signal applies to Dux-Soup Turbo and Cloud, as well as STACKED.