Integrations & API Connect Apartment Building Management Software to Zapier, Make, n8n, or any custom system

Apartment Building Management Software has two integration methods that work together:

Authentication

All API requests must include your API key as a Bearer token in the Authorization header.

Authorization: Bearer pm_your_api_key_here

# Example with curl:
curl -X POST https://yourdomain.com/api/action_create_tenant.php \
  -H "Authorization: Bearer pm_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"email":"tenant@example.com","first_name":"Jane","last_name":"Smith"}'

Generating an API key

Quick start — 5 minutes to your first integration

Option A — Zapier (no code)

Option B — curl / code

# Test the API in 30 seconds:
curl -X POST https://yourdomain.com/api/action_create_tenant.php \
  -H "Authorization: Bearer pm_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "email":      "jane@example.com",
    "first_name": "Jane",
    "last_name":  "Smith",
    "phone":      "+1555000000"
  }'

Webhooks — overview

A webhook is an HTTP POST request that Apartment Building Management Software sends to a URL you specify, the instant an event occurs. Your URL receives the request, reads the data, and acts on it — all within seconds of the event happening in Apartment Building Management Software.

How the flow works

Apartment Building Management Software makes up to 5 delivery attempts with exponential backoff if your server is down or returns an error. Failed and retried deliveries are visible in Settings → Integrations → Recent deliveries.

Setting up a webhook

All webhook events

Payload format

Every webhook POST request has the same envelope structure. The data object contains event-specific fields.

{
  "event":    "payment.succeeded",
  "id":       "evt_1715261400_42",       // unique event ID
  "fired_at": "2025-05-09T14:30:00Z",     // ISO 8601 UTC
  "data": {
    "id":         42,
    "tenant_id":  7,
    "amount":     1800.00,
    "method":     "stripe_card",
    "created_at": "2025-05-09T14:30:00Z"
  }
}

The request also includes these HTTP headers:

Verifying webhook signatures

When you add a signing secret to a subscription, Apartment Building Management Software signs every request body with HMAC-SHA256. You can verify this signature on your server to confirm the request really came from Apartment Building Management Software and wasn't faked by someone who found your URL.

How to verify

Compute HMAC-SHA256(raw_body, your_secret) and compare it to the X-PM-Signature header value.

// PHP verification example
$secret     = 'your_signing_secret';
$raw_body   = file_get_contents('php://input');
$signature  = $_SERVER['HTTP_X_PM_SIGNATURE'] ?? '';

$expected = 'sha256=' . hash_hmac('sha256', $raw_body, $secret);

if (!hash_equals($expected, $signature)) {
    http_response_code(403);
    die('Invalid signature');
}

// Signature is valid — process the webhook
$event = json_decode($raw_body, true);
echo 'Received: ' . $event['event'];

// Node.js verification example
const crypto = require('crypto');

app.post('/webhook', express.raw({type: 'application/json'}), (req, res) => {
  const secret    = 'your_signing_secret';
  const signature = req.headers['x-pm-signature'] || '';
  const expected  = 'sha256=' + crypto
    .createHmac('sha256', secret)
    .update(req.body)
    .digest('hex');

  if (!crypto.timingSafeEqual(
    Buffer.from(expected),
    Buffer.from(signature)
  )) {
    return res.status(403).send('Invalid signature');
  }

  const event = JSON.parse(req.body);
  console.log('Received:', event.event);
  res.status(200).send('OK');
});

# Python / Flask verification example
import hmac, hashlib
from flask import request, abort

SECRET = 'your_signing_secret'

@app.route('/webhook', methods=['POST'])
def webhook():
    signature = request.headers.get('X-PM-Signature', '')
    expected  = 'sha256=' + hmac.new(
        SECRET.encode(), request.data, hashlib.sha256
    ).hexdigest()

    if not hmac.compare_digest(expected, signature):
        abort(403)

    event = request.json
    print(f"Received: {event['event']}")
    return 'OK', 200

Retry behavior

If your server is unavailable or returns a non-2xx response, Apartment Building Management Software retries the delivery automatically:

After 5 failed attempts the delivery is marked as failed. You can see all delivery history in Settings → Integrations → Recent deliveries.

REST API — overview

The API lets external systems perform actions inside Apartment Building Management Software. All endpoints accept application/json and return JSON responses.

Response format

On success, each endpoint returns its result under a named key — there is no ok/data wrapper. The key differs per endpoint (tenant, charge, work_order, payment, broadcast_id, etc.).

// Success — HTTP 200 (key name varies by endpoint)
{
  "tenant": { ...resource fields... }
}

// Validation / processing error — HTTP 400
{
  "error": "A human-readable error message"
}

// Auth error — HTTP 401
{
  "error":   "unauthorized",
  "message": "Missing or invalid Bearer token"
}

Create tenant — POST /api/action_create_tenant.php

Invites a new tenant. Apartment Building Management Software creates the user and sends them an email with a link to activate their portal and set a password.

# Request
curl -X POST https://yourdomain.com/api/action_create_tenant.php \
  -H "Authorization: Bearer pm_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "email":      "jane@example.com",
    "first_name": "Jane",
    "last_name":  "Smith",
    "phone":      "+1555000000"
  }'

# Response — HTTP 200
{
  "tenant": {
    "id":         24,
    "email":      "jane@example.com",
    "first_name": "Jane",
    "last_name":  "Smith",
    "role":       "tenant",
    "status":     "invited",
    "accept_url": "https://yourdomain.com/accept-invite.php?token=…"
  }
}

Create work order — POST /api/action_create_work_order.php

Opens a new maintenance request.

# Request
{
  "title":       "Kitchen tap dripping",
  "description": "Cold tap has been dripping for 2 days.",
  "property_id": 3,
  "unit_id":     12,
  "priority":    "high",
  "category":    "plumbing"
}

# Response — HTTP 200
{
  "work_order": { "id": 88, "title": "Kitchen tap dripping", "status": "open", ... }
}

Record payment — POST /api/action_record_payment.php

Records a manual (cash / cheque / transfer) payment against a tenant.

# Request
{
  "tenant_id": 7,
  "amount":    1800.00,
  "method":    "bank_transfer",
  "reference": "TXN-99812"
}

# Response — HTTP 200
{
  "payment": { "id": 42, "tenant_id": 7, "amount": 1800.00, "method": "bank_transfer", ... }
}

Send message — POST /api/action_send_message.php

# Response — HTTP 200
{
  "broadcast_id": 17
}

Create charge — POST /api/action_create_charge.php

# Request
{
  "tenant_id":   7,
  "amount":      75.00,
  "description": "Late fee — May rent",
  "due_date":    "2025-06-01",
  "category":    "late_fee"
}

# Response — HTTP 200
{
  "charge": { "id": 131, "tenant_id": 7, "amount": 75.00, "status": "open", ... }
}

Polling trigger — GET /api/trigger_poll.php

Used for Zapier polling triggers. Returns recent events since the last poll. Zapier calls this endpoint every few minutes and checks for new items. Supported event values: tenant.created, payment.succeeded, work_order.created, work_order.completed.

# Zapier calls this automatically — no manual setup needed
GET /api/trigger_poll.php?event=payment.succeeded&since=2025-05-09T14:00:00Z
Authorization: Bearer pm_your_key

# Response — HTTP 200
{
  "event":   "payment.succeeded",
  "since":   "2025-05-09T14:00:00Z",
  "count":   2,
  "results": [ ...recent rows... ]
}

Zapier integration

Zapier connects Apartment Building Management Software to 6,000+ apps — Google Sheets, Slack, Gmail, HubSpot, QuickBooks, WhatsApp, and more. No coding required.

Trigger: receive data from Apartment Building Management Software

Action: send data to Apartment Building Management Software from Zapier

Make (Integromat)

Make uses a visual scenario builder. Use the Webhooks module to receive data from Apartment Building Management Software and the HTTP → Make a request module to call Apartment Building Management Software's API.

Receiving webhooks in Make

n8n

n8n is an open-source automation tool you can self-host. Use the Webhook node to receive and the HTTP Request node to send.

# n8n HTTP Request node settings for Apartment Building Management Software API:
Method:   POST
URL:      https://yourdomain.com/api/action_create_tenant.php
Auth:     Header Auth
Name:     Authorization
Value:    Bearer pm_your_key_here

Custom server / curl

Any server that can receive HTTP POST requests can be a webhook endpoint. Your endpoint just needs to:

• Accept POST requests
• Return HTTP 200 within 10 seconds
• Optionally verify the X-PM-Signature header

# Complete example — receive and process a webhook in PHP

$secret   = 'your_signing_secret';
$body     = file_get_contents('php://input');
$sig      = $_SERVER['HTTP_X_PM_SIGNATURE'] ?? '';
$expected = 'sha256=' . hash_hmac('sha256', $body, $secret);

if (!hash_equals($expected, $sig)) {
    http_response_code(403); exit;
}

$event = json_decode($body, true);

switch ($event['event']) {
    case 'payment.succeeded':
        // Add row to your accounting system
        record_payment($event['data']);
        break;
    case 'work_order.created':
        // Send SMS to maintenance team
        send_sms($event['data']['title']);
        break;
}

http_response_code(200);
echo 'OK';

Example: Payments → Google Sheets

Log every rent payment to a Google Sheet automatically for bookkeeping.

Example: Work orders → Slack

Get a Slack notification every time an emergency maintenance request is created.

Example: Tenants → CRM

When a tenant is added to Apartment Building Management Software, automatically create a contact in HubSpot or any CRM.