Transactions

User interaction with Nexus211 platform is recorded using the concept of a transaction.

A transaction links a contact profile and an agent profile. It starts at a known point in time (e.g. when a call is received) and may involve any number of related activities: referrals, survey responses, and other entities can all be tied to a transaction.

All of these activities, and other significant events will be individually captured as Transaction Events.

Manually logged events

Each Nexus211 application has freedom to create custom transaction events. It can pass an arbitrary action name and metadata to keep track of significant events that take place during the course of a I&R session.

Automatically logged events

Some transaction events are created automatically by Nexus211.

Created

This event marks the creation of the transaction.

{ "action": "nexus211.transaction.created" }

Closed

Transactions can be closed. When a transaction is closed, you can no longer attach new transaction events to it. Closing a transaction can be achieved by simply calling POST /transaction/:id/close.

{ "action": "nexus211.transaction.closed" }

Reopened

If a transaction is closed erronously, or more information needs to be attached, you can reopen the transaction. To do so, you can call POST /transaction/:id/ropen

{ "action": "nexus211.transaction.reopened" }

Survey Responded

This event is created when a survey is filled out during the transaction.

{
  "action": "nexus211.survey.responded",
  "elementType": "Survey",
  "elementId": "id of the survey"
}

Opted Out of Survey

This event is created when the contact opts out of a survey during the transaction.

{
  "action": "nexus211.survey.opted-out",
  "elementType": "Survey",
  "elementId": "id of the survey"
}

Survey Response Deleted

This event is created when a single survey response is deleted from Nexus211.

{
  "action": "nexus211.survey-response.deleted",
  "elementType": "SurveyResponse",
  "elementId": "id of the survey response"
}

Referral

This event is created when a referral is made in reference to the transaction.

{
  "action": "nexus211.referral.created",
  "elementType": "referral",
  "elementId": "id of the referral"
}

Referral Deleted

This event is created when a referral is deleted during the transaction.

{
  "action": "nexus211.referral.deleted",
  "elementType": "referral",
  "elementId": "id of the referral"
}