This subscription feed publishes notifications to the user.
Authentication is required.
|
Feed |
Event Type |
API Keys | Original & Signed Challenge |
| notifications_auth |
subscribe / unsubscribe
|
Any | Yes |
| Sample Sent Message |
| { "event":"subscribe", "feed":"notifications_auth", "api_key":"CMl2SeSn09Tz+2tWuzPiPUjaXEQRGq6qv5UaexXuQ3SnahDQU/gO3aT+", "original_challenge":"226aee50-88fc-4618-a42a-34f7709570b2", "signed_challenge":"RE0DVOc7vS6pzcEjGWd/WJRRBWb54RkyvV+AZQSRl4+rap8Rlk64diR+ Z9DQILm7qxncswMmJyvP/2vgzqqh+g==" } |
|
Sample Return if Successful. |
|
{ |
|
Field |
Type | Description |
|
event
|
string | The result, subscribed or subscribed_failed or unsubscribed or unsubscribed_failed |
| feed | string | The requested subscription feed |
| api_key | string | The user api key |
| original_challenge | string | The message that is received from a challenge request |
| signed_challenge | string | The signed challenge message with user api secret |
| Sample Subscription Snapshot Data |
|
{ ... |
|
Field |
Type | Description |
| feed | string | The subscribed feed |
| notifications | list of structures | A list containing the notifications. |
| id | positive integer | The notification id |
| type | string |
The notification type. Existing types are market, general, new_feature, bug_fix, maintenance, settlement. If type=="maintenance" then it implies downtime will occur at effective_time if priority=="high" |
| priority | string |
The notification priority. Existing priorities are low, medium, high. If priority=="high" then it implies downtime will occur at effective_time when type=="maintenance". |
| note | string | The notification note. A short description about the specific notification. |
| effective_time | integer | The time that notification is taking effect. |
| Sample Return if Unsuccessful |
| { "event":"error", "message":"Json Error" } |
|
Field |
Type | Description |
| event | string | Always error |
| message | string |
An error message out of:
|