Skip to main content

/api/v1/event/tag/notification

  • Updated

The /event/tag/notification/ endpoint is used to add and remove notification tags from events. Tags 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

event
string

The resource_uri of the event.

tag
string

The resource_uri of the notification tag.

 

Examples

List Notification Tags on Events (List method, GET)

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

{
    "meta": {
        "limit": 10,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "event": "/api/v1/event/list/71/", 
            "resource_uri": "/api/v1/event/tag/notification/5/", 
            "tag": {
                "resource_uri": "/api/v1/tag/notification/1/",
                "tag_name": "Customers", 
                "tag_value": "Banking"
            }
        }
    ]
}

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

Add a Notification Tag to an Event (List method, POST)

curl --header "Content-Type: application/json" --header "Authorization:ApiKey testuser:256ee09ded99b29036fac4de96acedb7e8af7bf7" -X POST --data '{"event":"/api/v1/event/list/71/","tag":"/api/v1/tag/notification/2/"}' https://www.statusdashboard.com/api/v1/event/tag/notification/

{
    "event": "/api/v1/event/list/71/",
    "resource_uri": "/api/v1/event/tag/notification/6/",
    "tag": {
        "resource_uri": "/api/v1/tag/notification/2/",
        "tag_name": "Customers",
        "tag_value": "Retail" 
    }
}

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

Delete a Notification Tag from an Event (Detail method, DELETE)

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

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