Signal

@Serializable
data class Signal(val externalCustomerId: String, val signalType: String, val occurredAt: String = nowIso(), val clientSignalId: String = UUID.randomUUID().toString(), val properties: Map<String, String> = emptyMap())

One behavioural event about a customer.

Constructors

Link copied to clipboard
constructor(externalCustomerId: String, signalType: String, occurredAt: String = nowIso(), clientSignalId: String = UUID.randomUUID().toString(), properties: Map<String, String> = emptyMap())

Properties

Link copied to clipboard
@SerialName(value = "client_signal_id")
val clientSignalId: String

Idempotency key, unique per event.

Link copied to clipboard
@SerialName(value = "external_customer_id")
val externalCustomerId: String

Opaque partner-assigned customer id. Never PII.

Link copied to clipboard
@SerialName(value = "occurred_at")
val occurredAt: String

When the event happened, ISO-8601.

Link copied to clipboard

Event payload.

Link copied to clipboard
@SerialName(value = "signal_type")
val signalType: String

Signal type, as registered for your org.