By setting up the "promoter_accepted" webhook in FirstPromoter, you'll receive crucial data about promoters that get added on campaigns, either automatically or sign up depending on your setup.
This is for FirstPromoter v2, if you are still using v1, please check this article
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 "promoter_accepted".
created_at: Timestamp of when the event occurred.
DATA OBJECT:
This object contains the data of the object who determined the event:
state: Current state of the promoter in relation to the campaign (e.g., "accepted").
promoter: Contains information about the promoter.
id: Promoter's ID.
cust_id: ID to identify the promoter in your system.
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.
auth_token: Authentication token.
email: Promoter's email.
temp_password: Temporary password generated for login.
profile: JSON containing additional promoter information (e.g., name, website).
promotion: Contains information about the promotion generated for the promoter.
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.
referral_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" - "+Add new webhook" - Add the desired webhook URL and test it by clicking on "Test webhook" - Save.