Skip to content

REST API ​

FluentEvent registers 34 endpoints under the fluent-event/v2 namespace:

https://yourwebsite.com/wp-json/fluent-event/v2/

The admin app in wp-admin uses the Admin API. The FluentCommunity portal and the public event page use the Front-End API.

Authentication ​

Every Admin API endpoint requires the manage_options capability. There are two ways to authenticate:

  • Cookie + nonce. In the browser, as a logged-in administrator, send the X-WP-Nonce header with a nonce from wp_create_nonce('wp_rest'). This is what the admin app does.
  • Application Passwords. For server-to-server calls, create an Application Password under Users → Profile and send it with HTTP Basic auth.
bash
curl -u "admin:abcd efgh ijkl mnop qrst uvwx" \
  "https://yourwebsite.com/wp-json/fluent-event/v2/events?per_page=5"

The Front-End API follows the visitor: the community endpoints use FluentCommunity's portal access rules, and the public event page's registration endpoint is open to anyone with the page's nonce.

Conventions ​

  • Request bodies are JSON (Content-Type: application/json) or form fields. Both reach the same validation.
  • Success returns HTTP 200 with the payload object. Writes include a message you can show to the user.
  • Validation errors return HTTP 422: { "message": "...", "errors": { "field": { "rule": "message" } } }.
  • Missing records return HTTP 404 from findOrFail().
  • Dates you send (start_at, end_at) are local times in the event's timezone. FluentEvent stores them in UTC. Responses carry both: start_at (UTC), start_at_local (event time zone) and start_at_site (site time zone).
  • Partial updates. PATCH /events/{id} and PATCH /calendars/{id} validate the full record, so send every required field. PATCH on a guest is partial.
  • Method override. If your server blocks PATCH or DELETE, send POST with an X-HTTP-Method-Override header.

Rate Limits ​

The registration endpoints limit how often one caller can send them. FluentEvent counts a logged-in user by account and a visitor by IP address (an IPv6 address by its /64 network). The limit holds over any 60 seconds, not per clock minute, and refused requests count too.

EndpointLimit per minuteCounter
Register Member10rsvp
Register Visitor (Portal) and Register Visitor (Event Page)5register_guest, shared by both

The counter is shared across every event, so a new event ID gives no new allowance. Over the limit, the API answers HTTP 429. Behind a reverse proxy, add the proxy with fluent_event/trusted_proxies so that each visitor is counted by their own address.

Interactive Playground ​

Every operation page has a playground. Enter your site's domain and username:application_password, then send the request. Use a staging site for anything that writes.

Endpoints ​

Admin API ​

MethodPathOperation
GET/eventsList Events
GET/events/by-slugGet Event by Slug
GET/events/{id}Get Event
POST/eventsCreate Event
PATCH/events/{id}Update Event
DELETE/events/{id}Delete Event
GET/events/{eventId}/guestsList Guests
POST/events/{eventId}/guestsCreate Guest
PATCH/events/{eventId}/guests/{guestId}Update Guest
DELETE/events/{eventId}/guests/{guestId}Delete Guest
GET/calendarsList Calendars
GET/calendars/optionsList Calendar Options
GET/calendars/{id}Get Calendar
POST/calendarsCreate Calendar
PATCH/calendars/{id}Update Calendar
DELETE/calendars/{id}Delete Calendar
GET/reportsGet Reports
GET/reports/guest-trendsGet Guest Trends
GET/settings/generalGet General Settings
POST/settings/generalUpdate General Settings
GET/settings/pagesSearch Pages
POST/settings/create-pageCreate Page
GET/settings/emailGet Email Settings
POST/settings/emailUpdate Email Settings
GET/settings/email-notificationsGet Email Notification Settings
POST/settings/email-notificationsUpdate Email Notification Settings
GET/settings/email-notifications/preview/{type}Preview Email
GET/usersSearch Users
GET/dashboardGet Dashboard

Front-End API ​

MethodPathOperation
GET/community/eventsList Community Events
GET/community/events/by-slugGet Community Event by Slug
POST/community/events/{id}/registerRegister Member
POST/community/events/{id}/register-guestRegister Visitor (Portal)
POST/portal/events/{id}/register-guestRegister Visitor (Event Page)

FluentEvent developer documentation