fbpx

In-App Events API

You are here:
< All Topics
Table of Contents

In-App Events API

Add In-App Events to Contact

An endpoint to add In-App Events to a contact.  Use the event_id from the User Interface: In-App Events > Define Event page. 

These events are used for trials/onboarding/churn automations, and various reports in the dashboard.

JSON Endpoint:

post: //api.saturnfunnels.com/api/app/contact/event

{

api_key: string, //  found in dashboard

// one of the following 2

contact_id: string, // unique contact identifier,

visitorId: string, // either contact_id or visitorId is required

event_id: string  // required, from the dashboard

value: number, // default=1, optional

}

Result: 

contact_id: string, // contact _id

event_id: string,

status: ‘ok’

}

 

Checklist API

Use this API below to access the checklist and event status for specific users. Then using you on development tools you can craft a checklist, with links to the

post: //api.saturnfunnels.com/api/app/contact/checklist

{

api_key: string, //  found in dashboard

// one of the following 3

contact_id: string, // unique contact identifier

visitorId: string, // either contact_id or visitorId is required

email: string, // email of the contact

plan: string  // optional plan token from the dashboard, see below

}

plan: 

If not given,

    1. the Contact plan is used
    2. If the Contact plan is not defined then the — All Plans — default is given.
    3. If nothing is defined a 400 error will be issued.

Result: 

contact_id: string, // contact _id

plan: string, // plan token used or ‘all’

complete: boolean, // true or false

event_list: [

event_id: string,

name: string,

defined_count: number,

actual_count: number,

event_complete: boolean

}

],

in_trial: boolean,

trial_start: date,  // trial start datetime

trial_end: date  // trial end datetime

customer: boolean // is a customer

customer_start: date

}