Here's an example of the payload that we will send to your webhook.
This is not an interactive endpoint but it documents the JSON we send to your webhook URL. You can set your webhook URL in your Company Settings
{
"formId": "1",
"formTitle": "Rejected after Interview Candidates",
"ratingId": "426",
"emailAddress": "[email protected]",
"senderEmailAddress": "[email protected]",
"elements": [
{
"elementId": 6,
"elementTitle": "NPS",
"elementType": "nps",
"elementData": [
{
"questionId": "1",
"subject": "NPS",
"question": "How likely is it that you would recommend us to a friend or a colleague?",
"response": "7",
"responseComment": "Response comment"
},
{
"questionId": "2",
"subject": "General feedback",
"question": "Your general feedback on our company:",
"response": "Some text"
}
]
},
{
"elementId": 7,
"elementTitle": "CES",
"elementType": "ces",
"elementData": [
{
"questionId": "1",
"question": "How much effort did you personally have to put forth to handle your request?",
"response": "4"
},
{
"questionId": "2",
"question": "How could we have made it easier for you?",
"responseComment": "Very Easy"
}
]
},
{
"elementId": 9,
"elementTitle": "Questions",
"elementType": "grid5x5",
"elementData": [
{
"questionId": "1",
"subject": "Are you a dev?",
"question": "",
"response": "1",
"responseComment": ""
},
{
"questionId": "2",
"subject": "Are you a team lead?",
"question": "",
"response": "2",
"responseComment": "No"
},
{
"questionId": "3",
"subject": "Are you a human?",
"question": "",
"response": "1",
"responseComment": "Yes indeed."
},
{
"questionId": "4",
"subject": "Are you happy?",
"question": "",
"response": "2",
"responseComment": ""
}
]
},
{
"elementId": 10,
"elementTitle": "",
"elementType": "grid5x5",
"elementData": [
{
"questionId": "1",
"subject": "Service",
"question": "",
"response": "9",
"responseComment": "Great"
},
{
"questionId": "2",
"subject": "Food",
"question": "",
"response": "7",
"responseComment": ""
},
{
"questionId": "3",
"subject": "Space",
"question": "",
"response": "8",
"responseComment": ""
},
{
"questionId": "4",
"subject": "Staff",
"question": "",
"response": "8",
"responseComment": ""
}
]
}
],
"nps": "8",
"companyId": "32",
"dateInvitationSent": "2018-02-07 14:23:01",
"dateResponseRecieved": "2018-02-07 14:24:49",
"responseUrl": "https://app.starred.com/en/invitation/rate/11745/10560/16f0bf905c4c3b380367ef9c6e7a7721",
"properties": [
{
"label": "AgentName",
"value": "James Bond"
},
{
"label": "Office",
"value": "Amsterdam"
}
]
}
Please note:
- Webhooks only get triggered once, meaning, if a candidate updates the response rating, the updated rating will not be visible in the webhook.
- Be aware that this can cause inconsistencies between data sources (Starred dashboards vs Data warehouse).
When using our Data API (paid feature) data of updated respondent ratings will be automatically updated.