Integration

This guide shows how to integrate the Axon SDK into your native iOS mobile app so that you can track events for that app.

Download the latest SDK

You can download the SDK through CocoaPods as a dependency.

The SDK requires the minimum iOS deployment target to be iOS 12.0 or above. It also requires Xcode version 15 or above.

To integrate the AxonSDK through CocoaPods:

1. Add the following line to your Podfile:

2. Run the following on the command line:

Initialize the SDK

Initialize the AxonSDK with the event or SDK key at startup to maximize how long the SDK can take to ready core services. Replace “«your-key»” with your Axon event or SDK Key.

You can find your Axon event key in the Account > General > Keys section of the AppLovin dashboard.

Processing deep links

You must provide a deep link so that when a user clicks an ad, either your app seamlessly opens if it is installed, or the click routes them to a browser otherwise. In your app delegate, call Axon SDK’s processDeepLink: API to handle inbound deep links and associated metadata.

Tracking events with the Axon SDK

To send an occurrence of an ecommerce event to Axon, use the following syntax. Each event should trigger when its corresponding event happens in the data layer.

Parameters

All events require the event_name argument. Each event except for page_view also requires certain event_data, described in the event-specific sections below.

Passing data to the Axon SDK

For each of the events that requires event_data, Axon recommends that you create a dictionary that is the payload. For example:

Enabling test mode

When you test your integration, it’s important that you prevent test events from affecting your production data.

To enable test mode for a set of IDFAs, pass a list of test device advertising IDs in the Axon SDK initialization configuration. The following code snippets show how to do this:

SDK integration is in beta and is only available in certain regions.

Axon only processes URLs that originate from Axon.

At a minimum, provide page_view, view_item, add_to_cart, begin_checkout, and purchase events. Also include sign_up or login if your site uses these events.