Response Webhooks
Getting Responses in real time to your endpoint
Response webhooks provide a way for responses to be delivered to an external web server. Webhook triggered immediately when a response saved. Note that Survey UI 3.0 in touchpoint settings must be enabled to use this feature.
Configuration
You can specify a URL in touchpoint settings by adding a custom settings with key "webhookURL". And if you want to attach an Authorization header to the request, you can add another custom settings with key "webhookAuthHeader" by the value being Authorization header itself.
Data
Webhook request body includes following fields;
createdAt
string
"2023-10-19T13:33:02.980Z"
Response Date in ISO 8601 format
feedbackId
string
"65312e12949a0d0508b71dae"
Id of the full response chain the response belongs to
language
string
"en"
Language code in two letter ISO 639-1 format
surveyId
string
"612615c51e9b5b00726f4cb4"
Survey's id
surveyName
string
"My Survey"
Survey's name
touchpointId
string
"643186eaabea9200298eeb43"
Touchpoint's id
touchpointName
string
"My Touchpoint"
Touchpoint name
questionId
string
"612615c51e9b5b00726f4cb1"
Question's id
questionTitle
string
"How likely are you to recommend us to your friends and colleagues?"
The title of the question in the response's language
tags
string[]
["CSAT"]
Question tags that set in the survey editor
answer
string | string[] | number
5, "Apple", ["Apple", "Orange"]
Mixed-type field related to question type
browser
string
"Chrome 118.0.0.0"
Respondent's Browser
device
string
"Macintosh"
Respondent's Device
os
string
"Mac OS 10.15.7"
Respondent's OS
metadata
object
{ "key": "value" }
metadata attached to response
cluster
string?
"detractor"
NPS or EVI cluster of the response
fieldId
string?
"507f1f77bcf86cd799439013"
Field id (used in Contact and Slider question types)
fieldName
string?
"Email"
Field name (used in Contact and Slider) in the response's language
contactId
string?
"507f1f77bcf86cd799439013"
Contact Id if the survey responded from a email/sms campaign
Last updated