Skip to content
/
New Influencer Order

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 Influencer ReplyWebhook

Request

This webhook is triggered when an influencer replies to an email associated with a particular 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 influencer's email reply.

email_informationobjectrequired

Details about the received email reply.

email_information.​from_addrstring

The sender (influencer's) email address.

email_information.​recipientstring

The primary recipient of the email (brand or user).

email_information.​cc_addressstring or null

Any CC recipients for this reply, if present.

email_information.​email_subjectstring

Subject line of the reply email.

email_information.​email_bodystring

Plaintext version of the email body.

email_information.​received_timestring(date-time)

Timestamp of when the email reply was received.

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

Unique identifier of the deal this email reply is for.

deal_urlstring(uri)required

A direct link to view the deal inside Influencer Hero.

application/json
{
  "email_information": {
    "from_addr": "janedoe@example.com",
    "recipient": "brand@mycompany.com",
    "cc_address": "team@mycompany.com",
    "email_subject": "Re: Collaboration Proposal",
    "email_body": "Thank you for reaching out. I'd love to discuss more details...",
    "received_time": "2025-01-16 09:15:00"
  },
  "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": "deal12345",
  "deal_url": "https://app.influencer-hero.com/deal/deal12345"
}

Responses

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

New Influencer OrderWebhook

Request

This webhook is triggered when a new order is attributed to an influencer (via discount code or affiliate link). 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 influencer order.

order_informationobjectrequired

Details about the order attributed to the influencer.

order_information.​order_idstring

Unique identifier for the order.

order_information.​order_namestring

Human-readable order name or number.

order_information.​order_revenuenumber

Total revenue of the order in the original order currency.

order_information.​order_currencystring

Currency code of the order (e.g., USD, EUR).

order_information.​account_currencystring

The account's default currency code (e.g., USD, EUR).

order_information.​account_currency_revenuenumber

Order revenue converted to the account's default currency.

order_information.​paid_commissionnumber

Commission amount to be paid to the influencer, in the account's default currency.

order_information.​commission_ratenumber

Commission rate applied (e.g., 0.10 for 10%).

order_information.​discount_codesstring or null

Discount code(s) used in the order, if any.

order_information.​platformstring

E-commerce platform where the order was placed (e.g., shopify, woocommerce).

order_information.​match_typesstring or null

How the order was attributed to the influencer (e.g., discount_code, utm_link, custom_link).

order_information.​order_timestampstring(date-time)

Timestamp when the order was placed.

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

collab_infoobject

Information about the collaboration linked to this order.

deal_idstringrequired

Unique identifier of the deal.

collab_idstringrequired

Unique identifier of the collaboration.

deal_urlstring(uri)required

A direct link to view the deal inside Influencer Hero.

application/json
{
  "order_information": {
    "order_id": "5123456789",
    "order_name": "Order #1234",
    "order_revenue": 149.99,
    "order_currency": "USD",
    "account_currency": "USD",
    "account_currency_revenue": 149.99,
    "paid_commission": 14.99,
    "commission_rate": 0.1,
    "discount_codes": "THEROCK20",
    "platform": "shopify",
    "match_types": "discount_code",
    "order_timestamp": "2025-01-15T14:30:00Z"
  },
  "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"
  },
  "collab_info": {
    "collab_id": "collab12345",
    "campaign_name": "Spring Collection 2025",
    "discount_code": "THEROCK20",
    "custom_url": null
  },
  "deal_id": "deal67890",
  "collab_id": "collab12345",
  "deal_url": "https://app.influencer-hero.com/deal/deal67890"
}

Responses

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