Webhook Events

Below is the list of currently available webhook events.

Accounts

The table below lists the webhook events available for accounts.

The recommended way to process this is to hit the retrieve an account API using the account_id from the webhook to check for account and data sync status.

Webhook Event	Description
ACCOUNTS.CONNECTED	Triggered when a creator links a new work platform account.
ACCOUNTS.DISCONNECTED	Triggered when a creator disconnects his work platform account.

ACCOUNTS.CONNECTED

{
  "event": "ACCOUNTS.CONNECTED",
  "name": "account is connected",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "4544993eac6f4c4a9ec27e23f6cb8c56",
    "user_id": "6bd84fa308f84e66abf108fd3d29f9ef",
    "last_updated_time": "2021-11-10T15:44:18.520054"
  }
}

ACCOUNTS.DISCONNECTED

{
  "event": "ACCOUNTS.DISCONNECTED",
  "name": "account is disconnected",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "29ebb0d8296b45159753833989834dbd",
    "user_id": "1290a1f5ad9b48b5a3f10daaa26469fd",
    "last_updated_time": "2021-11-10T16:12:58.006355"
  }
}

Profiles

The table below lists the webhook events available for profiles.

The recommended way to process this is to hit the retrieve a profile API using the profile_id from the webhook to get the latest identity data for the given profile.

Webhook Event	Description
PROFILES.ADDED	Triggered when a creator profile is synced successfully.
PROFILES.UPDATED	Triggered when a creator profile is updated.

PROFILES.ADDED

{
  "event": "PROFILES.ADDED",
  "name": "profile added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "4544993eac6f4c4a9ec27e23f6cb8c56",
    "user_id": "6bd84fa308f84e66abf108fd3d29f9ef",
    "profile_id": "74e5f67b9df04cbeba0894d749561447",
    "last_updated_time": "2021-11-10T12:59:51.874364"
  }
}

PROFILES.UPDATED

{
  "event": "PROFILES.UPDATED",
  "name": "profile updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "711c36fccb2b4304afb4bcd14e6bfbdd",
    "user_id": "0e3808ca12174c0082381fc5653f9538",
    "profile_id": "bdec2a8924d14904b022b90c8a463559",
    "last_updated_time": "2021-11-10T10:09:11.304556"
  }
}

Profile Audience

The table below lists the webhook events available for the profile audience.

The recommended way to process this is to hit the retrieve audience demographics API using the account_id from the webhook to get the latest audience demographics data for the given account.

Webhook Event	Description
PROFILES_AUDIENCE.ADDED	Triggered when a creator's audience demographics is scanned successfully.
PROFILES_AUDIENCE.UPDATED	Triggered when a creator's audience demographics is updated.

PROFILES_AUDIENCE.ADDED

{
  "event": "PROFILES_AUDIENCE.ADDED",
  "name": "profile audience added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "2b3316b8f4684f03841140b547ec7eb3",
    "user_id": "9864110df20646d29860d0f687c2670d",
    "profile_id": "0ccc5adf0d7d4eaabca56b58420f7da7",
    "last_updated_time": "2021-10-25T16:45:26.761Z"
  }
}

PROFILES_AUDIENCE.UPDATED

{
  "event": "PROFILES_AUDIENCE.UPDATED",
  "name": "profile audience updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "2b3316b8f4684f03841140b547ec7eb3",
    "user_id": "9864110df20646d29860d0f687c2670d",
    "profile_id": "0ccc5adf0d7d4eaabca56b58420f7da7",
    "last_updated_time": "2021-10-25T16:45:26.761Z"
  }
}

Content

The table below lists the webhook events available for content.

Content webhooks may deliver a maximum of up to 100 content IDs in the items array. The recommended way to process this is to hit the retrieve content items in bulk API, using the content IDs listed in the items array from the webhook to get the latest content data for the given IDs. Ideally, this should be done using a messaging queue system while respecting rate limits.

Webhook Event	Description
CONTENTS.ADDED	Triggered when a creator's content is scanned successfully .
CONTENTS.UPDATED	Triggered when a creator's content is updated.

CONTENTS.ADDED

{
  "event": "CONTENTS.ADDED",
  "name": "contents added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "2b3316b8f4684f03841140b547ec7eb3",
    "user_id": "9864110df20646d29860d0f687c2670d",
    "last_updated_time": "2021-10-25 16:45:26.761622",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

CONTENTS.UPDATED

{
  "event": "CONTENTS.UPDATED",
  "name": "contents updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "2b3316b8f4684f03841140b547ec7eb3",
    "user_id": "9864110df20646d29860d0f687c2670d",
    "last_updated_time": "2021-10-25 16:45:26.761622",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

Content Comments

The table below lists the webhook events available for content comments.

The recommended way to process this is to hit the retrieve all comments API, using the account_id and content IDs listed in the items array from the webhook to get the latest comment data for the given account and content ID. Ideally, this should be done using a messaging queue system while respecting rate limits.

The item IDs given in the payload are the content IDs for which the corresponding comments have been added or updated.

Webhook Event	Description
CONTENTS_COMMENTS.ADDED	Triggered when a creator's content is scanned for comments successfully .
CONTENTS_COMMENTS.UPDATED	Triggered when a comment on any content is updated.

CONTENTS_COMMENTS.ADDED

{
  "event": "CONTENTS_COMMENTS.ADDED",
  "name": "contents comments added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "2b3316b8f4684f03841140b547ec7eb3",
    "user_id": "9864110df20646d29860d0f687c2670d",
    "last_updated_time": "2021-10-25 16:45:26.761622",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

CONTENTS_COMMENTS.UPDATED

{
  "event": "CONTENTS_COMMENTS.UPDATED",
  "name": "contents comments updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "2b3316b8f4684f03841140b547ec7eb3",
    "user_id": "9864110df20646d29860d0f687c2670d",
    "last_updated_time": "2021-10-25 16:45:26.761622",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

Content Groups

The table below lists the webhook events available for content groups.

Content group webhooks may deliver a maximum of up to 100 content group IDs in the items array. The recommended way to process this is to hit the retrieve content group items in bulk API, using the content-group IDs listed in the items array from the webhook to get the latest content-group data for the given IDs. Ideally, this should be done using a messaging queue system while respecting rate limits.

Webhook Event	Description
CONTENT-GROUPS.ADDED	Triggered when a creator's content group i.e. playlists, albums is scanned successfully .
CONTENT-GROUPS.UPDATED	Triggered when a creator's content group i.e. playlists, albums is updated.

CONTENT-GROUPS.ADDED

{
  "event": "CONTENT-GROUPS.ADDED",
  "name": "content groups added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "2b3316b8f4684f03841140b547ec7eb3",
    "user_id": "9864110df20646d29860d0f687c2670d",
    "last_updated_time": "2021-10-25 16:45:26.761622",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

CONTENT-GROUPS.UPDATED

{
  "event": "CONTENT-GROUPS.UPDATED",
  "name": "content groups updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "2b3316b8f4684f03841140b547ec7eb3",
    "user_id": "9864110df20646d29860d0f687c2670d",
    "last_updated_time": "2021-10-25 16:45:26.761622",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

Income

The table below lists the webhook events available for income.

Income webhooks may deliver a maximum of up to 100 IDs in the items array. The recommended way to process this is to hit the "retrieve in bulk API" of the associated resource type, such as retrieve social transactions in bulk API, using the transaction IDs listed in the items array from the webhook to get the latest transaction data for the given IDs. The resource type can be identified from the webhook event name and the category (social, commerce, etc.) can be identified using the account_id in the webhook payload. Ideally, this should be done using a messaging queue system while respecting rate limits.

Webhook Event	Description
TRANSACTIONS.ADDED	Triggered when a creator's new transactions are scanned successfully.
TRANSACTIONS.UPDATED	Triggered when a creator's existing transactions are updated.
PAYOUTS.ADDED	Triggered when a creator's new payouts are scanned successfully.
PAYOUTS.UPDATED	Triggered when a creator's existing payouts are updated.
BALANCES.ADDED	Triggered when a creator's new balances are scanned successfully.
BALANCES.UPDATED	Triggered when a creator's existing balances are updated.

TRANSACTIONS.ADDED

{
  "event": "TRANSACTIONS.ADDED",
  "name": "transactions added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

TRANSACTIONS.UPDATED

{
  "event": "TRANSACTIONS.UPDATED",
  "name": "transactions updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

PAYOUTS.ADDED

{
  "event": "PAYOUTS.ADDED",
  "name": "payouts added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

PAYOUTS.UPDATED

{
  "event": "PAYOUTS.UPDATED",
  "name": "payouts updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

BALANCES.ADDED

{
  "event": "BALANCES.ADDED",
  "name": "balances added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

BALANCES.UPDATED

{
  "event": "BALANCES.UPDATED",
  "name": "balances updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

Activity

The table below lists the webhook events available for activity.

Activity webhooks may deliver a maximum of up to 100 IDs in the items array. The recommended way to process this is to hit the "retrieve in bulk API" of the associated resource type, such as retrieve artists in bulk API, using the artist IDs listed in the items array from the webhook to get the latest data for the given IDs. Ideally, this should be done using a messaging queue system while respecting rate limits.

Webhook Event	Description
ACTIVITY-ARTISTS.ADDED	Triggered when a user's new artists' data is scanned successfully.
ACTIVITY-ARTISTS.UPDATED	Triggered when a user's existing artists' data is updated.
ACTIVITY-CONTENTS.ADDED	Triggered when a user's new contents' data is scanned successfully.
ACTIVITY-CONTENTS.UPDATED	Triggered when a user's existing contents' data is updated.

ACTIVITY-ARTISTS.ADDED

{
  "event": "ACTIVITY-ARTISTS.ADDED",
  "name": "artists added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

ACTIVITY-ARTISTS.UPDATED

{
  "event": "ACTIVITY-ARTISTS.UPDATED",
  "name": "artists updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

ACTIVITY-CONTENTS.ADDED

{
  "event": "ACTIVITY-CONTENTS.ADDED",
  "name": "contents added",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

ACTIVITY-CONTENTS.UPDATED

{
  "event": "ACTIVITY-CONTENTS.UPDATED",
  "name": "contents updated",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257",
    "items": [
      "0ccc5adf0d7d4eaabca56b58420f7da7",
      "27c01cb47d3f462eaba08a86dc7bab82",
      "c61610a33ca641caaec8f2655c1d49f8"
    ]
  }
}

Creator Discovery

The table below lists the webhook events available for creator discovery.

Webhook Event	Description
CREATOR_SEARCH_EXPORT.SUCCESS	Triggered when a creator search operation is successful.
CREATOR_SEARCH_EXPORT.FAILURE	Triggered when a creator search operation operation has failed.
PROFILE_ANALYTICS.SUCCESS	Triggered when a profile analytics operation is successful.
PROFILE_ANALYTICS.FAILURE	Triggered when a profile analytics operation operation has failed.
EMAIL_LOOKUP.SUCCESS	Triggered when an email lookup operation is successful.
EMAIL_LOOKUP.FAILURE	Triggered when an email lookup operation has failed.
AUDIENCE_OVERLAP.SUCCESS	Triggered when an audience overlap operation is successful.
AUDIENCE_OVERLAP.FAILURE	Triggered when an audience overlap operation has failed.

CREATOR_SEARCH_EXPORT.SUCCESS

{
  "event": "CREATOR_SEARCH_EXPORT.SUCCESS",
  "name": "Creator search successfull, report ready.",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data":
  {
      "job_id": "674c9030-640a-4c83-a680-666361044f67"
  }
}

CREATOR_SEARCH_EXPORT.FAILURE

{
  "event": "CREATOR_SEARCH_EXPORT.FAILURE",
  "name": "Creator search failure, please try again after sometime.",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data":
  {
      "job_id": "674c9030-640a-4c83-a680-666361044f67"
  }
}

PROFILE_ANALYTICS.SUCCESS

{
    "event": "PROFILE_ANALYTICS.SUCCESS",
    "name": "Profile analytics successfull, report ready",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

PROFILE_ANALYTICS.FAILURE

{
    "event": "PROFILE_ANALYTICS.FAILURE",
    "name": "Profile analytics failure, please retry after sometime.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

EMAIL_LOOKUP.SUCCESS

{
  "event": "EMAIL_LOOKUP.SUCCESS",
  "name": "email lookup is successfull, report ready.",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data":
  {
      "job_id": "674c9030-640a-4c83-a680-666361044f67"
  }
}

EMAIL_LOOKUP.FAILURE

{
  "event": "EMAIL_LOOKUP.FAILURE",
  "name": "email lookup has been failed, please try again after sometime.",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data":
  {
      "job_id": "674c9030-640a-4c83-a680-666361044f67"
  }
}

AUDIENCE_OVERLAP.SUCCESS

{
  "event": "AUDIENCE_OVERLAP.SUCCESS",
  "name": "Audience overlap analysis successfull, report ready.",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data":
  {
      "job_id": "674c9030-640a-4c83-a680-666361044f67"
  }
}

AUDIENCE_OVERLAP.FAILURE

{
  "event": "AUDIENCE_OVERLAP.FAILURE",
  "name": "Audience overlap analysis failed, please try again after sometime.",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data":
  {
      "job_id": "674c9030-640a-4c83-a680-666361044f67"
  }
}

Public Content

The table below lists the webhook events available for public content.

Webhook Event	Description
CONTENTS_FETCH.SUCCESS	Triggered when a submitted public content job is successful and data is ready to be served.
CONTENTS_FETCH.FAILURE	Triggered when a submitted public content job has failed.

CONTENTS_FETCH.SUCCESS

{
    "event": "CONTENTS_FETCH.SUCCESS",
    "name": "Contents fetch success.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

CONTENTS_FETCH.FAILURE

{
    "event": "CONTENTS_FETCH.FAILURE",
    "name": "Contents fetch failure, please retry after sometime.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

Public Comments

The table below lists the webhook events available for public comments.

Webhook Event	Description
CONTENT_COMMENTS_FETCH.SUCCESS	Triggered when a submitted public comments job is successful and data is ready to be served.
CONTENT_COMMENTS_FETCH.FAILURE	Triggered when a submitted public comments job has failed.

CONTENT_COMMENTS_FETCH.SUCCESSS

{
    "event": "CONTENT_COMMENTS_FETCH.SUCCESS",
    "name": "Comments fetch successful.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

CONTENT_COMMENTS_FETCH.FAILURE

{
    "event": "CONTENT_COMMENTS_FETCH.FAILURE",
    "name": "Comments fetch failed, please retry after sometime.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

Insights

The table below lists the webhook events available for insights.

Webhook Event	Description
COMMENTS_ANALYTICS.SUCCESS	Triggered when a submitted comments relevance job is successful and data is ready to be served.
COMMENTS_ANALYTICS.FAILURE	Triggered when a submitted comments relevance job has failed.
PROFILE_COMMENTS_ANALYTICS.SUCCESS	Triggered when a submitted purchase intent analysis job is successful and data is ready to be served.
PROFILE_COMMENTS_ANALYTICS.FAILURE	Triggered when a submitted purchase intent analysis job has failed.
BRANDFIT_ANALYSIS.SUCCESS	Triggered when a submitted brandfit analyis job is successful and data is ready to be served.
BRANDFIT_ANALYSIS.FAILURE	Triggered when a submitted brandfit analyis job has failed.

COMMENTS_ANALYTICS.SUCCESS

{
    "event": "COMMENTS_ANALYTICS.SUCCESS",
    "name": "Comments analytics successful, report ready",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

COMMENTS_ANALYTICS.FAILURE

{
    "event": "COMMENTS_ANALYTICS.FAILURE",
    "name": "Comments analytics failure, please retry after sometime.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

PROFILE_COMMENTS_ANALYTICS.SUCCESS

{
    "event": "PROFILE_COMMENTS_ANALYTICS.SUCCESS",
    "name": "Profile comments analytics successful, report ready",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

PROFILE_COMMENTS_ANALYTICS.FAILURE

{
    "event": "PROFILE_COMMENTS_ANALYTICS.FAILURE",
    "name": "Profile comments analytics failure, please retry after sometime.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

BRANDFIT_ANALYSIS.SUCCESS

{
    "event": "BRANDFIT_ANALYSIS.SUCCESS",
    "name": "Brandfit analysis successful.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

BRANDFIT_ANALYSIS.FAILURE

{
    "event": "BRANDFIT_ANALYSIS.FAILURE",
    "name": "Brandfit analysis failed, please retry after sometime.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

Safety

The table below lists the webhook events available for insights.

Webhook Event	Description
SAFETY_FETCH.SUCCESS	Triggered when a submitted safety analysis job is successful and data is ready to be served.
SAFETY_FETCH.FAILURE	Triggered when a submitted safety analysis job has failed.

SAFETY_FETCH.SUCCESS

{
    "event": "SAFETY_FETCH.SUCCESS",
    "name": "Your safety report is ready to download.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

SAFETY_FETCH.FAILURE

{
    "event": "SAFETY_FETCH.FAILURE",
    "name": "Your safety report failed, please retry after sometime.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

The table below lists the webhook events available for social listening.

Webhook Event	Description
CONTENTS_SEARCH.SUCCESS	Triggered when a submitted social listening job is successful and data is ready to be served.
CONTENTS_SEARCH.FAILURE	Triggered when a submitted social listening job has failed.

CONTENTS_SEARCH.SUCCESS

{
    "event": "CONTENTS_SEARCH.SUCCESS",
    "name": "Contents search success.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

CONTENTS_SEARCH.FAILURE

{
    "event": "CONTENTS_SEARCH.FAILURE",
    "name": "Contents search failure, please retry after sometime.",
    "id": "674c9030-640a-4c83-a680-666361044f67",
    "data":
    {
        "job_id": "674c9030-640a-4c83-a680-666361044f67"
    }
}

Publish

The table below lists the webhook events available for publish APIs.

The recommended way to process this is to hit the check status of content publish API using the publish_id from the webhook to get the latest status of the content publish request.

Webhook Event	Description
CONTENTS.PUBLISH_SUCCESS	Triggered when a content is published successfully to the platform.
CONTENTS.PUBLISH_FAILURE	Triggered when content publishing fails at the platform end.
CONTENTS.PUBLISH_READY	Triggered when a content is uploaded to the platform under the given account and is ready to be published via further steps.

CONTENTS.PUBLISH_SUCCESS

{
  "event": "CONTENTS.PUBLISH_SUCCESS",
  "name": "contents publish success",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "711c36fccb2b4304afb4bcd14e6bfbdd",
    "user_id": "0e3808ca12174c0082381fc5653f9538",
    "publish_id": "bdec2a8924d14904b022b90c8a463559",
    "last_updated_time": "2021-11-10T10:09:11.304556"
  }
}

CONTENTS.PUBLISH_FAILURE

{
  "event": "CONTENTS.PUBLISH_FAILURE",
  "name": "contents publish failure",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "711c36fccb2b4304afb4bcd14e6bfbdd",
    "user_id": "0e3808ca12174c0082381fc5653f9538",
    "publish_id": "bdec2a8924d14904b022b90c8a463559",
    "last_updated_time": "2021-11-10T10:09:11.304556"
  }
}

CONTENTS.PUBLISH_READY

{
  "event": "CONTENTS.PUBLISH_READY",
  "name": "contents ready to be published",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "4544993eac6f4c4a9ec27e23f6cb8c56",
    "user_id": "6bd84fa308f84e66abf108fd3d29f9ef",
    "publish_id": "74e5f67b9df04cbeba0894d749561447",
    "last_updated_time": "2021-11-10T12:59:51.874364"
  }
}

Session expired

The table below lists the webhook events available for session expiry (when a creator's access token expires or is invalid).

The recommended way to process this is to inform and nudge your users to reconnect their accounts via mechanisms such as push notifications and emails.

Webhook Event	Description
SESSION.EXPIRED	Triggered when a creators OAuth access token is expired/invalid

SESSION.EXPIRED

{
  "event": "SESSION.EXPIRED",
  "name": "OAuth token session expired",
  "id": "674c9030-640a-4c83-a680-666361044f67",
  "data": {
    "account_id": "f9ed198434094d498473953cade79f5e",
    "user_id": "8145c37cb1744bcf9dd6f90548af9089",
    "last_updated_time": "2021-11-10T10:09:09.704257"
  }
}

Was this helpful?

Webhook Events

Accounts

Profiles

Profile Audience

Content

Content Comments

Content Groups

Income

Activity

Creator Discovery

Public Content

Public Comments

Insights

Safety

Social Listening

Publish

Session expired