{"_id":"57027a59adbd340e00928b86","editedParams2":true,"project":"55843604fd8d910d007b9502","user":"558435c2fb52ee0d0015d190","category":{"_id":"5936f82eaa591e0027638d57","project":"55843604fd8d910d007b9502","version":"558444ceafccfd0d00fcb2bb","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-06-06T18:45:02.355Z","from_sync":false,"order":6,"slug":"reference","title":"Reference"},"parentDoc":null,"version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":60,"createdAt":"2015-06-19T16:35:26.435Z","releaseDate":"2015-06-19T16:35:26.435Z","categories":["558444cfafccfd0d00fcb2bc","558444cfafccfd0d00fcb2bd","55ad4ce733616a0d00599d2e","55ad4cef6aadf20d0015b764","55ad4cf36aadf20d0015b765","55ad4cfb24cf160d0013584f","55ad4d0024cf160d00135850","55ad4d0a24cf160d00135851","55ad4d0d24cf160d00135852","55ad4d126aadf20d0015b766","55ad4d1624cf160d00135853","55ad4d1933616a0d00599d2f","55ad4d2233616a0d00599d30","55ad4d2e24cf160d00135854","55d35b6bf77e6d0d00b1b092","55d3649a0168850d0073f14a","55d366d40168850d0073f15a","55d37fcff77e6d0d00b1b13f","55d383e50168850d0073f1e1","55d3ac26c336ec0d007c2251","55d3c51cb2330119009c31db","55d3c59bfe37111900e536f3","55d3c5a7fe37111900e536f4","55d3c5b4fe37111900e536f5","55d3c5d4fe37111900e536f6","55d3c5d6b2330119009c31df","55d3c5d71f478b170077c164","55d3c687b2330119009c31e4","55d3c6a4fe37111900e536f9","55d3c6befe37111900e536fa","55d3c6e8d2c66f0d00497f93","55d49dcfd7c16b2d007de905","55d4ca8f5082980d0009c79b","55d4cab9c95a3d2f0069ad3d","55d4d279c95a3d2f0069ad60","55d4d9355082980d0009c7e1","55d4f6b5988e130d000b3eb1","55d64dc8e60a2f0d00b88ecb","5627ca43fcbbc621004ec07d","56c64a0d8f98b50d0012c37c","56f1b8b13eb62a34003ea041","56f1b9df4476fb2200795e8c","57f6907dca5e5d1700039ae9","591dd06ca266c423002ec4ca","59234825e465c11900922518","5936f82eaa591e0027638d57","59972f54fd7078001992c136","599c6da8f180820025f14909","59b054613c3e1b0019cf27d9","59b1ceca2d6231003ad73e5f","59b1cf1857911600382e0dc4","59b1cf2730f3d60010c30ef7","59b1cf385d4b89003035441a","59b1cf5857911600382e0dc6","59bc2c4e26ac9b0010a8b753","59bc2ce20b3eb30010657b70","59f0c793ba3bc90030f413ab","59f0cd62f5ecda00325294b9","59fb55a8e8d0f600101aedc3","59fcb05c067f8d0028613f86","5a2af4a1bc5fba00283909c1"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"__v":1,"editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T14:29:45.422Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"name":"","code":"{\n  \"result\": {\n    \"id\": \"SUB_012345678912345\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}","language":"json","status":200}]},"examples":{"codes":[{"language":"curl","code":"curl -X POST -H 'X-API-TOKEN: yourtokenhere'  -H 'Content-Type: application/json' -d '{\n    \"subscriptionId\": \"SUB_0123456789\",\n    \"topics\": \"controlpanel.activateSurvey\",\n    \"publicationUrl\": \"https://www.example.com/example\"\n}' 'https://yourdatacenterid.qualtrics.com/API/v3/eventsubscriptions/'"}]},"auth":"required","params":[{"_id":"55d365b40168850d0073f152","ref":"","in":"body","required":false,"desc":"Unique Identifier, will be generated if none provided","default":"","type":"string","name":"subscriptionId"},{"_id":"55d365b40168850d0073f151","ref":"","in":"body","required":true,"desc":"The FULLY-Qualified URL to publish events to. For Example, if \"http://mydomain.com/REST.php\" it will publish messages to you via HTTP REST.","default":"","type":"string","name":"publicationUrl"},{"_id":"55d365b40168850d0073f150","ref":"","in":"body","required":true,"desc":"String Value of Topics to subscribe to. Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics.","default":"","type":"string","name":"topics"},{"_id":"55d365b40168850d0073f14f","ref":"","in":"body","required":false,"desc":"If true, will encrypt the event messages using the supplied Shared Key. Encryption will be AES 128 or 256 depending on Shared Key length (16 bytes = 128 bit, 32 bytes = 256 bit). Encryption is not necessary if publishing to an https URL. *\tEncrypted MSG is Base64 encoded for transport purposes, therefore you must base64 decode the MSG before decrypting it. MSG plaintext will be in JSON format.","default":"false","type":"boolean","name":"encrypt"},{"_id":"55d365b40168850d0073f14e","ref":"","in":"body","required":false,"desc":"If specified, all event messages will be emitted with an HMAC using this key to guarantee message authenticity, and optionally encrypted using this key (if encrypt = true).","default":"","type":"string","name":"sharedKey"}],"url":"/v:version/eventsubscriptions"},"isReference":false,"order":5,"body":"Event subscriptions enable notifications to be sent to a `publicationUrl` when an event occurs.  The notification will also contain data specific to the triggering event.  The events currently supported are enumerated below, along with the data accompanying the event notification.\n\n**controlpanel.activateSurvey**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"Status\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The result will be `Active` if successful\",\n    \"1-0\": \"SurveyID\",\n    \"1-1\": \"GUID\",\n    \"1-2\": \"The Survey ID of the survey that has been activated\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n**controlpanel.deactivateSurvey**\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Status\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The result will be `Inactive` if successful\",\n    \"1-0\": \"SurveyID\",\n    \"1-1\": \"GUID\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-2\": \"The Survey ID of the survey that has been deactivated\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n**surveyengine.completedResponse.{SurveyID}**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"Status\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The status will always be `Complete` if successful\",\n    \"1-0\": \"SurveyID\",\n    \"1-1\": \"GUID\",\n    \"1-2\": \"The Survey ID of the survey whose response has been completed\",\n    \"2-0\": \"ResponseID\",\n    \"2-1\": \"GUID\",\n    \"2-2\": \"The Response ID of the response that has been completed\",\n    \"3-0\": \"RecipientID\",\n    \"3-1\": \"GUID\",\n    \"3-2\": \"The Recipient ID of the response that has been completed. Will only be included if non-null\",\n    \"4-0\": \"ResponseEventContext\",\n    \"4-1\": \"String\",\n    \"4-2\": \"Custom context that can be set via the ResponseEventContext embedded data. (50 character limit)\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n**threesixty.nominationCreated**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"ThreeSixtyID\",\n    \"0-1\": \"GUID\",\n    \"0-2\": \"The 360 for which the nomination was created\",\n    \"1-0\": \"SubjectID\",\n    \"1-1\": \"GUID\",\n    \"1-2\": \"The Person ID of the one doing the nominating; the one that will be evaluated\",\n    \"2-0\": \"EvaluatorID\",\n    \"2-1\": \"GUID\",\n    \"2-2\": \"The Person ID of the one being nominated that will perform the evaluation\",\n    \"3-0\": \"EvaluatorEmail\",\n    \"3-1\": \"String\",\n    \"3-2\": \"The Email Address of the person that will perform the evaluation\",\n    \"4-0\": \"Relationship\",\n    \"4-1\": \"String\",\n    \"4-2\": \"The Relationship of the nomination\",\n    \"5-0\": \"EvaluationURL\",\n    \"5-1\": \"String\",\n    \"5-2\": \"The link to perform the evaluation (Survey Engine Link)\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n**threesixty.nominationRemoved**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"ThreeSixtyID\",\n    \"0-1\": \"GUID\",\n    \"0-2\": \"The 360 for which the nomination was removed\",\n    \"1-0\": \"SubjectID\",\n    \"2-0\": \"EvaluatorID\",\n    \"3-0\": \"Relationship\",\n    \"1-1\": \"GUID\",\n    \"2-1\": \"GUID\",\n    \"3-1\": \"String\",\n    \"1-2\": \"The Person ID of the one doing the nominating; the one that was to be evaluated\",\n    \"2-2\": \"The Person ID of the one being nominated that was to perform the evaluation\",\n    \"3-2\": \"The Relationship of the nomination\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n**threesixty.created**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"ThreeSixtyID\",\n    \"1-0\": \"SurveyID\",\n    \"2-0\": \"Workflow\",\n    \"0-1\": \"GUID\",\n    \"1-1\": \"GUID\",\n    \"2-1\": \"JSON\",\n    \"0-2\": \"The ID of the newly-created 360\",\n    \"1-2\": \"The ID of associated survey\",\n    \"2-2\": \"The Workflow Settings\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n**threesixty.evaluationStatusChanged**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"ThreeSixtyID\",\n    \"1-0\": \"SubjectID\",\n    \"2-0\": \"EvaluatorID\",\n    \"3-0\": \"Status\",\n    \"4-0\": \"SessionID\",\n    \"5-0\": \"ResponseID\",\n    \"6-0\": \"Relationship\",\n    \"7-0\": \"Unsolicitied\",\n    \"0-1\": \"GUID\",\n    \"1-1\": \"GUID\",\n    \"2-1\": \"GUID\",\n    \"4-1\": \"GUID\",\n    \"5-1\": \"GUID\",\n    \"3-1\": \"String\",\n    \"6-1\": \"String\",\n    \"7-1\": \"Boolean\",\n    \"0-2\": \"The ID of the newly-created 360\",\n    \"1-2\": \"The Person ID of the person being evaluated\",\n    \"2-2\": \"The Person ID of the one performing the evaluation\",\n    \"3-2\": \"The Status of the evaluation (Started, Finished)\",\n    \"4-2\": \"The SessionID of the initiated open survey session\",\n    \"5-2\": \"(When finished) The ID of the Response\",\n    \"6-2\": \"The Relationship of the evaluation\",\n    \"7-2\": \"(When finished) Boolean TRUE if the response was unsolicited, FALSE otherwise\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n**threesixty.reportReady**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"ThreeSixtyID\",\n    \"1-0\": \"SubjectID\",\n    \"2-0\": \"ReportURL\",\n    \"0-1\": \"GUID\",\n    \"1-1\": \"GUID\",\n    \"2-1\": \"String\",\n    \"0-2\": \"The ID of the 360\",\n    \"1-2\": \"The Person ID of the subject of the report\",\n    \"2-2\": \"The URL to view the report (Currently the link to log in to the Qualtrics Portal to view the report)\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n**threesixty.statusChanged**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"ThreeSixtyID\",\n    \"1-0\": \"Status\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Active or Inactive\",\n    \"0-2\": \"The ID of the 360\",\n    \"0-1\": \"GUID\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n**threesixty.person.statusChanged**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"ThreeSixtyID\",\n    \"1-0\": \"SubjectID\",\n    \"2-0\": \"Status\",\n    \"0-1\": \"GUID\",\n    \"1-1\": \"GUID\",\n    \"2-1\": \"String\",\n    \"0-2\": \"The ID of the 360\",\n    \"1-2\": \"The Person ID of the Subject\",\n    \"2-2\": \"Done or Waiting\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","excerpt":"","slug":"events","type":"basic","title":"Events"}
Event subscriptions enable notifications to be sent to a `publicationUrl` when an event occurs. The notification will also contain data specific to the triggering event. The events currently supported are enumerated below, along with the data accompanying the event notification. **controlpanel.activateSurvey** [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-0": "Status", "0-1": "String", "0-2": "The result will be `Active` if successful", "1-0": "SurveyID", "1-1": "GUID", "1-2": "The Survey ID of the survey that has been activated" }, "cols": 3, "rows": 2 } [/block] **controlpanel.deactivateSurvey** [block:parameters] { "data": { "0-0": "Status", "0-1": "String", "0-2": "The result will be `Inactive` if successful", "1-0": "SurveyID", "1-1": "GUID", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "1-2": "The Survey ID of the survey that has been deactivated" }, "cols": 3, "rows": 2 } [/block] **surveyengine.completedResponse.{SurveyID}** [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-0": "Status", "0-1": "String", "0-2": "The status will always be `Complete` if successful", "1-0": "SurveyID", "1-1": "GUID", "1-2": "The Survey ID of the survey whose response has been completed", "2-0": "ResponseID", "2-1": "GUID", "2-2": "The Response ID of the response that has been completed", "3-0": "RecipientID", "3-1": "GUID", "3-2": "The Recipient ID of the response that has been completed. Will only be included if non-null", "4-0": "ResponseEventContext", "4-1": "String", "4-2": "Custom context that can be set via the ResponseEventContext embedded data. (50 character limit)" }, "cols": 3, "rows": 5 } [/block] **threesixty.nominationCreated** [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-0": "ThreeSixtyID", "0-1": "GUID", "0-2": "The 360 for which the nomination was created", "1-0": "SubjectID", "1-1": "GUID", "1-2": "The Person ID of the one doing the nominating; the one that will be evaluated", "2-0": "EvaluatorID", "2-1": "GUID", "2-2": "The Person ID of the one being nominated that will perform the evaluation", "3-0": "EvaluatorEmail", "3-1": "String", "3-2": "The Email Address of the person that will perform the evaluation", "4-0": "Relationship", "4-1": "String", "4-2": "The Relationship of the nomination", "5-0": "EvaluationURL", "5-1": "String", "5-2": "The link to perform the evaluation (Survey Engine Link)" }, "cols": 3, "rows": 6 } [/block] **threesixty.nominationRemoved** [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-0": "ThreeSixtyID", "0-1": "GUID", "0-2": "The 360 for which the nomination was removed", "1-0": "SubjectID", "2-0": "EvaluatorID", "3-0": "Relationship", "1-1": "GUID", "2-1": "GUID", "3-1": "String", "1-2": "The Person ID of the one doing the nominating; the one that was to be evaluated", "2-2": "The Person ID of the one being nominated that was to perform the evaluation", "3-2": "The Relationship of the nomination" }, "cols": 3, "rows": 4 } [/block] **threesixty.created** [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-0": "ThreeSixtyID", "1-0": "SurveyID", "2-0": "Workflow", "0-1": "GUID", "1-1": "GUID", "2-1": "JSON", "0-2": "The ID of the newly-created 360", "1-2": "The ID of associated survey", "2-2": "The Workflow Settings" }, "cols": 3, "rows": 3 } [/block] **threesixty.evaluationStatusChanged** [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-0": "ThreeSixtyID", "1-0": "SubjectID", "2-0": "EvaluatorID", "3-0": "Status", "4-0": "SessionID", "5-0": "ResponseID", "6-0": "Relationship", "7-0": "Unsolicitied", "0-1": "GUID", "1-1": "GUID", "2-1": "GUID", "4-1": "GUID", "5-1": "GUID", "3-1": "String", "6-1": "String", "7-1": "Boolean", "0-2": "The ID of the newly-created 360", "1-2": "The Person ID of the person being evaluated", "2-2": "The Person ID of the one performing the evaluation", "3-2": "The Status of the evaluation (Started, Finished)", "4-2": "The SessionID of the initiated open survey session", "5-2": "(When finished) The ID of the Response", "6-2": "The Relationship of the evaluation", "7-2": "(When finished) Boolean TRUE if the response was unsolicited, FALSE otherwise" }, "cols": 3, "rows": 8 } [/block] **threesixty.reportReady** [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-0": "ThreeSixtyID", "1-0": "SubjectID", "2-0": "ReportURL", "0-1": "GUID", "1-1": "GUID", "2-1": "String", "0-2": "The ID of the 360", "1-2": "The Person ID of the subject of the report", "2-2": "The URL to view the report (Currently the link to log in to the Qualtrics Portal to view the report)" }, "cols": 3, "rows": 3 } [/block] **threesixty.statusChanged** [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-0": "ThreeSixtyID", "1-0": "Status", "1-1": "String", "1-2": "Active or Inactive", "0-2": "The ID of the 360", "0-1": "GUID" }, "cols": 3, "rows": 2 } [/block] **threesixty.person.statusChanged** [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-0": "ThreeSixtyID", "1-0": "SubjectID", "2-0": "Status", "0-1": "GUID", "1-1": "GUID", "2-1": "String", "0-2": "The ID of the 360", "1-2": "The Person ID of the Subject", "2-2": "Done or Waiting" }, "cols": 3, "rows": 3 } [/block]