Listings: Webhook Webhook
Sends an updated Listing object to your server.
Request Body schema: application/json
The updated Listing
object | |
object |
Request samples
- Payload
Content type
application/json
{- "meta": {
- "eventType": "LISTING_UPDATED",
- "uuid": "string",
- "timestamp": "string",
- "accountId": "string",
- "appSpecificAccountId": "string"
}, - "listing": {
- "id": "string",
- "locationId": "string",
- "accountId": "string",
- "publisherId": "string",
- "status": "WAITING_ON_YEXT",
- "additionalStatus": "CONNECTED",
- "listingUrl": "string",
- "loginUrl": "string",
- "screenshotUrl": "string",
- "statusDetails": [
- {
- "code": "string",
- "type": "UNAVAILABLE_REASON",
- "message": "string",
- "actionable": true,
- "unavailableReasonType": "string"
}
], - "alternateBrands": [
- {
- "brandName": "string",
- "listingUrl": "string"
}
]
}
}Entity Listings: Webhook Webhook
Sends an updated Entity Listing object to your server. This endpoint currently only supports Event Listings.
Request Body schema: application/json
The updated Listing
object | |
object |
Request samples
- Payload
Content type
application/json
{- "meta": {
- "eventType": "LISTING_UPDATED",
- "uuid": "string",
- "timestamp": "string",
- "accountId": "string",
- "appSpecificAccountId": "string"
}, - "listing": {
- "id": "string",
- "entityId": "string",
- "accountId": "string",
- "publisherId": "string",
- "status": "NOT_SYNCED",
- "listingUrl": "string",
- "statusDetails": [
- {
- "code": "string",
- "type": "UNAVAILABLE_REASON",
- "message": "string",
- "actionable": true,
- "unavailableReasonType": "string"
}
]
}
}Duplicates: Webhook Webhook
Sends an updated Duplicate object to your server.
Request Body schema: application/json
The updated Duplicate
object | |
object |
Request samples
- Payload
Content type
application/json
{- "meta": {
- "eventType": "DUPLICATE_FOUND",
- "uuid": "string",
- "timestamp": "string",
- "accountId": "string",
- "appSpecificAccountId": "string"
}, - "duplicate": {
- "id": "string",
- "publisherId": "string",
- "locationId": "string",
- "url": "string",
- "name": "string",
- "address": "string",
- "phone": "string",
- "latitude": "string",
- "longitude": "string",
- "status": "POSSIBLE_DUPLICATE",
- "suppressionType": "REDIRECT",
- "unavailableReasons": [
- {
- "code": "string",
- "reason": "string"
}
]
}
}Publisher Suggestions: Webhook Webhook
Sends an updated Publisher Suggestion object to your server.
Request Body schema: application/json
The updated Publisher Suggestion
object | |
object |
Request samples
- Payload
Content type
application/json
{- "meta": {
- "eventType": "PUBLISHER_SUGGESTION_UPDATED",
- "uuid": "string",
- "timestamp": "string",
- "accountId": "string",
- "appSpecificAccountId": "string"
}, - "publisherSuggestion": {
- "id": "string",
- "publisherId": "string",
- "locationId": "string",
- "dateCreated": "2019-08-24",
- "dateResolved": "2019-08-24",
- "fieldName": "string",
- "status": "WAITING_ON_CUSTOMER",
- "resolvedBy": "string",
- "originalContent": "string",
- "suggestedContent": "string"
}
}Q&A: Webhook Webhook
Sends an updated Question object to your server whenever a Question or one of its Answers are created or modified.
Request Body schema: application/json
The updated Question
object | |
object |
Request samples
- Payload
Content type
application/json
{- "meta": {
- "eventType": "QUESTION_CREATED",
- "uuid": "string",
- "timestamp": "string",
- "accountId": "string",
- "appSpecificAccountId": "string"
}, - "question": {
- "id": "string",
- "entityIds": [
- "string"
], - "accountId": "string",
- "publisherId": "string",
- "authorName": "string",
- "authorEmail": "string",
- "authorPhotoUrl": "string",
- "authorType": "REGULAR_USER",
- "language": "string",
- "upvoteCount": 0,
- "content": "string",
- "description": "string",
- "createTime": 0,
- "updateTime": 0,
- "answerCount": 0,
- "answers": [
- {
- "id": 0,
- "authorName": "string",
- "authorPhotoUrl": "string",
- "authorType": "REGULAR_USER",
- "upvoteCount": 0,
- "content": "string",
- "createTime": 0,
- "updateTime": 0
}
]
}
}