Streams API & Webhooks

Streams is Yext's cutting-edge architecture developed to streamline the delivery of data from the Knowledge Graph to consumer-facing systems, like Answers, Pages, and Listings. Yext products are pre-built to deliver data, but if you are looking to dive deeper into the technology, streams can power any external applications. This means software developers can leverage our flexible, low-latency infrastructure to push and pull data, traverse relationships across entities, and power their own applications.

{$headline}
Streams Endpoint

A Streams Endpoint enables external users to interface with the entire Streams architecture. Users create their own unique Streams Endpoint with our configuration resources, where they can list out specific fields that they want to access from the Knowledge Graph. In addition to requesting a list of fields, users can filter the set of data, and specify which fields should be indexed for queries to the API.

Streams API

The Streams API is Yext's low-latency, consumer-grade API intended to fetch content from Streams Endpoints for publishing in consumer experiences. The data fetched is pre-processed according to the configuration of the Streams Endpoint, ensuring that the query is extremely fast since there is no requirement to traverse the graph at query time.

Streams Webhook

The Streams Webhooks allow applications to receive proactive updates about changes to the data within a Streams Endpoint in a push data flow. Just like the Streams API, Streams Webhooks follow the configuration of the Streams Endpoint. Once a webhook is configured for that Endpoint, the application will receive POST messages whenever there is an update to the relevant fields.

Relationship Traversal

Streams introduces a new way to traverse entity relationships, including support for "multi-hops,'' where users can reference data across multiple relationships. For example, Streams could enable users to search the hours of a particular location that carries the pink color variant of a parent sneaker SKU. Or users could query the doctors who accept a specific insurance plan, who also treat a specific condition through their list of available treatments.

Custom Configuration

The Streams infrastructure allows users to query any combination of fields in the Yext Knowledge Graph, across entity relationships, and even across other data sources, including Reviews. Since users define exactly the fields they want to receive in a Streams Endpoint configuration, the data gets pre-processed (at index time) so that at query time, the system does not need to traverse the Knowledge Graph to return results.

Streams CLI Commands

The Yext CLI has a set of Streams commands which will provide users visibility into the Streams associated with their Streams Endpoint. These CLI Commands will also help you debug the Streams Endpoint if necessary. You can learn all about how to use these commands in our CLI documentation.

Reviews in Streams Endpoints

Streams Endpoints for Reviews allows you to fetch reviews data, including individual reviews and aggregate statistics about your reviews, while optionally filtering on data from the relevant entity. Since Streams API is low-latency and consumer-grade, Streams API is perfect for fetching your review data to display within your consumer-facing application, such as a web page.

Want to become a Yext Expert?

Join Hitchhikers, the new Yext training platform and community, to test your knowledge, earn badges, and engage with the experts.
Create your free account
Environmental Image

One Platform. Unlimited Solutions.

A great search experience is key to a great brand experience — on and off your website. Answer customers' questions and convert more business across digital channels with AI\-powered marketing solutions from Yext.

Explore

Answer support questions before they become support tickets. Streamline the resolution process with Yext's modern, AI\-powered customer support solutions.

Explore

Create an intuitive ecommerce search and discovery experience so you can meet your customers with direct answers every step of the way. Streamline the digital customer journey and turn your website into a conversion engine with AI\-powered ecommerce solutions from Yext.

Create an intuitive ecommerce search and discovery experience so you can meet your customers with direct answers every step of the way.

Streamline the digital customer journey and turn your website into a conversion engine with AI-powered ecommerce solutions from Yext.

Employees need company information to do their jobs. Make it easy, fast, and fun to find with AI\-powered workplace search solutions from Yext.

Employees need company information to do their jobs. Make it easy, fast, and fun to find with AI-powered workplace search solutions from Yext.

Explore

Build on the Yext platform for a fully custom AI search experience — fast. With SDKs, APIs, and robust documentation, the Yext Answers platform provides the building blocks to create a bespoke search experience.

Build on the Yext platform for a fully custom AI search experience — fast. With SDKs, APIs, and robust documentation, the Yext Answers platform provides the building blocks to create a bespoke search experience.

Explore