REST API Outbound Notification
Overview
The outbound notification service sends you a message whenever a survey response is processed. The message includes the survey name, survey ID, response ID and the response's anonymous viewing URL. You can use the response ID included in the message to retrieve the full message details via the GetResponse resource.
Outbound notifications are JSON messages posted to a URL you specify on your account dashboard. To enable outbound notification, check the "enable outbound notification" checkbox and input your destination in the "outbound notification URL" field, then click the "save" button.
Please note that outbound notifications are attempted only once, so if your destination URL returns an error, the notification will fail silently. You can use the ListResponses API resource to guarantee you have all the responses to a given survey any time you wish.
Message Properties
| Property | Description |
|---|---|
| SurveyId | The globally unique identifier (GUID) used as the survey ID |
| SurveyName | The name of the survey |
| ResponseId | The globally unique identifier (GUID) used as the response ID |
| AnonymousUrl | Obfuscated URL used to access the response without being logged into Cognotix (the survey must have "allow anonymous viewing" set to true for this URL to work) |
Sample Message
{
"SurveyId": "c4fe4387-156f-41b4-9746-9dfd00f0xxxx",
"ResponseId": "322427c3-7816-4101-8a56-9e5c0170xxxx",
"SurveyName": "General Feedback",
"AnonymousUrl": "http://www.cognotix.com/surveydisplay/viewer/ac4c4c4e7a8e6fefd309cac7597dxxxx"
}