Webhook Documentation (1.0)

Download OpenAPI specification:Download

This is the Webhook section description

Webhooks

Notify Review Webhook

Publishers use this endpoint to notify Yext of review activity on listings. Specifically:

A new review has been posted
A new comment has been posted on an existing review
A review has been suppressed due to abuse reports

query Parameters

api_key

string

Publisher api key

Request Body schema: application/json

listingId required	string Publisher Listing ID
total required	string Total number of reviews on the listing, overall
timestamp required	string Official time the event occurred
averageRating	string The average rating across all reviews for this listing (of which there are total)
required	Array of objects (PartnerReview) A list containing one element - the updated review

Responses

Request samples

Payload

Content type

application/json

{"listingId": "5269143",
"total": "25",
"timestamp": "2020-01-02T13:15:53Z",
"averageRating": "3.4",
"reviews": [{"reviewId": "5382",
"status": "ACTIVE",
"timestamp": "2020-01-01T13:15:53Z",
"authorName": "Dana Smith",
"title": "Great falafel",
"content": "Went there for lunch and had the best sandwich of my life.",
"url": "http://www.partner.com/listings/382384/reviews/5382",
"rating": "4.5",
"maxRating": "string",
"flagReason": "INAPPROPRIATE_CONTENT",
"comments": [{"commentId": "832813382",
"timestamp": "2020-01-04T13:15:53Z",
"authorName": "Gomez Adams",
"content": "The hummus is good too!",
"ownerResponse": true
}
],
"generated": true
}
]
}

Notify Suggestion Webhook

Publishers use this endpoint to notify Yext of data suggestion on listings. Specifically, notifications for:

a new suggestion has been received
an existing suggestion has been update