Skip to main content
Activities are the foundation of how Smile tracks customer behaviour and issues rewards. Apps can define new types of activities, and then notify Smile when they are performed by a customer. Once an app is installed on a merchant’s account, the merchant can setup ways to earn that utilize any of the activity types defined by the app, and rewards will be issued based on the ways to earn they have configured.

​
Defining a new activity type

Your app should define new activity types for any kind of rewardable action that a customer can perform within your app. Common examples include things like leaving a review, subscribing to a newsletter, or rating a support conversation. To define a new activity type:
  1. In the Partner Portal, go to Apps.
  2. Click on the name of the app you want to define a new activity type for.
  3. Navigate to the Activities page for your app.
  4. Click + Create activity type.
  5. Enter the activity type details and click Create.

​
Creating an activity

Once an activity type has been defined, use the create an activity API endpoint to notify Smile when the activity has been performed. When making API calls, be sure to use the OAuth credentials for the account on which your app is installed (not your app’s private key).
Creating an activity requires that you provide the Smile Customer ID of the individual who performed the action. If you don’t have this stored, you can provide an email argument when using the list customers endpoint to lookup a customer in Smile based on their email address.