Event Actions#
https://api.losant.com/applications/APPLICATION_ID
/events/EVENT_ID
Below are the various requests that can be performed against the Event resource, as well as the expected parameters and the potential responses.
Delete#
Deletes an event
Method And Url #
DELETE https://api.losant.com/applications/APPLICATION_ID
/events/EVENT_ID
Authentication #
A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, event.*, or event.delete.
Request Path Components #
Path Component | Description | Example |
---|---|---|
APPLICATION_ID | ID associated with the application | 575ec8687ae143cd83dc4a97 |
EVENT_ID | ID associated with the event | 575ed0de7ae143cd83dc4aa5 |
Request Headers #
Name | Required | Description | Default |
---|---|---|---|
Authorization | Y | The token for authenticating the request, prepended with Bearer |
Curl Example #
curl -H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
-X DELETE \
https://api.losant.com/applications/APPLICATION_ID/events/EVENT_ID
Successful Responses #
Code | Type | Description |
---|---|---|
200 | Success | If event was successfully deleted |
Error Responses #
Code | Type | Description |
---|---|---|
400 | Error | Error if malformed request |
404 | Error | Error if event was not found |
Get#
Retrieves information on an event
Method And Url #
GET https://api.losant.com/applications/APPLICATION_ID
/events/EVENT_ID
Authentication #
A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, event.*, or event.get.
Request Path Components #
Path Component | Description | Example |
---|---|---|
APPLICATION_ID | ID associated with the application | 575ec8687ae143cd83dc4a97 |
EVENT_ID | ID associated with the event | 575ed0de7ae143cd83dc4aa5 |
Request Headers #
Name | Required | Description | Default |
---|---|---|---|
Authorization | Y | The token for authenticating the request, prepended with Bearer |
Curl Example #
curl -H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
-X GET \
https://api.losant.com/applications/APPLICATION_ID/events/EVENT_ID
Successful Responses #
Code | Type | Description |
---|---|---|
200 | Event | Event information |
Error Responses #
Code | Type | Description |
---|---|---|
400 | Error | Error if malformed request |
404 | Error | Error if event was not found |
Patch#
Updates information about an event
Method And Url #
PATCH https://api.losant.com/applications/APPLICATION_ID
/events/EVENT_ID
Authentication #
A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, event.*, or event.patch.
Request Path Components #
Path Component | Description | Example |
---|---|---|
APPLICATION_ID | ID associated with the application | 575ec8687ae143cd83dc4a97 |
EVENT_ID | ID associated with the event | 575ed0de7ae143cd83dc4aa5 |
Request Headers #
Name | Required | Description | Default |
---|---|---|---|
Authorization | Y | The token for authenticating the request, prepended with Bearer |
Request Body #
The body of the request should be serialized JSON that validates against the Event Patch schema. For example, the following would be a valid body for this request:
{
"state": "acknowledged",
"comment": "Looking into this issue"
}
Curl Example #
curl -H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
-X PATCH \
-d '{"state":"acknowledged","comment":"Looking into this issue"}' \
https://api.losant.com/applications/APPLICATION_ID/events/EVENT_ID
Successful Responses #
Code | Type | Description |
---|---|---|
200 | Event | Updated event information |
Error Responses #
Code | Type | Description |
---|---|---|
400 | Error | Error if malformed request |
404 | Error | Error if event is not found |