Reference · built on requestConnectorField service & CMMS

UpKeep

Work orders, assets, locations, parts, meters, preventive maintenance, and requests from UpKeep, with webhooks for changes.

Request accessPricing ↗

About

UpKeep is a mobile-first CMMS. Its API at https://api.onupkeep.com/api/v2/ covers users, assets, work orders, locations, parts, preventive maintenance, meters, purchase orders, vendors, customers, teams, requests, form templates, files, and vehicles, and is switched on only for accounts on the Enterprise Plan. Webhooks post work order, preventive maintenance, purchase order, and request events to a URL you register.

An operator on Fibric reads open work orders and requests as events arrive, then proposes a new work order, an assignment, or a request approval for your sign-off. Each proposal leaves a receipt with the reason and the reversal.

This is a reference listing. It documents what Fibric would read from UpKeep and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Work orders from /work-orders/, with worker and team assignments, and WORK_ORDER_CREATED, UPDATED, STATUS_UPDATED, and DELETED webhook events
  • Preventive maintenance templates and schedules from /preventive-maintenance/, plus PM_WORK_ORDER and WORK_ORDER_SCHEDULE events
  • Assets with downtime records and statuses, and locations nested up to six levels on Enterprise and Business Plus plans
  • Meters and meter readings from /meters/
  • Requests from /requests/, with REQUEST_CREATED, UPDATED, APPROVED, and REJECTED events
  • Parts, purchase orders, vendors, customers, and form-template checklists, filtered by createdAt timestamps and expanded with includes

Proposed actions

  • Target capability: propose a work order through POST /work-orders/, or a worker or team assignment on one
  • Target capability: propose approving, rejecting, or cancelling a request through /requests/
  • Target capability: propose recording asset downtime, singly or in bulk through POST /assets/downtime
  • Target capability: propose a meter reading against a meter
  • Target capability: propose a purchase order or its fulfilment update through /purchase-orders/

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Age out stale work orders

    Read open work orders by createdAtLessThan, flag those idle past your threshold, and propose a reassignment or priority change.

    With Work Order Aging

  • Turn a filter or meter interval into a scheduled job

    Read meter readings and PM schedules, and propose a work order when a reading or elapsed interval says service is due.

    With Service Interval, Filter Change

  • Reorder parts consumed on completed work

    Watch WORK_ORDER_STATUS_UPDATED events, read parts used, and propose a purchase order when stock falls below the reorder point.

    With Spares Reorder

Requirements

  • An UpKeep account on the Enterprise Plan, which is the only plan with the API enabled
  • A user account for the connector to sign in as; its permissions bound what the API can see
  • Webhooks registered in Settings > Webhooks or through POST /webhooks/, with the events to subscribe to
  • An upkeep-version header if you need to pin a dated API version other than 2022-09-14
Authentication
A session token: POST /api/v2/auth with a user's email and password returns sessionToken and expiresAt, sent afterwards in the Session-Token header.

Limits

  • Session tokens expire at the expiresAt time returned by /auth and must be renewed
  • The documentation lists a 429 Too Many Requests error but publishes no numeric rate limit
  • Webhook events cover work orders, PM work orders, schedules, purchase orders, and requests; asset and meter changes are polled
  • The webhook documentation describes no signing header or secret for deliveries

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request UpKeep ↗

Questions and answers

Which plan includes API access?
The Enterprise Plan. UpKeep's developer documentation states the API is enabled only for accounts on that plan, and the webhooks setup article lists webhooks as available on Enterprise.
Which events can a webhook subscribe to?
Work order events (created, updated, status updated, deleted), PM work order events, work order schedule events, purchase order events including approved and declined, and request events including approved and rejected. Passing * subscribes to all of them.
How does pagination work?
List endpoints take offset, limit, and orderBy, with date filters such as createdAtGreaterThan and createdAtLessThan in Unix milliseconds. An includes parameter expands related fields. Breaking changes ship as a new dated version selected with the upkeep-version header.
Ask about UpKeep

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.

This connector listing is developed, published, and supported by Fibric. It describes integration with UpKeep through published interfaces. Third-party names and logos identify the systems an integration connects to; they are the property of their respective owners, who are not affiliated with Fibric and do not sponsor or endorse this listing. Trademark policy