By setting up the "lead_signup" webhook in FirstPromoter, you'll receive vital data when a new lead signs up or switches to the "signup" state.
Here's the key information included in the webhook event payload:
EVENT OBJECT:
This object contains information about the event webhook. The most important fields are:
type: Indicates the webhook event type, such as "lead_signup."
created_at: Timestamp of when the event occurred.
DATA OBJECT:
This object contains the data of the object who determined the event.
id: Lead ID.
state: Current state of the lead (e.g., "signup").
first_name: Lead's first name.
last_name: Lead's last name.
email: Lead's email.
uid: Billing customer ID passed through the JavaScript signup tracking function.
customer_since: Null at the "signup" state.
plan_name: Null at the "signup" state.
promoter: Contains information about the promoter who referred the lead.
id: Promoter's ID.
cust_id: ID to identify the promoter.
auth_token: Authentication token.
earnings_balance: JSON containing the total amount of rewards earned.
current_balance: JSON containing remaining amounts after payments.
paid_balance: JSON containing paid/fulfilled amounts.
email: Promoter's email.
temp_password: Temporary password generated.
profile: JSON containing additional promoter information.
promotion: Contains information about the promotion that referred the lead.
campaign_id: ID of the campaign where the promotion runs.
promoter_id: ID of the promoter/affiliate.
status: Current offer status.
promo_code: Discount/credit coupon used.
ref_id: Promotion referral ID.
ref_link: Promotion referral link.
current_offer: JSON with details about the current offer available to the lead.
To add a webhook in FirstPromoter, you will need to access your profile on the upper-right corner - "Settings" - "Integrations" tab - "Webhooks" - "Test webhook"/"Select event" - "+Add new webhook" - Add the desired webhook URL and test it by clicking on "Test webhook" - Save.