WebApi Settings

xEvent provides a Web API that lets external programs read event data (custom front ends, mobile apps and so on). Open Settings → WebApi Settings — a single Basic Options panel:

Option	Description
Enable	Enable the WebApi endpoints
Authorized Roles	Roles allowed to call the API, checked from the site role list (Administrators, author, Registered Users and custom roles)
Review New Event	Events submitted via the API require admin approval before publishing (on by default)

Usage

Once enabled, external apps can request event data in the format defined by the module. For security, grant access only to the roles that need it.

WARNING

The WebApi targets developers. Interface formats and parameters are defined in Resource/xml/Service.xml and ShareService.xml inside the module folder.