Loxo

⌘K
  2. Home
  4. Docs
  6. Loxo
  8. Features
  10. REST API

REST API

Overview

The Loxo plugin exposes REST API endpoints for programmatic control of job synchronization, webhooks, and data management. All endpoints are under the loxo/v1 namespace and require the manage_options capability (WordPress administrator).

Job Synchronization

  • POST /wp-json/loxo/v1/job-sync — Start a background job synchronization
  • GET /wp-json/loxo/v1/job-sync — Get current sync status (running, paused, completed)
  • DELETE /wp-json/loxo/v1/job-sync — Cancel an ongoing sync
  • PATCH /wp-json/loxo/v1/job-sync — Pause an active sync
  • PUT /wp-json/loxo/v1/job-sync — Resume a paused sync

Webhook Management

  • POST /wp-json/loxo/v1/loxo-webhooks — Register webhooks with Loxo for real-time job updates
  • GET /wp-json/loxo/v1/loxo-webhooks — Check for missing webhooks and report status
  • DELETE /wp-json/loxo/v1/loxo-webhooks — Remove all registered webhooks from Loxo

Webhook Event Listener

  • POST /wp-json/loxo/v1/loxo-event — Endpoint that receives incoming webhook events from Loxo. This is the callback URL registered with Loxo and is called automatically — you do not need to call this manually.

Job Expiration

  • POST /wp-json/loxo/v1/job-expiration — Set the expiration date for a job. Parameters: id (WordPress job post ID), date_expires (date in Y-m-d format).

Data Management

  • DELETE /wp-json/loxo/v1/cache — Clear all cached API responses
  • DELETE /wp-json/loxo/v1/data — Delete all imported job data from WordPress (jobs, taxonomies, and metadata)

Authentication

All endpoints require WordPress authentication with administrator privileges. You can authenticate using:

  • Cookie authentication — When logged in to WordPress admin (used by the plugin’s admin UI)
  • Application passwords — For external integrations (WordPress 5.6+)