Ambassador

The Ambassador Developer Hub

Welcome to the Ambassador developer hub. You'll find comprehensive guides and documentation to help you start working with Ambassador as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Integration: Embeddable Image Snippet

Paste this image snippet on the "success" page of the event you are tracking.

The example code is pre-filled with campaign information for you, but you will need to alter the "mbsy_email" to correlate with your new customer.

Multiple campaign events can be triggered by specifying multiple campaigns separated by commas in the "mbsy_campaign_uid" variable. The events will occur in the order provided.

Don't paste more than one image snippet on your page.

See the table below the code for additional data you can pass us.

Required Fields:

  • mbsy_username
  • mbsy_campaign_uid
  • mbsy_email
Variable
Description
Options
Default

mbsy_username

Your company's username

mbsy_campaign_uid

Your campaign's ID(s)

mbsy_email

Your customer's email address

mbsy_short_code

Referrer's "mbsy" shortcode

mbsy_revenue

Revenue amount of the event

mbsy_transaction_uid

Unique transaction ID for the event

mbsy_uid

Your customer's internal unique ID

mbsy_first_name

Your customer's first name

mbsy_last_name

Your customer's last name

mbsy_email_new_ambassador

Email login credentials to new ambassadors

1 - yes
0 - no

1

mbsy_deactivate_new_ambassador

New ambassadors created are deactivated

1 - yes
0 - no

0

mbsy_auto_create

If the customer is not an ambassador, create them

1 - yes
0 - no

0 (1 if you signed up before Nov 5 2013)

mbsy_add_to_group_id

Define which group(s) new ambassadors will be created in. Using this parameter will override default group settings. Group IDs should be separated by commas. If mbsy_add_to_group_id=-1, then ambassador will not be added to any group

mbsy_event_data1

Custom field - related to event/commission

mbsy_event_data2

Custom field - related to event/commission

mbsy_event_data3

Custom field - related to event/commission

mbsy_is_approved

Commission status

1 - approved
0 - pending

campaign setting

 <img src="https://mbsy.co/embed/v2/img/?mbsy_username=[[app:username]]&mbsy_campaign_uid=000&mbsy_email=example@example.com&mbsy_revenue=0.00" style="border: none; display: none" alt="" />