# YouScan Webhook API

**Canonical:** https://apis.io/apis/youscan/youscan-webhook-api/  
**Provider:** YouScan — https://apis.io/providers/youscan/  
**Base URL:** https://api.youscan.io/api/external  
**Documentation:** https://developers.youscan.io/

YouScan Webhook API is one of 8 APIs that [YouScan](https://apis.io/providers/youscan/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

Webhooks push new mentions to your own server in real time, so you don't have to poll the API. Every time a new mention is found and saved to a topic, YouScan sends an HTTP `POST` with the mention payload to a URL you control. ### Setup Webhooks are configured in the YouScan UI — there is **no API to create them**. Open a topic's **Settings → Integrations**, click **Add** next to *Webhook*, and enter your destination URL. Full guide: [How to use webhook integration](https://help.youscan.io/en/articles/3371690-how-to-use-webhook-integration). - Set up **per topic** — point several topics at the same URL, or add several webhooks to one topic. - Mentions are sent **automatically** via rule-based alerts, and can also be sent **manually** from the mention stream. - For a protected endpoint, put Basic Auth credentials in the URL: `https://user:password@example.com/callback`. ### Your endpoint Respond with any `2xx` status code within **4 minutes** to acknowledge receipt; any other response — or a timeout — is treated as a failed delivery. Fields with `null` values are omitted from the payload. > Mentions from Reddit, Quora and some smaller sources are not delivered. Twitter mentions > are restricted — text, URL and author details are removed.

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/youscan/refs/heads/main/openapi/youscan-webhook-api-openapi.yml
- **LLMsTxt** — https://raw.githubusercontent.com/api-evangelist/youscan/refs/heads/main/llms/youscan-llms.txt
- **Documentation** — https://developers.youscan.io/
- **APIReference** — https://developers.youscan.io/api/

## Other YouScan APIs (7)

- [YouScan Data Import API](https://apis.io/apis/youscan/youscan-data-import-api/)
- [YouScan History API](https://apis.io/apis/youscan/youscan-history-api/)
- [YouScan Mentions API](https://apis.io/apis/youscan/youscan-mentions-api/)
- [YouScan Spaces API](https://apis.io/apis/youscan/youscan-spaces-api/)
- [YouScan Statistics API](https://apis.io/apis/youscan/youscan-statistics-api/)
- [YouScan Tags API](https://apis.io/apis/youscan/youscan-tags-api/)
- [YouScan Topics API](https://apis.io/apis/youscan/youscan-topics-api/)

## Tags

Webhook

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/youscan/youscan-webhook-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/youscan/.