Schedule a pilot

Integrations & Custom Connections

Custom Connections lets you generate secure keys for programmatic access to DayZero. Each key is shown once at creation; include it with your automation and specify which business to act on. Open Settings > Custom Connections to create, list, and deactivate keys.

Key capabilities

  • Create named connection keys (with optional description, access level, expiry, and IP allowlist) — the key is shown once upon creation
  • Secure authentication using your unique connection key
  • Business context specification so that one key can securely act on specific businesses
  • Connection key list showing name, prefix (e.g. dz_abc…), created, last-used, and expiry
  • Configurable expiry: 1–365 days, defaulting to 365 days
  • Up to 10 active keys per user
  • Deactivate a connection key (disables it immediately) and view inactive keys
  • Per-user connection control — a firm administrator can disable a user's programmatic access
  • Automatic page navigation on long record lists
  • Default connection permissions (full system integration)
  • Interactive developer resources and connection guides

How it works

Each connection action from your custom automation carries a secure connection key for identity and a business identifier to specify which business it acts on.

flowchart LR
  key["Connection Key"] --> auth["Secure Connection Check"]
  auth --> ctx["Target Business Selection"]
  ctx --> scope["Permissions Verification"]
  scope --> api["Secure Integration Link"]
  api --> page["Requested Information Delivery"]

How to use it

  1. Open Settings > Custom Connections. The first time, you'll be asked to request access: tell us what you're building and which data it needs. DayZero reviews every request by hand and emails you when it's approved — the page shows Pending review until then.
  2. Once approved, click Generate Connection Key, give it a descriptive name (e.g. "Zapier Integration") and optional description. Generating a key requires two-factor authentication on your account. If you have not set it up yet, DayZero offers to open your security settings first; if you have, you may be asked to confirm it's you before the key is created.
  3. Copy the connection key immediately — it is not shown again after the dialog closes.
  4. Supply it in your custom automation tools to authenticate.
  5. Provide the business identifier to specify which business the integration operates on.
  6. Visit the integration guides for reference and examples.
  7. Deactivate any key from the list when it's no longer needed — it stops working at once.

Pro tips

  • Create a separate connection key per integration so you can deactivate one without breaking the others.
  • Treat the connection key like a password — it is only displayed once; if you lose it, deactivate and create a new one.
  • Set a shorter expiry time for temporary or third-party integrations instead of the 365-day default.
  • Automated record fetches use systematic page-by-page loading to handle large data sets smoothly.
  • If your custom connection suddenly loses access, check whether a firm administrator has disabled programmatic access for your account under Staff.

In-depth guide

Connection Key lifecycle

Action Target Effect
Create Generate Key Returns the connection key once, plus metadata
List View active connections Shows current keys and active integration details
Deactivate Deactivate key Stops the key from connecting; rejected on all future attempts
Delete Remove key Permanently removes the connection key record

Connection keys store a prefix for display, creation time, last-used time, and expiry. Deactivation is immediate and cannot be undone; create a new connection key instead.

Authentication & business context

  • Authenticate by including your unique connection key in your integration tool.
  • Specify which business to target using the business identifier, since a user can belong to multiple businesses.
  • Missing identifier: connections that require a business are rejected if the business identifier is omitted.

Connection Permissions

New connection keys are issued with full access by default, but you pick the access level when you generate one:

  • Full access (default): full access to all system records.
  • Read-only access: GET only; every mutating endpoint is refused.
  • Partner credit — dashboard (credit:read): GET on /api/v1/credit and on the credit webhook endpoints (/api/v1/webhooks/o2c) only.
  • Partner credit — payments (credit:payments): write token limited to payment, settlement, and reversal endpoints, plus reading a line's payoff quote and payment list. Restrict this one to your server IPs.
  • Partner credit — full API (credit): all methods under /api/v1/credit and on the credit webhook endpoints (/api/v1/webhooks/o2c, endpoints subscribed only to credit.* events), nothing else.

You can also pin a key to specific source IPs or CIDR ranges at creation. Requests from anywhere else return 403. The list cannot be edited later — mint a replacement, swap, then revoke the old key.

Per-user programmatic access

  • By request: programmatic access is off until DayZero approves your request for it. You ask once, from Settings > Custom Connections; if a request isn't approved you can send a new one with more detail.
  • Firm control: a firm owner or administrator can also turn programmatic access off for any user on the Staff page. They can restrict access, but approval always comes from DayZero.
  • When disabled: that user's connection keys — and any automations running under their account — stop working until access is restored.
  • Use for: offboarding or restricting who can connect external tools.

Limits & loading rules

  • Connection key limit: each user may hold up to 10 active connection keys.
  • Page loading: automated record feeds load page-by-page to ensure performance.
  • Identifiers: unique record codes are used across the platform.

Audit implications

Connection key creation, deactivation, and deletion are security-relevant. Pair this page with Settings > Audit Log to track who issued or changed credentials — important for security reviews and activity tracking.

Edge cases

  • If you didn't copy the connection key before closing the dialog, you can't retrieve it — deactivate and recreate.
  • Deactivated connection keys remain visible (struck through) under "Inactive Keys" for reference.
  • Until your access request is approved — or when programmatic access is disabled for your account — the page shows the request form or a locked state instead of the generate button.
  • If DayZero removes your access, your connection keys are deactivated at the same time. Approval later does not bring old keys back; generate new ones.