webhooks
/
Product Sent

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

CRM

Endpoints related to CRM functionalities.

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

Account

Account-related functionalities for dealflow and brand searching.

Operations

webhooks

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.
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.

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.

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.

Update Custom LinkWebhook

Request

This webhook is triggered when a custom link is updated (or deleted) for a collaboration. The receiving endpoint can use X-InfluencerHero-Timestamp and X-InfluencerHero-Signature to verify authenticity via HMAC-SHA256.

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 custom link.

webhook_timestampstringrequired

Server-side timestamp included in the webhook body.

custom_link_informationobjectrequired

Details about the previous and new custom link.

custom_link_information.​old_custom_linkstring or null

The existing custom link before the update.

custom_link_information.​old_custom_link_targetstring or null

The existing target URL for the old custom link.

custom_link_information.​new_custom_linkstring or null

The new custom link, if changed.

custom_link_information.​new_custom_link_targetstring or null

The new target URL for the updated custom link.

deal_infoobject(DealInfo)

A lightweight summary of the influencers deal.

collab_idstringrequired

Unique identifier of the collaboration receiving the custom link.

deal_idstringrequired

Unique identifier of the deal associated with this custom link.

application/json
{
  "webhook_timestamp": "1693427202",
  "custom_link_information": {
    "old_custom_link": "/the-old-link",
    "old_custom_link_target": "https://old.example.com",
    "new_custom_link": "/the-new-link",
    "new_custom_link_target": "https://new.example.com"
  },
  "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_id": "collab123",
  "deal_id": "deal321"
}

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.
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.

New Email SentWebhook

Request

This webhook is triggered when a new email is sent to a deal contact. The receiving endpoint can use X-InfluencerHero-Timestamp and X-InfluencerHero-Signature to verify authenticity via HMAC-SHA256.

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 newly sent email.

webhook_timestampstringrequired

Server-side timestamp included in the webhook body.

email_informationobjectrequired

Details about the email that was just sent.

email_information.​sent_from_email_accountstring

Email address from which the email was sent.

email_information.​recipientstring

Primary recipient of the email.

email_information.​cc_addressstring or null

CC recipient of the email, if any.

email_information.​email_subjectstring

Subject line of the email.

email_information.​email_bodystring

Plaintext version of the email body.

email_information.​sent_by_userstring

The name or identifier of the user who sent the email.

deal_infoobject(DealInfo)

A lightweight summary of the influencers deal.

deal_idstringrequired

Unique identifier of the deal to which the email was sent.

application/json
{
  "webhook_timestamp": "1693427202",
  "email_information": {
    "sent_from_email_account": "brand@mycompany.com",
    "recipient": "influencer@example.com",
    "cc_address": "manager@example.com",
    "email_subject": "Collaboration Proposal",
    "email_body": "Hello, I'd like to collaborate on our new campaign...",
    "sent_by_user": "John Marketer"
  },
  "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": "deal123"
}

Responses

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

New Influencer PostWebhook

Request

This webhook is triggered when an influencer publishes a new post on social media that is linked to a deal.
The receiving endpoint can use X-InfluencerHero-Timestamp and X-InfluencerHero-Signature to verify authenticity via HMAC-SHA256.

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 post.

post_informationobjectrequired

Details of the influencer's social media post.

post_information.​account_idinteger

Unique account ID from Influencer Hero.

post_information.​brand_idinteger

ID of the brand or organization the post is for.

post_information.​post_typestring

Type of post (e.g., 'story_post', 'feed_post', 'reel_post')

post_information.​post_assetsArray of strings

List of media assets associated with the post (URLs, file references, etc.).

post_information.​post_timestampstring

Timestamp at which the influencer made the post.

post_information.​platform_media_codestring

Platform-specific code or identifier for the post.

post_information.​platform_user_idstring

User ID of the influencer on the social media platform.

post_information.​platform_handlestring

Influencer's handle on the platform (e.g., 'therock').

post_information.​platformstring

Social media platform (e.g., 'instagram', 'youtube').

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 post belongs to.

collab_idstringrequired

Unique identifier of the collaboration.

deal_urlstring(uri)required

A direct link to view the deal inside Influencer Hero.

application/json
{
  "post_information": {
    "account_id": 3218,
    "brand_id": 12398,
    "post_type": "story_post",
    "post_assets": [ … ],
    "post_timestamp": "2025-01-15 10:30:00",
    "platform_media_code": "ABC123XYZ",
    "platform_user_id": "923478147",
    "platform_handle": "therock",
    "platform": "instagram"
  },
  "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",
  "collab_id": "collab5678",
  "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 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.

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.