Skip to main content

Purpose and scope

When an associated user’s data changes on etoro, etoro can publish an event to your platform. Delivery is push onto Azure Event Hub: etoro writes the message, and your consumer reads it. This is the opposite direction from Reporting events to etoro, where your backend calls the Partners API. Event delivery is provisioned per partner. If your integration agreement does not include outbound events, this page does not apply until etoro enables it for your application.
Connection details — Event Hub namespace, hub name, consumer group, and access material — are issued by your etoro contact when the integration is provisioned. They are not self-service and are not listed in this portal.

Delivery

etoro publishes an event only when the user has an associated account on your platform and the change is relevant to the field set approved for your application. If neither condition holds, no message is written to your hub.

Message envelope

Every message body is a JSON object with two properties:

eventMetadata

Example

Keys are camelCase. Consumers should keep advancing the partition when they see an unknown eventType or eventDataVersion, and confirm support with their etoro contact before handling new ones. Additional optional fields may appear in later versions. The payload inside eventData depends on eventType and is documented on that event’s page under Events.

Operational rules

1

Parse the envelope, then parse eventData

eventData is a string. A single JSON.parse (or equivalent) leaves you with a string, not an object. Deserialize it again before reading the payload for that eventType.
2

Branch on eventType

Route handling by eventMetadata.eventType. Ignore event types your integration does not implement, and keep the consumer advancing so an unknown type does not block the partition.
3

Key users by externalUserId

Match the event to your user record with eventMetadata.externalUserId. Do not expect an etoro customer id in the payload.
4

Treat the message as a change signal

An event names what changed. It is not a full snapshot of the user, and it does not include the new values. Read those through the Partners API only where your integration is approved to.
5

Retain correlationId

Store correlationId with your processing record. It is the reference etoro uses when tracing whether a given change was delivered.

Reporting events to etoro

The partner-to-etoro direction: deposit notifications and related reporting over the Partners API.

Partner integration flow

Non-interactive tokens, account association, and data-sharing rules.

Data sharing and PII

What personal data a partner may receive, and under which approval.

KYC

Payload and field names for the KycUpdates event.

Partners API reference

REST operations for reading approved KYC and account data after an event.