Job tasks and actions
The User Manual has moved! For the most up-to-date information, please visit our new site at docs.antavo.com.
We're committed to providing you with the best resources, and our new site offers an enhanced experience with the latest documentation. Thank you for your understanding and continued support.
Module | Task | Action | Parameters | Description | Generated automatically | |
---|---|---|---|---|---|---|
Key | Value | |||||
Bookenda | bookenda |
| d (date) | Date in 'Y-m-d' format. If no date is specified, the job returns the bookings for the current day. | Retrieves bookings for a specific date and registers a booking event on the customer’s history based on the email address. |
|
Charts | chart |
| - | - | Deletes the histroical data of all the charts generated or configured in the brand. |
|
overall |
| d (date) | Date in 'Y-m-d' format. If no date is specified, the job generate chart metrics every day. | Calculate the daily ‘overall’ types of Dashboard statistical data sets. |
| |
| s (start_date) | Start date in 'Y-m-d' format. | Daily overall types of Dashboard statistical data sets for a specific time period (days). |
| ||
e (end_date) | Start date in 'Y-m-d' format. | |||||
daily_report |
| x (extension) | Name of the module (Challenges or Rewards) | Daily calculation of Dashboard statistical graphs for a specific time period (days). |
| |
s (start_date) | Date in 'Y-m-d' format. | |||||
e (end_date) | Date in 'Y-m-d' format. | |||||
| x (extension) | Name of the module (Challenges or Rewards). | Daily calculation of Dashboard statistical graphs. |
| ||
| s (start_date) | Date in 'Y-m-d' format. | The purpose of this action is the same of |
| ||
e (end_date) | Date in 'Y-m-d' format. | |||||
Checkout accept | checkout-accept |
|
|
| Triggers the registration of |
|
Content approvals | approvals-digest |
|
|
| Handles the content approval digest email sending service. |
|
Coupons | coupon-pool |
| r (criteria) | One of the following value: ‘all', ‘none', 'unassigned’, or 'unredeemed’. | Responsible for updating coupon pools and reward coupons. |
|
m (matching) | true/false |
| ||||
h (changes) | Changes to be applied in a JSON-encoded format. |
| ||||
bulk-generation |
| p (pool) | ID of the coupon pool. | Responsible for generating bulk coupons based on the configured pattern. |
| |
b (batch) | Number of coupons to be generated. | |||||
u (user_id) | ID of the platform user who triggered the bulk coupon generation. | |||||
Customer insights | customer-report |
|
|
| Maintains a cache for customer lists. |
|
customer-status-corrector |
|
|
| Sets the inactive customers to active, if the customer has an |
| |
Customer mapping | customer-mapping |
| l (limit) | Number of customer updates to be processed each time the job runs. | Processes the queue of customer updates and modifies the values according to the configured customer mapping rules. |
|
Expiring points | expire_points |
|
|
| Triggers the expiration of points. |
|
Exports | export |
| e (export) | ID of the export to be processed. e.g. 619e178f1bd6ca9810000001 | Runs the exports configured under the Exports module. |
|
Imports | import |
| i (import) | ID of the import to be processed. eg. 6495d9a64214ad707b4529e3 | Runs the import configured under the Imports module. |
|
Instagram contests | instagram-contests |
|
|
| Runs a check on new entries of comment-type Instagram contests and registers them to the system. |
|
instagram-contests |
|
|
| Runs a check on new entries of hashtag-type Instagram contests and registers them to the system. |
| |
Responsys
| responsys |
|
|
| Updates the list of customer within segments synchronized from Responsys. |
|
Newsletter tracking | newsletter-tracking |
| l (limit) | Number of customer to be processed each time the job runs. | Processes and register newsetter open events based on the configuration the Newsletter engagement module. |
|
Leaderboard | leaderboard |
|
|
| Calculates the data to be displayed on the leaderboard. |
|
Listrak | listrak |
|
|
| Querries customer fields from Listrak and updates the dropdown list of Listrak fields in the Listrak module configuration page. |
|
NLP | nlp |
| l (limit) | Number of entries to be checked for data field updates each time the job runs. | Adds the update entries to the queue and synchronizes the data to the marketing automation provider. |
|
| c (customer) | ID of the customer to be synced. | Sends updated customer fields values of one specific customer to the marketing automation provider. |
| ||
f (fields) | List of fields to be synced, separated by comma. | |||||
p (provider) | The name of the NLP provider. | |||||
Maitred | maitred-transaction-cache |
|
|
| Deletes the cached transactions. |
|
mParticle | mparticle |
| l (limit) | Number of outbound messages to be processed each time the job runs. Default: 100 | Processes the outbound messages in the resend queue. |
|
Passes | passes |
|
|
| Triggers the update of data displayed on passes. |
|
Rewards | bidding |
| r (reward) | ID of the bidding reward. | Registers the customers who bid for rewards unsuccessfully. |
|
bulk-operation |
|
|
| Adds the submitted reward claim batches to the queue and registers reward claim events accordingly. |
| |
Pending events | pending-events |
| d (date) | Date in 'Y-m-d' format. | Executes the invalidation and validation of pending events configured under the Pending events module, |
|
Product | product |
| f (file) | CSV file path for the import. | Processes product imports uploaded in the Product catalog module. |
|
Salesforce SalesCloud | salesforcesc |
| l (limit) | Number of entry updates to be processed each time the job runs. | Triggers syncronization to Salesforce Sales Cloud. |
|
Segments | segment |
|
|
| Maintains a cache for the relation-type operators (eg. in segment, item not purchased, action taken) of segments. |
|
Sportsdata | sports-data |
|
|
| Collects the results of games from Sportsdata. |
|
sports-data |
|
|
| Closes the bets based on the collected results and assigns prizes to customers. |
| |
Tiered campaigns | preview |
| c (campaign) | ID of the tiered campaign. | Calculates the preview of the number of bonus points to be earned at the end of the tiered campaign. |
|
awarding |
| c (campaign) | ID of the tiered campaign. | Assign the calculated number of points to customers. |
| |
Tier expiration | tier-expiration |
| l (limit) | Number of customers to be checked for tier expiration. | Triggers the expiration of tiers. |
|
User groups | user-groups |
|
|
| Updates the entities selected under the Settings page of the User group module with the configured user group. |
|
Wallet | wallet |
| l (limit) | Number of passes to be checked for updates each time the job runs. Default value: 100 | Updates the customer’s Google Wallet pass if the pass template or any data displayed on the pass change. |
|
wallet |
|
|
| Updates the customer’s Apple pass if the pass template or any data displayed on the pass change. |
| |
Webhooks Legacy | webhook |
|
|
| Triggers the resending of webhook messages when the external party responds with an error, or not responded within the timeout interval configured in the Webhooks (legacy) module settings. Resend is triggered up to 5 times maximum. |
|
webhook |
| h (batch) | Number of async queue batches. | Processes async webhook messages. |
| |
Webhooks | webhooks |
| h (batch) | Number of async queue batches. | Processes the webhook messages sent through the Webhooks module. |
|
l (limit) | Number of webhook messages processed each time the job runs. |
| ||||
s (sleep) | Time between the runnings of the job in seconds. |
| ||||
Workflows | automation |
| w (workflow) | ID of the workflow. | Processes on-date workflows. |
|
automation-delay |
| l (limit) | Number of workflow delay entries to be processed each time the job runs. | Processes workflow entries that are suspended by a Wait node. |
| |
h (batch) | Number of workflow entries to be processed simultaniously. | |||||
automation-historic-events |
| a (automation) | ID of the workflow. | Processes workflows triggered by Historical events. |
| |
Yotpo | review |
| s (since) | Date in 'Y-m-d' format. | Collects reviews submitted to through the integrated Yotpo account after the date specified through the ‘since' key. |
|
© Copyright 2022 Antavo Ltd.