swarmtix_online_categories_create

Creates a category on an online event and returns it. Talks can then be put in it.

When you would reach for it

Grouping talks into tracks such as "Beginner" or "Workshops".
Clearing the NoCategories blocker that swarmtix_event_readiness reports for an online event.

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 category, even when the title is the same.

Parameters

Name	Type	Required	Default	Description
`event`	string	Yes	-	The event's id (a GUID) or its URL slug.
`title`	string	Yes	-	The category's title. Up to 255 characters.
`shortDescription`	string	No	empty	A one-line description. Up to 500 characters.
`description`	string	No	empty	The full description. Basic HTML is kept. Up to 20,000 characters.

Example call

{
  "name": "swarmtix_online_categories_create",
  "arguments": {
    "event": "spring-summit-online",
    "title": "Machine learning",
    "shortDescription": "Practical talks"
  }
}

What comes back

The new category: id, title and shortDescription. The category gets the default icon. Icons are set in the Swarmtix dashboard.

What happens when you call it

The event is resolved through the edit gate and must be an online event.
Text is cleaned: tags are removed from plain fields and unsafe HTML from the description.
The category is created and linked to the event.

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".

Two categories with the same title

Expected after a retry. The tool is not idempotent. Remove the spare with swarmtix_online_categories_delete.

Use cases

Setting up tracks for a multi-session online event

swarmtix_online_categories_create

On this page