Friendbuy Connector Setup Guide | Server-Side Connectors

Connector Actions

Action Name	AudienceStream	EventStream
Email Opt Out	✓	✓
Send Email	✓	✓
Post a Purchase	✗	✓

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the [Connector Overview]Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

API Access Key
For information on how to get your API Access Key, see: Developer Docs: Security.
API Secret Key
For information on how to get your API Secret Key, see: Developer Docs: Security.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Email Opt Out

Parameters

Parameter	Description
Email Address	Email address to add to opt-out list. Only single email addresses allowed. For more information on this endpoint, see: Friendbuy’s documentation.

Action - Send Email

Parameters

Parameter	Description
Email Address	Where to send the email. Only single email addresses allowed. For more information on this endpoint, see: Friendbuy’s documentation.
Email Template ID	ID of communication email template to be used.
Coupon Bank ID	ID of coupon bank to be used.

Action - Post a Purchase

Parameters

Parameter	Description
Order ID	Unique order ID for the purchase. If this order ID has been previously used, the request will fail and no new purchase (and no new conversion) will be created. For more information on this endpoint, see: Friendbuy’s documentation.
Referral Code	Refcode that referred the friend to make the purchase. Required unless Coupon Code is present. If both Referral Code and Coupon Code are provided, Referral Code will take precedence.
Coupon Code	Coupon code that brought the friend to the merchant to make the purchase. Required unless Referral Code is present.
Order Amount	Amount of the order.
Order Email	Email address associated with the order.
New Customer	Whether or not the purchase is made by a new (first-time) customer. Possible values: `true` or `false`. Used to check for reward eligibility, since Friendbuy allows merchants to state `must be a new customer` as one of the reward criteria.
Customer ID	The ID you assigned to your customer (not the same as the internal Friendbuy-assigned ID).
Customer First Name
Customer Last Name
Customer Email	Email address associated with the customer.
Stripe Customer ID	Stripe’s ID for the customer.
Chargebee Customer ID	Chargebee’s ID for the customer