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

Affiliate new

Webhook
POST
affiliate.new
Occurs when there is a new affiliate in the store (signup or create manual). 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": 2029238,
    "email": "test233@gmail.com",
    "first_name": "Test",
    "last_name": "233",
    "status": "inactive",
    "email_verified": "unverified",
    "company": null,
    "address": null,
    "city": null,
    "state": null,
    "zipcode": null,
    "country": null,
    "phone": null,
    "facebook": null,
    "twitter": null,
    "youtube": null,
    "instagram": null,
    "created_at": "2025-09-24T08:57:32Z",
    "default_affiliate_link": "https://mat-test-85.myshopify.com/collections/all?sca_ref=2029238.",
    "custom_affiliate_link": null,
    "program_id": 29486,
    "program_name": "Standard Affiliate Commission",
    "custom_fields": [
        {
            "label": "fghdfgh",
            "value": "1"
        },
        {
            "label": "fgherth",
            "value": "1"
        }
    ],
    "coupons": [],
    "vat_number": null,
    "tax_value": 0,
    "up_line_affiliate_id": 2029220,
    "up_line_affiliate_email": "test232@gmail.com",
    "payment_method": "debit",
    "payment_info": null,
    "paid_amount": 0,
    "approved_amount": 0,
    "pending_amount": 0,
    "denied_amount": 0
}
Modified at 2025-10-02 02:29:25
Previous
Referral status changed
Next
Affiliate approved
Built with