Configuration
Add account access
To connect Buzzlead, you need:
- Account Email: The email registered as the account owner in Buzzlead.
- API Key and API Token: Both available in your Buzzlead dashboard under Integracoes > API.
Select streams
Choose which data streams to sync:
- Ambassadors: All ambassadors with personal referral links.
- Bonuses: Bonus records across all campaigns.
- Referrals: Referral records per campaign (requires Campaign IDs).
- Rescues: Reward rescue/redemption records.
- NPS: NPS evaluations per campaign (requires Campaign IDs).
Configure data source
Fill in the required configuration:
- Account Email (required): Your Buzzlead registration email.
- API Key (required): Your API key from the Buzzlead dashboard.
- API Token (required): Your API token from the Buzzlead dashboard.
- Campaign IDs (optional): A list of campaign IDs to fetch referrals and NPS data for. If not provided, the referrals and NPS streams are skipped.
- Start Date (optional): The earliest date to fetch data from (format: YYYY-MM-DD). Used for filtering bonuses and referrals.
Streams and Fields
Ambassadors
Ambassadors
List of ambassadors registered in your Buzzlead account with their personal referral links.
| Field | Type | Description |
|---|---|---|
nome | string | Ambassador name |
email | string | Ambassador email (primary key) |
telefone | string | Phone number |
empresa | string | Company name |
documento | string | Document number (CPF/CNPJ) |
cnpj | string | CNPJ number |
hashid | string | Unique hash identifier |
link | string | Personal referral link |
campanha | string | Campaign name |
campanha_id | string | Campaign identifier |
created | datetime | Creation date |
Bonuses
Bonuses
Bonus records generated from referral conversions across all campaigns.
| Field | Type | Description |
|---|---|---|
origem_nome | string | Ambassador name |
origem_email | string | Ambassador email |
origem_telefone | string | Ambassador phone |
origem_empresa | string | Ambassador company |
origem_cnpj | string | Ambassador CNPJ |
data | datetime | Bonus creation date |
numeroVenda | string | Sale number (primary key) |
status | string | Bonus status (pendente/confirmado) |
valorVenda | number | Sale value |
recompensa | number | Reward amount |
cliente_nome | string | Converted customer name |
cliente_email | string | Converted customer email |
cliente_documento | string | Customer document |
campanha_id | string | Campaign identifier |
campanha_nome | string | Campaign name |
Referrals
Referrals
Referral records per campaign. Requires Campaign IDs to be configured.
| Field | Type | Description |
|---|---|---|
campaign_id | string | Campaign identifier (partition key) |
codigo | string | Referral code (primary key) |
numero | string | Numeric referral code |
data | datetime | Referral date |
canal | string | Referral channel (whatsapp/email/link/facebook) |
origem_nome | string | Referrer name |
origem_email | string | Referrer email |
origem_telefone | string | Referrer phone |
origem_empresa | string | Referrer company |
origem_documento | string | Referrer document |
destino_nome | string | Referred person name |
destino_email | string | Referred person email |
destino_telefone | string | Referred person phone |
destino_empresa | string | Referred person company |
destino_documento | string | Referred person document |
campanha_id | string | Campaign identifier |
campanha_nome | string | Campaign name |
situacao | string | Referral status (Valida/Invalida) |
situacao_motivo | string | Status reason |
divulgador_nome | string | Promoter name |
divulgador_email | string | Promoter email |
conversao | string | Conversion details (JSON) |
Rescues
Rescues
Reward rescue and redemption records.
| Field | Type | Description |
|---|---|---|
hashid | string | Unique hash identifier (primary key) |
nome | string | Ambassador name |
email | string | Ambassador email |
telefone | string | Phone number |
status | string | Rescue status |
valor | number | Rescue value |
campanha_id | string | Campaign identifier |
campanha_nome | string | Campaign name |
data | datetime | Rescue date |
tipo | string | Rescue type |
NPS
NPS
NPS evaluation records per campaign. Requires Campaign IDs to be configured.
| Field | Type | Description |
|---|---|---|
campaign_id | string | Campaign identifier (partition key) |
nome | string | Respondent name |
email | string | Respondent email |
nota | integer | NPS score |
comentario | string | Comment |
data | datetime | Evaluation date |