Org.AI FoundationSchemaPartner

Webhook

A webhook endpoint that receives event-driven notifications.

Kind of
WebAPI
Properties
None of its own40 more from 3 types above it
Source
The .org.ai superset

Read the 40 properties JSON-LDMarkdown

Properties

All 40 are inherited. Each says what kind of value it takes.

From WebAPI1
PropertyValueWhat it means
documentationValue: CreativeWork or URL

Further documentation describing the Web API in more detail.

From Service25
PropertyValueWhat it means
aggregateRatingValue: AggregateRating

The overall rating, based on a collection of reviews or ratings, of the item.

areaServedValue: AdministrativeArea, GeoShape, Place or Text

The geographic area where a service or offered item is provided.

audienceValue: Audience

An intended audience, i.e. a group for whom something was created.

availableChannelValue: ServiceChannel

A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).

awardValue: Text

An award won by or for this item.

brandValue: Brand or Organization

The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.

brokerValue: Organization or Person

An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.

categoryValue: CategoryCode, PhysicalActivityCategory, Text, Thing or URL

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

hasCertificationValue: Certification

Certification information about a product, organization, service, place, or person.

hasOfferCatalogValue: OfferCatalog

Indicates an OfferCatalog listing for this Organization, Person, or Service.

hoursAvailableValue: OpeningHoursSpecification

The hours during which this service or contact is available.

isRelatedToValue: Product or Service

A pointer to another, somehow related product (or multiple products).

isSimilarToValue: Product or Service

A pointer to another, functionally similar product (or multiple products).

offersValue: Demand or Offer

An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use businessFunction to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a Demand. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.

producesSupersededValue: Thing

Superseded by serviceOutput.

The tangible thing generated by the service, e.g. a passport, permit, etc.

providerValue: Organization or Person

The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.

providerMobilityValue: Text

Indicates the mobility of a provided service (e.g. 'static', 'dynamic').

reviewValue: Review

A review of the item.

serviceAreaSupersededValue: AdministrativeArea, GeoShape or Place

Superseded by areaServed.

The geographic area where the service is provided.

serviceAudienceSupersededValue: Audience

Superseded by audience.

The audience eligible for this service.

serviceOutputValue: Thing

The tangible thing generated by the service, e.g. a passport, permit, etc.

serviceTypeValue: GovernmentBenefitsType or Text

The type of service being offered, e.g. veterans' benefits, emergency relief, etc.

sloganValue: Text

A slogan or motto associated with the item.

termsOfServiceValue: Text or URL

Human-readable terms of service documentation.

From Thing14
PropertyValueWhat it means
additionalTypeValue: Text or URL

An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.

alternateNameValue: Text

An alias for the item.

descriptionValue: Text or TextObject

A description of the item.

digital.org.aiValue: Number

Digital maturity score from 0.0 (fully analog/manual) to 1.0 (fully digital/autonomous). Indicates the degree to which an entity operates digitally.

disambiguatingDescriptionValue: Text

A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

identifierValue: PropertyValue, Text or URL

The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.

imageValue: ImageObject or URL

An image of the item. This can be a URL or a fully described ImageObject.

mainEntityOfPageValue: CreativeWork or URL

Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.

nameValue: Text

The name of the item.

ownerValue: Organization or Person

A person or organization who owns this Thing.

potentialActionValue: Action

Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

sameAsValue: URL

URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

subjectOfValue: CreativeWork or Event

A CreativeWork or Event about this Thing.

urlValue: URL

URL of the item.

Where this comes from

Written by the Org.AI Foundation, for the .org.ai superset of Schema.org.

  1. Published by
    The Org.AI FoundationThe .org.ai superset of Schema.org
  2. Defined in
  3. License
    CC BY-SA 4.0Free to copy and adapt, with credit, under the same licence
  4. Written by
    Us.

Use this type

Its definition is free to reuse, with credit to the Org.AI Foundation. The same type is here as data, for programs and for language models.

Partner with us

Fund the next pass, contribute data, or build on the record. Tell us what you have in mind.

Partner with us