Ambassador Connector Setup Guide
This article describes how to set up the Ambassador connector.
Connector Actions
Action Name | AudienceStream | EventStream |
---|---|---|
Record Campaign Referral Event | ✓ | ✓ |
Update Ambassador | ✓ | ✓ |
Add Ambassador Commission | ✓ | ✓ |
Remove Contact | ✓ | ✓ |
Configure Settings
Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.
After adding the connector, configure the following settings:
- Username:
For information on how to find your username, see: https://docs.getambassador.com/docs/authentication - API Key
For information on how to find your API key, see: https://docs.getambassador.com/docs/authentication
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 - Record Campaign Referral Event
Parameters
Parameter | Description |
---|---|
Email Address |
|
Campaign UID |
|
Product ID |
|
Short Code |
|
Revenue |
|
Transaction UID |
|
IP Address |
|
Customer UID |
|
First Name |
|
Last Name |
|
Custom Field 1 |
|
Custom Field 2 |
|
Custom Field 3 |
|
Email New Ambassador |
|
Deactivate New Ambassador |
|
Auto Create Customer |
|
Add to Group ID |
|
Event Data 1 |
|
Event Data 2 |
|
Event Data 3 |
|
Commission is Approved |
|
Street |
|
City |
|
State |
|
Postal Code |
|
Country |
|
Phone |
|
Action - Update Ambassador
Parameters
Parameter | Description |
---|---|
UID |
|
Email Address |
|
New Email Address |
|
New UID |
|
First Name |
|
Last Name |
|
Custom Field 1 |
|
Custom Field 2 |
|
Custom Field 3 |
|
Deactivate Ambassador |
|
Send Welcome Email |
|
Street |
|
City |
|
State |
|
Postal Code |
|
Country |
|
Phone |
|
Paypal Email |
|
Company |
|
Set Groups |
|
Action - Add Ambassador Commission
Parameters
Parameter | Description |
---|---|
UID |
|
Ambassador Email |
|
Campaign UID |
|
Commission Amount |
|
Customer Email |
|
First Name |
|
Last Name |
|
Revenue Amount |
|
Transaction UID |
|
Referrer UID |
|
Customer UID |
|
Commission is Approved |
|
Email New Ambassador |
|
Deactivate New Ambassador |
|
Event Data 1 |
|
Event Data 2 |
|
Event Data 3 |
|
Action - Remove Contact
Parameters
Parameter | Description |
---|---|
Email Address |
|
This page was last updated: January 24, 2020