Skip to content

wepow:notifications

Andres Freyria edited this page Sep 25, 2013 · 1 revision

wepow:notifications

Collection resource consisting of all the wepow:notification resources for the current API key.

Properties

Name Type Description
count Number The total number of wepow:notification resources.

Links / Embedded Resources

<tr>
  <td><a href='/docs/wepow%3Anotification'>wepow:notification</a></td>
  <td>Individual notifications for the API key</td>
</tr>
Relation Description
self The resource full representation

Example

{
  "count" : 1,

  "_embedded" : {
    "wepow:notification": [
      {
        "id": "50cbad05a8326c0358000007",
        "callback_url": "http://sample.url/endpoint",
        "target": "application_status",
        "active": true,

        "_links": {
          "self": {
            "href": "/hypermedia/notifications/50cbad05a8326c0358000007"
          }
        }
      }
    ]
  },
  
  "_links" : {
    "self" : { "href" : "/notifications" }
  }
}

Actions

GET

Responses

  • 200: The resource representation is returned.

POST

Request

The desired values for the new wepow:notification properties.

Sample request:

{ "callback_url" : "https://sample.com/endpoint", "target": "application_status", ... }

Responses

  • 204: The resource has been updated.
  • 422: The input was invalid.