Skip to main content

Pulse Connect pilot checklist

Use this checklist with your MaidCentral representative before connecting a reporting tool, MCP server, CLI workflow, or AI application.

Controlled pilot

The pilot is enabled for approved branches only. External pilot partners build and run against staging only, at https://api.staging.maidcentral.ai/api/connect/v1; production access isn't offered yet. Staging is a copy of production that is refreshed periodically, and every refresh wipes staging keys and webhook subscriptions. It holds a copy of real branch data, so treat it with the same care. What the API covers.

Choose the pilot​

  • Name one business owner who can approve data access.
  • Name one developer or integration partner responsible for the connection.
  • Select one branch for the first pilot.
  • Describe the business outcome in one sentence.
  • Confirm which data and actions are needed: reads (customers, homes, service sets, jobs, operations, billing, leads and quotes, time summaries, scorecards, reports), writes, booking, save-card links, or webhooks.
  • Confirm that the external tool and any AI provider are approved to receive that data.

Start with one narrow workflow. Good first pilots include a read-only report, scheduled export, or customer lookup assistant.

Request access​

  • Sign the Pulse Connect partner agreement with MaidCentral.
  • Ask MaidCentral to enroll the selected branch.
  • Agree on the monthly included API usage for the pilot.
  • Create a test customer for write tests, and agree which real customers, if any, the integration may book, move, skip or cancel during the pilot.
  • Ask MaidCentral for a staging key with only the scopes the workflow needs. A branch has at most 10 active keys; keep one slot free for rotation.
  • Choose an expiry (90 days by default, 180 at most) and an owner for rotation.
  • Choose an approved secret manager or secure credential store.

Use a separate API key for each integration. Never share one key between unrelated tools or vendors.

Verify the connection​

  • Store the key without placing it in source code, browser code, logs, tickets, or prompts.
  • Call /me and confirm the expected branch and scopes.
  • Call /capabilities and confirm the families the workflow needs are true.
  • Call /usage and confirm the expected monthly allowance.
  • Read one small page from each required resource.
  • Verify pagination using next_cursor when more data is available.
  • Confirm the integration retries 429 and 503 responses using Retry-After.
  • If you use webhooks, give the key webhooks.manage, send a test event, and verify its signature.
  • If you book, confirm on the test customer that saving a quote sends lead.created and booking it sends lead.converted.
  • Record the credential owner, key prefix, expiration date, and support contact. Do not record the plaintext key.

Follow the copy-ready requests in the developer quickstart. Use the API guide to confirm scopes and filters.

Approve launch​

  • The business owner confirms the returned data matches the approved use case.
  • The developer confirms the key is stored securely.
  • No payroll, HR, card numbers, access instructions or message content is expected.
  • The integration stays within the documented page size and date-range limits.
  • The team knows how to stop the integration and request immediate key revocation.

Review the first week​

  • Check /usage for unexpected volume.
  • Review errors and slow requests without collecting customer payloads.
  • Confirm the workflow still produces the intended business result.
  • Capture questions, missing fields, and confusing documentation for MaidCentral.
  • Decide whether to continue, adjust, or stop the pilot.

Contact MaidCentral Support with the Pulse-Connect-Operation-Id and correlation ID for a failed request. Never send the API key, cursor, or customer response body.