The Hub Events API lets you create and manage events and registrations published on ArcGIS Hub. ArcGIS Hub events are a way to share details about upcoming meetings, openings, programs, and other activities related to a site, initiative, project, and more. You can manage attendees, resources, and registrations entirely through this API.
Use-cases
Some of the broad use-cases of the Events API are as follows:
- Create and manage events including updating details and deleting events
- Search and find events across Hub sites
- Attach or remove resources to events
- Manage registrations by creating, updating, and deleting attendee registrations
- Invite registrants in bulk to an event
- Retrieve registration details for a specific attendee or all attendees for an event
Endpoints
The Events API includes the following endpoints for events and registrations.
Events
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/events/v1/events | Create a new event |
| POST | /api/events/v1/events/search | Search for events using filters in the request body |
| GET | /api/events/v1/events/{id} | Get a single event by ID |
| PATCH | /api/events/v1/events/{id} | Update an existing event |
| DELETE | /api/events/v1/events/{id} | Delete an event |
| POST | /api/events/v1/events/{id}/resources | Initiate a resource upload for an event |
| DELETE | /api/events/v1/events/{id}/resources/{resource | Remove a resource from an event |
Registrations
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/events/v1/registrations | Create a new registration for an event |
| GET | /api/events/v1/registrations | List registrations, optionally filtered by event |
| POST | /api/events/v1/registrations/invite | Invite one or more registrants to an event |
| GET | /api/events/v1/registrations/{id} | Get a single registration by ID |
| PATCH | /api/events/v1/registrations/{id} | Update a registration |
| DELETE | /api/events/v1/registrations/{id} | Delete a registration |
Authentication
Endpoints require an ArcGIS login token. To learn more about authentication, see Authentication.