Yext Publisher Notify Review API icon

Yext Publisher Notify Review API

Interact with Yext Publisher Notify Review API

Actions2

Webhooks → Notify Suggestion

AI-generated

Summary

Notify Yext of a suggestion event for a specific publisher listing by sending event details such as listing ID, event type, timestamp, and suggestion data.

Inputs

  • Listing Id (required) — Publisher Listing ID identifying the listing for which the suggestion notification is sent.
  • Event Type (required) — Type of suggestion event to notify, either 'SUGGESTION_CREATED' or 'SUGGESTION_UPDATED'.
  • Timestamp (required) — ISO 8601 timestamp representing the official time the event occurred.
  • Suggestion (required) — JSON object containing details of the suggestion, including id, affected field, timestamp, currentValue, and proposedValue.

Output shape

a single response object indicating the result of the notify operation

The API call sends a JSON body with all parameters included. The output contains the HTTP response from Yext's API, generally confirming receipt or failure. Request options such as batching, timeouts, proxy, and SSL certificate handling can be configured but do not affect output shape.

Discussion