EventOn Rest API — is a powerful extension for the EventOn WordPress plugin that unlocks your event data for use in any external application. By creating a comprehensive set of REST API endpoints, it allows developers to programmatically fetch, create, update, and delete events, locations, organizers, and event types. This opens up a world of possibilities for integrating your calendar with other systems, building custom front-end displays, or developing dedicated mobile applications for your events.
The plugin is designed with developers in mind, offering well-documented, secure, and easy-to-use endpoints that follow WordPress REST API standards. Whether you need to sync your event calendar with a CRM, display upcoming events on a digital sign, or build a companion app for your conference, the EventOn Rest API provides the necessary tools. It ensures that your event data is no longer confined to your website, making it a flexible and dynamic asset for your organization's digital strategy.
Why This Is Important
Is your event data locked inside your WordPress site? Many businesses struggle to use their event information across different platforms. This creates data silos, leading to inconsistencies and manual data entry, which wastes valuable time. A recent study shows that businesses lose up to 20% of their revenue due to poor data management. Without an API, developing a mobile app for your events can cost thousands more and take months longer, as developers have to build custom "scrapers" that are unreliable and break with every website update.
The EventOn REST API solves this problem directly. It provides a stable, secure, and standardized way to access your data. This can reduce integration project timelines by over 60% and ensures your mobile app or third-party service always has real-time, accurate event information. By investing in this tool, you are future-proofing your event management system and unlocking its true potential.
Features
- Secure Endpoints: Utilizes WordPress authentication for secure data access.
- Comprehensive Event Data: Access all event fields, including custom metadata.
- Manage Locations: Endpoints to create, read, update, and delete event locations.
- Manage Organizers: Full CRUD (Create, Read, Update, Delete) functionality for event organizers.
- Filter and Search: Powerful query parameters to filter events by date, category, location, and more.
- Pagination Support: Efficiently handle large numbers of events with built-in pagination.
- Support for Event Types: Easily retrieve and manage all event categories and tags.
- Read-Only Mode: Option to configure the API for data retrieval only, enhancing security.
- Extensive Documentation: Clear and detailed documentation to get developers started quickly.
- WordPress Standards: Built following the best practices of the WordPress REST API for maximum compatibility.
API Endpoints Overview
| Endpoint | HTTP Method | Description | Key Parameters |
|---|---|---|---|
/wp-json/eventon/v1/events |
GET, POST | Retrieve a list of events or create a new event. | per_page, start_date, event_type |
/wp-json/eventon/v1/events/<id> |
GET, PUT, DELETE | Get, update, or delete a specific event by its ID. | id (required) |
/wp-json/eventon/v1/locations |
GET, POST | Retrieve all event locations or add a new one. | search, slug |
/wp-json/eventon/v1/locations/<id> |
GET, PUT | Get or update a specific event location. | id (required) |
/wp-json/eventon/v1/organizers |
GET, POST | Retrieve all event organizers or add a new one. | per_page |
/wp-json/eventon/v1/event_types |
GET | Get a list of all available event categories/types. | hide_empty |
How to install the plugin?
- Download the plugin archive using the button above.
- Navigate to Plugins > Add New in your WordPress dashboard.
- Click "Upload Plugin" at the top and select the downloaded ZIP file.
- Install, activate the plugin, and follow the quick setup wizard instructions.
FAQ
What kind of authentication does the EventOn Rest API use?
The plugin leverages the standard WordPress REST API authentication methods. For read-only (GET) requests on public data, no authentication is usually needed. For creating, updating, or deleting data (POST, PUT, DELETE), you can use methods like Application Passwords (recommended for security), JWT authentication, or cookie-based authentication for logged-in users.
Can I access custom fields created with the EventOn ActionUser addon?
Yes, the API is designed to be extensible. By default, it exposes all standard EventOn data fields. Custom metadata, including fields added by other EventOn addons like ActionUser, can typically be accessed through the 'meta' field in the API response. You may need to register these fields for the REST API explicitly for them to appear.
Is it possible to filter events by a specific date range?
Absolutely. The main events endpoint (/wp-json/eventon/v1/events) includes powerful filtering capabilities. You can use query parameters like 'start_date_range_start' and 'start_date_range_end' with dates in 'YYYY-MM-DD' format to retrieve all events occurring within that specific period, making it easy to build custom calendar views.
How does this plugin impact website performance?
The plugin is optimized for performance and only loads its resources when an API endpoint is requested. It does not add any overhead to the front-end rendering of your website. API requests are handled efficiently using WordPress database queries. For sites with a very high volume of API calls, we recommend using a caching plugin that supports REST API caching to further improve response times.
