swarmtix_hosts_create
Adds a host to an online event; the host connects Zoom in the dashboard
swarmtix_hosts_create
Creates a host on an online event and returns it. A host is the person whose Zoom account runs live sessions.
When you would reach for it
- Preparing an event for Zoom live sessions.
Scope
events:write
The connection's user must be allowed to edit the event, and the event must be an online event.
It is not idempotent: each call creates a new host. It is refused when the organisation's plan has no more hosts.
No tool can connect Zoom. The host does that in the Swarmtix dashboard. Until then swarmtix_event_readiness reports ConnectWebinarProvider and the event cannot be published. To drop an unconnected host, use swarmtix_hosts_delete.
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
event | string | Yes | - | The event's id (a GUID) or its URL slug. |
firstName | string | Yes | - | The host's first name. Up to 255 characters. |
lastName | string | Yes | - | The host's last name. Up to 255 characters. |
email | string | Yes | - | The host's email address. Up to 255 characters. Never returned by any tool. |
Example call
{
"name": "swarmtix_hosts_create",
"arguments": {
"event": "spring-summit-online",
"firstName": "Marko",
"lastName": "Ilic",
"email": "[email protected]"
}
}What comes back
The new host: id, firstName, lastName and zoom, which is "notConnected" for a new host.
What happens when you call it
- The event is resolved through the edit gate and must be an online event.
- The organisation's plan limit on hosts is checked.
- The host is created, not connected to Zoom.
Troubleshooting
"Event not found, or this connection does not have access to it."
The event does not exist, it belongs to another organisation, or this organizer may read it but not edit it.
"This event is not an online event. Talks, speakers, categories and hosts belong to online events only. Nothing was changed."
The event is a physical event. These tools only work on events created with kind: "online".
"This organisation has reached its plan's limit on hosts. Nothing was changed. Upgrade the plan in the Swarmtix dashboard to add another."
The plan has no room for another host.
Use cases
- Setting up a host before connecting Zoom in the dashboard