Fulfilment Pending

{
"event": {
"id": 13007875,
"type": "fulfilment_pending",
"created_at": "2023-08-23T11:06:02.663Z"
},
"data": {
"id": 2429153,
"status": "pending",
"amount": 3,
"date_paid": null,
"due_date": null,
"unit": "free_months",
"created_at": "2023-08-23T11:06:02.607Z",
"has_issues": false,
"reward": {
  "id": 109465,
  "amount": null,
  "type": "per_promotion",
  "unit": "free_months",
  "name": "Free subscription months",
  "per_of_sale": 0,
  "default_promo_code": null
},
"promoter": {
  "id": 5272969,
  "status": "active",
  "cust_id": "",
  "email": "[email protected]",
  "created_at": "2023-02-08T06:25:28.004Z",
  "temp_password": "gpBwBYw1",
  "default_promotion_id": 5680057,
  "pref": "i790yc6",
  "default_ref_id": "referralid18",
  "note": null,
  "w8_form_url": null,
  "w9_form_url": null,
  "parent_promoter_id": null,
  "earnings_balance": {
    "cash": 882,
    "free_months": 3
  },
  "current_balance": {
    "cash": 882,
    "free_months": 3
  },
  "paid_balance": null,
  "auth_token": "2-5P1Shfk2nnKaZrYFZExh-sfCThGt-2",
  "profile": {
    "id": 5306304,
    "first_name": "Promoter",
    "last_name": "Name",
    "website": "",
    "company_name": "",
    "phone_number": "",
    "address": "",
    "vat_id": "",
    "country": "",
    "paypal_email": null,
    "avatar_url": "",
    "description": null,
    "social_accounts": {
      "twitter": {
        "url": ""
      },
      "youtube": {
        "url": ""
      },
      "facebook": {
        "url": ""
      },
      "linkedin": {
        "url": ""
      },
      "instagram": {
        "url": ""
      }
    }
  },
  "promotions": [
    {
      "id": 5680057,
      "status": "offer_inactive",
      "ref_id": "referralid18",
      "promo_code": "",
      "customer_promo_code": "",
      "target_reached_at": null,
      "promoter_id": 5272969,
      "campaign_id": 17476,
      "referral_link": "https://www.your-company.com/?fpr=referralid18",
      "current_offer": null,
      "current_referral_reward": {
        "id": 90548,
        "amount": null,
        "type": "per_referral",
        "unit": "cash",
        "name": "35% recurring commission",
        "per_of_sale": 35,
        "default_promo_code": null
      },
      "current_promotion_reward": null,
      "current_target_reward": null,
      "campaign_name": "Campaign Name",
      "hidden": false,
      "visitors_count": 4,
      "leads_count": 3,
      "customers_count": 2,
      "refunds_count": 0,
      "cancellations_count": 0,
      "sales_count": 2,
      "sales_total": 2522,
      "refunds_total": 0,
      "active_customers_count": 2
    }
  ]
},
"campaign": {
  "id": 17476,
  "name": "Campaign Name",
  "landing_url": "https://www.your-company.com",
  "description": "Private campaign with 2 plans",
  "private": false,
  "color": "#42a5f5",
  "default_webhook_url": "https://your-webhook-url.com",
  "auto_approve_rewards": true,
  "auto_approve_promoters": false,
  "offer": null,
  "referral_reward": {
    "id": 90548,
    "amount": null,
    "type": "per_referral",
    "unit": "cash",
    "name": "35% recurring commission",
    "per_of_sale": 35,
    "default_promo_code": null
  },
  "promotion_reward": null,
  "target_reward": null
}
}
}

{
"event": {
"id": 13007875,
"type": "fulfilment_pending",
"created_at": "2023-08-23T11:06:02.663Z"
},
"data": {
"id": 2429153,
"status": "pending",
"amount": 3,
"date_paid": null,
"due_date": null,
"unit": "free_months",
"created_at": "2023-08-23T11:06:02.607Z",
"has_issues": false,
"reward": {
  "id": 109465,
  "amount": null,
  "type": "per_promotion",
  "unit": "free_months",
  "name": "Free subscription months",
  "per_of_sale": 0,
  "default_promo_code": null
},
"promoter": {
  "id": 5272969,
  "status": "active",
  "cust_id": "",
  "email": "[email protected]",
  "created_at": "2023-02-08T06:25:28.004Z",
  "temp_password": "gpBwBYw1",
  "default_promotion_id": 5680057,
  "pref": "i790yc6",
  "default_ref_id": "referralid18",
  "note": null,
  "w8_form_url": null,
  "w9_form_url": null,
  "parent_promoter_id": null,
  "earnings_balance": {
    "cash": 882,
    "free_months": 3
  },
  "current_balance": {
    "cash": 882,
    "free_months": 3
  },
  "paid_balance": null,
  "auth_token": "2-5P1Shfk2nnKaZrYFZExh-sfCThGt-2",
  "profile": {
    "id": 5306304,
    "first_name": "Promoter",
    "last_name": "Name",
    "website": "",
    "company_name": "",
    "phone_number": "",
    "address": "",
    "vat_id": "",
    "country": "",
    "paypal_email": null,
    "avatar_url": "",
    "description": null,
    "social_accounts": {
      "twitter": {
        "url": ""
      },
      "youtube": {
        "url": ""
      },
      "facebook": {
        "url": ""
      },
      "linkedin": {
        "url": ""
      },
      "instagram": {
        "url": ""
      }
    }
  },
  "promotions": [
    {
      "id": 5680057,
      "status": "offer_inactive",
      "ref_id": "referralid18",
      "promo_code": "",
      "customer_promo_code": "",
      "target_reached_at": null,
      "promoter_id": 5272969,
      "campaign_id": 17476,
      "referral_link": "https://www.your-company.com/?fpr=referralid18",
      "current_offer": null,
      "current_referral_reward": {
        "id": 90548,
        "amount": null,
        "type": "per_referral",
        "unit": "cash",
        "name": "35% recurring commission",
        "per_of_sale": 35,
        "default_promo_code": null
      },
      "current_promotion_reward": null,
      "current_target_reward": null,
      "campaign_name": "Campaign Name",
      "hidden": false,
      "visitors_count": 4,
      "leads_count": 3,
      "customers_count": 2,
      "refunds_count": 0,
      "cancellations_count": 0,
      "sales_count": 2,
      "sales_total": 2522,
      "refunds_total": 0,
      "active_customers_count": 2
    }
  ]
},
"campaign": {
  "id": 17476,
  "name": "Campaign Name",
  "landing_url": "https://www.your-company.com",
  "description": "Private campaign with 2 plans",
  "private": false,
  "color": "#42a5f5",
  "default_webhook_url": "https://your-webhook-url.com",
  "auto_approve_rewards": true,
  "auto_approve_promoters": false,
  "offer": null,
  "referral_reward": {
    "id": 90548,
    "amount": null,
    "type": "per_referral",
    "unit": "cash",
    "name": "35% recurring commission",
    "per_of_sale": 35,
    "default_promo_code": null
  },
  "promotion_reward": null,
  "target_reward": null
}
}
}

This webhook will be fired right after the reward is attributed. To utilize the ‘fulfilment_pending’ webhook in FirstPromoter, follow these steps:

How to respond to this webhook call:

Respond with status 200 if you fulfilled the reward on your end. Respond with a 2xx status (except 200) to keep the fulfilment marked as pending on FirstPromoter’s end. Respond with any other status to indicate an error (FirstPromoter will retry for 7 times during the day).

Event

Event Object

Show properties

string

The Id of the event

type

string

Indicates the webhook event type, such as fulfilment_pending.

created_at

string

Timestamp of when the event occurred.

Data

Data Object

Show properties

number

The Id of the reward

status

string

The status of the reward.

amount

number

The reward amount

unit

string

The unit of the reward

created_at

string

The date and time the reward was created

has_issues

boolean

Whether the reward has issues

reward

Reward Object

Show properties

number

The Id of the reward

amount

number

The reward amount

type

string

The type of the reward

unit

string

The unit of the reward

name

string

The name of the reward

per_of_sale

number

The per of sale of the reward

The default promo code of the reward

promoter

Promoter Object

Show properties

number

The Id of the promoter

status

string

The status of the promoter

cust_id

string

The customer id of the promoter

string

The email of the promoter

created_at

string

The date the promoter was created

temp_password

string

The temporary password of the promoter

default_promotion_id

number

The default promotion id of the promoter

pref

string

The pref of the promoter

default_ref_id

string

The default referral id of the promoter

note

string

The note saved on the promoter profile by an admin

w8_form_url

string

The w8 form url saved on the promoter profile by an admin

w9_form_url

string

The w9 form url saved on the promoter profile by an admin

parent_promoter_id

number

The parent promoter id of the promoter

earnings_balance

number

The earnings balance of the promoter

current_balance

number

The current balance of the promoter

paid_balance

number

The paid balance of the promoter

auth_token

string

The auth token of the promoter

profile

Profile Object

Show properties

number

The Id of the profile

first_name

string

The first name of the profile

last_name

string

The last name of the profile

website

string

The website of the profile

company_name

string

The company name of the profile

phone_number

string

The phone number of the profile

address

string

The address of the profile

vat_id

string

The vat id of the profile

country

string

The country of the profile

paypal_email

string

The paypal email of the profile

avatar_url

string

The avatar url of the profile

description

string

The description of the profile

Show properties

tiktok

Social Account Object

Show properties

url

string

The url of the social account

twitch

Social Account Object

Show properties

url

string

The url of the social account

twitter

Social Account Object

Show properties

url

string

The url of the social account

youtube

Social Account Object

Show properties

url

string

The url of the social account

facebook

Social Account Object

Show properties

url

string

The url of the social account

Social Account Object

Show properties

url

string

The url of the social account

instagram

Social Account Object

Show properties

url

string

The url of the social account

{
"event": {
"id": 13007875,
"type": "fulfilment_pending",
"created_at": "2023-08-23T11:06:02.663Z"
},
"data": {
"id": 2429153,
"status": "pending",
"amount": 3,
"date_paid": null,
"due_date": null,
"unit": "free_months",
"created_at": "2023-08-23T11:06:02.607Z",
"has_issues": false,
"reward": {
  "id": 109465,
  "amount": null,
  "type": "per_promotion",
  "unit": "free_months",
  "name": "Free subscription months",
  "per_of_sale": 0,
  "default_promo_code": null
},
"promoter": {
  "id": 5272969,
  "status": "active",
  "cust_id": "",
  "email": "[email protected]",
  "created_at": "2023-02-08T06:25:28.004Z",
  "temp_password": "gpBwBYw1",
  "default_promotion_id": 5680057,
  "pref": "i790yc6",
  "default_ref_id": "referralid18",
  "note": null,
  "w8_form_url": null,
  "w9_form_url": null,
  "parent_promoter_id": null,
  "earnings_balance": {
    "cash": 882,
    "free_months": 3
  },
  "current_balance": {
    "cash": 882,
    "free_months": 3
  },
  "paid_balance": null,
  "auth_token": "2-5P1Shfk2nnKaZrYFZExh-sfCThGt-2",
  "profile": {
    "id": 5306304,
    "first_name": "Promoter",
    "last_name": "Name",
    "website": "",
    "company_name": "",
    "phone_number": "",
    "address": "",
    "vat_id": "",
    "country": "",
    "paypal_email": null,
    "avatar_url": "",
    "description": null,
    "social_accounts": {
      "twitter": {
        "url": ""
      },
      "youtube": {
        "url": ""
      },
      "facebook": {
        "url": ""
      },
      "linkedin": {
        "url": ""
      },
      "instagram": {
        "url": ""
      }
    }
  },
  "promotions": [
    {
      "id": 5680057,
      "status": "offer_inactive",
      "ref_id": "referralid18",
      "promo_code": "",
      "customer_promo_code": "",
      "target_reached_at": null,
      "promoter_id": 5272969,
      "campaign_id": 17476,
      "referral_link": "https://www.your-company.com/?fpr=referralid18",
      "current_offer": null,
      "current_referral_reward": {
        "id": 90548,
        "amount": null,
        "type": "per_referral",
        "unit": "cash",
        "name": "35% recurring commission",
        "per_of_sale": 35,
        "default_promo_code": null
      },
      "current_promotion_reward": null,
      "current_target_reward": null,
      "campaign_name": "Campaign Name",
      "hidden": false,
      "visitors_count": 4,
      "leads_count": 3,
      "customers_count": 2,
      "refunds_count": 0,
      "cancellations_count": 0,
      "sales_count": 2,
      "sales_total": 2522,
      "refunds_total": 0,
      "active_customers_count": 2
    }
  ]
},
"campaign": {
  "id": 17476,
  "name": "Campaign Name",
  "landing_url": "https://www.your-company.com",
  "description": "Private campaign with 2 plans",
  "private": false,
  "color": "#42a5f5",
  "default_webhook_url": "https://your-webhook-url.com",
  "auto_approve_rewards": true,
  "auto_approve_promoters": false,
  "offer": null,
  "referral_reward": {
    "id": 90548,
    "amount": null,
    "type": "per_referral",
    "unit": "cash",
    "name": "35% recurring commission",
    "per_of_sale": 35,
    "default_promo_code": null
  },
  "promotion_reward": null,
  "target_reward": null
}
}
}

Promoter Accepted

Overview

How to Guides

Scripts

Integration Options

Webhooks

How to respond to this webhook call:

Overview

How to Guides

Scripts

Integration Options

Webhooks

​How to respond to this webhook call:

How to respond to this webhook call: