# Livestorm

> Manage webinar events, sessions, registrations and engagement in Livestorm.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/livestorm

## Actions

### Create event

Create an event.

**Inputs**

- Copy from event ID (`copy_from_event_id`, text): Copy from event id.
- Owner ID (`owner_id`, text): Owner id.
- Title (`title`, text, required): Title.
- Slug (`slug`, text): Slug.
- Status (`status`, text): Status.
- Everyone can speak (`everyone_can_speak`, true/false): Everyone can speak.
- Detailed registration page enabled (`detailed_registration_page_enabled`, true/false): Detailed registration page enabled.
- Light registration page enabled (`light_registration_page_enabled`, true/false): Light registration page enabled.
- Description (`description`, text): Description.
- Recording enabled (`recording_enabled`, true/false): Recording enabled.
- Recording public (`recording_public`, true/false): Recording public.
- Show in company page (`show_in_company_page`, true/false): Show in company page.
- Chat enabled (`chat_enabled`, true/false): Chat enabled.
- Questions enabled (`questions_enabled`, true/false): Questions enabled.
- Polls enabled (`polls_enabled`, true/false): Polls enabled.
- Relationships sessions (`relationships_sessions`, list): Relationships sessions.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {
        "chat_enabled": false,
        "created_at": 1,
        "description": "example",
        "detailed_registration_page_enabled": false,
        "estimated_duration": 1,
        "everyone_can_speak": false,
        "fields": [],
        "language": "example",
        "light_registration_page_enabled": false,
        "owner": {},
        "polls_enabled": false,
        "published_at": 1,
        "questions_enabled": false,
        "recording_enabled": false,
        "recording_public": false,
        "registration_link": "example",
        "registration_page_enabled": false,
        "sessions_count": 1,
        "show_in_company_page": false,
        "slug": "example",
        "status": "example",
        "title": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}
```

### Create session

Create an event session.

**Inputs**

- Id (`id`, text, required): Event ID
- Estimated started at (`estimated_started_at`, date and time): Estimated started at.
- Timezone (`timezone`, text): Time zone for this session. Dates are converted to this zone; defaults to UTC. One of: `Africa/Abidjan`, `Africa/Accra`, `Africa/Addis_Ababa` (Africa/addis ababa), `Africa/Algiers`, `Africa/Asmara`, `Africa/Asmera`, `Africa/Bamako`, `Africa/Bangui`, `Africa/Banjul`, `Africa/Bissau`, and 589 more.
- Name (`name`, text): Name.
- Relationships people (`relationships_people`, list): Relationships people.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {
        "attendees_count": 1,
        "canceled_at": 1,
        "created_at": 1,
        "duration": 1,
        "ended_at": 1,
        "estimated_started_at": 1,
        "event_type_id": "example",
        "name": "example",
        "registrants_count": 1,
        "room_link": "example",
        "started_at": 1,
        "status": "example",
        "timezone": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}
```

### Create webhook

Create a webhook.

**Inputs**

- Url (`url`, text, required): Url.
- Event (`event`, text, required): Event.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {
        "created_at": 1,
        "event": "example",
        "updated_at": 1,
        "url": "example"
      },
      "id": "example",
      "type": "example"
    }
  }
}
```

### Delete event

Delete an event.

**Inputs**

- Id (`id`, text, required): Event ID

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Delete session

Delete a session.

**Inputs**

- Id (`id`, text, required): Session ID

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Delete webhook

Delete a webhook.

**Inputs**

- Id (`id`, text, required): Webhook ID

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Get event

Get an event.

**Inputs**

- Id (`id`, text, required): Event ID
- Include (`include`, list): Include Related Data. One or more of: `tags`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {
        "chat_enabled": false,
        "created_at": 1,
        "description": "example",
        "detailed_registration_page_enabled": false,
        "estimated_duration": 1,
        "everyone_can_speak": false,
        "fields": [],
        "language": "example",
        "light_registration_page_enabled": false,
        "owner": {},
        "polls_enabled": false,
        "published_at": 1,
        "questions_enabled": false,
        "recording_enabled": false,
        "recording_public": false,
        "registration_link": "example",
        "registration_page_enabled": false,
        "sessions_count": 1,
        "show_in_company_page": false,
        "slug": "example",
        "status": "example",
        "title": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}
```

### Get organization

Get current organization.

**Inputs**: None.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {
        "name": "example",
        "parent_id": "example",
        "slug": "example"
      },
      "id": "example",
      "type": "example"
    }
  }
}
```

### Get person

Get a person.

**Inputs**

- Person (`id`, text, required): People ID

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {
        "avatar_link": "example",
        "created_at": 1,
        "email": "example",
        "first_name": "example",
        "last_name": "example",
        "role": "example",
        "timezone": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}
```

### Get session

Get a Session.

**Inputs**

- Id (`id`, text, required): Session ID
- Include (`include`, list): Include Related Data. One or more of: `event`, `people`, `chat_messages` (Chat messages), `questions`, `recordings`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {
        "attendees_count": 1,
        "canceled_at": 1,
        "created_at": 1,
        "duration": 1,
        "ended_at": 1,
        "estimated_started_at": 1,
        "event_type_id": "example",
        "name": "example",
        "registrants_count": 1,
        "room_link": "example",
        "started_at": 1,
        "status": "example",
        "timezone": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}
```

### List chat messages

List the chat messages from a session.

**Inputs**

- Id (`id`, text, required): Session ID
- Page number (`page_number`, number): Page index to be returned. From 1 to 1000000.
- Page size (`page_size`, number): Number of record to be returned by page. From 1 to 100.
- Include (`include`, list): Include Related Data. One or more of: `people`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}
```

### List event people

List the people from an event.

**Inputs**

- Id (`id`, text, required): Event ID
- Page number (`page_number`, number): Page index to be returned. From 1 to 1000000.
- Page size (`page_size`, number): Number of record to be returned by page. From 1 to 100.
- Filter role (`filter_role`, text): Filter People by role : 'participant', 'team_member'. One of: `team_member` (Team member), `participant`.
- Filter email (`filter_email`, text): Filter People by their email (exact match)

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}
```

### List event sessions

List event sessions.

**Inputs**

- Id (`id`, text, required): Event ID
- Page number (`page_number`, number): Page index to be returned. From 1 to 1000000.
- Page size (`page_size`, number): Number of record to be returned by page. From 1 to 100.
- Filter status (`filter_status`, text): Filter Sessions by status : 'upcoming', 'live', 'on_demand', 'past', 'past_not_started', 'canceled', 'draft'. One of: `upcoming`, `live`, `on_demand` (On demand), `past`, `past_not_started` (Past not started), `canceled`, `draft`.
- Filter date from (`filter_date_from`, date and time): Filter Sessions which ‘estimated_started_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter date to (`filter_date_to`, date and time): Filter Sessions which ‘estimated_started_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter created since (`filter_created_since`, date and time): Filter Sessions which ‘created_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter created until (`filter_created_until`, date and time): Filter Sessions which ‘created_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter updated since (`filter_updated_since`, date and time): Filter Sessions which ‘updated_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter updated until (`filter_updated_until`, date and time): Filter Sessions which ‘updated_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter include breakout rooms (`filter_include_breakout_rooms`, text): Filter Sessions depending upon if they are breakout room sessions or not
- Include (`include`, list): Include Related Data. One or more of: `event`, `people`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}
```

### List events

List events.

**Inputs**

- Page number (`page_number`, number): Page index to be returned. From 1 to 1000000.
- Page size (`page_size`, number): Number of record to be returned by page. From 1 to 100.
- Filter title (`filter_title`, text): Filter Events by title
- Filter everyone can speak (`filter_everyone_can_speak`, true/false): Filter Events by everyone_can_speak
- Filter scheduling status (`filter_scheduling_status`, text): Filter Events by scheduling_status (live, upcoming, on_demand, ended, not_started, draft, cancelled, not_scheduled). One of: `live`, `upcoming`, `on_demand` (On demand), `ended`, `not_started` (Not started), `draft`, `cancelled`, `not_scheduled` (Not scheduled).
- Filter created since (`filter_created_since`, date and time): Filter Events which ‘created_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter created until (`filter_created_until`, date and time): Filter Events which ‘created_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter updated since (`filter_updated_since`, date and time): Filter Events which ‘updated_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter updated until (`filter_updated_until`, date and time): Filter Events which ‘updated_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter tag (`filter_tag`, text): Filter Events by tag title (case-insensitive, comma-separated for multiple tags)
- Include (`include`, list): Include Related Data. One or more of: `sessions`, `tags`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}
```

### List people

List people.

**Inputs**

- Page number (`page_number`, number): Page index to be returned. From 1 to 1000000.
- Page size (`page_size`, number): Number of record to be returned by page. From 1 to 100.
- Filter role (`filter_role`, text): Filter People by role : 'participant', 'team_member'. One of: `team_member` (Team member), `participant`.
- Filter email (`filter_email`, text): Filter People by their email (exact match)

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}
```

### List people attributes

List people_attributes.

**Inputs**

- Page number (`page_number`, number): Page index to be returned. From 1 to 1000000.
- Page size (`page_size`, number): Number of record to be returned by page. From 1 to 100.
- Sort (`sort`, text): Sortable Fields: (-)slug, name, placeholder, created_at, updated_at
- Filter builtin (`filter_builtin`, text): Filter PeopleAttributes by builtin
- Filter description (`filter_description`, text): Filter PeopleAttributes by description
- Filter name (`filter_name`, text): Filter PeopleAttributes by name
- Filter placeholder (`filter_placeholder`, text): Filter PeopleAttributes by placeholder
- Filter slug (`filter_slug`, text): Filter PeopleAttributes by slug
- Filter type (`filter_type`, text): Filter PeopleAttributes by type (text, email, avatar, url, consent, unique_select, multiple_select)
- Filter user ID (`filter_user_id`, text): Filter PeopleAttributes by user_id

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}
```

### List questions

List the questions from a session.

**Inputs**

- Id (`id`, text, required): Session ID
- Page number (`page_number`, number): Page index to be returned. From 1 to 1000000.
- Page size (`page_size`, number): Number of record to be returned by page. From 1 to 100.
- Include (`include`, list): Include Related Data. One or more of: `asker`, `responder`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}
```

### List recordings

List the recordings from a session.

**Inputs**

- Id (`id`, text, required): Session ID
- Page number (`page_number`, number): Page index to be returned. From 1 to 1000000.
- Page size (`page_size`, number): Number of record to be returned by page. From 1 to 100.
- Url expires in seconds (`url_expires_in_seconds`, text): Time before URL link expires. Accepts values between 3600 and 604800 seconds (1 hour to 7 days), and default to 12 hours if not used

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}
```

### List session people

List the people from a session.

**Inputs**

- Id (`id`, text, required): Session ID
- Page number (`page_number`, number): Page index to be returned. From 1 to 1000000.
- Page size (`page_size`, number): Number of record to be returned by page. From 1 to 100.
- Filter role (`filter_role`, text): Filter People by role : 'participant', 'team_member'. One of: `team_member` (Team member), `participant`.
- Filter attended (`filter_attended`, true/false): Filter People that attend or not the Session
- Filter email (`filter_email`, text): Filter People by their email (exact match)
- Filter created since (`filter_created_since`, date and time): Filter People which ‘created_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter created until (`filter_created_until`, date and time): Filter People which ‘created_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter updated since (`filter_updated_since`, date and time): Filter People which ‘updated_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter updated until (`filter_updated_until`, date and time): Filter People which ‘updated_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Include (`include`, list): Include Related Data. One or more of: `event`, `session`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}
```

### List sessions

List Sessions.

**Inputs**

- Page number (`page_number`, number): Page index to be returned. From 1 to 1000000.
- Page size (`page_size`, number): Number of record to be returned by page. From 1 to 100.
- Filter status (`filter_status`, text): Filter Sessions by status : 'upcoming', 'live', 'on_demand', 'past', 'past_not_started', 'canceled', 'draft'. One of: `upcoming`, `live`, `on_demand` (On demand), `past`, `past_not_started` (Past not started), `canceled`, `draft`.
- Filter date from (`filter_date_from`, date and time): Filter Sessions which ‘estimated_started_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter date to (`filter_date_to`, date and time): Filter Sessions which ‘estimated_started_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter created since (`filter_created_since`, date and time): Filter Sessions which ‘created_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter created until (`filter_created_until`, date and time): Filter Sessions which ‘created_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter updated since (`filter_updated_since`, date and time): Filter Sessions which ‘updated_at’ attribute starts from the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter updated until (`filter_updated_until`, date and time): Filter Sessions which ‘updated_at’ attribute ends with the given date (expressed as a Unix timestamp or an ISO 8601 date).
- Filter include breakout rooms (`filter_include_breakout_rooms`, text): Filter Sessions depending upon if they are breakout room sessions or not

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {
      "items_per_page": 1,
      "page_count": 1,
      "record_count": 1
    }
  }
}
```

### List webhooks

List webhooks.

**Inputs**

- Page number (`page_number`, number): Page index to be returned. From 1 to 1000000.
- Page size (`page_size`, number): Number of record to be returned by page. From 1 to 100.
- Filter event (`filter_event`, text): Filter Webhooks by event : event.published, event.created, session.started, session.ended, session.created, people.registered, people.attended, people.not_attended, people.watched_replay, job.ended

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "meta": {}
  }
}
```

### Register person

Register someone for a session.

**Inputs**

- Id (`id`, text, required): Session ID
- Referrer (`referrer`, text): Referrer.
- Utm source (`utm_source`, text): Utm source.
- Utm medium (`utm_medium`, text): Utm medium.
- Utm term (`utm_term`, text): Utm term.
- Utm content (`utm_content`, text): Utm content.
- Utm campaign (`utm_campaign`, text): Utm campaign.
- Email (`email`, text, required): Email address of the person to register.
- First name (`first_name`, text): First name.
- Last name (`last_name`, text): Last name.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {
        "avatar_link": "example",
        "created_at": 1,
        "email": "example",
        "first_name": "example",
        "last_name": "example",
        "registrant_detail": {},
        "role": "example",
        "timezone": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}
```

### Remove person

Remove someone from a session.

**Inputs**

- Id (`id`, text, required): Session ID
- Registered person (`people_id`, text, required): People ID

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Update event

Partially update an event.

**Inputs**

- Id (`id`, text, required): Event ID
- Owner ID (`owner_id`, text): Owner id.
- Title (`title`, text): Title.
- Slug (`slug`, text): Slug.
- Status (`status`, text): Status.
- Everyone can speak (`everyone_can_speak`, true/false): Everyone can speak.
- Detailed registration page enabled (`detailed_registration_page_enabled`, true/false): Detailed registration page enabled.
- Light registration page enabled (`light_registration_page_enabled`, true/false): Light registration page enabled.
- Description (`description`, text): Description.
- Recording enabled (`recording_enabled`, true/false): Recording enabled.
- Recording public (`recording_public`, true/false): Recording public.
- Show in company page (`show_in_company_page`, true/false): Show in company page.
- Chat enabled (`chat_enabled`, true/false): Chat enabled.
- Questions enabled (`questions_enabled`, true/false): Questions enabled.
- Polls enabled (`polls_enabled`, true/false): Polls enabled.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {
        "chat_enabled": false,
        "created_at": 1,
        "description": "example",
        "detailed_registration_page_enabled": false,
        "estimated_duration": 1,
        "everyone_can_speak": false,
        "fields": [],
        "language": "example",
        "light_registration_page_enabled": false,
        "owner": {},
        "polls_enabled": false,
        "published_at": 1,
        "questions_enabled": false,
        "recording_enabled": false,
        "recording_public": false,
        "registration_link": "example",
        "registration_page_enabled": false,
        "sessions_count": 1,
        "show_in_company_page": false,
        "slug": "example",
        "status": "example",
        "title": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}
```

### Update session

Partially update a session.

**Inputs**

- Id (`id`, text, required): Session ID
- Estimated started at (`estimated_started_at`, date and time): Estimated started at.
- Timezone (`timezone`, text): Time zone for this session. Dates are converted to this zone; defaults to UTC. One of: `Africa/Abidjan`, `Africa/Accra`, `Africa/Addis_Ababa` (Africa/addis ababa), `Africa/Algiers`, `Africa/Asmara`, `Africa/Asmera`, `Africa/Bamako`, `Africa/Bangui`, `Africa/Banjul`, `Africa/Bissau`, and 589 more.
- Name (`name`, text): Name.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": {
      "attributes": {
        "attendees_count": 1,
        "canceled_at": 1,
        "created_at": 1,
        "duration": 1,
        "ended_at": 1,
        "estimated_started_at": 1,
        "event_type_id": "example",
        "name": "example",
        "registrants_count": 1,
        "room_link": "example",
        "started_at": 1,
        "status": "example",
        "timezone": "example",
        "updated_at": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}
```
