Skip to main content

/api/v1/event/update/

  • Updated

The /event/update/ endpoint is used to add and remove updates from events. Updates can also be added to events via the /event/list/ endpoint when the event is created, or by submitting a PUT request to the /event/list/ endpoint after the event is created. The following parameters are supported on this endpoint:

INPUT PARAMETERS

date
string
(optional)

The update date/time (in UTC). Date/time must be in the following format: yyyy-mm-ddThh:mm:ss. If the date is not provided, the current date/time will be used for the update.

event
string

The resource_uri of the event that this update relates to.

markdown
boolean
(optional)

Enable the markdown editor in the StatusDashboard administration console for this field.

status
string
(optional)

The resource_uri of the status of this update. If no status is provided, the 'update' status will be assigned.

update
string

The text of the update to add to the event. Event updates are currently limited to 5000 characters.

 

Examples

List Event Updates (List method, GET)

curl --header "Authorization:ApiKey testuser:256ee09ded99b29036fac4de96acedb7e8af7bf7" https://www.statusdashboard.com/api/v1/event/update/

{
    "meta": {
        "limit": 10,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "date": "2015-08-10T17:30:00",
            "event": "/api/v1/event/list/71/",
            "markdown": false,
            "resource_uri": "/api/v1/event/update/15/",
            "status": {
                "resource_uri": "/api/v1/status/2/", 
                "status": "investigating"
            },
            "update": "We are continuing to troubleshoot the issue with email services.  We will provide another update in 30 minutes.",
            "user": "/api/v1/user/1002/"
        }
    ]
}

Upon success, you'll receive back an HTTP 200 (OK) indicating that the API call succeeded.

Add an Event Update (List method, POST)

curl --header "Content-Type: application/json" --header "Authorization:ApiKey testuser:256ee09ded99b29036fac4de96acedb7e8af7bf7" -X POST --data '{"event":"/api/v1/event/list/71/","status":"/api/v1/status/9/","update":"We have identified the problem with email services.  We expect full resolution to the issue within 30 minutes."}' https://www.statusdashboard.com/api/v1/event/update/

{
    "date": "2015-08-10T17:45:00.216969",
    "event": "/api/v1/event/list/71/",
    "markdown": false,
    "resource_uri": "/api/v1/event/update/16/",
    "status": {
        "resource_uri": "/api/v1/status/9/", 
        "status": "identified"
    },
    "update": "We have identified the problem with email services.  We expect full resolution to the issue within 30 minutes.",
    "user": "/api/v1/user/1002/"
}

Upon success, you'll receive back an HTTP 201 (created) along with details about the resource you just created.

Delete an Event Update (Detail method, DELETE)

curl --header "Authorization:ApiKey testuser:256ee09ded99b29036fac4de96acedb7e8af7bf7" -X DELETE https://www.statusdashboard.com/api/v1/event/update/16/

Upon success, you'll receive back an HTTP 204 (No Content) indicating that the request was fulfilled but there is no data to display.

Related articles