Event Types

A gateway service processes messages and proofs. Upon lifecycle state change, a new event message is generated. Clients retrieve events from the gateway service endpoint which is polled periodically by a Client:

GET /api/gateway/iso20022/gateway/event

Event Types are defined in API definition

MESSAGE_CREATED

Description: Triggered by a sender node when message is successfully created.

val traceId: UUID,
val endToEndId: String,
val type: String,
val body: ByteArray,
val bodyType: MessageBodyType,

MESSAGE_SENT

Description: Triggered by a sender node when message is sent to a counterparty node.

val traceId: UUID,
val endToEndId: String,
val type: String,

MESSAGE_RECEIVED

Description: Triggered by a recipient node when a message is received and successfully created on a counterparty node.

val traceId: UUID,
val endToEndId: String,
val type: String,
val body: ByteArray,
val bodyType: MessageBodyType,

MESSAGE_ACKNOWLEDGED

Description: Triggered by both (sender/recipient) nodes when a message is acknowledged by a counterparty node.

val traceId: UUID,
val endToEndId: String,
val type: String,

MESSAGE_NOT_ACKNOWLEDGED

Description: Triggered by both (sender/recipient) nodes when a message is not acknowledged by a counterparty node

val traceId: UUID,
val endToEndId: String,
val type: String,

PROOF_CREATED

Description: Triggered by a sender node when a proof is successfully created.

val traceId: UUID,
val endToEndIds: List<String>,
val messagesIds: List<String>,

PROOF_SENT

Description: Triggered by a sender node when proof was sent to a counterparty.

val traceId: UUID,
val endToEndIds: List<String>,
val messagesIds: List<String>,

PROOF_RECEIVED

Description: Triggered by a recipient node when a proof is received and successfully acknowledged by a counterparty node.

val traceId: UUID,
val endToEndIds: List<String>,
val messagesIds: List<String>,

PROOF_ACKNOWLEDGED

Description: Triggered by both nodes when a proof is acknowledged by counterparty node.

val traceId: UUID,
val endToEndIds: List<String>,
val messagesIds: List<String>,

PROOF_NOT_ACKNOWLEDGED

Description: Triggered by both nodes when a proof is not acknowledged by a counterparty node.

val traceId: UUID,
val endToEndIds: List<String>,
val messagesIds: List<String>,

PROOF_COMMITTED

Description: Triggered by both nodes when a proof is successfully committed.

val traceId: UUID,
val endToEndIds: List<String>,
val messagesIds: List<String>,
val transactionHash: String,

PROOF_APPROVED

Description: Triggered by both nodes when a proof is successfully approved.

val traceId: UUID,
val endToEndIds: List<String>,
val messagesIds: List<String>,

PROOF_REJECTED

Description: Triggered by both nodes when a proof is rejected.

val traceId: UUID,
val endToEndIds: List<String>,
val messagesIds: List<String>,

Last updated