# Angler AI (Actions) Destination ## Destination Info * Accepts [Page](/docs/segment/connections/spec/page), [Alias](/docs/segment/connections/spec/alias), [Group](/docs/segment/connections/spec/group), [Identify](/docs/segment/connections/spec/identify), [Track](/docs/segment/connections/spec/track) calls. * Refer to it as **Angler AI** in the [Integrations object.](/docs/segment/guides/filtering-data/#filtering-with-the-integrations-object) * This integration is **partner owned.** Please reach out to the partner's support for any issues. * This destination is **Beta.** [Angler AI](https://getangler.ai/?utm_source=segmentio\&utm_medium=docs\&utm_campaign=partners) helps direct-to-consumer brands radically improve prospecting and customer lifetime value using the power of AI. Gain a full view of your customer base, deploy custom audiences with precision, and measure the true ROI of your campaigns. This destination is maintained by Angler AI. For any issues with the destination, [contact the Angler AI Support team](mailto:support@getangler.ai). ## Getting started 1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog) search for "Angler AI". 2. Select Angler AI and click **Add Destination**. 3. Select an existing Source to connect to Angler AI (Actions). 4. Go to the [Angler AI dashboard](https://getangler.ai), find and copy the **Workspace ID** and **Access Token**. This information can also be provided by your Angler AI account manager. 5. Return to the Segment app and enter the **Workspace ID** and **Access Token** in your Angler AI destination's settings page. ## Destination Settings | Field | Description | Required | Type | | -------------------- | --------------------------------------- | -------- | -------- | | Authentication Token | Your Angler AI API Authentication Token | Yes | password | | Workspace ID | Your Angler AI Workspace ID | Yes | string | ## Available Presets Angler AI has the following presets | Preset Name | Trigger | Default Action | | --------------------------------------------- | ------------------------------------------------ | --------------------- | | Save Event - Checkout Address Info Submitted | Event event = "Checkout Address Info Submitted" | Save Checkout Event | | Save Event - Page Viewed | Event type = "page" | Save Base Event | | Save Event - Checkout Contact Info Submitted | Event event = "Checkout Contact Info Submitted" | Save Checkout Event | | Save Order | Event event = "Order Completed" | Save Order | | Save Event - Checkout Started | Event event = "Checkout Started" | Save Checkout Event | | Save Event - Product Removed From Cart | Event event = "Product Removed" | Save Cart Event | | Save Event - Collection Viewed | Event event = "Product List Viewed" | Save Collection Event | | Save Event - Checkout Completed | Event event = "Order Completed" | Save Checkout Event | | Save User | Event type = "identify" | Save User | | Save Event - Product Viewed | Event event = "Product Viewed" | Save Product Event | | Save Event - Form Submitted | Event event = "Form Submitted" | Save Form Event | | Save Event - Search Submitted | Event event = "Products Searched" | Save Search Event | | Save Event - Product Added To Cart | Event event = "Product Added" | Save Cart Event | | Save Event - Checkout Shipping Info Submitted | Event event = "Checkout Shipping Info Submitted" | Save Checkout Event | | Save Event - Cart Viewed | Event event = "Cart Viewed" | Save Base Event | | Save Event - Checkout Payment Info Submitted | Event event = "Payment Info Entered" | Save Checkout Event | ## Available Actions Build your own Mappings. Combine supported [triggers](/docs/segment/connections/destinations/actions/#components-of-a-destination-action) with the following Angler AI-supported actions: > \[!NOTE] > > Individual destination instances have support a maximum of 50 mappings. * [Save Form Event](#save-form-event) * [Save Collection Event](#save-collection-event) * [Save Checkout Event](#save-checkout-event) * [Save Product Event](#save-product-event) * [Save Custom Event](#save-custom-event) * [Save Order](#save-order) * [Save User](#save-user) * [Save Search Event](#save-search-event) * [Save Cart Event](#save-cart-event) * [Save Base Event](#save-base-event) ### Save Form Event Save a form event. Save Form Event is a **Cloud** action. | Field | Description | Required | Type | | ----------------- | ---------------------------------------------------------------------------- | -------- | ------ | | Event ID | A unique event identifier. | Yes | STRING | | IP Address | The IP address of the user. | No | STRING | | User Agent | The user agent of the device sending the event. | No | STRING | | Timestamp | The timestamp when the event was triggered. | No | STRING | | Identifiers | Identifiers for the user | Yes | OBJECT | | Page | Page details to send with the event | No | OBJECT | | Custom Attributes | Custom attributes for the event. Data should be specified as key:value pairs | No | OBJECT | | Customer | Customer details | No | OBJECT | | Cart | Cart details | No | OBJECT | | Cart Line Items | Cart Line Item details | No | OBJECT | | Form ID | The id attribute of an element. | No | STRING | | Form Action | The action attribute of a form element. | No | STRING | | Form Elements | A list of elements associated with the form. | No | OBJECT | | Form Event Name | The name of the Form Event to track. | Yes | STRING | ### Save Collection Event Save a collection event. Save Collection Event is a **Cloud** action. | Field | Description | Required | Type | | --------------------------- | ---------------------------------------------------------------------------- | -------- | ------ | | Event ID | A unique event identifier. | Yes | STRING | | IP Address | The IP address of the user. | No | STRING | | User Agent | The user agent of the device sending the event. | No | STRING | | Timestamp | The timestamp when the event was triggered. | No | STRING | | Identifiers | Identifiers for the user | Yes | OBJECT | | Page | Page details to send with the event | No | OBJECT | | Custom Attributes | Custom attributes for the event. Data should be specified as key:value pairs | No | OBJECT | | Customer | Customer details | No | OBJECT | | Cart | Cart details | No | OBJECT | | Cart Line Items | Cart Line Item details | No | OBJECT | | Collection | Collection details | No | OBJECT | | Collection Product Variants | A list of product variants associated with the collection. | No | OBJECT | | Collection Event Name | The name of the Collection Event to track. | Yes | STRING | ### Save Checkout Event Save a checkout event. Save Checkout Event is a **Cloud** action. | Field | Description | Required | Type | | ------------------------- | ---------------------------------------------------------------------------- | -------- | ------ | | Event ID | A unique event identifier. | Yes | STRING | | IP Address | The IP address of the user. | No | STRING | | User Agent | The user agent of the device sending the event. | No | STRING | | Timestamp | The timestamp when the event was triggered. | No | STRING | | Identifiers | Identifiers for the user | Yes | OBJECT | | Page | Page details to send with the event | No | OBJECT | | Custom Attributes | Custom attributes for the event. Data should be specified as key:value pairs | No | OBJECT | | Customer | Customer details | No | OBJECT | | Checkout | Checkout details | No | OBJECT | | Checkout Line Items | Checkout Line Item details | No | OBJECT | | Checkout Billing Address | The billing address associated with the checkout. | No | OBJECT | | Checkout Shipping Address | The address to which the order will be shipped. | No | OBJECT | | Checkout Event Name | The name of the Checkout Event to track. | Yes | STRING | ### Save Product Event Save a product event. Save Product Event is a **Cloud** action. | Field | Description | Required | Type | | ------------------ | ---------------------------------------------------------------------------- | -------- | ------ | | Event ID | A unique event identifier. | Yes | STRING | | IP Address | The IP address of the user. | No | STRING | | User Agent | The user agent of the device sending the event. | No | STRING | | Timestamp | The timestamp when the event was triggered. | No | STRING | | Identifiers | Identifiers for the user | Yes | OBJECT | | Page | Page details to send with the event | No | OBJECT | | Custom Attributes | Custom attributes for the event. Data should be specified as key:value pairs | No | OBJECT | | Customer | Customer details | No | OBJECT | | Cart | Cart details | No | OBJECT | | Cart Line Items | Cart Line Item details | No | OBJECT | | Product Variant | Product Variant details | No | OBJECT | | Product Event Name | The name of the Product event to track. | Yes | STRING | ### Save Custom Event Save a custom event that may have any fields. Save Custom Event is a **Cloud** action. | Field | Description | Required | Type | | --------------------------- | ---------------------------------------------------------------------------- | -------- | ------ | | Event ID | A unique event identifier. | Yes | STRING | | IP Address | The IP address of the user. | No | STRING | | User Agent | The user agent of the device sending the event. | No | STRING | | Timestamp | The timestamp when the event was triggered. | No | STRING | | Identifiers | Identifiers for the user | Yes | OBJECT | | Page | Page details to send with the event | No | OBJECT | | Custom Attributes | Custom attributes for the event. Data should be specified as key:value pairs | No | OBJECT | | Customer | Customer details | No | OBJECT | | Cart | Cart details | No | OBJECT | | Cart Line Items | Cart Line Item details | No | OBJECT | | Cart Line | Cart Line details | No | OBJECT | | Checkout | Checkout details | No | OBJECT | | Checkout Line Items | Checkout Line Item details | No | OBJECT | | Checkout Billing Address | The billing address associated with the checkout. | No | OBJECT | | Checkout Shipping Address | The address to which the order will be shipped. | No | OBJECT | | Collection | Collection details | No | OBJECT | | Collection Product Variants | A list of product variants associated with the collection. | No | OBJECT | | Form ID | The id attribute of an element. | No | STRING | | Form Action | The action attribute of a form element. | No | STRING | | Form Elements | A list of elements associated with the form. | No | OBJECT | | Product Variant | Product Variant details | No | OBJECT | | Search Results | Search results details | No | OBJECT | | Search Query | The search query that was executed. | No | STRING | | Event Name | The name of the event to track. | Yes | STRING | | Custom Event Name | Additional name for custom events if 'event\_name' is 'custom\_event'. | No | STRING | ### Save Order Send an order to Angler. Use this Mapping for transactions which may not originate from the browser. E.g. recurring subscriptions. Save Order is a **Cloud** action. | Field | Description | Required | Type | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | | Line items | list of line items associated with the order. | No | OBJECT | | Billing Address | The mailing address associated with the payment method. | No | OBJECT | | Browser IP | The IP address of the browser used by the customer when they placed the order. Both IPv4 and IPv6 are supported. | No | STRING | | Buyer Accepts Marketing | Whether the customer consented to receive email updates from the shop. | No | BOOLEAN | | Checkout ID | The ID of the checkout. | No | STRING | | Client Details | Information about the browser that the customer used when they placed their order. | No | OBJECT | | Confirmed | Confirmed | No | BOOLEAN | | Contact Email | Contact Email | No | STRING | | Created At | The autogenerated date and time (ISO 8601 format) when the order was created. | No | STRING | | Currency | The three-letter code (ISO 4217 format) for the currency that the customer used when they paid for their last order. | No | STRING | | Current Subtotal Price | The current subtotal price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds. | No | STRING | | Current Total Discounts | The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds. | No | STRING | | Current Total Price | The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds. | No | STRING | | Current Total Tax | The current total taxes charged on the order in the shop currency. The value of this field reflects order edits, returns, or refunds. | No | STRING | | Customer ID | A unique identifier for the customer. | No | STRING | | Discount Applications | An ordered list of stacked discount applications. The discount\_applications property includes 3 types: discount\_code, manual, and script. All 3 types share a common structure and have some type specific attributes. | No | OBJECT | | Discount Codes | A list of discounts applied to the order. | No | OBJECT | | Email | The customer's email address. | No | STRING | | Estimated Taxes | Whether taxes on the order are estimated. Many factors can change between the time a customer places an order and the time the order is shipped, which could affect the calculation of taxes. | No | BOOLEAN | | Financial Status | The status of payments associated with the order. | No | STRING | | Fulfillment Status | The order's status in terms of fulfilled line items. | No | STRING | | Gateway | The payment gateway used. | No | STRING | | ID | The ID of the order, used for API purposes. | Yes | STRING | | Landing Site | The URL for the page where the buyer landed when they entered the shop. | No | STRING | | Landing Site Ref | Landing Site Ref | No | STRING | | Name | The order name. | No | STRING | | Order Number | The order position in the shop count of orders starting at 1001. Order numbers are sequential and start at 1001. | No | INTEGER | | Phone | The customer's phone number for receiving SMS notifications. | No | STRING | | Processed At | The date and time (ISO 8601 format) when an order was processed. | No | STRING | | Processing Method | How the payment was processed. | No | STRING | | Reference | Reference | No | STRING | | Referring Site | The website where the customer clicked a link to the shop. | No | STRING | | Shipping Address | The mailing address associated with the payment method. | No | OBJECT | | Source Identifier | The ID of the order placed on the originating platform. | No | STRING | | Source Name | The source of the checkout. | No | STRING | | Source URL | A valid URL to the original order on the originating surface. | No | STRING | | Subtotal Price | The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips. | No | STRING | | Tags | Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length. | No | STRING | | Taxes Included | Whether taxes are included in the order subtotal. | No | BOOLEAN | | Total Discounts | The total discounts applied to the price of the order in the shop currency. | No | STRING | | Total Line Items Price | The sum of all line item prices in the shop currency. | No | STRING | | Total Outstanding | The total outstanding amount of the order in the shop currency. | No | STRING | | Total Price | The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive. | No | STRING | | Total Price USD | The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency in USD | No | STRING | | Total Tax | The sum of all the taxes applied to the order in the shop currency. Must be positive. | No | STRING | | User ID | The ID of the user logged into Shopify POS who processed the order, if applicable. | No | STRING | | Updated At | The date and time (ISO 8601 format) when the order was last modified. | No | STRING | | Additional Fields | Extra properties. | No | OBJECT | ### Save User Send a customer to Angler. Save User is a **Cloud** action. | Field | Description | Required | Type | | ----------------------- | ------------------------------------------------------------------------------------------------------- | -------- | ------ | | User | The user object. | No | OBJECT | | Addresses | A list of the ten most recently updated addresses for the customer. | No | OBJECT | | Default Address | The mailing address associated with the payment method. | No | OBJECT | | Email Marketing Consent | The marketing consent information when the customer consented to receiving marketing material by email. | No | OBJECT | | Metafield | Attaches additional metadata to a shop's resources. | No | OBJECT | | SMS Marketing Consent | The marketing consent information when the customer consented to receiving marketing material by SMS. | No | OBJECT | ### Save Search Event Save a search event. Save Search Event is a **Cloud** action. | Field | Description | Required | Type | | ----------------- | ---------------------------------------------------------------------------- | -------- | ------ | | Event ID | A unique event identifier. | Yes | STRING | | IP Address | The IP address of the user. | No | STRING | | User Agent | The user agent of the device sending the event. | No | STRING | | Timestamp | The timestamp when the event was triggered. | No | STRING | | Identifiers | Identifiers for the user | Yes | OBJECT | | Page | Page details to send with the event | No | OBJECT | | Custom Attributes | Custom attributes for the event. Data should be specified as key:value pairs | No | OBJECT | | Customer | Customer details | No | OBJECT | | Cart | Cart details | No | OBJECT | | Cart Line Items | Cart Line Item details | No | OBJECT | | Search Results | Search results details | No | OBJECT | | Search Query | The search query that was executed. | No | STRING | | Search Event Name | The name of the Search event to track. | Yes | STRING | ### Save Cart Event Save a cart event. Save Cart Event is a **Cloud** action. | Field | Description | Required | Type | | ----------------- | ---------------------------------------------------------------------------- | -------- | ------ | | Event ID | A unique event identifier. | Yes | STRING | | IP Address | The IP address of the user. | No | STRING | | User Agent | The user agent of the device sending the event. | No | STRING | | Timestamp | The timestamp when the event was triggered. | No | STRING | | Identifiers | Identifiers for the user | Yes | OBJECT | | Page | Page details to send with the event | No | OBJECT | | Custom Attributes | Custom attributes for the event. Data should be specified as key:value pairs | No | OBJECT | | Customer | Customer details | No | OBJECT | | Cart Line | Cart Line details | No | OBJECT | | Cart Event Name | The name of the Cart Event to track. | Yes | STRING | ### Save Base Event Send a base event that has the basic fields applicable to all events. Save Base Event is a **Cloud** action. | Field | Description | Required | Type | | ----------------- | ---------------------------------------------------------------------------- | -------- | ------ | | Event ID | A unique event identifier. | Yes | STRING | | IP Address | The IP address of the user. | No | STRING | | User Agent | The user agent of the device sending the event. | No | STRING | | Timestamp | The timestamp when the event was triggered. | No | STRING | | Identifiers | Identifiers for the user | Yes | OBJECT | | Page | Page details to send with the event | No | OBJECT | | Custom Attributes | Custom attributes for the event. Data should be specified as key:value pairs | No | OBJECT | | Customer | Customer details | No | OBJECT | | Cart | Cart details | No | OBJECT | | Cart Line Items | Cart Line Item details | No | OBJECT | | Event Name | The name of the event to track. | Yes | STRING | ### Event Mappings A default list of event mappings are applied when you add the destination to your workspace. You might need to modify the default mappings, depending on the event schema in your Segment workspace. Please refer the [Angler AI Documentation](https://docs.getangler.ai/docs/using-gtm-to-setup-events?utm_source=segmentio\&utm_medium=docs\&utm_campaign=partners) for details about the events that you can send to Angler AI. ## Engage You can send computed traits and audiences generated using [Engage](/docs/segment/engage) to this destination as a **user property**. To learn more about Engage, schedule a [demo](https://segment.com/contact/demo). For user-property destinations, an [identify](/docs/segment/connections/spec/identify/) call is sent to the destination for each user being added and removed. The property name is the snake\_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property `order_completed_last_30days: true`. When the user no longer satisfies this condition (for example, it's been more than 30 days since their last order), Engage sets that value to `false`. When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync. > \[!NOTE] > > Real-time audience syncs to Angler AI (Actions) may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected. ## Settings Segment lets you change these destination settings from the Segment app without having to touch any code. | Field | Description | Required | Type | | -------------------- | --------------------------------------- | -------- | -------- | | Authentication Token | Your Angler AI API Authentication Token | Yes | password | | Workspace ID | Your Angler AI Workspace ID | Yes | string |