YOyouscan
Webhook

Mention found

Sent by YouScan to the URL you configured, every time a new mention is found and saved to the topic. Fields with null values are omitted from the payload.

post/your-webhook-endpoint

Request

Request body

topicIdinteger required

Topic ID.

topicNamestring

Topic name.

themeIdinteger

Legacy duplicate of topicId.

themeNamestring

Legacy duplicate of topicName.

mentionIdinteger required

Mention identifier.

sourceNamestring

Mention source (domain).

titlestring

Mention title.

textstring

Mention text.

urlstring

Direct URL to the mention.

publishedstring date-time required

Date when the mention was published (ISO 8601 format).

addedAtstring date-time

Date when the mention was saved to the topic (ISO 8601 format).

sentiment'positive' | 'neutral' | 'negative' | 'undefined'
imageUrlstring

URL to the mention image.

languagestring

3-letter ISO 639 language code.

postType'post' | 'repost' | 'extendedRepost' | 'comment' required
resourceType'social' | 'blog' | 'forum' | 'messenger' | 'news' | 'reviews' | 'other' required

Source type.

spamboolean

Whether the mention is marked as spam.

ratingnumber

Rating (for reviews).

tagsstring[]

List of tag names.

postIdstring

External post ID.

parentPostIdstring

External ID of the parent post.

discussionIdstring

External ID of the root discussion.

likesinteger
repostsinteger
commentsinteger
engagementinteger

Sum of likes, reposts and comments.

dislikesinteger
viewsinteger
impressionsinteger
reachinteger
savesinteger
contentTypesstring[]
collectionMethodsstring[]

How the mention was matched into the topic: text by the text query, ocrText by text recognised on an image, imageLogo by a detected logo, imageFeature by other image attributes, audio by a transcript, channel by an owned page, manual when added by hand, import when uploaded. A mention can match through several methods at once.

sourceFormat'instagramReels' | 'instagramStories' | 'pinterestStoryPins' | 'youTubeShorts' | 'facebookReels' | 'facebookStories' | 'tikTokPhoto' | 'twitterNote' | 'youTubeLive' | 'facebookLive' | 'twitchLive' | 'twitterCommunityNote'

Source-specific format of the post.

countrystring

ISO alpha-2 country code.

regionstring
citystring
potentialReachinteger

Potential reach.

imageScenesstring[]

Scenes detected on the image. Requires the Visual Insights option.

imageObjectsstring[]

Objects detected on the image. Requires the Visual Insights option.

imageColorsstring[]

HEX color codes detected on the image. Requires the Visual Insights option.

imageActivitiesstring[]

Activities detected on the image. Requires the Visual Insights option.

imageBrandsstring[]

Brands detected on the image. Requires the Visual Insights option.

Response

Return any 2xx status code to acknowledge receipt of the mention.

Changes

No recorded changes to this operation across all 1 revision of this API.