Connector Events

Event	Data	Description (This event is triggered when …)
consumption.attributeCreated	LocalAttribute	… an Attribute was created manually or through a Request.
consumption.attributeDeleted	LocalAttribute	… an Attribute was deleted manually or through a Request.
consumption.attributeSucceeded	LocalAttribute	… an Attribute was succeeded manually or through a Request.
consumption.attributeUpdated	LocalAttribute	… an Attribute was updated manually or through a Request.
consumption.incomingRequestReceived	LocalRequest	… an incoming Request was received either by loading a RelationshipTemplate or by receiving a Message
consumption.incomingRequestStatusChanged	RequestStatusChangedEventData	… the status of an incoming Request has changed.
consumption.messageProcessed	MessageProcessedEventData	… a Message was processed by Modules like the RequestModule or DeciderModule.
consumption.outgoingRequestCreated	LocalRequest	… any outgoing Request was created by the Connector API or Connector Module.
consumption.outgoingRequestCreatedAndCompleted	LocalRequest	… any outgoing Request was transferred via a RelationshipTemplate. This event could either be triggered: • by an incoming pending Relationship using the onNewRelationship property within the RelationshipTemplate Content • by an incoming Message using the onExistingRelationship property within the RelationshipTemplate Content, if the user already has a Relationship with the RelationshipTemplate creator
consumption. outgoingRequestFromRelationshipCreation CreatedAndCompleted	LocalRequest	… a consumption. outgoingRequest CreatedAndCompleted event is fired and it was fired due to an incoming pending Relationship. This convenience event is useful to act on incoming pending Relationships.
consumption.outgoingRequestStatusChanged	RequestStatusChangedEventData	… the status of an outgoing Request has changed.
consumption.relationshipTemplateProcessed	RelationshipTemplateProcessedEventData	… a RelationshipTemplate was processed by Modules like the RequestModule or DeciderModule.
consumption.sharedAttributeCopyCreated	LocalAttribute	… an Attribute is copied for sharing with another Identity.
transport.fileOwnershipClaimed	File	… the ownership of the File was claimed by another Identity. This happens when they accept a corresponding TransferFileOwnershipRequestItem.
transport.fileOwnershipLocked	File	… the ownership of the File is locked and can only be claimed once the ownershipToken is regenerated.
transport.identityDeletionProcessStatusChanged	IdentityDeletionProcess	… a new IdentityDeletionProcess has been created or the status of an existing IdentityDeletionProcess has changed.
transport.messageReceived	Message	… a Message is received during synchronization.
transport.messageSent	Message	… a Message was sent.
transport.peerRelationshipTemplateLoaded	RelationshipTemplate	… a RelationshipTemplate was loaded that belongs to another Identity.
transport.relationshipChanged	Relationship	… a Relationship has changed. This can be due to one of the following cases: • you create a Relationship • you accept, reject or revoke a pending Relationship • you terminate an active Relationship • you request the reactivation of a terminated Relationship or accept, reject or revoke such a reactivation request • a new Relationship is received or an existing one changed during synchronization
transport.relationshipReactivationRequested	Relationship	… the reactivation of a terminated Relationship has been requested by you or the peer.
transport.relationshipReactivationCompleted	Relationship	… the reactivation of a terminated Relationship has been accepted, rejected or revoked by you or the peer.
transport.relationshipDecomposedBySelf	Relationship	… you have decomposed a terminated Relationship.
transport.relationshipTemplateAllocationsExhausted	RelationshipTemplate	… an own RelationshipTemplate has reached its maxNumberOfAllocations and can therefore no longer be allocated by further peers.
transport.peerToBeDeleted	Relationship	… your Relationship’s peer triggered their deletion.
transport.peerDeleted	Relationship	… your Relationship’s peer was deleted.
transport.peerDeletionCancelled	Relationship	… your Relationship’s peer cancelled their deletion.

Event structure

Every event is structured as follows (TData depends on the actual event, e.g. LocalAttribute):

interface Event<TData> {
  namespace: string;
  eventTargetAddress: string;
  data: TData;
}

RequestStatusChangedEventData

LocalRequest

export interface RequestStatusChangedEventData {
  request: LocalRequest;
  oldStatus: LocalRequestStatus;
  newStatus: LocalRequestStatus;
}

MessageProcessedEventData

Message

export interface MessageProcessedEventData {
  message: MessageDTO;
  result: "ManualRequestDecisionRequired" | "NoRequest" | "Error";
}

RelationshipTemplateProcessedEventData

RelationshipTemplate

export interface RelationshipTemplateProcessedEventData {
  template: RelationshipTemplateDTO;
  result: "ManualRequestDecisionRequired" | "NonCompletedRequestExists" | "RelationshipExists" | "NoRequest" | "Error";
}