{"_id":"57028e00f2d6f336005e8f46","user":"558435c2fb52ee0d0015d190","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":45,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"55d3649a0168850d0073f14a","project":"55843604fd8d910d007b9502","version":"558444ceafccfd0d00fcb2bb","pages":["55d364c3f77e6d0d00b1b0be","55d364ff0168850d0073f14b","55d365fbf77e6d0d00b1b0c6","55d36615f77e6d0d00b1b0c7","55d36630f77e6d0d00b1b0c8","55d36656f77e6d0d00b1b0c9","55d3669b0168850d0073f156"],"__v":7,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-18T17:00:10.231Z","from_sync":false,"order":17,"slug":"event-subscriptions","title":"Event Subscriptions"},"parentDoc":null,"project":"55843604fd8d910d007b9502","__v":4,"editedParams":true,"editedParams2":true,"updates":["5896554f3191370f0060de26","58aa855e90d1d20f00b774a5"],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T15:53:36.782Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -X POST -H 'X-API-TOKEN: yourtokenhere'  -H 'Content-Type: application/json' -d '{\n    \"topics\": \"controlpanel.activateSurvey\",\n    \"publicationUrl\": \"https://www.example.com/example\"\n}' 'https://yourdatacenterid.qualtrics.com/API/v3/eventsubscriptions/'","language":"curl"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n  \"result\": {\n    \"id\": \"SUB_012345678912345\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"55d365b40168850d0073f151","ref":"","in":"body","required":true,"desc":"The fully qualified URL to publish events to. The web server URL must be able to handle HTTP REST. It will be receiving x-www-form-urlcoded data not JSON.","default":"","type":"string","name":"publicationUrl"},{"_id":"55d365b40168850d0073f150","ref":"","in":"body","required":true,"desc":"String Value of topics to subscribe to. ’threesixty.*’ will subscribe to all 360 events from Qualtrics. [More Info](/v3/docs/events)","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":2,"body":"Topic subscription can be a single event (Ex: 'threesixty.created') or a wildcard list of events using the * (star) notation to denote 'everything' (Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics.)\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Administrator Request\",\n  \"body\": \"To use this call you must be a Qualtrics brand administrator\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Publication URL\",\n  \"body\": \"This is a REST endpoint that would be set up on your end. We will ping that URL with a POST request.\"\n}\n[/block]\nNote: the publicationUrl must be able to handle HTTP GET/POST. It will be receiving x-www-form-urlencoded data not JSON","excerpt":"Add an event subscription","slug":"create-subscription","type":"endpoint","title":"Create Subscription"}

postCreate Subscription

Add an event subscription

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

publicationUrl:
required
string
The fully qualified URL to publish events to. The web server URL must be able to handle HTTP REST. It will be receiving x-www-form-urlcoded data not JSON.
topics:
required
string
String Value of topics to subscribe to. ’threesixty.*’ will subscribe to all 360 events from Qualtrics. [More Info](/v3/docs/events)
encrypt:
booleanfalse
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. * Encrypted MSG is Base64 encoded for transport purposes, therefore you must base64 decode the MSG before decrypting it. MSG plaintext will be in JSON format.
sharedKey:
string
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).

Examples


Result Format


Documentation

Topic subscription can be a single event (Ex: 'threesixty.created') or a wildcard list of events using the * (star) notation to denote 'everything' (Ex:’threesixty.*’ will subscribe to all 360 events from Qualtrics.) [block:callout] { "type": "warning", "title": "Administrator Request", "body": "To use this call you must be a Qualtrics brand administrator" } [/block] [block:callout] { "type": "info", "title": "Publication URL", "body": "This is a REST endpoint that would be set up on your end. We will ping that URL with a POST request." } [/block] Note: the publicationUrl must be able to handle HTTP GET/POST. It will be receiving x-www-form-urlencoded data not JSON

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}