{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/subscription","auth":"required","method":"post","params":[{"name":"uuid","type":"string","default":"D867AB3E-36D2-11E4-AEA8-76C9E2E253B6","desc":"The device UUID","required":true,"in":"body","ref":"","_id":"555fb747d7777119003ad037"},{"name":"service","type":"string","default":"4be3-eda97a-0d7faeab05a0-89403-ad4751c49","desc":"The service's public token","required":true,"in":"body","ref":"","_id":"555fb747d7777119003ad036"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  'subscription': {\n    \"created\": 1410106353,\n    \"icon\": \"https://upload.wikimedia.org/wikipedia/commons/8/88/Red_triangle_alert_icon.png\",\n    \"name\": \"Important stuff\",\n    \"public\": \"4be3-eda97a-0d7faeab05a0-89403-ad4751c49\",\n  }\n}"},{"status":409,"language":"json","code":"{\n\t'error': {\n    'id':4,\n   \t'message': 'Already listening to that service',\n  }\n}"},{"status":404,"language":"json","code":"{\n \t'error': {\n    'id': 6,\n   \t'message': 'Service not found',\n  }\n}"}]},"settings":""},"next":{"description":"","pages":[]},"title":"Subscribe to a service","type":"endpoint","slug":"subscribe-to-service","excerpt":"","body":"Subscribes the device/client to the target service. This will allow the client to receive messages sent by the service.","updates":["586e55fbd8e4e939009cbf08"],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"555fb747d7777119003ad035","user":"555f9a010758330d000d531a","parentDoc":null,"__v":1,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["555f9bf814d68e0d0096658b","555f9e9ed7777119003acfee","555fa040d7777119003acffd","555fa344d7777119003ad00b","555fa3e6d7777119003ad00f","555fb694336c041700a9b86e","555fb779336c041700a9b86f","555fb86bd7777119003ad039","555fbf1a336c041700a9b87f"],"_id":"555f9bf814d68e0d0096658a","project":"555f9bf814d68e0d00966587","releaseDate":"2015-05-22T21:13:28.470Z","__v":9,"createdAt":"2015-05-22T21:13:28.470Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["555fb747d7777119003ad035","555fb7e5336c041700a9b870","555fb8c5d7777119003ad03a"],"title":"Subscription","slug":"subscription","order":3,"from_sync":false,"reference":false,"_id":"555fb694336c041700a9b86e","version":"555f9bf814d68e0d0096658a","__v":3,"createdAt":"2015-05-22T23:07:00.798Z","project":"555f9bf814d68e0d00966587"},"githubsync":"","project":"555f9bf814d68e0d00966587","createdAt":"2015-05-22T23:09:59.439Z","editedParams":true,"editedParams2":true}

postSubscribe to a service


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

uuid:
required
stringD867AB3E-36D2-11E4-AEA8-76C9E2E253B6
The device UUID
service:
required
string4be3-eda97a-0d7faeab05a0-89403-ad4751c49
The service's public token

Result Format


Documentation

Subscribes the device/client to the target service. This will allow the client to receive messages sent by the service.

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 }}