Skip to main content

Track Ambassador Actions outside of SocialLadder using our Ambassador Event API

Track actions performed by ambassadors in your app or website, to use them in challenges or as an event log

Jaylon Henrique avatar
Written by Jaylon Henrique
Updated over 3 months ago

Introduction

  • Purpose: This article explains how to track and log ambassador actions performed outside of SocialLadder using the Ambassador Event API. These tracked events can be used to trigger challenges or serve as a historical record of ambassador engagement with your brand’s app, website, or products.

  • Context: By integrating SocialLadder’s Ambassador Event API, brands can:

    • Seamlessly track ambassador interactions on their platform.

    • Reward specific actions within challenges.

    • Generate reports to analyze ambassador activity and engagement trends.

How the Event API Works

The Ambassador Event API allows brands to send real-time event data to SocialLadder, linking ambassador actions directly to their profiles.

Process Overview:

  1. Define the actions you want to track (e.g., commenting on a product page, sharing a link, signing up for a newsletter).

  2. Use the API to send event data to SocialLadder.

  3. Store and link the data to ambassador profiles for reporting or challenge completion.

To better understand the API structure, refer to SocialLadder's API documentation (Swagger) for technical details and implementation guidelines.

Setting Up API Access

To use the Ambassador Event API, follow these steps:

  1. Obtain API Credentials:

    • Contact your Account Manager or Implementation Specialist to receive your API Key.

  2. Review API Documentation:

    • Visit the SocialLadder API documentation page to explore the payload structure for event tracking.

  3. Generate an Event Payload:

    • Replace the placeholder fields with actual event data from your platform before sending the request.

Key Elements of the API Payload

When integrating the Ambassador Event API, the payload should include the following fields:

Field Name

Description

Name

Unique identifier for the event, used to link it to challenges.

Type

Represents a category or group the event belongs to (e.g., engagement, purchase, referral).

Description

A user-friendly event description for reports and admin reference.

UDF1 - UDF5 (Optional)

User-Defined Fields to store additional relevant event data for reports or profile tracking.

Ambassador ID

Required: The unique ID of the ambassador in SocialLadder. If not available in your system, use /SocialLadderAPI/api/v1/ambassador to retrieve it.

Best Practices & Tips

  • Ensure API Accuracy: Work closely with your development team to correctly format and send event data.

  • Define Meaningful Actions: Focus on tracking high-value interactions like referrals, purchases, or social shares.

  • Leverage UDF Fields: Store additional event data in UDF fields for deeper reporting and analysis.

  • Use Events for Challenges: Combine API-tracked events with the Complete Action Challenge to automate ambassador rewards.

  • Monitor and Optimize: Regularly review event data and adjust tracking parameters to maximize ambassador engagement.

Related Articles

Did this answer your question?