UpPromote Public API
  1. Webhook Event Payload
UpPromote Public API
  • API overview
  • Affiliate
    • Get affiliates
      GET
    • Get affiliate by ID
      GET
    • Create an affiliate
      POST
    • Approve/Deny affiliate
      POST
    • Set upline for an affiliate
      POST
    • Move an affiliate to a program
      POST
    • Connect a customer to an affiliate
      POST
  • Coupon
    • Get coupons
      GET
    • Assign a coupon to an affiliate
      POST
  • Payment
    • Get unpaid payments
      GET
    • Get paid payments (History)
      GET
    • Count total paid payments
      GET
    • Get a payment by ID
      GET
    • Mark as paid a manual payment
      POST
  • Referral
    • Get list referrals
      GET
    • Get a referral by ID
      GET
    • Create a referral
      POST
    • Add referral adjustment
      POST
  • Webhook
    • Get webhook subscriptions
    • Subscribe a webhook event
    • Update a webhook subscription
    • Delete a webhook subscription
  • Webhook Event Payload
    • Webhook overview
    • Referral new
      POST
    • Referral approved
      POST
    • Referral denied
      POST
    • Referral status changed
      POST
    • Affiliate new
      POST
    • Affiliate approved
      POST
    • Affiliate inactive
      POST
    • Affiliate status changed
      POST
    • Payment paid
      POST
  1. Webhook Event Payload

Referral new

Webhook
POST
referral.new
Occurs whenever there is a new referral in the store. The event payload shown below.

Request

None

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://your-api-server.com'
Response Response Example
{
    "id": 1781959,
    "order_id": null,
    "order_number": null,
    "customer_id": null,
    "quantity": null,
    "total_sales": "0.00",
    "commission_rule": {
        "program_id": 29486,
        "commission_rate": null,
        "commission_type": "Percent Of Sale"
    },
    "commission_adjustment": "0.00",
    "status": "pending",
    "commission": "100.00",
    "refund_id": null,
    "tracking_type": "Performance bonus",
    "affiliate": {
        "id": 2029458,
        "email": "testhoook-tiktok-okela@gmail.com",
        "first_name": "Test",
        "last_name": "Hook"
    },
    "coupon_applied": null,
    "customer_email": null,
    "created_at": "2025-09-25T04:59:43Z"
}
Modified at 2025-10-02 02:28:46
Previous
Webhook overview
Next
Referral approved
Built with