YouScan Webhook API
Webhooks push new mentions to your own server in real time, so you don't have to poll theAPI. 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.### SetupWebhooks are configured in the YouScan UI — there is **no API to create them**. Open atopic's **Settings → Integrations**, click **Add** next to *Webhook*, and enter yourdestination 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 endpointRespond with any `2xx` status code within **4 minutes** to acknowledge receipt; any otherresponse — or a timeout — is treated as a failed delivery. Fields with `null` values areomitted 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.
YouScan Webhook API is one of 8 APIs that YouScan publishes on the 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.
This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://api.youscan.io/api/external.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
YouScan Webhook API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-API-KEY (ApiKeyHeader).
An API key is passed in the query as apiKey (ApiKeyQuery).
By default, every request must be authenticated.
ApiKeyHeader— API key authentication. The recommended way to authenticate requests.ApiKeyQuery— API key as a query parameter. For testing purposes only.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Webhooks push new mentions to your own server in real time, so you don't have to poll the API.
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are WebhookMention (45 properties), WebhookProfile (8 properties), Reactions (7 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from YouScan 7
Other APIs YouScan publishes across the network.
This is an independent, third-party profile of YouScan Webhook API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.