---
title: "Job tasks and actions"
slug: "job-tasks-and-actions"
description: "The user manual provides comprehensive guidance on using the Antavo Management UI for managing loyalty programs."
updated: 2025-08-13T19:21:57Z
published: 2025-08-13T19:21:57Z
canonical: "docs.antavo.com/job-tasks-and-actions"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.antavo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Job tasks and actions

### Bookenda

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| bookenda | `process` | 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**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| chart | `cleanup` | - | - | Deletes the histroical data of all the charts generated or configured in the workspace. | ❌ |
| overall | `generate` | 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](/v1/docs/dashboard#data-set). | ❌ |
| `generateRange` | s (start_date) | Start date in 'Y-m-d' format. | Daily *overall* types of Dashboard statistical [data sets](/v1/docs/dashboard#data-set) for a specific time period (days). | ❌ |
| e (end_date) | Start date in 'Y-m-d' format. |  | ❌ |
| daily_report | `generateExtension MetricsRange` | x (extension) | Name of the module (Challenges or Rewards) | Daily calculation of Dashboard statistical graphs for a specific time period (days). | ❌ |
| `generateExtension Metrics` | x (extension) | Name of the module (Challenges or Rewards). | Daily calculation of Dashboard statistical graphs. | ❌ |
| `generateRange` | s (start_date) | Date in 'Y-m-d' format. | The purpose of this action is the same of generate action of the overall task, however this one generates data on a daily basis between the start and end dates. | ✅ |
| e (end_date) | Date in 'Y-m-d' format. |

### Checkout accept

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| checkout-accept | `autoAccept` |  |  | Triggers the registration of `checkout_accept` events to pending transactions. The job processes the events with `autoAccept `dates that are earlier than the current day when the job runs. This does not include the events of the current day. | ❌ |

### Clubs

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| club-point-expiration | expire |  |  | Handles expiration of club points. Updates the number of expired club points and the spendable club points. It’s recommended to configure the day-to-day running. | ❌ |
| club-member-remove-donation-intervals | process |  |  | Cleans up the donation records so members' donation limits can be reset as [configured](/engine/docs/club-templates#accountlevel-contribution-settings), either on fixed dates or after a set time from their first donation. | ✅ |

### 

### **Content approvals**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| approvals-digest | `process` |  |  | Handles the [content approval](/v1/docs/content-approvals) digest email sending service. | ❌ |

### Coupons

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| coupon-pool | `update` | r (criteria) | One of the following values: ‘all', ‘none', 'unassigned’, or 'unredeemed’. | Responsible for updating coupon pools and reward coupons. | ✅ |
| m (matching) | true/false If matching is enabled, the service will update only the coupons that have the same value as the currently set coupon value. |
| h (changes) | Changes to be applied in a JSON-encoded format. |
| bulk-generation | `generate` | 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. |

### **Coupon pools**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| coupon-pool-bulk-operation-upload | `process` | - | - | Processes requests in the queue that upload, assign, or unassign coupon codes in bulk for coupon pools. Multiple requests affecting the same coupon pool are processed asynchronously, ensuring efficient handling of large volumes of coupon operations. | ❌ |

### Customer insights

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| customer-report | `generate` |  |  | Maintains a cache for customer lists. | ❌ |
| customer-status-corrector | `process` |  |  | Sets the inactive customers to active, if the customer has an optin event and doesn’t have an opt-out event. | ❌ |

### Customer lists

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| bulk-operation-customer-list | `process` | - | - | Processes [requests](https://developers.antavo.com/reference/post_v1-bulk-operation-customer-list-add-customer-list-id) in the queue that add or remove customers from a customer list. Multiple requests to update the same customer list are processed asynchronously. | ❌ |

### Customer mapping

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| customer-mapping | `processQueue` | 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](/v1/docs/customer-mapping) rules. | ✅ |

### Expiring points

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| expire_points | `run` |  |  | Triggers the expiration of points. The job processes the events with expiration dates that are earlier than the current day when the job runs. This does not include the events of the current day. | ❌ |

### Exports

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| export | `process` | e (export) | ID of the export to be processed. e.g. 619e178f1bd6ca9810000001 | Runs the exports configured under the [Exports module](/v1/docs/exports). | ✅ |

### Imports

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| import | `process` | i (import) | ID of the import to be processed. eg. 6495d9a64214ad707b4529e3 | Runs the import configured under the [Imports module](/v1/docs/imports). | ✅ |

### Instagram contests

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| instagram-contests | `processComments` |  |  | Runs a check on new entries for [comment-type Instagram contests](/v1/docs/instagram-contests#instagram-comment-contest) and registers them in the system. | ❌ |
| `processHashtag` |  |  | Runs a check on new entries for [hashtag-type Instagram contests](/v1/docs/instagram-contests#instagram-comment-contest) and registers them in the system. | ❌ |

### Responsys

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| responsys | `cacheSegments` |  |  | Updates the list of customers within segments synchronized from [Responsys](/v1/docs/responsys). | ❌ |

### **Newsletter tracking**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| leaderboard | `generate` |  |  | Calculates the data to be displayed on the [leaderboard](/v1/docs/leaderboard). | ❌ |

### Listrak

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| listrak | `cacheFields` |  |  | Queries customer fields from Listrak and updates the dropdown list of Listrak fields in the Listrak module configuration page. | ❌ |

### **Newsletter providers, Exponea, Bloomreach, SFMC**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| nlp | `processQueue` | l (limit) | Number of entries to be checked for data field updates each time the job runs. Min: 1 Max: 1000 | Adds the update entries to the queue and synchronizes the data to the marketing automation provider. | ❌ |
| `sync` | c (customer) | ID of the customer to be synced. | Sends updated customer field 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. | ❌ |

### **Klaviyo**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| klaviyo-membership-queue | `process` |  |  | Queues customers and asynchronously processes their addition to the selected Klaviyo list via the [Add to Klaviyo list](https://docs.antavo.com/docs/actions#add-to-klaviyo-list) workflow node. | ✅ |
| klaviyo-subscription-queue | `process` |  |  | Queues customers and asynchronously processes their subscription changes (subscribe or unsubscribe) to the selected Klaviyo channel via the [Manage Klaviyo marketing channels](/engine/docs/actions#manage-klaviyo-marketing-channels) workflow node. | ✅ |

### Maitre’D

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| maitred-transaction-cache | `clear` |  |  | Deletes the cached transactions. | ❌ |

### **mParticle**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| mparticle | `resend` | l (limit) | Number of outbound messages to be processed each time the job runs. Default: 100 | Processes the outbound messages in the [resend queue](/v1/docs/mparticle#resend-queue). | ❌ |
| mparticle-queue-processor | `process` |  |  | Processes the inbound audience subscriptions and event requests from mParticle. | ❌ |

### **Passes**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| passes | `processQueue` |  |  | Triggers the update of data displayed on passes. | ❌ |

### Rewards

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| bidding | `processNonWinners` | r (reward) | ID of the bidding reward. | Registers the customers who [bid for rewards](/v1/docs/rewards#bidding-rewards) unsuccessfully. | ✅ |
| bulk-operation | `processReward ClaimRequest Processor` | - | - | Adds the submitted reward claim batches to the queue and registers reward claim events accordingly. | ❌ |

### **Pending events**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| pending-events | `run` | d (date) | Date in 'Y-m-d' format. | Executes the invalidation and validation of pending events configured under the [Pending events module](/v1/docs/pending-events). | ❌ |

### **Product catalog**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| product | `import` | f (file) | CSV file path for the import. | Processes product imports uploaded in the [Product catalog module](/v1/docs/product-catalog). | ❌ |

### **Salesforce SalesCloud**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| salesforcesc | `processQueue` | l (limit) | Number of entry updates to be processed each time the job runs. | Triggers synchronization to Salesforce Sales Cloud. | ❌ |

### Segments

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| segment | `cache` |  |  | Maintains a cache for the relation-type operators (e.g., in segment, item not purchased, action taken) of segments. | ❌ |

### Shopify

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| shopify-incoming | `process` |  |  | Triggers the synchronization of data coming from [Shopify](https://developers.antavo.com/docs/shopify). | ❌ |

### **Sportsdata**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| sports-data | `trackMatches` |  |  | Collects the results of games from Sportsdata. | ❌ |
| `closePrizes` |  |  | Closes the bets based on the collected results and assigns prizes to customers. | ❌ |

### **Tiered campaigns**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| preview | `generate` | 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](/v1/docs/tiered-campaigns). | ✅ |
| awarding | `process` | c (campaign) | ID of the tiered campaign. | Assign the calculated number of points to customers. | ❌ |

### **Tier expiration**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| tier-expiration | `expire` | l (limit) | Number of customers to be checked for tier expiration. | Triggers the expiration of tiers. The job processes the tier expiration of tiers with expiration dates that are earlier than the current day when the job runs. This does include the events of the current day. | ❌ |

### **User groups**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| user-groups | `process` |  |  | Updates the entities selected under the [Settings page](/v1/docs/user-groups#entities) of the User group module with the configured user group. | ✅ |

### Wallet

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| wallet | `processGoogle SendQueue` | 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. | ❌ |
| `processQueue` |  |  | Updates the customer’s Apple pass if the pass template or any data displayed on the pass change. | ❌ |

### **Webhooks (legacy)**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| webhook | `resend` |  |  | Triggers the resending of [webhook messages](/v1/docs/webhooks-legacy) when the external party responds with an error or fails to respond within the timeout interval set in the Webhooks (legacy) module settings. Resending occurs up to a maximum of 5 times. | ❌ |
| `processQueue` | h (batch) | Number of async queue batches. | Processes async [webhook messages](/v1/docs/webhooks-legacy). | ❌ |

### **Webhooks**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| webhooks | `processQueue` | h (batch) | Number of async queue batches. Min: 1 Max: 10 | Processes the webhook messages sent through the [Webhooks module](/v1/docs/webhooks). | ❌ |
| l (limit) | Number of webhook messages processed each time the job runs. Min: 1 Max: 1000 Default:100 |
| s (sleep) | Time between the runnings of the job in milliseconds. Min: 0 Max: 10000 Default: 250 |

### **Workflows**

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| automation | `process` | w (workflow) | ID of the workflow. | Processes on-date workflows. The job is automatically generated when an On-date triggered workflow is activated. | ✅ |
| automation-delay | `process` | l (limit) | Number of workflow delay entries to be processed each time the job runs. The default value is 20, which means that the job processes 20 entries per one run. | Processes workflow entries that are suspended by a Wait node. | ❌ |
| h (batch) | Batch number of the batch to be processed. To process multiple batches concurrently, you need to set up additional jobs with different batch numbers. |
| automation-historic-events | `process` | a (automation) | ID of the workflow. | Processes workflows triggered by Historical events. The job is automatically created upon the activation of a Historical event-triggered workflow. | ✅ |

### Yotpo

| **Task** | **Action** | **Parameters** | **Description** | **Auto- generated** |
| --- | --- | --- | --- | --- |
| **Key** | **Value** |
| review | `run` | s (since) | Date in 'Y-m-d' format. If the value is empty, the job runs every day. | Collects reviews submitted through the integrated [Yotpo](/v1/docs/yotpo) account after the date specified via the since key. | ❌ |