---
title: Configuring HomeRunner Plugin
description: "This guide covers the essential configuration steps for the HomeRunner Plugin. ## Required Credentials[https://github.com/hudsoncreativestudio/homerunner-plugin/blob/main/docs/configuration.md#required-credentials](https://github.com/hudsoncreativestudio/homerunner-plugin/blob/main/docs/configuration.md#required-credentials) To use the HomeRunner Plugin, you'll need: 1. **HomeRunner Customer API Key** - Available from your [HomeRunner Customer Dashboard](https://dashboard.homerunner.io): click your profile icon in the top-right…"
url: "https://homerunner.io/docs/configuring-homerunner-plugin/"
updated: "2026-08-15"
category: Getting Started
---

# Configuring HomeRunner Plugin

This guide covers the essential configuration steps for the HomeRunner Plugin.

## Required Credentials[https://github.com/hudsoncreativestudio/homerunner-plugin/blob/main/docs/configuration.md#required-credentials](https://github.com/hudsoncreativestudio/homerunner-plugin/blob/main/docs/configuration.md#required-credentials)

To use the HomeRunner Plugin, you'll need:

1. **HomeRunner Customer API Key**
   - Available from your [HomeRunner Customer Dashboard](https://dashboard.homerunner.io): click your profile icon in the top-right corner, then choose **Settings**. Your API key is listed there with a copy button.
   - Required for connecting to HomeRunner services
   - Unique to your account
2. **Property Management System (PMS) Integration**
   - HomeRunner supports various PMS platforms
   - Integration credentials from your PMS provider
   - Required for property synchronization

## Basic Setup[https://github.com/hudsoncreativestudio/homerunner-plugin/blob/main/docs/configuration.md#basic-setup](https://github.com/hudsoncreativestudio/homerunner-plugin/blob/main/docs/configuration.md#basic-setup)

1. **API Key Configuration**
   - Copy your API key from the [Customer Dashboard](https://dashboard.homerunner.io) (profile icon in the top-right corner > Settings)
   - Navigate to WordPress Dashboard > HomeRunner > Settings
   - Locate the "API Key" field
   - Enter your HomeRunner Customer API key
   - Save changes
2. **PMS Integration Setup**
   - Make sure you have connected at least one PMS from https://dashboard.homerunner.io
   - Select your PMS provider

## Verification[https://github.com/hudsoncreativestudio/homerunner-plugin/blob/main/docs/configuration.md#verification](https://github.com/hudsoncreativestudio/homerunner-plugin/blob/main/docs/configuration.md#verification)

After configuration:

- Test the connection to verify API key validity
- Confirm PMS integration is working
- Check property synchronization status