Webhooks · Reference

Event types.

Every webhook delivery carries one of the events below. Event names are part of your integration contract — we won't rename or repurpose them. New events may be added to an existing group, but existing ones keep their semantics.

Quick reference

All events.

10 events across the trader and signal lifecycles. Subscribe to any combination of them per endpoint.

trader.startedFires when a trader opens the bot with /start.
traderReferral-filterable
trader.onboardedFires when a trader completes onboarding.
traderReferral-filterable
trader.mt5_connectedFires when an MT5 account becomes connected through REST, web, or Telegram. Revalidating the same connected account does not emit another event.
traderReferral-filterable
trader.mt5_failedFires when a connection attempt fails through REST, web, or Telegram. A working connection is preserved. Validation-only API probes do not emit lifecycle events.
traderReferral-filterable
trader.mt5_disconnectedFires when MT5 becomes disconnected. Detaching a web or Telegram session while another frontend remains connected does not emit this event.
traderReferral-filterable
signal.publishedFires when a signal becomes published.
signal
signal.invalidatedFires when a published signal is invalidated.
signal
signal.action.viewedFires when a trader views a signal.
signalReferral-filterable
signal.action.executedFires when a trader completes a signal action successfully.
signalReferral-filterable
signal.action.failedFires when a trader signal action fails.
signalReferral-filterable

One reference, every event

All dynamic params.

The complete catalog of dynamic values you can attach to a webhook param. Fields that don't apply to a given event resolve to null on POST and are omitted on GET.

System

5 fields

Event IDevent.id

Stable identifier for this webhook event.

Event Typeevent.type

Public event name, such as trader.started.

Event Created Atevent.createdAt

ISO timestamp when the event was queued.

Test Eventevent.isTest

True when the delivery came from the dashboard test action.

Test Messagewebhook.testMessage

Synthetic message used by dashboard test deliveries.

Trader

9 fields

Trader IDtrader.id

Internal trader identifier.

Telegram IDtrader.telegramId

Numeric Telegram user ID.

Usernametrader.username

Telegram username when the user has one.

First Nametrader.firstName

Telegram first name captured from the bot profile.

Last Nametrader.lastName

Telegram last name when available.

Activetrader.isActive

Whether the trader is currently active.

First Seen Attrader.firstSeenAt

When the trader was first created in Trading Layer.

Last Active Attrader.lastActiveAt

Most recent bot activity timestamp for this trader.

Onboarded Attrader.onboardedAt

When onboarding was completed, if completed.

Referral

15 fields

Referral Link IDreferral.linkId

Attributed referral link ID for trader-scoped events.

Referral Link Namereferral.linkName

Internal name of the attributed referral link.

Referral Start Payloadreferral.startPayload

Fixed ref_ token that identifies the referral link.

Raw Start Payloadreferral.rawStartPayload

Full latest Telegram /start payload.

Initial Start Payloadreferral.initialStartPayload

First Telegram /start payload captured for this trader.

Latest Start Payloadreferral.latestStartPayload

Most recent Telegram /start payload captured for this trader.

Click IDreferral.clickId

Click ID parsed after the _cid marker in the start payload.

Initial Click IDreferral.initialClickId

First Click ID captured for this trader.

Latest Click IDreferral.latestClickId

Most recent Click ID captured for this trader.

UTM Sourcereferral.utmSource

UTM source configured on the attributed referral link.

UTM Mediumreferral.utmMedium

UTM medium configured on the attributed referral link.

UTM Campaignreferral.utmCampaign

UTM campaign configured on the attributed referral link.

UTM Termreferral.utmTerm

UTM term configured on the attributed referral link.

UTM Contentreferral.utmContent

UTM content configured on the attributed referral link.

Partner Codereferral.partnerCode

Partner code configured on the attributed referral link.

MT5

6 fields

MT5 Statusmt5.status

Current MT5 connection status for the trader.

MT5 Loginmt5.login

MT5 login for the connection, failed attempt, or disconnected account.

MT5 Servermt5.server

MT5 server for the connection, failed attempt, or disconnected account.

MT5 Connected Atmt5.connectedAt

When MT5 was connected successfully.

Last MT5 Errormt5.lastError

Last MT5 validation error stored for this trader.

Last MT5 Error Atmt5.lastErrorAt

When the last MT5 validation error happened.

Signal

19 fields

Signal IDsignal.id

Internal signal identifier.

Signal Headlinesignal.headline

Signal headline/title.

Symbolsignal.symbol

Market symbol, such as EURUSD.

Directionsignal.direction

Signal direction, such as buy or sell.

Signal Statussignal.status

Current signal status.

Strategysignal.strategy

Signal strategy name.

Providersignal.provider

Provider name configured for the signal.

Risk Levelsignal.riskLevel

Risk level configured for the signal.

Entrysignal.entry

Fixed entry price when configured.

Stop Losssignal.stopLoss

Fixed stop-loss price when configured.

Take Profitsignal.takeProfit

Fixed take-profit price when configured.

Stop Loss Percentsignal.stopLossPercent

Percent stop-loss for market-entry signals.

Take Profit Percentsignal.takeProfitPercent

Percent take-profit for market-entry signals.

Max Slippage Percentsignal.maxSlippagePercent

Maximum allowed slippage for market-entry signals.

Published Atsignal.publishedAt

When the signal was published.

Valid Untilsignal.validUntil

When the signal stops being valid.

Invalidated Atsignal.invalidatedAt

When the signal was invalidated.

Invalidation Reasonsignal.invalidationReason

Reason the signal was invalidated.

Reference Pricesignal.referencePrice

Reference price captured for market-entry signals.

Signal action

9 fields

Action IDsignal.actionId

Internal signal-action identifier.

Action Typesignal.actionType

Action type, such as view_signal or copy_signal.

Action Statussignal.actionStatus

Current action status.

Risk Amountsignal.riskAmount

Risk amount selected by the trader.

Requested Volumesignal.requestedVolume

Requested trade volume when available.

Runtime Correlation IDsignal.runtimeCorrelationId

Runtime correlation ID for the trade request.

Executed Atsignal.executedAt

When the signal action completed successfully.

Error Messagesignal.errorMessage

Failure message for failed signal actions.

Action Metadatasignal.actionMetadata

Structured metadata stored on the signal action.

Fields are selected per endpoint.

Configure the params you want on the dashboard. Each param is either a static string or one of the dynamic keys above.

PreviousOverview NextSignature verification