Add participant

Adds a participant to the referral campaign.

growsurf.addParticipant(data, callback)

Returns a Promise that resolves with an Object containing limited participant data.

Example use

// Email only using a Callback
growsurf.addParticipant('gavin@hooli.com', function(participant) {
  // handle participant
});
​
// Object using a Callback
growsurf.addParticipant({
  email: 'gavin@hooli.com', 
  firstName: 'Gavin', 
  lastName: 'Belson',
  company: 'Hooli, Inc',
  companySize: 10000
}, function(participant) {
  // handle participant
});

// Email only using a Promise
growsurf.addParticipant('gavin@hooli.com').then(participant => {
  // handle participant
});
​
// Object using a Promise
growsurf.addParticipant({
  email: 'gavin@hooli.com', 
  firstName: 'Gavin', 
  lastName: 'Belson',
  company: 'Hooli, Inc',
  companySize: 10000
}).then(participant => {
  // handle participant
});

Example response

{
    "id": "kafewp",
    "firstName": "Gavin",
    "lastName": "Belson",
    "referralCount": 0,
    "shareUrl": "https://piedpiper.com?grsf=kafewp",
    "rewards": []
}

Trigger referral

Triggers a referral, awarding referral credit to the referrer of an existing or new participant. If the campaign participant does not exist, they will be newly added.

growsurf.triggerReferral(data, callback)

Returns a Promise that resolves with an Object containing limited participant data.

Example use

// Email only using a Callback
growsurf.triggerReferral('gavin@hooli.com', function(participant) {
  // handle participant
});
​
// Object using a Callback
growsurf.triggerReferral({
  email: 'gavin@hooli.com', 
  firstName: 'Gavin', 
  lastName: 'Belson',
  company: 'Hooli, Inc',
  companySize: 10000  
}, function(participant) {
  // handle participant
});

// Email only using a Promise
growsurf.triggerReferral('gavin@hooli.com').then(participant => {
  // handle participant
});
​
// Object using a Promise
growsurf.triggerReferral({
  email: 'gavin@hooli.com', 
  firstName: 'Gavin', 
  lastName: 'Belson',
  company: 'Hooli, Inc',
  companySize: 10000
}).then(participant => {
  // handle participant
});

Example response

{
    "id": "kafewp",
    "firstName": "Gavin",
    "lastName": "Belson",
    "referralCount": 0,
    "shareUrl": "https://piedpiper.com?grsf=kafewp",
    "rewards": []
}

Get campaign

Retrieves limited details of a campaign.

growsurf.getCampaign(callback)

Returns a Promise that resolves with an Object containing limited campaign data.

Example use

// Using a Callback
growsurf.getCampaign(function(campaign) {
    // Handle Campaign
});

// Using a Promise
growsurf.getCampaign().then(campaign =>  {
    // Handle Campaign
});

Example response

{
    id: "bpsxg4",
    name: "Middle-Out Compression Campaign",
    participantCount: 41
}

Get participant by email

Retrieves limited details of an existing participant. You will need to supply the unique email of the participant.

growsurf.getParticipantByEmail(participantEmail, callback)

Returns a Promise that resolves with an Object containing the participant data. If the participant does not exist in the campaign, then undefined is returned.

Example use

// Using a callback
growsurf.getParticipantByEmail('gavin@hooli.com', function(participant) {
    // Handle participant data
});

// Using a promise
growsurf.getParticipantByEmail('gavin@hooli.com').then(participant => {
    // Handle participant data
});

Example response

{
    "id": "kafewp",
    "firstName": "Gavin",
    "lastName": "Belson",
    "referralCount": 0,
    "shareUrl": "https://piedpiper.com?grsf=kafewp",
    "rewards": []
}

Get participant by ID

Retrieves limited details of an existing participant. You will need to supply the GrowSurf unique identifier that was returned upon participant creation.

growsurf.getParticipantById(participantId, callback)

Returns a Promise that resolves with an Object containing the participant data. If the participant does not exist in the campaign, then undefined is returned.

Example use

// Using a Callback
growsurf.getParticipantById('kafewp', function(participant) {
    // Handle participant data
});

// Using a promise
growsurf.getParticipantById('kafewp').then(participant => {
    // Handle participant data
});

Example response

{
    "id": "kafewp",
    "firstName": "Gavin",
    "lastName": "Belson",
    "referralCount": 0,
    "shareUrl": "https://piedpiper.com?grsf=kafewp",
    "rewards": []
}

Get referrer ID

Returns the ID of the participant that referred the visitor or null if the visitor was not referred. This method will first check to see if a grsf URL parameter exists, then will check for the presence of a referrer ID as a browser cookie (which was set from the initial visit).

growsurf.getReferrerId()

Example use

growsurf.getReferrerId();

Example response

"1h97da"

Open GrowSurf window

Opens the GrowSurf window.

growsurf.open(callback)

Returns a Promise that resolves once complete.

Example use

// Using a Callback
growsurf.open(function() {
    // Do something here
});

// Using a Promise
growsurf.open().then(() => {
    // Do something here
});

Close GrowSurf window

Closes the GrowSurf window.

growsurf.close(callback)

Returns a Promise that resolves once complete.

Example use

// Using a Callback
growsurf.close(function() {
    // Do something here
});

// Using a Promise
growsurf.close().then(() => {
    // Do something here
});

Subscribe to event

Adds an event subscription of the given event type. When an event of the given type occurs, the given callback will be invoked. Below are detailed descriptions of each event type.

growsurf.subscribe(eventType, callback)

Returns a Promise that resolves once complete.

Example use

// Using Callbacks
​
// Subscribe to a `signup` event type
growsurf.subscribe('signup', function(participant) {
  // A participant was added
});
​
// Subscribe to a `share` event type
growsurf.subscribe('share', function(data) {
  // A participant shared their unique referral url
});
​
// Subscribe to a `referral` event type
growsurf.subscribe('referral', function(participant) {
  // A participant was referred
});

// Using Promises
​
// Subscribe to a `signup` event type
growsurf.subscribe('signup').then(participant => {
  // A participant was added
});
​
// Subscribe to a `share` event type
growsurf.subscribe('share').then(data => {
  // A participant shared their unique referral url
});
​
// Subscribe to a `referral` event type
growsurf.subscribe('referral').then(participant => {
  // A participant was referred
});

Example response

Dispatched anytime a new participant is added to the campaign. The provided callback will be invoked with an Object containing the added participant data once the participant has been added successfully.

{
    "id": "kafewp",
    "firstName": "Gavin",
    "lastName": "Belson",
    "referralCount": 0,
    "shareUrl": "https://piedpiper.com?grsf=kafewp",
    "rewards": []
}

{
    "participant": {
        "id": "kafewp",
        "firstName": "Gavin",
        "lastName": "Belson",
        "referralCount": 0,
        "shareUrl": "https://piedpiper.com?grsf=kafewp",
        "rewards": []
    },
    "type": "facebook"
}

{
    "id": "kafewp",
    "firstName": "Gavin",
    "lastName": "Belson",
    "referralCount": 0,
    "shareUrl": "https://piedpiper.com?grsf=kafewp",
    "rewards": []
}