Mobile Setup - Hardal

Event Schema

Send a POST request to your Hardal endpoint for every event.

POST https://signal.<yourcustomdomain>.com/push/hardal

Required header: Content-Type: application/json

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "your_event_name",
      "url": "app://screen-name",
      "title": "Screen Title",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "your_field": "your_value",
        "another_field": 123
      }
    }
  }'

Show Payload fields

type

string

required

Request type. Use "event" for events, "identify" for user identification.

website

string

required

Your Signal ID from the Hardal dashboard.

name

string

required

Event name. Any string you choose.

url

string

required

Screen identifier or deep link. Example: app://product-details/123

title

string

required

Screen or view title. Example: Product Details

device_type

string

required

mobile, tablet, or desktop.

platform

string

required

app, web, or server.

language

string

User’s language. Example: en-US, tr-TR

data

object

Your event-specific parameters.

Response codes: 200 Success — 400 Invalid request — 401 Invalid Signal ID

Use consent parameter if you are planning to use Destinations for sending data to consent requiring endpoints; such as Ads channels.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "your_event_name",
      "url": "https://yourdomain.com/page",
      "title": "Page Title",
      "device_type": "desktop",
      "language": "en-US",
      "platform": "web",
      "data": {
        "your_field": "your_value",
        "another_field": 123,
        "consent": true
      }
    }
  }'

Consent is required for Destinations in Marketing category. This requirement might change due to your region and regulations.

Navigate to the related section for recommended events.

Sales Events

Track product views, cart actions, checkout steps, purchases, and refunds

Lead Events

Track form submissions, signups, logins, shares, subscriptions, and trials

Game Events

Track virtual currency, levels, scores, achievements, and tutorials

App Status

Track app installs, opens, and updates

Identify

Link events to known users after login, signup, or consent

Sales

`page_view`

Fires when a user views a screen.

Show Parameters

screen_name

string

Screen name. Example: HomeScreen

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "page_view",
      "url": "app://home",
      "title": "Home",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "screen_name": "HomeScreen"
      }
    }
  }'

`view_item`

Fires when a user views a product detail screen.

Show Parameters

currency

string

required

ISO 4217 code. Required if value is set. Example: USD

value

number

required

Sum of (price × quantity). Exclude shipping and tax. Example: 79.99

items

object[]

required

Product array. See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "view_item",
      "url": "app://product/YOGA-MAT-PRO",
      "title": "ZenFlex Pro Yoga Mat",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "currency": "USD",
        "value": 79.99,
        "items": [
          {
            "item_id": "YOGA-MAT-PRO",
            "item_name": "ZenFlex Pro Yoga Mat",
            "item_brand": "FlowGear",
            "item_category": "Sports",
            "item_category2": "Yoga",
            "price": 79.99,
            "quantity": 1
          }
        ]
      }
    }
  }'

`view_item_list`

Fires when a user views a product list.

Show Parameters

item_list_id

string

List ID. Example: top_picks

item_list_name

string

List name. Example: Top Picks For You

items

object[]

required

Product array. See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "view_item_list",
      "url": "app://discover/top-picks",
      "title": "Top Picks For You",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "item_list_id": "top_picks",
        "item_list_name": "Top Picks For You",
        "items": [
          {
            "item_id": "BOTTLE-INS-32",
            "item_name": "HydroKeep Insulated Bottle 32oz",
            "item_brand": "HydroKeep",
            "item_category": "Sports",
            "item_category2": "Hydration",
            "price": 34.99,
            "quantity": 1,
            "index": 0
          }
        ]
      }
    }
  }'

`select_item`

Fires when a user taps a product from a list.

Show Parameters

item_list_id

string

List ID. Example: search_results

item_list_name

string

List name. Example: Search Results

items

object[]

required

Single item. See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "select_item",
      "url": "app://search?q=backpack",
      "title": "Search Results",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "item_list_id": "search_results",
        "item_list_name": "Search Results",
        "items": [
          {
            "item_id": "BAG-TREK-40L",
            "item_name": "SummitPack 40L Hiking Backpack",
            "item_brand": "TrailBound",
            "item_category": "Outdoor",
            "item_category2": "Backpacks",
            "price": 119.00,
            "quantity": 1,
            "index": 3
          }
        ]
      }
    }
  }'

`view_promotion`

Fires when a user views a promotion.

Show Parameters

creative_name

string

Creative name. Example: summer_splash_hero

creative_slot

string

Creative slot. Example: app_home_carousel

promotion_id

string

Promotion ID. Example: PROMO_SUMMER25

promotion_name

string

Promotion name. Example: Summer Splash Sale

items

object[]

See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "view_promotion",
      "url": "app://home",
      "title": "Home",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "promotion_id": "PROMO_SUMMER25",
        "promotion_name": "Summer Splash Sale",
        "creative_name": "summer_splash_hero",
        "creative_slot": "app_home_carousel"
      }
    }
  }'

`select_promotion`

Fires when a user taps a promotion.

Show Parameters

creative_name

string

Creative name. Example: summer_splash_hero

creative_slot

string

Creative slot. Example: app_home_carousel

promotion_id

string

Promotion ID. Example: PROMO_SUMMER25

promotion_name

string

Promotion name. Example: Summer Splash Sale

items

object[]

See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "select_promotion",
      "url": "app://home",
      "title": "Home",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "promotion_id": "PROMO_SUMMER25",
        "promotion_name": "Summer Splash Sale",
        "creative_name": "summer_splash_hero",
        "creative_slot": "app_home_carousel"
      }
    }
  }'

`search`

Fires when a user performs an in-app search.

Show Parameters

search_term

string

required

Search term. Example: noise cancelling headphones

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "search",
      "url": "app://search",
      "title": "Search",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "search_term": "noise cancelling headphones"
      }
    }
  }'

`add_to_cart`

Fires when a user adds an item to their cart.

Show Parameters

currency

string

required

ISO 4217 code. Required if value is set. Example: USD

value

number

required

Sum of (price × quantity). Exclude shipping and tax. Example: 249.00

items

object[]

required

Product array. See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "add_to_cart",
      "url": "app://product/DRONE-MINI-4K",
      "title": "SkyLens Mini 4K Drone",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "currency": "USD",
        "value": 249.00,
        "items": [
          {
            "item_id": "DRONE-MINI-4K",
            "item_name": "SkyLens Mini 4K Drone",
            "item_brand": "SkyLens",
            "item_category": "Electronics",
            "item_category2": "Drones",
            "price": 249.00,
            "quantity": 1
          }
        ]
      }
    }
  }'

`remove_from_cart`

Fires when a user removes an item from their cart.

Show Parameters

currency

string

ISO 4217 code. Example: USD

value

number

Value of removed items. Example: 34.99

items

object[]

required

Product array. See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "remove_from_cart",
      "url": "app://cart",
      "title": "Cart",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "currency": "USD",
        "value": 34.99,
        "items": [
          {
            "item_id": "BOTTLE-INS-32",
            "item_name": "HydroKeep Insulated Bottle 32oz",
            "item_brand": "HydroKeep",
            "item_category": "Sports",
            "item_category2": "Hydration",
            "price": 34.99,
            "quantity": 1
          }
        ]
      }
    }
  }'

`add_to_wishlist`

Fires when a user adds an item to their wishlist.

Show Parameters

currency

string

required

ISO 4217 code. Required if value is set. Example: USD

value

number

required

Sum of (price × quantity). Example: 189.00

items

object[]

required

Product array. See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "add_to_wishlist",
      "url": "app://product/LAMP-DESK-ARC",
      "title": "ArcLight Desk Lamp",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "currency": "USD",
        "value": 189.00,
        "items": [
          {
            "item_id": "LAMP-DESK-ARC",
            "item_name": "ArcLight Adjustable Desk Lamp",
            "item_brand": "LumenCraft",
            "item_category": "Home",
            "item_category2": "Lighting",
            "price": 189.00,
            "quantity": 1
          }
        ]
      }
    }
  }'

`view_cart`

Fires when a user views their cart.

Show Parameters

currency

string

required

ISO 4217 code. Required if value is set. Example: USD

value

number

required

Sum of (price × quantity). Exclude shipping and tax. Example: 328.99

items

object[]

required

Product array. See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "view_cart",
      "url": "app://cart",
      "title": "Cart",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "currency": "USD",
        "value": 328.99,
        "items": [
          {
            "item_id": "DRONE-MINI-4K",
            "item_name": "SkyLens Mini 4K Drone",
            "item_brand": "SkyLens",
            "item_category": "Electronics",
            "item_category2": "Drones",
            "price": 249.00,
            "quantity": 1
          },
          {
            "item_id": "YOGA-MAT-PRO",
            "item_name": "ZenFlex Pro Yoga Mat",
            "item_brand": "FlowGear",
            "item_category": "Sports",
            "item_category2": "Yoga",
            "price": 79.99,
            "quantity": 1
          }
        ]
      }
    }
  }'

`begin_checkout`

Fires when a user begins checkout.

Show Parameters

currency

string

required

ISO 4217 code. Required if value is set. Example: USD

value

number

required

Sum of (price × quantity). Exclude shipping and tax. Example: 328.99

coupon

string

Event-level coupon. Example: APPFIRST

items

object[]

required

Product array. See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "begin_checkout",
      "url": "app://checkout",
      "title": "Checkout",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "currency": "USD",
        "value": 328.99,
        "coupon": "APPFIRST",
        "items": [
          {
            "item_id": "DRONE-MINI-4K",
            "item_name": "SkyLens Mini 4K Drone",
            "item_brand": "SkyLens",
            "item_category": "Electronics",
            "item_category2": "Drones",
            "price": 249.00,
            "quantity": 1
          },
          {
            "item_id": "YOGA-MAT-PRO",
            "item_name": "ZenFlex Pro Yoga Mat",
            "item_brand": "FlowGear",
            "item_category": "Sports",
            "item_category2": "Yoga",
            "price": 79.99,
            "quantity": 1
          }
        ]
      }
    }
  }'

`add_shipping_info`

Fires when a user submits shipping information.

Show Parameters

currency

string

required

ISO 4217 code. Example: USD

value

number

required

Sum of (price × quantity). Example: 328.99

coupon

string

Coupon. Example: APPFIRST

shipping_tier

string

Shipping tier. Example: Express

items

object[]

required

Product array. See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "add_shipping_info",
      "url": "app://checkout/shipping",
      "title": "Shipping",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "currency": "USD",
        "value": 328.99,
        "coupon": "APPFIRST",
        "shipping_tier": "Express",
        "items": [
          {
            "item_id": "DRONE-MINI-4K",
            "item_name": "SkyLens Mini 4K Drone",
            "item_brand": "SkyLens",
            "item_category": "Electronics",
            "price": 249.00,
            "quantity": 1
          },
          {
            "item_id": "YOGA-MAT-PRO",
            "item_name": "ZenFlex Pro Yoga Mat",
            "item_brand": "FlowGear",
            "item_category": "Sports",
            "price": 79.99,
            "quantity": 1
          }
        ]
      }
    }
  }'

`add_payment_info`

Fires when a user submits payment information.

Show Parameters

currency

string

required

ISO 4217 code. Example: USD

value

number

required

Sum of (price × quantity). Example: 328.99

coupon

string

Coupon. Example: APPFIRST

payment_type

string

Payment method. Example: Apple Pay

items

object[]

required

Product array. See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "add_payment_info",
      "url": "app://checkout/payment",
      "title": "Payment",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "currency": "USD",
        "value": 328.99,
        "coupon": "APPFIRST",
        "payment_type": "Apple Pay",
        "items": [
          {
            "item_id": "DRONE-MINI-4K",
            "item_name": "SkyLens Mini 4K Drone",
            "item_brand": "SkyLens",
            "item_category": "Electronics",
            "price": 249.00,
            "quantity": 1
          },
          {
            "item_id": "YOGA-MAT-PRO",
            "item_name": "ZenFlex Pro Yoga Mat",
            "item_brand": "FlowGear",
            "item_category": "Sports",
            "price": 79.99,
            "quantity": 1
          }
        ]
      }
    }
  }'

`purchase`

Fires when a user completes a purchase.

Show Parameters

transaction_id

string

required

Unique transaction ID. Prevents duplicates. Example: APP-ORD-20250718-4412

value

number

required

Total order value. Exclude shipping and tax. Example: 328.99

currency

string

required

ISO 4217 code. Example: USD

tax

number

Total tax. Example: 26.32

shipping

number

Total shipping cost. Example: 9.99

coupon

string

Event-level coupon. Example: APPFIRST

items

object[]

required

Product array. See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "purchase",
      "url": "app://order/confirmation",
      "title": "Order Confirmed",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "transaction_id": "APP-ORD-20250718-4412",
        "value": 328.99,
        "currency": "USD",
        "tax": 26.32,
        "shipping": 9.99,
        "coupon": "APPFIRST",
        "payment_type": "Apple Pay",
        "items": [
          {
            "item_id": "DRONE-MINI-4K",
            "item_name": "SkyLens Mini 4K Drone",
            "item_brand": "SkyLens",
            "item_category": "Electronics",
            "item_category2": "Drones",
            "price": 249.00,
            "quantity": 1
          },
          {
            "item_id": "YOGA-MAT-PRO",
            "item_name": "ZenFlex Pro Yoga Mat",
            "item_brand": "FlowGear",
            "item_category": "Sports",
            "item_category2": "Yoga",
            "price": 79.99,
            "quantity": 1
          }
        ]
      }
    }
  }'

`refund`

Fires when a user receives a refund. Include items for item-level reporting.

Show Parameters

transaction_id

string

required

Original transaction ID. Example: APP-ORD-20250718-4412

value

number

required

Refund value. Example: 79.99

currency

string

required

ISO 4217 code. Example: USD

tax

number

Tax refunded. Example: 6.40

shipping

number

Shipping refunded. Example: 0

items

object[]

Refunded items. See Item Object.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "refund",
      "url": "app://order/APP-ORD-20250718-4412",
      "title": "Refund",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "transaction_id": "APP-ORD-20250718-4412",
        "value": 79.99,
        "currency": "USD",
        "tax": 6.40,
        "items": [
          {
            "item_id": "YOGA-MAT-PRO",
            "item_name": "ZenFlex Pro Yoga Mat",
            "item_brand": "FlowGear",
            "item_category": "Sports",
            "price": 79.99,
            "quantity": 1
          }
        ]
      }
    }
  }'

Leads

`generate_lead`

Fires when a user submits a lead form.

Show Parameters

lead_id

string

required

Unique lead identifier. Example: LEAD-55021

currency

string

required

ISO 4217 code. Required if value is set. Example: USD

value

number

required

Monetary value of the lead. Example: 750

lead_source

string

Source. Example: In-App Banner

name

string

required

Contact name. Example: Priya Sharma

`sign_up`

Fires when a user creates an account.

Show Parameters

method

string

Signup method. Example: Apple

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "sign_up",
      "url": "app://register",
      "title": "Sign Up",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "method": "Apple"
      }
    }
  }'

Fires when a user logs in.

Show Parameters

method

string

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "login",
      "url": "app://login",
      "title": "Login",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "method": "Biometrics"
      }
    }
  }'

Fires when a user shares content.

Show Parameters

method

string

Share method. Example: iMessage

content_type

string

Content type. Example: product

item_id

string

Content ID. Example: DRONE-MINI-4K

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "share",
      "url": "app://product/DRONE-MINI-4K",
      "title": "Share",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "method": "iMessage",
        "content_type": "product",
        "item_id": "DRONE-MINI-4K"
      }
    }
  }'

Fires when a user subscribes to notifications.

Show Parameters

list_name

string

List name. Example: Deal Alerts

list_id

string

List ID. Example: PUSH_DEALS

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "subscribe",
      "url": "app://settings/notifications",
      "title": "Notification Settings",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "list_name": "Deal Alerts",
        "list_id": "PUSH_DEALS"
      }
    }
  }'

`trial_start`

Fires when a user starts a free trial.

Show Parameters

plan

string

Plan name. Example: pro

trial_days

integer

Trial days. Example: 7

value

number

Plan value. Example: 9.99

currency

string

ISO 4217 code. Example: USD

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "trial_start",
      "url": "app://premium",
      "title": "Go Pro",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "plan": "pro",
        "trial_days": 7,
        "value": 9.99,
        "currency": "USD"
      }
    }
  }'

Games

`earn_virtual_currency`

Fires when a user earns virtual currency.

Show Parameters

virtual_currency_name

string

Currency name. Example: Crystals

value

number

Amount earned. Example: 200

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "earn_virtual_currency",
      "url": "app://game/reward",
      "title": "Reward",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "virtual_currency_name": "Crystals",
        "value": 200
      }
    }
  }'

`spend_virtual_currency`

Fires when a user spends virtual currency.

Show Parameters

virtual_currency_name

string

Currency name. Example: Crystals

value

number

Amount spent. Example: 80

item_name

string

Item purchased. Example: Flame Shield

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "spend_virtual_currency",
      "url": "app://game/shop",
      "title": "Shop",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "virtual_currency_name": "Crystals",
        "value": 80,
        "item_name": "Flame Shield"
      }
    }
  }'

`tutorial_begin`

Fires when a user begins a tutorial. No additional parameters.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "tutorial_begin",
      "url": "app://game/tutorial",
      "title": "Tutorial",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {}
    }
  }'

`tutorial_complete`

Fires when a user completes a tutorial. No additional parameters.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "tutorial_complete",
      "url": "app://game/tutorial",
      "title": "Tutorial Complete",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {}
    }
  }'

App Status

`app_install`

Fires when a user opens the app for the first time. No additional parameters.

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "app_install",
      "url": "app://launch",
      "title": "First Launch",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {}
    }
  }'

`app_open`

Fires when a user opens the app (not first time).

Show Parameters

from_push

boolean

Opened from push notification. Example: true

deeplink_url

string

Deep link URL. Example: app://product/DRONE-MINI-4K

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "app_open",
      "url": "app://home",
      "title": "Home",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "from_push": true,
        "deeplink_url": "app://product/DRONE-MINI-4K"
      }
    }
  }'

`app_update`

Fires when a user updates the app.

Show Parameters

previous_version

string

Previous app version. Example: 3.1.2

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "event",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "app_update",
      "url": "app://home",
      "title": "Home",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "previous_version": "3.1.2"
      }
    }
  }'

Identify

`distinct`

Fires when a user logs in, signs up, or gives consent. Links subsequent events to a known user profile.

Show Parameters

string

required

User’s email. Example: [email protected]

phone

number

required

Phone number. Example: 919876543210

firstName

string

First name. Example: Priya

lastName

string

Last name. Example: Sharma

customerId

string

Your platform’s user ID. Example: USR_78310

birthday

string

Birthday in YYYY-MM-DD. Example: 1992-09-05

gender

string

Gender. Example: female

city

string

City. Example: Mumbai

state

string

State or region. Example: MH

zip

string

Zip or postal code. Example: 400001

country

string

Country code. Example: IN

curl -X POST https://signal.yourdomain.com/push/hardal \
  -H "Content-Type: application/json" \
  -d '{
    "type": "identify",
    "payload": {
      "website": "YOUR_WEBSITE_ID",
      "name": "distinct",
      "url": "app://account",
      "title": "Account",
      "device_type": "mobile",
      "language": "en-US",
      "platform": "app",
      "data": {
        "email": "[email protected]",
        "firstName": "Priya",
        "lastName": "Sharma",
        "customerId": "USR_78310",
        "phone": 919876543210,
        "birthday": "1992-09-05",
        "gender": "female",
        "city": "Mumbai",
        "state": "MH",
        "zip": "400001",
        "country": "IN"
      }
    }
  }'

Item Object

Used by view_item, view_item_list, select_item, add_to_cart, remove_from_cart, add_to_wishlist, view_cart, begin_checkout, add_shipping_info, add_payment_info, purchase, and refund.

view_item, add_to_cart, and purchase must send the same item details for accurate funnel reporting.

Hide Required fields

item_id

string

required

Unique product identifier. Example: DRONE-MINI-4K

item_name

string

required

Product name. Example: SkyLens Mini 4K Drone

item_brand

string

required

Brand name. Example: SkyLens

item_category

string

required

Primary category. Example: Electronics

price

number

required

Unit price. Use discounted price if applicable. Example: 249.00

quantity

integer

required

Quantity. Defaults to 1. Example: 1

Show Optional fields

coupon

string

Item-level coupon. Example: DRONE20

discount

number

Unit discount value. Example: 50.00

index

number

Position in a list. Example: 0

item_category2

string

Secondary category. Example: Drones

item_category3

string

Tertiary category. Example: Mini Drones

item_list_id

string

List ID. Example: top_picks

item_list_name

string

List name. Example: Top Picks For You

item_variant

string

Variant. Example: arctic_white

item_sku

string

SKU code. Example: SL-MINI4K-WHT

item_first_price

number

Original price before discounts. Example: 299.00

item_tax

number

Tax for the item. Example: 19.92

item_variant_id

string

Variant identifier. Example: VAR-MINI4K-WHT

item_url

string

Product page URL. Example: https://store.example.com/product/skylens-mini-4k

​Event Schema

​Consent Parameter

Sales Events

Lead Events

Game Events

App Status

Identify

​Sales

​page_view

​view_item

​view_item_list

​select_item

​view_promotion

​select_promotion

​search

​add_to_cart

​remove_from_cart

​add_to_wishlist

​view_cart

​begin_checkout

​add_shipping_info

​add_payment_info

​purchase

​refund

​Leads

​generate_lead

​sign_up

​login

​share

​subscribe

​trial_start

​Games

​earn_virtual_currency

​spend_virtual_currency

​tutorial_begin

​tutorial_complete

​App Status

​app_install

​app_open

​app_update

​Identify

​distinct

​Item Object

Event Schema

Consent Parameter

Sales

`page_view`

`view_item`

`view_item_list`

`select_item`

`view_promotion`

`select_promotion`

`search`

`add_to_cart`

`remove_from_cart`

`add_to_wishlist`

`view_cart`

`begin_checkout`

`add_shipping_info`

`add_payment_info`

`purchase`

`refund`

Leads

`generate_lead`

`sign_up`

`login`

`share`

`subscribe`

`trial_start`

Games

`earn_virtual_currency`

`spend_virtual_currency`

`tutorial_begin`

`tutorial_complete`

App Status

`app_install`

`app_open`

`app_update`

Identify

`distinct`

Item Object