Skip to content

Latest commit

 

History

History
163 lines (121 loc) · 4.63 KB

event.md

File metadata and controls

163 lines (121 loc) · 4.63 KB
Raw

Event Actions

Details on the various actions that can be performed on the Event resource, including the expected parameters and the potential responses.

Contents

Delete

Deletes an event

var params = {
  applicationId: myApplicationId,
  eventId: myEventId
};

// with callbacks
client.event.delete(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.event.delete(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, event.*, or event.delete.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
eventId string Y ID associated with the event 575ed0de7ae143cd83dc4aa5
losantdomain string N Domain scope of request (rarely needed) example.com

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

var params = {
  applicationId: myApplicationId,
  eventId: myEventId
};

// with callbacks
client.event.get(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.event.get(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. 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.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
eventId string Y ID associated with the event 575ed0de7ae143cd83dc4aa5
losantdomain string N Domain scope of request (rarely needed) example.com

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

var params = {
  applicationId: myApplicationId,
  eventId: myEventId,
  event: myEvent
};

// with callbacks
client.event.patch(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.event.patch(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, event.*, or event.patch.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
eventId string Y ID associated with the event 575ed0de7ae143cd83dc4aa5
event Event Patch Y Object containing new properties of the event Event Patch Example
losantdomain string N Domain scope of request (rarely needed) example.com

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