• Documentation >
• Apps >
• Marketing >
• GrowSurf

GrowSurf

The Growsurf modules allow you to watch, create, update, and delete campaigns, participants, and participant rewards in your Growsurf account.

Getting Started with Growsurf

Prerequisites

• A Growsurf account

In order to use Growsurf with Ibexa Connect, it is necessary to have a Growsurf account. If you do not have one, you can create a Growsurf account at growsurf.com/signup.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting Growsurf to Ibexa Connect

To connect your Growsurf account to Ibexa Connect you need to obtain the API Key from your Growsurf account and insert it in the Create a connection dialog in the Ibexa Connect module.

1. Log in to your Growsurf account.

2. Click Your Profile Icon > Account > Reveal, and copy the API key to your clipboard.

   

3. Go to Ibexa Connect and open the Growsurf module's Create a connection dialog.

   

4. In the Connection name field, enter a name for the connection.

5. In the API Key field, enter the API key copied in step 2 and click Continue.

The connection has been established.

Campaigns

Watch Campaign Ended

Triggers when a campaign ends.

Webhook Name	Enter a name for the webhook.

See the Connecting to Growsurf Webhook using Ibexa Connect to add the webhook in your Growsurf account.

List Campaigns

Retrieves a list of your campaigns.

Limit	Set the maximum number of campaigns Ibexa Connect should return during one scenario execution cycle.

Get a Campaign

Retrieves a campaign.

Campaign ID	Select the Campaign ID whose details you want to retrieve.

Participants

Watch New Participants

Triggers when a new participant is added or referred to your campaign.

Webhook Name	Enter a name for the webhook.

See the Connecting to Growsurf Webhook using Ibexa Connect to add the webhook in your Growsurf account.

List Participants

Retrieves a list of participants in the campaign.

Campaign ID	Select the Campaign ID whose participants you want to list.
Limit	Set the maximum number of participants Ibexa Connect should return during one scenario execution cycle.

Get Participants

Retrieves a single participant from a campaign.

Campaign ID	Select the Campaign ID whose participant details you want to retrieve.
Participant ID or Email	Select the Participant ID or enter the email address of the participant whose details you want to retrieve.

Create a Participant

Adds a participant to the campaign.

Campaign ID	Select the Campaign ID for which you want to add the participant.
Referred By	Select the reference if the participant is referred by any user.
Referral Status	Select the referral status: Credit Pending Credit Awarded
Email	Enter the email address of the participant.
First Name	Enter the first name of the participant.
Last Name	Enter the last name of the participant.
IP Address	Enter the IP address of the participant.
Metadata	Enter the key-value metadata for the participant.

Update a participant

Updates a participant within the campaign.

Campaign ID	Select the Campaign ID whose participant's details you want to update.
Participant ID or Email	Select the Participant ID or the email address of the participant whose details you want to update.
Referred By	Select the reference if the participant is referred by any user.
Referral Status	Select the referral status: Credit Pending Credit Awarded
Email	Enter the email address of the participant.
First Name	Enter the first name of the participant.
Last Name	Enter the last name of the participant.
IP Address	Enter the IP address of the participant.
Metadata	Enter the key-value metadata for the participant.

Delete a Participant

Removes participants within the campaign.

Connecti0on	Establish a connection to your Growsurf account.
Campaign ID	Select the Campaign ID whose participant's details you want to delete.
Participant ID or Email	Select the Participant ID or the email address of the participant you want to delete.

Participant Rewards

Watch New Participants

Triggers when a participant unlocks a reward (if the reward is double-sided, two events will trigger for both referrer and referee).

Webhook Name	Enter a name for the webhook.

See the Connecting to Growsurf Webhook using Ibexa Connect to add the webhook in your Growsurf account.

List Participant Rewards

Retrieves a list of rewards earned by a participant.

Campaign ID	Select the Campaign ID whose participant's rewards you want to list.
Participant ID or Email	Select the Participant ID or the email address of the participant whose rewards you want to list.
Limit	Set the maximum number of rewards Ibexa Connect should return during one scenario execution cycle.

Delete a Participant Reward

Removes a reward that was earned by a participant.

Campaign ID	Select the Campaign ID whose participant's rewards you want to delete.
Participant ID or Email	Select the Participant ID or the email address of the participant whose rewards you want to delete.
Reward ID	Select the Reward ID you want to delete.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.growsurf.com/. For example: /v2/campaigns

For the list of available endpoints, refer to the Growsurf API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - Get Participants

The following API call returns all the participants from your Growsurf account:

URL:

/v2/campaign/{campaign_id}/participants

Method:

GET

Matches of the search can be found in the module's Output under Bundle > Body > participants.

In our example, 2 participants were returned:

Connecting to Growsurf Webhook using Ibexa Connect

1. Open any watch module, enter the details as mentioned in the respective module, click Save and copy the URL address to your clipboard.

   

2. Login to your Growsurf account. Open the campaign whose triggers you want to watch. Click Campaign Actions > Edit Campaign > Options > View All Integrations > Webhooks.

   Enter the URL address copied in step 1 and select the options for which you want to recevie the alerts.

   

The webhook is successfully enabled.