Skip to content
/
Update Commission

Influencer Hero API (1.4.2)

API documentation for the Influencer Hero platform.

Download OpenAPI description
ih_api.json
ih_api.yaml
Overview
URL
https://help.influencer-hero.com/
Influencer Hero Support
support@influencer-hero.com
Languages
Servers
https://api.influencer-hero.com/

Test endpoints

Endpoints to test authenticated and public requests

Operations

Search & Reports

Operations

Identify influencers

Operations

Helper endpoints

Operations

Import influencers

Operations

Influencer Page

Operations

Affiliate Tracking

[Advanced] Server-side endpoints for tracking affiliate actions and performance. For most use cases, the client-side tracking script will be sufficient.

Operations

Managing Webhooks

Operations

Webhooks

Receive real-time notifications when events occur in your account. Webhooks are secured via HMAC-SHA256 signatures.

Webhooks

Update CommissionWebhook

Request

This webhook is triggered when a commission percentage is updated for a collaboration. The receiving endpoint can use X-InfluencerHero-Timestamp and X-InfluencerHero-Signature to verify authenticity via HMAC-SHA256.

Security
ApiKeyAuth
Headers
X-InfluencerHero-Timestampstringrequired

Unix timestamp (in seconds) at which the webhook was sent.

X-InfluencerHero-Signaturestringrequired

HMAC-SHA256 signature computed using your webhook signing key and the request body.

Bodyapplication/jsonrequired

Payload containing information about the updated commission percentage.

webhook_timestampstringrequired

Server-side timestamp included in the webhook body.

commission_informationobjectrequired

Details about the previous and new commission percentages.

commission_information.​old_commission_percnumber or null

The existing commission percentage before the update.

commission_information.​new_commission_percnumber

The new commission percentage.

collab_idstringrequired

Unique identifier of the collaboration.

deal_idstringrequired

Unique identifier of the deal associated with this collaboration.

deal_infoobject(DealInfo)

A lightweight summary of the influencers deal.

is_ch_collabboolean

Whether this is a Creator Hero collaboration.

application/json
{
  "webhook_timestamp": "1693427202",
  "commission_information": {
    "old_commission_perc": 10,
    "new_commission_perc": 15
  },
  "collab_id": "collab987",
  "deal_id": "xyz789",
  "deal_info": {
    "deal_name": "therock",
    "is_active": true,
    "dealflow_funnel_step": 3,
    "dealflow_type": "outreach",
    "dealflow_name": "Spring Collection Promo",
    "picture_url": "https://imgp.sptds.icu/v2?mb0KwpL92uYofJiSjDn1%2F6peL1lBwv3s%2BUvShHERlDbrEEwrWumIvR20xZeZXa0LDeIrcniqZeG9S%2F1a5s2Rx3FZdXrWpY%2BmSBJp1l%2FmBGon3rcHA4EfuatZqMhVBzAT",
    "nr_followers": 60000,
    "full_name": "Dwayne Johnson",
    "platform": "instagram",
    "profile_url": "https://instagram.com/therock"
  },
  "is_ch_collab": false
}

Responses

The server processing the webhook should generally return a 200 status indicating successful receipt.

Product SentWebhook

Request

This webhook is fired whenever a user sends a product to an influencer or contact. The request body contains core details of the shipped order (in a simplified form), along with minimal information about the related deal. Security / Verification - Each request includes a timestamp (X-InfluencerHero-Timestamp) and
an HMAC-SHA256 signature (X-InfluencerHero-Signature) in the headers.

  • The payload can be used along with the secret key your system has stored (provided by Influencer Hero) to verify authenticity of the request.
Security
ApiKeyAuth
Headers
X-InfluencerHero-Timestampstringrequired

Unix timestamp (in seconds) at which the webhook was sent.

X-InfluencerHero-Signaturestringrequired

HMAC-SHA256 signature computed using your webhook signing key and the request body.

Bodyapplication/jsonrequired
send_product_infoobjectrequired

Details about the product and recipient information being sent.

send_product_info.​line_itemsArray of objects

A list of items being sent in this order.

send_product_info.​customerobject

Basic customer/influencer information.

send_product_info.​shipping_addressobject

Shipping address where items should be delivered.

send_product_info.​phonestring

Optional phone number for the order (duplicate of shipping/billing).

deal_infoobject(DealInfo)required

A lightweight summary of the influencers deal.

deal_info.​deal_namestring

Deal name / Influencer handle

deal_info.​is_activeboolean

Indicates if the deal is still active.

deal_info.​dealflow_funnel_stepinteger

Funnel step of the deal in the respective dealflow (0-4)

deal_info.​dealflow_typestring

Whether the dealflow is an outreach or relationship dealflow

deal_info.​dealflow_namestring

Name of the dealflow

deal_info.​picture_urlstring(uri)

Influencer Profile Picture URL

deal_info.​nr_followersinteger

Number of followers of the influencer

deal_info.​full_namestring

Full name for the influencer, as indicated on his social media account

deal_info.​platformstring

Indicates which social media platform is primarily used.

deal_info.​profile_urlstring(uri)

Link to the influencer's social media page

deal_idstringrequired

Internal ID of the deal for reference.

application/json
{
  "send_product_info": {
    "line_items": [ … ],
    "customer": { … },
    "shipping_address": { … },
    "phone": "555-555-5555"
  },
  "deal_info": {
    "deal_name": "therock",
    "is_active": true,
    "dealflow_funnel_step": 3,
    "dealflow_type": "outreach",
    "dealflow_name": "Spring Collection Promo",
    "picture_url": "https://imgp.sptds.icu/v2?mb0KwpL92uYofJiSjDn1%2F6peL1lBwv3s%2BUvShHERlDbrEEwrWumIvR20xZeZXa0LDeIrcniqZeG9S%2F1a5s2Rx3FZdXrWpY%2BmSBJp1l%2FmBGon3rcHA4EfuatZqMhVBzAT",
    "nr_followers": 60000,
    "full_name": "Dwayne Johnson",
    "platform": "instagram",
    "profile_url": "https://instagram.com/therock"
  },
  "deal_id": "DEAL-12345"
}

Responses

Your server should return a 2xx response to acknowledge successful receipt of the event.