Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Angler AI (Actions) Destination


Destination Info
  • Accepts Page, Alias, Group, Identify and Track calls.
  • Refer to it as Angler AI in the Integrations object
  • This integration is partner owned. Please reach out to the partner's support for any issues.
  • This destination is in Beta

Angler AI(link takes you to an external page) 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.


Getting started

getting-started page anchor
  1. From your workspace's Destination catalog page(link takes you to an external page) 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(link takes you to an external page), 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.

Property nameTypeRequiredDescription
Authentication Tokenpassword
required

Your Angler AI API Authentication Token


Workspace IDstring
required

Your Angler AI Workspace ID


Angler AI has the following presets

Preset NameTriggerDefault Action
Save Event - Checkout Address Info SubmittedEvent event = "Checkout Address Info Submitted"Save Checkout Event
Save Event - Page ViewedEvent type = "page"Save Base Event
Save Event - Checkout Contact Info SubmittedEvent event = "Checkout Contact Info Submitted"Save Checkout Event
Save OrderEvent event = "Order Completed"Save Order
Save Event - Checkout StartedEvent event = "Checkout Started"Save Checkout Event
Save Event - Product Removed From CartEvent event = "Product Removed"Save Cart Event
Save Event - Collection ViewedEvent event = "Product List Viewed"Save Collection Event
Save Event - Checkout CompletedEvent event = "Order Completed"Save Checkout Event
Save UserEvent type = "identify"Save User
Save Event - Product ViewedEvent event = "Product Viewed"Save Product Event
Save Event - Form SubmittedEvent event = "Form Submitted"Save Form Event
Save Event - Search SubmittedEvent event = "Products Searched"Save Search Event
Save Event - Product Added To CartEvent event = "Product Added"Save Cart Event
Save Event - Checkout Shipping Info SubmittedEvent event = "Checkout Shipping Info Submitted"Save Checkout Event
Save Event - Cart ViewedEvent event = "Cart Viewed"Save Base Event
Save Event - Checkout Payment Info SubmittedEvent event = "Payment Info Entered"Save Checkout Event

Build your own Mappings. Combine supported triggers with the following Angler AI-supported actions:

(information)

Mapping limits per destination

Individual destination instances have support a maximum of 50 mappings.

Save Form Event

save-form-event page anchor

Save a form event.

Save Form Event is a Cloud action.

Property nameTypeRequiredDescription
Event IDSTRING
required

A unique event identifier.


IP AddressSTRING

Optional

The IP address of the user.


User AgentSTRING

Optional

The user agent of the device sending the event.


TimestampSTRING

Optional

The timestamp when the event was triggered.


IdentifiersOBJECT
required

Identifiers for the user


PageOBJECT

Optional

Page details to send with the event


Custom AttributesOBJECT

Optional

Custom attributes for the event. Data should be specified as key:value pairs


CustomerOBJECT

Optional

Customer details


CartOBJECT

Optional

Cart details


Cart Line ItemsOBJECT

Optional

Cart Line Item details


Form IDSTRING

Optional

The id attribute of an element.


Form ActionSTRING

Optional

The action attribute of a form element.


Form ElementsOBJECT

Optional

A list of elements associated with the form.


Form Event NameSTRING
required

The name of the Form Event to track.

Save a collection event.

Save Collection Event is a Cloud action.

Property nameTypeRequiredDescription
Event IDSTRING
required

A unique event identifier.


IP AddressSTRING

Optional

The IP address of the user.


User AgentSTRING

Optional

The user agent of the device sending the event.


TimestampSTRING

Optional

The timestamp when the event was triggered.


IdentifiersOBJECT
required

Identifiers for the user


PageOBJECT

Optional

Page details to send with the event


Custom AttributesOBJECT

Optional

Custom attributes for the event. Data should be specified as key:value pairs


CustomerOBJECT

Optional

Customer details


CartOBJECT

Optional

Cart details


Cart Line ItemsOBJECT

Optional

Cart Line Item details


CollectionOBJECT

Optional

Collection details


Collection Product VariantsOBJECT

Optional

A list of product variants associated with the collection.


Collection Event NameSTRING
required

The name of the Collection Event to track.

Save a checkout event.

Save Checkout Event is a Cloud action.

Property nameTypeRequiredDescription
Event IDSTRING
required

A unique event identifier.


IP AddressSTRING

Optional

The IP address of the user.


User AgentSTRING

Optional

The user agent of the device sending the event.


TimestampSTRING

Optional

The timestamp when the event was triggered.


IdentifiersOBJECT
required

Identifiers for the user


PageOBJECT

Optional

Page details to send with the event


Custom AttributesOBJECT

Optional

Custom attributes for the event. Data should be specified as key:value pairs


CustomerOBJECT

Optional

Customer details


CheckoutOBJECT

Optional

Checkout details


Checkout Line ItemsOBJECT

Optional

Checkout Line Item details


Checkout Billing AddressOBJECT

Optional

The billing address associated with the checkout.


Checkout Shipping AddressOBJECT

Optional

The address to which the order will be shipped.


Checkout Event NameSTRING
required

The name of the Checkout Event to track.

Save a product event.

Save Product Event is a Cloud action.

Property nameTypeRequiredDescription
Event IDSTRING
required

A unique event identifier.


IP AddressSTRING

Optional

The IP address of the user.


User AgentSTRING

Optional

The user agent of the device sending the event.


TimestampSTRING

Optional

The timestamp when the event was triggered.


IdentifiersOBJECT
required

Identifiers for the user


PageOBJECT

Optional

Page details to send with the event


Custom AttributesOBJECT

Optional

Custom attributes for the event. Data should be specified as key:value pairs


CustomerOBJECT

Optional

Customer details


CartOBJECT

Optional

Cart details


Cart Line ItemsOBJECT

Optional

Cart Line Item details


Product VariantOBJECT

Optional

Product Variant details


Product Event NameSTRING
required

The name of the Product event to track.

Save a custom event that may have any fields.

Save Custom Event is a Cloud action.

Property nameTypeRequiredDescription
Event IDSTRING
required

A unique event identifier.


IP AddressSTRING

Optional

The IP address of the user.


User AgentSTRING

Optional

The user agent of the device sending the event.


TimestampSTRING

Optional

The timestamp when the event was triggered.


IdentifiersOBJECT
required

Identifiers for the user


PageOBJECT

Optional

Page details to send with the event


Custom AttributesOBJECT

Optional

Custom attributes for the event. Data should be specified as key:value pairs


CustomerOBJECT

Optional

Customer details


CartOBJECT

Optional

Cart details


Cart Line ItemsOBJECT

Optional

Cart Line Item details


Cart LineOBJECT

Optional

Cart Line details


CheckoutOBJECT

Optional

Checkout details


Checkout Line ItemsOBJECT

Optional

Checkout Line Item details


Checkout Billing AddressOBJECT

Optional

The billing address associated with the checkout.


Checkout Shipping AddressOBJECT

Optional

The address to which the order will be shipped.


CollectionOBJECT

Optional

Collection details


Collection Product VariantsOBJECT

Optional

A list of product variants associated with the collection.


Form IDSTRING

Optional

The id attribute of an element.


Form ActionSTRING

Optional

The action attribute of a form element.


Form ElementsOBJECT

Optional

A list of elements associated with the form.


Product VariantOBJECT

Optional

Product Variant details


Search ResultsOBJECT

Optional

Search results details


Search QuerySTRING

Optional

The search query that was executed.


Event NameSTRING
required

The name of the event to track.


Custom Event NameSTRING

Optional

Additional name for custom events if 'event_name' is 'custom_event'.

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.

Property nameTypeRequiredDescription
Line itemsOBJECT

Optional

list of line items associated with the order.


Billing AddressOBJECT

Optional

The mailing address associated with the payment method.


Browser IPSTRING

Optional

The IP address of the browser used by the customer when they placed the order. Both IPv4 and IPv6 are supported.


Buyer Accepts MarketingBOOLEAN

Optional

Whether the customer consented to receive email updates from the shop.


Checkout IDSTRING

Optional

The ID of the checkout.


Client DetailsOBJECT

Optional

Information about the browser that the customer used when they placed their order.


ConfirmedBOOLEAN

Optional

Confirmed


Contact EmailSTRING

Optional

Contact Email


Created AtSTRING

Optional

The autogenerated date and time (ISO 8601 format) when the order was created.


CurrencySTRING

Optional

The three-letter code (ISO 4217 format) for the currency that the customer used when they paid for their last order.


Current Subtotal PriceSTRING

Optional

The current subtotal price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.


Current Total DiscountsSTRING

Optional

The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds.


Current Total PriceSTRING

Optional

The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.


Current Total TaxSTRING

Optional

The current total taxes charged on the order in the shop currency. The value of this field reflects order edits, returns, or refunds.


Customer IDSTRING

Optional

A unique identifier for the customer.


Discount ApplicationsOBJECT

Optional

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.


Discount CodesOBJECT

Optional

A list of discounts applied to the order.


EmailSTRING

Optional

The customer's email address.


Estimated TaxesBOOLEAN

Optional

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.


Financial StatusSTRING

Optional

The status of payments associated with the order.


Fulfillment StatusSTRING

Optional

The order's status in terms of fulfilled line items.


GatewaySTRING

Optional

The payment gateway used.


IDSTRING
required

The ID of the order, used for API purposes.


Landing SiteSTRING

Optional

The URL for the page where the buyer landed when they entered the shop.


Landing Site RefSTRING

Optional

Landing Site Ref


NameSTRING

Optional

The order name.


Order NumberINTEGER

Optional

The order position in the shop count of orders starting at 1001. Order numbers are sequential and start at 1001.


PhoneSTRING

Optional

The customer's phone number for receiving SMS notifications.


Processed AtSTRING

Optional

The date and time (ISO 8601 format) when an order was processed.


Processing MethodSTRING

Optional

How the payment was processed.


ReferenceSTRING

Optional

Reference


Referring SiteSTRING

Optional

The website where the customer clicked a link to the shop.


Shipping AddressOBJECT

Optional

The mailing address associated with the payment method.


Source IdentifierSTRING

Optional

The ID of the order placed on the originating platform.


Source NameSTRING

Optional

The source of the checkout.


Source URLSTRING

Optional

A valid URL to the original order on the originating surface.


Subtotal PriceSTRING

Optional

The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.


TagsSTRING

Optional

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.


Taxes IncludedBOOLEAN

Optional

Whether taxes are included in the order subtotal.


Total DiscountsSTRING

Optional

The total discounts applied to the price of the order in the shop currency.


Total Line Items PriceSTRING

Optional

The sum of all line item prices in the shop currency.


Total OutstandingSTRING

Optional

The total outstanding amount of the order in the shop currency.


Total PriceSTRING

Optional

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.


Total Price USDSTRING

Optional

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency in USD


Total TaxSTRING

Optional

The sum of all the taxes applied to the order in the shop currency. Must be positive.


User IDSTRING

Optional

The ID of the user logged into Shopify POS who processed the order, if applicable.


Updated AtSTRING

Optional

The date and time (ISO 8601 format) when the order was last modified.


Additional FieldsOBJECT

Optional

Extra properties.

Send a customer to Angler.

Save User is a Cloud action.

Property nameTypeRequiredDescription
UserOBJECT

Optional

The user object.


AddressesOBJECT

Optional

A list of the ten most recently updated addresses for the customer.


Default AddressOBJECT

Optional

The mailing address associated with the payment method.


Email Marketing ConsentOBJECT

Optional

The marketing consent information when the customer consented to receiving marketing material by email.


MetafieldOBJECT

Optional

Attaches additional metadata to a shop's resources.


SMS Marketing ConsentOBJECT

Optional

The marketing consent information when the customer consented to receiving marketing material by SMS.

Save a search event.

Save Search Event is a Cloud action.

Property nameTypeRequiredDescription
Event IDSTRING
required

A unique event identifier.


IP AddressSTRING

Optional

The IP address of the user.


User AgentSTRING

Optional

The user agent of the device sending the event.


TimestampSTRING

Optional

The timestamp when the event was triggered.


IdentifiersOBJECT
required

Identifiers for the user


PageOBJECT

Optional

Page details to send with the event


Custom AttributesOBJECT

Optional

Custom attributes for the event. Data should be specified as key:value pairs


CustomerOBJECT

Optional

Customer details


CartOBJECT

Optional

Cart details


Cart Line ItemsOBJECT

Optional

Cart Line Item details


Search ResultsOBJECT

Optional

Search results details


Search QuerySTRING

Optional

The search query that was executed.


Search Event NameSTRING
required

The name of the Search event to track.

Save a cart event.

Save Cart Event is a Cloud action.

Property nameTypeRequiredDescription
Event IDSTRING
required

A unique event identifier.


IP AddressSTRING

Optional

The IP address of the user.


User AgentSTRING

Optional

The user agent of the device sending the event.


TimestampSTRING

Optional

The timestamp when the event was triggered.


IdentifiersOBJECT
required

Identifiers for the user


PageOBJECT

Optional

Page details to send with the event


Custom AttributesOBJECT

Optional

Custom attributes for the event. Data should be specified as key:value pairs


CustomerOBJECT

Optional

Customer details


Cart LineOBJECT

Optional

Cart Line details


Cart Event NameSTRING
required

The name of the Cart Event to track.

Send a base event that has the basic fields applicable to all events.

Save Base Event is a Cloud action.

Property nameTypeRequiredDescription
Event IDSTRING
required

A unique event identifier.


IP AddressSTRING

Optional

The IP address of the user.


User AgentSTRING

Optional

The user agent of the device sending the event.


TimestampSTRING

Optional

The timestamp when the event was triggered.


IdentifiersOBJECT
required

Identifiers for the user


PageOBJECT

Optional

Page details to send with the event


Custom AttributesOBJECT

Optional

Custom attributes for the event. Data should be specified as key:value pairs


CustomerOBJECT

Optional

Customer details


CartOBJECT

Optional

Cart details


Cart Line ItemsOBJECT

Optional

Cart Line Item details


Event NameSTRING
required

The name of the event to track.

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(link takes you to an external page) for details about the events that you can send to Angler AI.


You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo(link takes you to an external page).

For user-property destinations, an 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.

(information)

Real-time to batch destination sync frequency

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.


Segment lets you change these destination settings from the Segment app without having to touch any code.

Property nameTypeRequiredDescription
Authentication Tokenpassword
required

Your Angler AI API Authentication Token


Workspace IDstring
required

Your Angler AI Workspace ID