REST API Endpoint & Webhook Action Schema (JSON-LD Blueprint)
Structured data for specific HTTP REST endpoints, webhook listeners, and serverless actions with URI templates, HTTP methods, and payload requirements.
Displayed below main page header or above the tool container. • Zero CLS Container
Production JSON-LD Code Block
Embed this structured data block directly into your HTML <head> or framework layout template.
{
"@context": "https://schema.org",
"@type": "WebAPI",
"@id": "https://omniseotools.com/api/v1/validate-schema#endpoint",
"name": "JSON-LD Schema Validation REST Endpoint",
"description": "Programmatic endpoint for linting raw Schema.org structured data graphs and auditing Google Rich Results compliance.",
"documentation": "https://omniseotools.com/docs/api/endpoints/validate",
"provider": {
"@type": "Organization",
"name": "OmniSEO Tools"
},
"potentialAction": {
"@type": "Action",
"target": {
"@type": "EntryPoint",
"urlTemplate": "https://api.omniseotools.com/v1/schema/validate",
"httpMethod": "POST",
"contentType": "application/json",
"encodingType": "application/json"
},
"resultReview": {
"@type": "Review",
"reviewBody": "Returns real-time syntax error mapping and Google compliance scoring."
}
}
}Typed Properties Specification (6 Fields)
Key Schema.org properties and sub-objects required to qualify for rich snippet treatment in Google Search.
| Property | Expected Type | Status | Description & Example |
|---|---|---|---|
| target | EntryPoint | Required | Target URI endpoint with HTTP method and supported payload formats. e.g. { "@type": "EntryPoint", "urlTemplate": "..." } |
| httpMethod | Text | Required | Standard HTTP verb (GET, POST, PUT, DELETE, PATCH). e.g. POST |
| resultReview / potentialAction | Action | Required | Action encapsulation defining input and expected output. e.g. { "@type": "Action", ... } |
| provider | Organization | Required | Entity maintaining the endpoint infrastructure. e.g. { "@type": "Organization", "name": "..." } |
| documentation | URL | Required | Endpoint-specific parameter documentation URL. e.g. https://.../validate |
| contentType | Text | Recommended | Accepted request body MIME type (e.g. application/json). e.g. application/json |
Google Search Console Pitfalls & Critical Warnings
Avoid these 3 common validation traps, parser errors, and algorithmic policy penalties when deploying WebAPI schema.
Non-Standard httpMethod String
Writing 'post' in lowercase or using unsupported custom method tokens.
Always supply uppercase RFC standard methods (GET, POST, PUT, DELETE, PATCH).
Missing contentType Parameter Format
Omitting MIME encoding causing client integration ambiguity.
Explicitly set contentType to 'application/json' or 'multipart/form-data'.
Inconsistent Provider Attribution
Mismatched provider node vs host domain name.
Link provider to canonical Organization node.
Recommended Implementation Scenarios
Related Schema Blueprints
Explore complementary structured data blueprints across the Technical SEO cluster.
WebAPI & RESTful Microservice Schema Markup (JSON-LD Blueprint)
APIDocumentation & Developer Guide Schema (JSON-LD Blueprint)
TechSpec & RFC Architecture Schema (JSON-LD Blueprint)
SoftwareApplication & SaaS Schema Markup (JSON-LD)
Displayed below main page header or above the tool container. • Zero CLS Container