Events API#

The Events API is used to record events in Antavo. An Antavo event is a WORM (Write Once Read Multiple) document object and once submitted cannot be deleted or altered in any way.

There are two ways of submitting events to Antavo:

  1. Single event submission- An individual action is written to a single customer’s event stream.

  2. Bulk event submission - Multiple events are contained within a single API call. This is commonly used for submitting a single action for multiple customers and frequently used within integrations.

Note

The bulk event submission endpoint is designed to process up to 50 events per request. Any additional events include in a request will not be rejected but event processing performance may be affected.

The Events API follows a RESTful approach. Events are sent into Antavo by POST requests to the Events API. The WORM nature of events means that Events API does not support PUT and DELETE requests. Several attributes can be included with one event. Events can be submitted using external_IDs.

The currently available actions and corresponding attributes are listed below. Antavo can accept and will process events submitted with null attributes. This section also contain the specific action-related Antavo errors and general Antavo errors for this module are also listed here.

PII information returned from Events API endpoints can be suppressed using the Events API configuration module. When enabled, no customer information will be present in any response.

All server to server calls should follow the API security protocol and signing procedure and be aware of the API rate limits.

The OpenApi yaml file used to generate this documentation can be downloaded here

Actions#

All available event actions and corresponding parameters are listed below. The availability of some actions require a module to be activated with Antavo Required items are highlighted with an asterisk. Form data can be tested by manual entry into the suitable endpoint.

Tags#

challenge_reset#

Submission of this event leads to the counting of the specified challenge being reset – the current value of the criteria is set to 0. This is particularly useful for resetting challenges which do not have time restrictions. This functionality requires the target challenge to have the resetable flag enabled in the Antavo Backoffice.

Name

Type

Required

Module

Description

challenge

string

Yes

built-in

The unique id of the challenge to be reset

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "challenge_reset",
   "data":  {
       "challenge": "aabbccddeeffgghh"
   }

}

checkout#

pending points transaction

A purchase of any product or service. This existing list of attributes can be extended using the Custom Events module of Antavo, allowing the tracking of other attributes and establishment of different loyalty logic and journeys.

The automatic awarding of points for checkout requires the Incentivized purchase / Points economy modules. When enabled, customers’ points are not awarded for the checkout itself as points are only granted after each checkout line item, the corresponding checkout_item event. The checkout event will also trigger the release of any reserved points. See also: Checkout

Note

The checkout event can be extended by the activated Checkout accept or pending module. In these scenarios, the resulting transaction from a submitted checkout is assigned a pending status and an additional step accepts/rejects the transaction.

Name

Type

Required

Module

Description

auto_accept

date

No

built-in

An optional field which overrides the default auto_accept date with the supplied date

transaction_id

string

Yes

built-in

A unique code that is used for identifying each transaction. An event submission with a preexisting transaction_id will be rejected as a duplicate with the ERR_TX_ALREADY_EXISTS error message

total

number

Yes

built-in

The overall sum paid by the customer during the checkout.

items

string array

No

built-in

A collection of line items describing the product or service that was purchased. checkout_item consists of multiple separate sub-properties.

points_burned

integer

No

built-in

The amount of loyalty points customers has used in the transaction. Antavo will automatically remove these points from the customer upon a successful event submission. The event will be rejected if points_burned is larger than the customer’s available points balance. Despite not being able to give points for them, checkouts can still have a negative points value assigned to them due to points_burned.

channel

string

No

built-in

Under channel, you can send in any platform you wish to track, such as “store”, “mobile”, or “online”, or more specific channels, like “POS” or “API”.

currency

string

No

built-in

Currency Code You can describe the currency used for the transaction in multiple ways, but the 3-character currency code is preferred: USD, EUR, GBP

country

string

No

built-in

The country where the checkout was made.

discount

string

No

built-in

The amount of discount applied to the purchase. It’s useful to send this information in case you would like to offer points after purchases made without any discounts.

shipping

integer

No

built-in

Records the cost of the shipping. Antavo LMP can give customer bonus points depending on shipping costs.

total_quantity

integer

No

checkout_accept

The total quantity for the checkout.

points_rewarded

integer

No

checkout_accept

A custom number of positive integer points awarded for purchasing a certain product which overrides the default subtotal-based behavior provided by Antavo Incentivized Purchase module.

store

string

No

store

The name of the store. This is commonly used for physical in-store purchases. This process can be simplified by using the Store Management module. Stores can be registered in the Store Management module, each of them receives a Store ID which can be used in this store property.

coupon_code

string

No

coupon

A coupon code which will be automatically redeemed upon a successful checkout event submission

coupons

array

No

coupon

An array of coupon codes which will be automatically redeemed upon a successful checkout event submission

offers

array

No

offers

An array of offers which are associated with the current transaction.

purchase_date_timestamp

string

No

shopify

computed_total_quantity

integer

No

shopify

Calculated total quantity of checkout items in a checkout

shipping_shop_money_amount

integer

No

shopify

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "checkout",
   "data":  {
       "transaction_id": "<unique_transaction_id>",
       "total": 100,
       "points_burned": 0,
       "items": [
                       {
                                       "product_id": "product_id",
                                       "product_name": "name_of_the_product",
                                       "product_url": "webstore_url_of_product",
                                       "price": 50,
                                       "quantity": 1,
                                       "discount": 0,
                                       "subtotal": 50,
                                       "points_rewarded": 0
                       },
                       {
                                       "product_id": "product_id2",
                                       "product_name": "name_of_the_product",
                                       "product_url": "webstore_url_of_product",
                                       "price": 50,
                                       "quantity": 1,
                                       "discount": 0,
                                       "subtotal": 50,
                                       "points_rewarded": 0
                       }
       ]
   }

}

Error Code

Message

Description

0

Property <attribute> cannot be empty

A required field is empty

0

Customer doesn’t have enough points for discount

The number of points to be burned are greater than the customer’s spendable points

5003

ERR_TX_ALREADY_EXISTS

The transaction ID has already be used

checkout_accept#

pending points transaction

The checkout approval mechanism for pending checkouts, created using a standard checkout event in conjunction with the checkout_accept module. The event and its associated checkout_accept_item can be extending using the custom events module to contain fields/values present in the original checkout/checkout_item event. These can be subsequently used in workflows and/or challenges but can not be modified by this event. checkout_update should be used for making modification to transactions. See also: Checkout accept

Name

Type

Required

Module

Description

transaction_id

string

Yes

checkout_accept

The transaction id for the pending checkout event to be approved.

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "checkout_accept",
   "data":  {
       "transaction_id": "<unique_transaction_id>"
   }

}

Error Code

Message

Description

0

Property transaction_id cannot be empty

No transaction ID was sent

911001

Transaction not found

Checkout event with same transaction_id was not located in the database. This transaction has not been received has been already accepted/rejected

checkout_claim#

transaction

This event claims a guest transaction based upon the submitted transaction_id.

Name

Type

Required

Module

Description

transaction_id

string

Yes

Customer ID validation

The unique transaction ID of a submitted guest checkout.

checkout_reject#

pending points transaction

The checkout rejection mechanism for pending checkouts, created using a standard checkout event in conjunction with the checkout_accept module.

Name

Type

Required

Module

Description

transaction_id

string

Yes

checkout_accept

The transaction id for the pending checkout event to be rejected.

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "checkout_reject",
   "data":  {
       "transaction_id": "<unique_transaction_id>"
   }

}

Error Code

Message

Description

0

Property transaction_id cannot be empty

No transaction ID was sent

911001

Transaction not found

Checkout event with same transaction_id was not located in the database. This transaction has not been received has been already accepted/rejected

checkout_update#

pending points transaction

This event updates information within a pending checkout before checkout approval using checkout_update_item events. This is the only way to remove items from a pending checkout. See also: Checkout accept

Name

Type

Required

Module

Description

auto_accept

date

No

built-in

An optional field which overrides the default auto_accept date with the supplied date. Submitting a NULL or empty string will result in the checkout event needing to be manually accepted/denied.

total

number

Yes

checkout_accept

Modify the total of the pending checkout

transaction_id

string

Yes

checkout_accept

The transaction id for the pending checkout to be modified.

items

string array

No

built-in

A collection of line items describing the product or service that was purchased. checkout_update_item consists of multiple separate sub-properties.

points_burned

integer

No

built-in

The amount of loyalty points customers have used in the transaction. Antavo will set these points to reserved upon a successful event submission. The event will be rejected if points_burned is larger than the customer’s available points balance. Checkouts can have a negative points value assigned to them due to points_burned. The validation in this case is expected to allow the transaction if the sum of customer’s spendable points and the number of points already reserved for this transaction is sufficient.

channel

string

No

built-in

Under channel, you can send in any platform you wish to track, such as “store”, “mobile”, or “online”, or more specific channels, like “POS” or “API”.

currency

string

No

built-in

Currency Code You can describe the currency used for the transaction in multiple ways, but the 3-character currency code is preferred: USD, EUR, GBP

country

string

No

built-in

The state where the checkout was made.

discount

string

No

built-in

The amount of discount applied to the purchase. It’s useful to send this information in case you would like to offer points after purchases made without any discounts.

shipping

integer

No

built-in

Add this property if you wish to send in the cost of the shipping. Antavo LMP can give customer bonus points depending on shipping costs.

store

string

No

Store

The name of the store. This is commonly used for physical in-store purchases. This process can be simplified by using the Store Management module. Stores can be registered in the Store Management module, each of them receives a Store ID which can be used in this store property.

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "checkout_update",
   "data":  {
       "transaction_id": "<unique_transaction_id>",
       "total": 100,
       "points_burned": 0,
       "items": [
                       {
                                       "product_id": "product_id",
                                       "product_name": "name_of_the_product",
                                       "product_url": "webstore_url_of_product",
                                       "price": 50,
                                       "quantity": 1,
                                       "discount": 0,
                                       "subtotal": 50,
                                       "points_rewarded": 0
                       },
                       {
                                       "product_id": "product_id2",
                                       "product_name": "name_of_the_product",
                                       "product_url": "webstore_url_of_product",
                                       "price": 50,
                                       "quantity": 1,
                                       "discount": 0,
                                       "subtotal": 50,
                                       "points_rewarded": 0
                       }
       ]
   }

}

Error Code

Message

Description

0

Property transaction_id cannot be empty

No transaction ID was sent

911001

Transaction not found

Checkout event with same transaction_id was not located in the database. This transaction has not been received has been already accepted/rejected

contest_entry_revoke#

A number of entries into a contest-lite competition are revoked for a give customer

Name

Type

Required

Module

Description

contest_id

string

No

The ID of the contest

refund_points

boolean

No

Should points be returned to the customer?

count

number

No

The number of entries to be revoked

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "contest_entry_revoke",
   "data":  {
       "contest_id": "aabbccddeeffgghh",
       "refund_points": 1
   }

}

coupon#

Creates and assigns a coupon with the given code to the customer. Only available through the coupons module. Deprecated use coupon_create

Name

Type

Required

Module

Description

code

string

Yes

built-in

The coupon code to be generated.

amount

number

No

built-in

The value of the coupon

expiration_date

date

No

built-in

the expiration date of the coupon

coupon_create#

An extended mechanism where coupons can be created and assigned with additional informative data. Only available through the coupons module.

Name

Type

Required

Module

Description

code

string

Yes

built-in

The coupon code to be generated.

name

string

No

built-in

The name of the coupon

currency

string

No

built-in

The currency of the coupon

type

selection

No

built-in

The type of coupon - amount, percentage or free shipping

amount

number

No

built-in

The value of the coupon

expdate

date

No

built-in

The expiration date of the coupon

pool

string

No

built-in

select corresponding coupon pool

stores

string

No

built-in

Add Antavo stores identifiers to the coupon

product

string

No

built-in

Add Antavo product identifiers to the coupon

cost

number

No

built-in

The associated business cost for the coupon

value

number

Yes

built-in

The value of the coupon

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "coupon_create",
   "data":  {
       "code": "ABC-DEF",
       "name": "Test coupon",
       "currency": "GBP",
       "type": "amount",
       "value": 10
   }

}

coupon_invalidate#

coupon

The specified coupon is invalidated

Name

Type

Required

Module

Description

code

string

Yes

built-in

The code of the coupon to be invalidated

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "coupon_invalidate",
   "data":  {
       "code": "ABC-DEF"
   }

}

coupon_redeem#

coupon

This event marks a coupon as redeemed, using the timestamp of the event. Only available through the coupons module. The coupon redeem process can be automatically triggered for uploaded coupons in a coupon pool. The configuration settings are described in the user manual <>.

Name

Type

Required

Module

Description

code

string

Yes

built-in

The coupon code to be redeemed.

transaction_id

string

No

built-in

The corresponding transaction used when redeeming the coupon

amount

number

Yes

built-in

The value of the coupon. This is only required for multiple use gift card coupons and can be any value between 0 and the value of the coupon’s balance field.

cost

number

No

built-in

The associated business cost for the coupon

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "coupon_redeem",
   "data":  {
       "code": "abc-def-123-456"
   }

}

Error Code

Message

Description

1601

Coupon not found

Coupon not found

1606

The coupon balance is lower than the amount

The value being redeemed is greater than the gift card’s balance

coupon_transfer#

coupon

This event transfers a coupon from one customer to another.

Name

Type

Required

Module

Description

code

string

No

The code of the coupon to be transferred.

email

string

No

The email address of the target customer. An inactive customer will be created if the email address does not match an Antavo user.

target

string

No

The Antavo ID of the target customer.

reward_id

string

No

The unique Antavo ID of the reward issuing the coupon.

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "coupon_transfer",
   "data":  {
       "code": "keys2deathstar",
       "email": null,
       "target": "skywalker",
       "reward_id": "deathstarplans1"
   }

}

coupon_unredeem#

coupon

This event restores a coupon to a pre-redeemed state. Only available through the coupons module.

Name

Type

Required

Module

Description

code

string

Yes

built-in

The coupon code to be restored.

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "coupon_unredeem",
   "data":  {
       "code": "abc-def-123-456"
   }

}

customer_list_add#

An event written to customers’ event stream when they were added to a customer list

Name

Type

Required

Module

Description

customer_list_id

string

Yes

Built-in

The ID of the list the customer should be added to

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "customer_list_add",
   "data":  {
       "customer_list_id": "customer_01"
   }

}

customer_list_remove#

An event written to customers’ event stream when they were removed from a customer list

Name

Type

Required

Module

Description

customer_list_id

string

Yes

Built-in

The ID of the list the customer should be added to

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "customer_list_remove",
   "data":  {
       "customer_list_id": "customer_01"
   }

}

daily_login#

This event will be written down when a customer logs in on the membership site. The registration of this event automatically updates the customers.last_login_at customer attribute, providing access to customers’ latest login date information as a data field.

Name

Type

Required

Module

Description

N/A

No

This event has no attributes

offer_redeem#

This event records that customer has redeemed a stated offer

Name

Type

Required

Module

Description

offer

string

Yes

offers

The offer’s unique ID

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "offer_redeem",
   "data":  {
       "offer": "aabbccddeeffgghh"
   }

}

offer_unredeem#

This event records that customer has unredeemed a stated offer

Name

Type

Required

Module

Description

offer

string

Yes

offers

The offer’s unique ID

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "offer_unredeem",
   "data":  {
       "offer": "aabbccddeeffgghh"
   }

}

offline_treasure_code_found#

Offline treasure code has been found by the customer.

Name

Type

Required

Module

Description

treasure_id

string

Yes

built-in

The ID of the treasure

code

string

Yes

built-in

The treasure code

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "offline_treasure_code_found",
   "data":  {
       "treasure_id": "Herebethemap",
       "code": "Herebethetreasure"
   }

}

offline_treasure_found#

Offline treasure has been found by the customer.

Name

Type

Required

Module

Description

treasure_id

string

Yes

built-in

The ID of the treasure

account

string

No

built-in

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "offline_treasure_found",
   "data":  {
       "treasure_id": "Herebegold",
       "account": "bronze_account"
   }

}

opt_in#

A customer enrolls in the loyalty program. This is usually the first registered event of any customer in Antavo and thus the submitted customer string will become the unique identifier for the newly created customer.

Name

Type

Required

Module

Description

email

string

Yes

built-in

A valid email address of the loyalty program member

first_name

string

No

built-in

The first name of the loyalty program member. This can be used as a personalization token for emails and newsletters.

last_name

string

No

built-in

The last name of the loyalty program member.

handler

string

No

built-in

The nickname that would appear on the user profile.

language

string

No

built-in

An ISO 639-2 Code to identify the language of the loyalty member. Any value can be used, but a recognized language code may result in the loyalty page in the user’s language, if available.

currency

string

No

built-in

The preferred currency in an ISO 4217 code format. E.g., USD, EUR, GBP

birth_date

DateString

No

built-in

Year, month and day. (YYYY-MM-DD). An invalid date entry will result in the event submission being rejected

referrer

string

No

Friend referral

The unique account id of the customer who referred the newly-joining customer to the loyalty scheme

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "opt_in",
   "data":  {
       "email": "starkiller@example.com",
       "first_name": "Luke",
       "last_name": "Skywalker",
       "handler": "Rogue1",
       "referrer": "OB1"
   }

}

opt_out#

GDPR compliant opt-out of a customer from loyalty program. All information that could identify the customer is hashed and is non- recoverable. Transaction related information remains, but the customer is unidentifiable.

Name

Type

Required

Module

Description

reason

string

No

built-in

A reason can be given for leaving the loyalty program

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "opt_out",
   "data":  {
       "reason": "Broke terms and conditions"
   }

}

partial_refund#

refund transaction

A refund event which enables a specified total to be refunded. This value is usually less than the full transaction amount. Only transactions with an accepted status can be refunded. The following actions occur for a successfully submitted event:

  • The appropriate amount is removed from all transaction details

  • The customer score is reduced. There is no change in customer spent.

  • Any burned points are restored using the point_unburn event

  • Transaction’s earned & burned properties are updated

  • The customer’s expiring points are updated

Name

Type

Required

Module

Description

transaction_id

string

Yes

built-in

A unique code that is used for identifying the refunded event

amount

numeric

Yes

built-in

The value of the partial refund

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "partial_refund",
   "data":  {
       "transaction_id": "<unique_transaction_id>",
       "amount": 140
   }

}

pending_expired#

pending events transaction

Invalidates the specified pending event using the pending_event module and records the event into the customer’s event history

Name

Type

Required

Module

Description

points

numeric

Yes

pending events

The pending points that have expired

pending_invalidate#

pending events transaction

Invalidates the specified pending event using the pending_event module and records the event into the customer’s event history

Name

Type

Required

Module

Description

event

string

Yes

pending events

The pending event id to be invalidated

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "pending_invalidate",
   "data":  {
       "event": "aabbccddeeffgghh"
   }

}

pending_validate#

pending events transaction

Validates the specified pending event using the pending_event module and records the event into the customer’s event history

Name

Type

Required

Module

Description

event

string

Yes

pending events

The pending event id to be validated

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "pending_validate",
   "data":  {
       "event": "aabbccddeeffgghh"
   }

}

point_add#

customer service

Adjusts the customer’s point balance by adding points. This increases the customer’s all time collected points (score). Admins can use this event to manually correct a customer’s score in the case of misalignment.

Name

Type

Required

Module

Description

points

integer

Yes

built-in

A positive number to be added the customer’s overall score

reason

string

No

built-in

Describe the motive behind point_add. For internal purposes only

transaction_id

string

No

built-in

Associates the submitted event with the specified transaction_id and it will appear in the transaction’s detailed breakdown

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "point_add",
   "data":  {
       "points": 100,
       "reason": "The customer was extremely nice and polite"
   }

}

point_spend#

customer service

Adjusts the customer’s point balance by subtracting points. This action does not affect customer’s all time collected points (score) and mimics redeeming points at checkout or redeeming a reward. Admins can use this event to manually change the customer’s point balance in a way that it’s trackable in the point history.

Name

Type

Required

Module

Description

points

integer

Yes

built-in

The number of points to be spent. Only positive integers are accepted.

reason

string

No

built-in

Describe the motive behind point_spend. For internal purposes only.

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "point_spend",
   "data":  {
       "points": 100,
       "reason": "Customer service correction"
   }

}

point_sub#

customer service

Adjusts the customer’s point balance by removing points. This decreases the customer’s all time collected points (score). Admins can use this event to manually correct a customer’s score in the case of misalignment.

Name

Type

Required

Module

Description

points

integer

Yes

built-in

The number of points to be subtracted from the score. Only positive integers are accepted.

reason

string

No

built-in

Describe the motive behind point_sub. For internal purposes only.

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "point_sub",
   "data":  {
       "points": 100,
       "reason": "Customer services were too generous with point_add"
   }

}

point_unspend#

customer service

Adjusts the customer’s point balance by adding points. This action does not affect customer’s all time collected points (score) and mimics refunding points or revoking a reward. Admins can use this event to manually change the customer’s point balance in a way that it’s trackable in the point history.

Name

Type

Required

Module

Description

points

integer

Yes

built-in

The number of points to be added to the customer. Only positive integers are accepted.

reason

string

No

built-in

Describe the motive behind point_unspend. For internal purposes only.

transaction_id

string

No

built-in

Associates the submitted event with the specified transaction_id and it will appear in the transaction’s detailed breakdown

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "point_unspend",
   "data":  {
       "points": 100,
       "reason": "Customer service correction"
   }

}

profile#

customer service

This event updates the customer’s profile. This existing list of properties can be expanded with custom fields.

Name

Type

Required

Module

Description

email

string

No

built-in

The virtual address that helps to identify the loyalty program member.

first_name

string

No

built-in

The first name of the loyalty program member. This can be used as a personalization token for emails and newsletters.

last_name

string

No

built-in

The last name of the loyalty program member.This can be used as a personalization token for emails and newsletters.

handler

string

No

built-in

The nickname that would appear on the user profile.

language

string

No

built-in

An ISO 639-2 Code to identify the language of the loyalty member. Any value can be used, but a recognised language code may result in the loyalty page in the user’s language, if available.

gender

string

No

built-in

The gender of the customer.

currency

string

No

built-in

The preferred currency in an ISO 4217 code format. E.g., USD, EUR, GBP

birth_date

DateString

No

built-in

Year, month and day. (YYYY-MM-DD). An invalid date entry will result in the event submission being rejected

image_url

string

No

built-in

The web address of the customer’s profile picture.

opt_in

boolean

No

built-in

If true, a customer is created, with all the submitted profile attributes for the new userid contained in the event.label

labels

array

No

built-in

Add external segmentation via labels. Data is entered as strings in an array.

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "profile",
   "data":  {
       "email": "sithlord@example.com",
       "first_name": "Darth",
       "last_name": "Vader",
       "labels": [
                       "Sith",
                       "Ex-Jedi"
       ]
   }

}

refund#

refund transaction

A previous purchase has been refunded in full to the customer. Any points rewarded for the associated purchase will be removed

Name

Type

Required

Module

Description

transaction_id

string

Yes

built-in

A unique code that is used for identifying the refunded event

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "refund",
   "data":  {
       "transaction_id": "ABC-DEF"
   }

}

refund_item#

refund transaction

Itemized refunds to the customer. Any points rewarded for the associated purchase will be removed. Any points burnt will be restored to the customer. This action should not be used with a pending checkout. Please note that this event does not update/change the total attribute of the transaction and the transaction item.

Name

Type

Required

Module

Description

transaction_id

string

Yes

built-in

A unique code that is used for identifying the refunded event

product_id

string

Yes

built-in

This must be identical to product ID values in all non-Antavo system

quantity

integer

No

built-in

The exact number of items that were purchased during the checkout.

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "refund_item",
   "data":  {
       "transaction_id": "<unique_transaction_id>",
       "product_id": "unique_product_id",
       "quantity": 5
   }

}

release_points#

point burn

Releases previously reserved points

Name

Type

Required

Module

Description

transaction_id

string

Yes

built-in

A unique code that is used for identifying the transaction event

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "release_points",
   "data":  {
       "transaction_id": "ABC-DEF",
       "points": 123
   }

}

reserve_points#

point burn

Reserves points during a purchase to be used as discounts. This transaction can be reverted by releasing the points.

Name

Type

Required

Module

Description

transaction_id

string

Yes

built-in

A unique code that is used for identifying the transaction event

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "reserve_points",
   "data":  {
       "transaction_id": "ABC-DEF",
       "points": 123
   }

}

review#

Legacy product review event. Superseded by review_submit

Name

Type

Required

Module

Description

item_id

string

Yes

built-in

The item ID

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "review",
   "data":  {
       "item_id": "unique_item_id"
   }

}

review_submit#

The customer has written a product, site or service review.

Name

Type

Required

Module

Description

item

string

Yes

built-in

The product ID being reviewed

review

string

Yes

built-in

The Review

provider

string

No

built-in

The reviewer

review_id

string

No

built-in

The review ID

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "review_submit",
   "data":  {
       "item": "aabbccddeeffgghh",
       "review": "This is a lightsabre, the weapon of a jedi from a more civilized age",
       "provider": "OB1",
       "review_id": "JEDI1"
   }

}

reward_revoke#

reward

A Reward is revoked, the claim statistics are reset for the customer and the reward. Any redeemed coupons must be unredeemed (coupon_unredeem) before submitting this event

Name

Type

Required

Module

Description

event

string

Yes

built-in

The unique identify of the event recording the claimed reward

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "reward_revoke",
   "data":  {
       "event": "aabbccddeeffgghh"
   }

}

reward_transfer#

reward

The internal event which award a reward between two members

Name

Type

Required

Module

Description

email

string

No

built-in

The email address of person to receive the reward

target

string

No

built-in

The customer ID of person to receive the reward

reward

string

No

built-in

The unique ID of the Antavo Reward to be transferred

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "reward_transfer",
   "data":  {
       "target": "OB1",
       "reward": "62f3893316e5935a35742a4a"
   }

}

share#

Sharing a page

Name

Type

Required

Module

Description

network

string

Yes

built-in

url

string

No

built-in

recipients

array

No

built-in

share_impression#

Someone has clicked through a link which has been previously shared using the Social Sharing module.

Name

Type

Required

Module

Description

url

string

Yes

built-in

The referring URL

referrer

No

visitor

No

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "share_impression",
   "data":  {
       "url": "https://www.starwars.com/",
       "visitor": "OB1"
   }

}

subscribe#

This event does not opt the customer in to the loyalty program but creates an inactive customer profile in Antavo with the provided information.

Name

Type

Required

Module

Description

email

string

No

built-in

A unique identifier that identifies the loyalty program member.

first_name

string

No

built-in

The first name of the loyalty program member. This can be used as a personalization token for emails and newsletters.

last_name

string

No

built-in

The last name of the loyalty program member. This can be used as a personalization token for emails and newsletters.

handler

string

Yes

built-in

The nickname that would appear on the user profile.

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "subscribe",
   "data":  {
       "email": "sithlord@example.com",
       "first_name": "Darth",
       "last_name": "Vader"
   }

}

suspend#

This event changes an active customer’s status to suspended and prevents them from spending points

Name

Type

Required

Module

Description

reason

No

Optional reason for suspending customer

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "suspend",
   "data":  {
       "reason": "Destroying the Deathstar"
   }

}

treasure_found#

Treasure has been found by the customer in an online or in-store treasure hunt.

Name

Type

Required

Module

Description

treasure_id

string

Yes

built-in

The ID of the treasure

unassign_coupon#

This event changes the coupon’s status from claimed to unassigned making the coupon is available for future reassignment

Name

Type

Required

Module

Description

code

string

No

the code of the target coupon

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "unassign_coupon",
   "data":  {
       "code": "abc-def-123-456"
   }

}

unsuspend#

This event changes a suspended customer’s status to active and enables them to spending points

Name

Type

Required

Module

Description

reason

No

Optional reason for restoring a suspended customer

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "unsuspend",
   "data":  {
       "reason": "Bringing balance to the force."
   }

}

video#

The event logs a customer watching a video at a particular site. This action can have a custom number of points associated with it.

Name

Type

Required

Module

Description

network

string

No

built-in

video_id

string

No

built-in

url

string

Yes

built-in

The referring URL - This must be a complete and valid URL.

title

string

No

built-in

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "video",
   "data":  {
       "network": "https://www.youtube.com",
       "video_id": "ViVJPjInPxg",
       "url": "https://www.youtube.com/watch?v=ViVJPjInPxg",
       "title": "OBI-WAN KENOBI Trailer Teaser"
   }

}

visit#

The event logs a customer visiting a webpage. This action can have a custom number of points associated with it.

Name

Type

Required

Module

Description

url

string

Yes

built-in

The referring URL - This must be a complete and valid URL.

referrer

string

No

built-in

The referrer

type

string

No

built-in

Additional media information

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "visit",
   "data":  {
       "url": "https://www.starwars.com/",
       "type": "Homepage"
   }

}

Internal actions#

These events are written by the system and thus cannot be submitted directly to the events API. These events can be used as actions for challenges and workflow triggers.

activity#

An event recording a challenge completion

Name

Type

Required

Module

Description

challenge

string

No

Challenges

The Antavo challenge ID

checkout_accept_item#

Accepts line items for the purchase, including detailed information about the product name, product category, SKU, quantity and price. All information in this event comes from the corresponding checkout_item and checkout_update_item events . This event can not be directly submitted but is created from a checkout_accept event

Name

Type

Required

Module

Description

product_id

string

Yes

built-in

This must be identical to product ID values in all non-Antavo system

product_name

string

Yes

built-in

The name of the item in any non-Antavo system

product_url

string

Yes

built-in

The web address that points to the item’s online store page.

quantity

integer

Yes

built-in

The exact number of items that were purchased during the checkout.

points_rewarded

integer

No

built-in

A custom number of positive integer points awarded for purchasing a certain product which overrides the default subtotal-based behavior provided by Antavo Incentivized Purchase module.

subtotal

number

Yes

built-in

The overall amount paid during the checkout.

price

number

No

built-in

The full value of a single item before discount. The value has to be entered and is not calculated by Antavo.

discount

number

No

built-in

The reduction made to the original price during the checkout.

product_category

string

No

built-in

Any number of categories or subcategories that match the product.

checkout_item#

Defines line items for the purchase, including detailed information about the product name, product category, SKU, quantity and price. These pre-existing properties can be expanded by using custom fields. This event can not be directly submitted but is created from items in a checkout event. The checkout_item also inherits every checkout attribute.

Points are only automatically awarded based upon the value of the subtotal. Only elements submitted in the event are recorded – Antavo does not calculate any checkout_item attributes. All elements can, however, be accessed from the event and used elsewhere in the loyalty management platform. It is strongly recommended that the subtotal is externally calculated in the following way:

\((price - discount) \times quantity = subtotal\)

Name

Type

Required

Module

Description

product_id

string

Yes

built-in

This must be identical to product ID values in all non-Antavo system

product_name

string

Yes

built-in

The name of the item in any non-Antavo system

product_url

string

Yes

built-in

The web address that points to the item’s online store page.

quantity

integer

Yes

built-in

The exact number of items that were purchased during the checkout.

points_rewarded

integer

No

built-in

A custom number of positive integer points awarded for purchasing a certain product which overrides the default subtotal-based behavior provided by Antavo Incentivized Purchase module.

subtotal

number

Yes

built-in

The overall amount paid during the checkout.

price

number

No

built-in

The full value of a single item before discount. The value has to be entered and is not calculated by Antavo .

discount

number

No

built-in

The reduction from the original price during the checkout.

product_category

string

No

built-in

Any number of categories or subcategories that match the product.

checkout_update_item#

Updates line items for the purchase, including detailed information about the product name, product category, SKU, quantity and price. This pre-existing properties can be expanded by using custom fields. This event can not be directly submitted but is created from items in a checkout_update event

Name

Type

Required

Module

Description

product_id

string

Yes

built-in

This must be identical to product ID values in all non-Antavo system

product_name

string

Yes

built-in

The name of the item in any non-Antavo system

product_url

string

Yes

built-in

The web address that points to the item’s online store page.

quantity

integer

Yes

built-in

The exact number of items that were purchased during the checkout.

points_rewarded

integer

No

built-in

A custom number of positive integer points awarded for purchasing a certain product which overrides the default subtotal-based behavior provided by Antavo Incentivized Purchase module.

subtotal

number

Yes

built-in

The overall amount paid during the checkout.

price

number

No

built-in

The full value of a single item before discount. The value has to be entered and is not calculated by Antavo.

discount

number

No

built-in

The reduction made to the original price during the checkout.

product_category

string

No

built-in

Any number of categories or subcategories that match the product.

coupon_receive#

An event written to a customer’s event stream when a coupon has been transferred to them

Name

Type

Required

Module

Description

code

string

No

The coupon Code

original

string

No

The Antavo ID of original owner of the coupon

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "coupon_receive",
   "data":  {
       "code": "C3-PO",
       "original": "Anakin Skywalker"
   }

}

garmin_activity#

This event is submitted when a customer completes any sports activity recorded by Garmin

Name

Type

Required

Module

Description

summary_id

string

No

Garmin Integration

The unique identifier of the summary

activity_id

string

No

Garmin Integration

The unique identifier of the activity at Garmin

start_time_in_seconds

numeric

No

Garmin Integration

The start time of the activity in seconds since January 1, 1970, 00:00:00 UTC (Unix timestamp)

start_time_offset_in_seconds

numeric

No

Garmin Integration

The offset in seconds to add to start_time_in_seconds to derive the “local” time of the device that captured the data

activity_type

string

No

Garmin Integration

The text description of the activity type

duration_in_seconds

numeric

No

Garmin Integration

The length of activity in seconds

average_bike_cadence_in_rounds_per_minute

numeric

No

Garmin Integration

average_heart_rate_in_beats_per_minute

numeric

No

Garmin Integration

average_run_cadence_in_steps_per_minute

numeric

No

Garmin Integration

average_push_cadence_in_pushes_per_minute

numeric

No

Garmin Integration

This field will only be present if the user’s watch is in wheelchair mode.

average_speed_in_meters_per_second

numeric

No

Garmin Integration

average_swim_cadence_in_strokes_per_minute

numeric

No

Garmin Integration

average_pace_in_minutes_per_kilometer

numeric

No

Garmin Integration

active_kilocalories

numeric

No

Garmin Integration

device_name

string

No

Garmin Integration

Only Fitness activities are associated with a specific Garmin device rather than the user’s overall account. If the user wears two devices simultaneously and starts a Fitness Activity on each, both will generate separate activities with two different device names.

distance_in_meters

numeric

No

Garmin Integration

max_bike_cadence_in_rounds_per_minute

numeric

No

Garmin Integration

max_heart_rate_in_beats_per_minute

numeric

No

Garmin Integration

max_pace_in_minutes_per_kilometer

numeric

No

Garmin Integration

max_run_cadence_in_steps_per_minute

numeric

No

Garmin Integration

max_push_cadence_in_pushes_per_minute

numeric

No

Garmin Integration

This field will only be present if the user’s watch is in wheelchair mode.

max_speed_in_meters_per_second

numeric

No

Garmin Integration

number_of_active_lengths

numeric

No

Garmin Integration

starting_latitude_in_degree

numeric

No

Garmin Integration

starting_longitude_in_degree

numeric

No

Garmin Integration

steps

numeric

No

Garmin Integration

pushes

numeric

No

Garmin Integration

This field will only be present if the user’s watch is in wheelchair mode.

total_elevation_gain_in_meters

numeric

No

Garmin Integration

total_elevation_loss_in_meters

numeric

No

Garmin Integration

is_parent

boolean

No

Garmin Integration

If present and set to true, this activity is considered the parent activity of one or more child activities that should also be included in the data feed provided to Antavo. An example of a parent activity is an activity of type MULTI_SPORT.

parent_summary_id

string

No

Garmin Integration

If present, this is the summary_id of the related parent activity. An activity of type CYCLING with a parent activity of type MULTI_SPORT is an example of this type of relationship.

manual

boolean

No

Garmin Integration

Indicates that the activity was generated not on a Garmin Device, but was manually created at Garmin directly.

merge#

The customer’s profile has been merged with another customer. This event is recorded automatically by Antavo on the target customer’s profile

Name

Type

Required

Module

Description

source

string

Yes

built-in

The source account to be merged

POST /events
Host: api.<region>.antavo.com
Authorization: ANTAVO-HMAC-SHA256 Credential=TEST_API_KEY/20181207/test/api/antavo_request,
SignedHeaders=date;host,
Signature=77a273065129d9967e6569c750bd1401e6bccae5f3876cd48708d593726e20bc

{
   "customer": "demo_customer_id",
   "action": "merge",
   "data":  {
       "source": "Another_account_ID"
   }

}

newsletter_click#

Name

Type

Required

Module

Description

campaign

string

Yes

NewsletterTracking

url

string

Yes

NewsletterTracking

newsletter_open#

Name

Type

Required

Module

Description

campaign

string

Yes

NewsletterTracking

pending#

An event to create a pending event.

Name

Type

Required

Module

Description

event

string

Yes

pending events

The event id to be made pending.

prize_wheel_spin#

The spin of a specified prizewheel, using the prizewheels module

Name

Type

Required

Module

Description

wheel

string

Yes

prizewheels

result

string

Yes

prizewheel

type

string

Yes

prizewheel

points

numeric

No

prizewheel

referral_bonus#

Bonus points awarded to customer upon a successful friend’s referral

Name

Type

Required

Module

Description

reason

string

No

Friends referral

points

string

Yes

Friends referral

number of points awarded

refund_contest_entry#

An event triggered by the revoking of a contest entry which returns the entry points to the customer

Name

Type

Required

Module

Description

contest_id

No

reward_receive#

The creation of a transferred reward for the receiving member

Name

Type

Required

Module

Description

original

string

No

The Antavo account ID of the original owner of the reward

reward

string

No

The unique ID of the Antavo Reward to be transferred

tier_change#

The properties of the customer’s tier has been modified.

Name

Type

Required

Module

Description

tier

select

Yes

tier

expdate

string

No

tier

expires_at

select

No

tier

tier_down#

The customer has been demoted to a lower tier

Name

Type

Required

Module

Description

structure

string

Yes

tier

tier

string

Yes

tier

tier_recalculation#

The customer’s tier has been recalculated.

Name

Type

Required

Module

Description

structure

string

Yes

tier

tier_up#

The customer has been promoted to a higher tier

Name

Type

Required

Module

Description

structure

string

Yes

expdate

string

No

manual

boolean

No

verify_customer#

An event usd by the Customer Login module

Name

Type

Required

Module

Description

N/A

No

Customer Login

This event has no attributes

visual_search_bound#

Name

Type

Required

Module

Description

gender

string

No

Syte

offers

string

No

Syte

label

string

No

Syte

catalog

string

No

Syte

wheel_spin#

The spin of a prizewheel from the prizewheel module

Name

Type

Required

Module

Description

result

string

Yes

prizewheel

type

string

Yes

prizewheel

points

numeric

No

prizewheel