{"_id":"5711234ca10f7c1900698136","version":{"_id":"56abbf55f25f160d00e17f51","project":"56abbf55f25f160d00e17f4e","__v":12,"createdAt":"2016-01-29T19:36:53.665Z","releaseDate":"2016-01-29T19:36:53.665Z","categories":["56abbf56f25f160d00e17f52","56abca6bf9757e0d007c6650","56acddfa0ab3c00d00ce3332","56af65da9d32e30d0006d30f","56af66cab34d210d003d9ad0","56af6afcd21e9c0d00b628d1","56af6d6ecc4cbd0d00ce2c88","5705b12221cfed0e00e8c580","570a5676ade45d0e00c1ad33","570d7d25d1e4b82000d9e385","570eac3c3160d10e0041df0e","575709000fd6a3200010dded"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":2,"user":"56abbec30b9e0b0d00616274","parentDoc":null,"project":"56abbf55f25f160d00e17f4e","category":{"_id":"56af6d6ecc4cbd0d00ce2c88","pages":["56af6e8460a37a0d00ed87ac","56af71e58be2ea0d00b48887","56af73a08be2ea0d00b48890"],"version":"56abbf55f25f160d00e17f51","__v":3,"project":"56abbf55f25f160d00e17f4e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-01T14:36:30.275Z","from_sync":false,"order":2,"slug":"concepts","title":"Kongregate APIs & Concepts"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-15T17:22:20.050Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":13,"body":"## Shared Links & Raids API\n\nA number of games on Kongregate have guilds, raids, or other group events within them that players can join by clicking on a link, usually posted in chat or the forums. This is an excellent social feature, but can also clog up chat rooms and be difficult to track, especially for new players. To help clean up chat and provide a better organization method for games and players, we put together a Shared Links API.\n\nBroadly, the API provides a way for a game to provide a link, the relevant URL parameters, and some basic details about the event. These links will appear on a separate tab from chat and be filterable by type and sorted by expiration. Clicking on the link will load within the game's frame, removing the weird and unnecessary page reload or new tab that previously occurred.\n\nThere are only two methods needed to control this functionality - creating a raid, and destroying a raid. Kongregate will take care of sorting and filtering the list of raids automatically. This is all done through server-to-server calls in order to prevent spamming of links from client-side users.\n\n## Using the API\n\nThe following server side methods can be used to manage shared links:\n* [Shared Links - Create](doc:server-api-create-shared-link)\n* [Shared Links - Destroy](doc:server-api-destroy-shared-link)","excerpt":"","slug":"shared-links-raids","type":"basic","title":"Shared Links & Raids"}

Shared Links & Raids


## Shared Links & Raids API A number of games on Kongregate have guilds, raids, or other group events within them that players can join by clicking on a link, usually posted in chat or the forums. This is an excellent social feature, but can also clog up chat rooms and be difficult to track, especially for new players. To help clean up chat and provide a better organization method for games and players, we put together a Shared Links API. Broadly, the API provides a way for a game to provide a link, the relevant URL parameters, and some basic details about the event. These links will appear on a separate tab from chat and be filterable by type and sorted by expiration. Clicking on the link will load within the game's frame, removing the weird and unnecessary page reload or new tab that previously occurred. There are only two methods needed to control this functionality - creating a raid, and destroying a raid. Kongregate will take care of sorting and filtering the list of raids automatically. This is all done through server-to-server calls in order to prevent spamming of links from client-side users. ## Using the API The following server side methods can be used to manage shared links: * [Shared Links - Create](doc:server-api-create-shared-link) * [Shared Links - Destroy](doc:server-api-destroy-shared-link)