For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create Event

Create event within specified project.

Create Event

POST https://environment.monterosa.cloud/api/v2/events

Headers

Name
Type
Description

Authorization*

string

Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb

Content-Type*

string

application/vnd.api+json

Request Body

Name
Type
Description

name*

string

Event name.

duration*

integer

Event duration in seconds.

start_at*

integer

Planned event start time (timestamp).

start_mode*

string

Start mode, one of : "manual", "clock".

repeat

boolean

true to say this event has to be automatically recreated after it's finished.

repeat_in

integer

Repeat event will be automatically created in repeat_in minutes after end of original event.

settings

array

List of fields of event settings. Each field is updated separately and if present its content is rewritten completely.

action

string

Set to perform action on event. Possible actions: start - start manual event.

end_mode

string

Event end mode. One of "duration", "scheduled".

{
  "data": {
    "id": "18b17c20-5e84-4086-8da0-784f21622e16",
    "type": "events",
    "attributes": {
      "name": "Live Event",
      "duration": 3600,
      "start_at": 1458487800,
      "start_at_iso": "2016-03-20T15:30:00Z",
      "start_mode": "manual",
      "end_mode": "duration",
      "repeat": false,
      "settings": [
        {
          "key": "hold_prompt",
          "values": {
            "en": "We'll be back shortly",
            "de": "Wir sind gleich wieder da"
          }
        }
      ],
      "state": "future"
    },
    "links": {
      "self": "https://example.lvis.io/api/v2/events/18b17c20-5e84-4086-8da0-784f21622e16"
    },
    "relationships": {
      "elements": {
        "links": {
          "related": "https://example.lvis.io/api/v2/events/18b17c20-5e84-4086-8da0-784f21622e16/elements"
        }
      },
      "stats": {
        "data": {
          "id": "18b17c20-5e84-4086-8da0-784f21622e16",
          "type": "stats"
        }
      },
      "project": {
        "data": {
          "id": "850e644e-f1ea-444d-bae3-cf38badbe501",
          "type": "projects"
        }
      }
    }
  }
}

Create Event

POST https://environment.monterosa.cloud/api/v2/events

Headers

Name
Type
Description

Authorization*

string

l0gVURLT5MSG

Content-Type*

string

jC0pJgVvaRez

Request Body

Name
Type
Description

name*

string

Rru6E9cNrwMM

duration*

integer

ynFRpKtMu1dd

start_at*

integer

2rkZo70YXc2p

start_mode*

string

g3akxzkckjw4

repeat

boolean

FziJr1EXJKoi

repeat_in

integer

nvEFFVNVMdMI

settings

array

3zopTTH1dlw0

action

string

PeCtM00JQxAI

end_mode

string

6b4AMZ1ZF0aW

Example

Create an event and start it

To start new event action must be set to start. Otherwise event will be started according to start_mode and start_at properties.

Validation error message about an invalid attribute

Last updated