Reviews: Webhook Webhook
Sends an updated Review object to your server whenever a Review or one of its Comments are created or modified on the publisher's site.
NOTE: Not all publishers' reviews will be sent. For more details, please contact your Account Manager.
Request Body schema: application/json
The updated Review
object | |
object |
Request samples
- Payload
Content type
application/json
{- "meta": {
- "eventType": "REVIEW_CREATED",
- "uuid": "string",
- "timestamp": "string",
- "accountId": "string",
- "appSpecificAccountId": "string"
}, - "review": {
- "id": 0,
- "entityId": "string",
- "accountId": "string",
- "publisherId": "string",
- "rating": 0,
- "title": "string",
- "content": "string",
- "authorName": "string",
- "authorEmail": "string",
- "url": "string",
- "publisherDate": 0,
- "lastYextUpdateTime": 0,
- "status": "LIVE",
- "flagStatus": "FLAGGED",
- "reviewLanguage": "string",
- "mediaItems": [
- {
- "thumbnailUrl": "string",
- "thumbnailLabel": "string",
- "videoUrl": "string"
}
], - "comments": [
- {
- "id": 0,
- "parentId": 0,
- "publisherDate": 0,
- "authorName": "string",
- "authorEmail": "string",
- "authorRole": "BUSINESS_OWNER",
- "content": "string",
- "visibility": "PUBLIC",
- "date": "2019-08-24",
- "suppressReviewerContact": true,
- "attestation": {
- "reviewerWasPaid": true,
- "reviewerIsClient": true,
- "isConflictOfInterest": true,
- "conflictOfInterestDetails": "string"
}
}
], - "reviewLabels": [
- {
- "id": 0,
- "name": "string"
}
], - "reviewType": "Rating",
- "recommendation": "Recommended",
- "transactionId": "string",
- "invitationId": "string",
- "apiIdentifier": "string"
}
}Reviews Invitations: Webhook Webhook
Sends an updated invitation object to your server whenever a new invitation is added to our system.
Request Body schema: application/json
The new Review Invitation
object | |
object |
Request samples
- Payload
Content type
application/json
{- "meta": {
- "eventType": "INVITATION_ADDED",
- "uuid": "string",
- "timestamp": "string",
- "accountId": "string",
- "appSpecificAccountId": "string"
}, - "invitation": {
- "id": "string",
- "locationId": "string",
- "partnerLocationId": "string",
- "locale": "string",
- "country": "string",
- "generationUrl": "string",
- "googleListingUrl": "string",
- "facebookListingUrl": "string",
- "firstName": "string",
- "lastName": "string",
- "titleName": "string",
- "contact": "string",
- "type": "EMAIL",
- "partnerId": "string",
- "templateId": "string",
- "language": "string"
}
}