Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Event Name

Description

Properties

Property Description

Loyalty Points Assignment

Triggered when the Loyalty Points Assignment endpoint receives a request from a partner.

Duration

The duration in ms of the loyalty points assignment process from the time the request is received until it is finished.

Partner

The partner that requested the loyalty points assignment.

pointsDeducted

How many points were deducted from the user.

pointsEarned

How many points the user earned.

Reference

An optional property where the partner can send the reason or event that generated the request for this loyalty points assignment.

Status

Successful or Error.

TransactionId

The id of the transaction created for the points assignment. (Only for the Successful status)

ErrorDescription

The error that happened. (Only for the Error status)

Promo Codes

Event

Fires when

Main attributes

Payload details

Action Sheet View

When a Action tab it`s displayed to the user

Image Modified

actionSheetHeader record the component/object name (i.e. “Apply Promo Code”)

currentScreen records the current screen where the Action tab it`s displayed (i.e. “/rewards/offers“)

Image Modified

Action Sheet Submission

When a Action form it`s submitted

Image Modified

response: records the response "Failed" or “successful“

failureReason reason why the response was failed main reasons it`s "INVALID_CODE" or “EXPIRED_CODE“

submittedData records the data sent in the Action form

Image Modified

Promo Code Applied

When the Promo Code endpoint in the Loyalty Engine is hit

  • Duration: The duration in ms of the offer being unlocked when a promo code is sent.

  • sanityId: The Sanity ID of the offer.

  • Partner: The “posSystem” of the vendor sending the request. If this request is from RBI to show promo code offer in the app, then partner would be “RBI”.

  • Status: Successful or Error.

  • traceId: The tracking_id sent by Voucherify.

  • ErrorDescription (Only for the Error status): The error that happened.

    • Error: “Promo Code” not found

    • Error: “Promo code” already used

    • Error: Failed to unlock offer due to a technical issue

To add when tested in Staging