---
title: "Mention found"
method: POST
path: "/your-webhook-endpoint"
tags: ["Webhook"]
---

# Mention found

`POST /your-webhook-endpoint`

## Request

- Base URL: `https://your-app.example`
- URL: `https://your-app.example/your-webhook-endpoint`
- Auth: none required
- TypeScript: <https://skmtc.dev/youscan/apis/youscan-api/docs/your-webhook-endpoint/post.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Request body

- WebhookMention
  - `topicId` integer, required: Topic ID.
  - `topicName` string: Topic name.
  - `themeId` integer: Legacy duplicate of `topicId`.
  - `themeName` string: Legacy duplicate of `topicName`.
  - `mentionId` integer, required: Mention identifier.
  - `sourceName` string: Mention source (domain).
  - `author` WebhookProfile
    - `url` string: Link to the profile.
    - `name` string
    - `nickname` string
    - `profileId` string: Profile ID in the source system.
    - `profileType` string: Profile type, specific to the source.
    - `avatarUrl` string: Avatar image URL.
    - `subscribers` integer: Number of subscribers (followers, friends).
    - `age` integer: Author age. Sent only for accounts with the extended webhook feature enabled.
  - `channel` WebhookProfile
    - `url` string: Link to the profile.
    - `name` string
    - `nickname` string
    - `profileId` string: Profile ID in the source system.
    - `profileType` string: Profile type, specific to the source.
    - `avatarUrl` string: Avatar image URL.
    - `subscribers` integer: Number of subscribers (followers, friends).
    - `age` integer: Author age. Sent only for accounts with the extended webhook feature enabled.
  - `title` string: Mention title.
  - `text` string: Mention text.
  - `url` string: Direct URL to the mention.
  - `published` string, date-time, required: Date when the mention was published (ISO 8601 format).
  - `addedAt` string, date-time: Date when the mention was saved to the topic (ISO 8601 format).
  - `sentiment` 'positive' | 'neutral' | 'negative' | 'undefined'
  - `imageUrl` string: URL to the mention image.
  - `language` string: 3-letter ISO 639 language code.
  - `postType` 'post' | 'repost' | 'extendedRepost' | 'comment', required
  - `resourceType` 'social' | 'blog' | 'forum' | 'messenger' | 'news' | 'reviews' | 'other', required: Source type.
  - `spam` boolean: Whether the mention is marked as spam.
  - `rating` number: Rating (for reviews).
  - `tags` string[]: List of tag names.
  - `postId` string: External post ID.
  - `parentPostId` string: External ID of the parent post.
  - `discussionId` string: External ID of the root discussion.
  - `likes` integer
  - `reposts` integer
  - `comments` integer
  - `engagement` integer: Sum of likes, reposts and comments.
  - `dislikes` integer
  - `views` integer
  - `impressions` integer
  - `reach` integer
  - `saves` integer
  - `reactions` Reactions
    - `total` integer: Total number of reactions.
    - `angry` integer, nullable
    - `haha` integer, nullable
    - `love` integer, nullable
    - `sad` integer, nullable
    - `wow` integer, nullable
    - `care` integer, nullable
  - `contentTypes` string[]
  - `collectionMethods` string[]: 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.
  - `country` string: ISO alpha-2 country code.
  - `region` string
  - `city` string
  - `potentialReach` integer: Potential reach.
  - `imageScenes` string[]: Scenes detected on the image. Requires the Visual Insights option.
  - `imageObjects` string[]: Objects detected on the image. Requires the Visual Insights option.
  - `imageColors` string[]: HEX color codes detected on the image. Requires the Visual Insights option.
  - `imageActivities` string[]: Activities detected on the image. Requires the Visual Insights option.
  - `imageBrands` string[]: Brands detected on the image. Requires the Visual Insights option.

## Response `200`

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

## Other responses

- `4XX`: YouScan treats any non-2xx response — or no response within 4 minutes — as a failed delivery.

---

[API](https://skmtc.dev/youscan/apis/youscan-api.md) - [All operations](https://skmtc.dev/youscan/apis/youscan-api/llms.txt) - [OpenAPI document](https://skmtc.dev/youscan/apis/youscan-api/revisions/f5bef260f153?raw)