Skip to content
/
New payout request

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

New payout requestWebhook

Request

This webhook is fired whenever a user creates a payout request in Influencer Hero. The request body contains all the details of the requested payout as well as minimal information about the associated 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
payout_informationobjectrequired

Key information about the requested payout.

payout_information.​payout_commentstringrequired

A comment or note associated with the payout.

payout_information.​brand_idstringrequired

Identifier for the brand requesting or associated with the payout.

payout_information.​payout_currencystringrequired

The currency in which the payout is requested (e.g., USD).

payout_information.​payout_amountnumberrequired

The numerical value of the payout.

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
{
  "payout_information": {
    "payout_comment": "January bonus payment",
    "brand_id": "12345",
    "payout_currency": "USD",
    "payout_amount": 1500
  },
  "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-67890"
}

Responses

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

New Max Bid RequestedWebhook

Request

This webhook is triggered when a new Max Bid is requested for a deal. 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 new Max Bid request.

webhook_timestampstringrequired

Server-side timestamp included in the webhook body.

max_bid_informationobjectrequired

Additional details about the Max Bid request.

max_bid_information.​max_bid_commentstring

Notes or comments provided with the Max Bid request.

deal_infoobject(DealInfo)

A lightweight summary of the influencers deal.

deal_idstringrequired

Unique identifier of the deal for which the Max Bid is requested.

application/json
{
  "webhook_timestamp": "1693427202",
  "max_bid_information": {
    "max_bid_comment": "Please provide the highest possible bid for this influencer."
  },
  "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": "abc123"
}

Responses

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

Update Discount CodeWebhook

Request

This webhook is triggered when a discount code 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 discount code.

webhook_timestampstringrequired

Server-side timestamp included in the webhook body.

code_informationobjectrequired

Details about the previous and new discount codes.

code_information.​old_discount_codestring

The existing discount code before the update.

code_information.​old_discount_percnumber

The existing discount percentage before the update.

code_information.​new_discount_codestring

The new discount code, if changed.

code_information.​new_discount_percnumber

The new discount percentage, if changed.

collab_idstringrequired

Unique identifier of the collaboration receiving the discount code.

deal_infoobject(DealInfo)

A lightweight summary of the influencers deal.

deal_idstringrequired

Unique identifier of the deal associated with this discount code.

application/json
{
  "webhook_timestamp": "1693427202",
  "code_information": {
    "old_discount_code": "FIT2023",
    "old_discount_perc": 15,
    "new_discount_code": "FIT2024",
    "new_discount_perc": 20
  },
  "collab_id": "collab987",
  "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": "xyz789"
}

Responses

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