In-app ribbons

In-app ribbons enables brokers to display targeted promotional and informational elements directly within the cTrader interface.

Prerequisites

Important

Before implementing In-app ribbons, ensure completion of:

• Setup actions: Infrastructure & connectivity, authentication of API calls
• Contracts: Broker identification, screen URL conventions
• Identity options: SSO user creation and authorisation

Implementation flow

The flow proceeds through the following stages:

1. The broker defines the ribbon content and configuration (title, colour, action and visibility scope).
2. The broker registers the controls for a specific userId with the cTrader backend (PUT /oauth2/ctid/inAppControls).
3. The cTrader backend processes the controls and displays the ribbons to the targeted user.

Endpoints used

• PUT /oauth2/ctid/inAppControls — create or update the in-app controls (ribbons) shown to a user

Examples

Web: 1

Web: 2

Web: 3

Mobile: 1

Mobile: 2

Mobile: 3