Manage CrispHive field-service customers, job requests, scheduling previews and commits, technicians, skills, service areas and vehicles.
Explore 64 workflow actions for CrispHive, including account permissions and operation limits.
30 read actions34 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Book and confirm job request
Write
Creates the job, quotes it (job_duration_minutes, or the job type's default_duration_minutes) and confirms it at scheduled_at on the customer's behalf - the dashboard's "book for a caller" in a single request, built for voice agents and automation platforms that cannot run create to quote to slots to confirm.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Commit absence resolve
Write
Applies the plan returned by /absence/preview, ATOMICALLY: every assignment in one transaction (all or nothing), each job re-staffed onto its alternate at its unchanged window, its "needs attention" flag cleared, its status_version bumped.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Commit emergency reschedule
Write
Applies the cascade previewed by /emergency/preview: assigns the emergency job to the technician and pushes the displaced jobs back (or, with displacement_mode=reassign, re-staffs them onto their previewed alternates first), atomically.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Commit job request move
Write
Applies the move previewed by /move/preview: places the job on the technician at the new time and pushes the displaced jobs back, atomically (per-tech advisory lock; the server recomputes the plan and fences each job on its status_version - drift since the preview returns 409 SCHEDULE_MOVE_PLAN_DRIFTED, re-preview).
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Confirm job request
Write
Fires the customer-actor confirm_booking action from the BUSINESS surface (audited as business_on_behalf).
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create customer
Write
Creates a customer record - the client/account profile a job request (work order) is booked against; use it to import or sync customers from your own CRM, website lead form or intake flow.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create job request
Write
Books a field-operations job - the work order that enters the dispatch & scheduling pipeline.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create job type
Write
Creates a kind of work customers can book, such as "Annual boiler service" or "Drain unblocking".
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create service area
Write
Creates a service area: a named region used as a HARD filter when deciding who can take a job.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create skill
Write
Creates a skill under the given category.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create skill category
Write
Creates a skill category for the current business.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create technician
Write
Creates a technician membership under the current business.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create technician time off
Write
Records a time-off block for a technician.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create vehicle
Write
Registers a van, truck or car in the business's own fleet.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete customer
Write
Soft-deletes a customer record, removing it from the active customer directory; existing bookings keep their customer snapshot.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete job type
Write
Soft-deletes the entry: it disappears from the catalog and can no longer be selected for new bookings.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete service area
Write
Soft-deletes the service area: it disappears from listServiceAreas and stops counting for coverage immediately.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete skill
Write
Permanently deletes a skill.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete skill category
Write
Permanently deletes a skill category.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete technician
Write
Closes the technician's membership: the profile is set to deactive and soft-deleted, and their access to this business ends on their next request.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete vehicle
Write
Soft-deletes the vehicle and, in the same transaction, removes it from every technician's vehicle list.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get customer
Read
Returns the full customer record: profile, contact details, tier and lifetime spending summary - a 360° client view for support, upsell or CRM enrichment.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
Get job request
Read
Returns the full work order: current workflow status, quoted duration, confirmed schedule, customer contact snapshot and the assigned technician / crew - everything a dispatcher or an external field-operations system needs to track one job.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
Get job request timeline
Read
Per-status progress of a job's lifecycle (e.g.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
Get job type
Read
Returns one entry of the business's service catalog (job/work-order type) with its localized display name - e.g.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
Get service area
Read
Returns one service area - a geographic coverage zone (service territory) the business operates in, with its name and geometry metadata.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
Get technician
Read
Returns one technician's full profile: contact info, employment status, assignment tier, skills/qualifications, buddy (crew) relations and assigned vehicles - the dispatch-ready view of a field worker.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
Get technician schedule
Read
The technician's ACTUAL occupancy over a date range: every job session on their lane (solo/lead and crew) plus approved time-off blocks.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
Get vehicle
Read
Returns one fleet vehicle (service van/truck): identity, plate, operational status (idle, on job, maintenance) and which technicians use it - the fleet-management view of a single asset.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List assignable groups
Read
Returns the role groups the CURRENT caller is allowed to hand out when creating or re-roling a team member, filtered server-side by the role-assignment ceiling (system groups: at or below the caller's own rank, inclusive; custom groups: only those whose permissions are a subset of the caller's).
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List crew candidates
Read
RE-STAFFING candidates for a CONFIRMED, SCHEDULED job (not yet completed/archived) - any earlier or later stage returns 409 JOB_REQUEST_INVALID_TRANSITION.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List customers
Read
Returns a paginated, searchable directory of the business's customer records - the customer database (CRM) behind every booking and work order.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List emergency candidates
Read
Returns the technicians who could take the emergency job at the requested start, ranked FASTEST-ARRIVAL first (arrival beats route efficiency for a P0).
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List job request booking windows
Read
Real-time appointment availability from the scheduling engine: returns the bookable date + time-period windows given technician capacity, working hours and service-territory coverage.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List job request changes
Read
Keep an external system (your CRM, ERP or field-operations tool) in sync with bookings WITHOUT re-listing everything: returns the job requests (work orders) whose state changed (created, status transition, reschedule, soft-delete/archive) at or after the since cursor, ordered oldest-change-first (updated_at ASC).
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List job requests
Read
Paginated list of the business's bookings (work orders) with dispatch-oriented filters: workflow status, customer, assigned technician, scheduled date range and free-text search over code/description.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List job types
Read
Returns the business's service catalog - the job/work-order types it offers (e.g.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List matching slots
Read
Bookable arrival-window slots for a quoted job, computed by the smart-assignment matching engine: each slot lists the technicians actually available to start then (skills, weekly availability, existing schedule, time off and travel all checked), with a per-technician match score.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List nearby technicians
Read
Ranks who could serve a hypothetical visit at (lat,lng) starting at for duration_minutes - the engine applies the REAL hard filters (weekly hours, existing schedule, approved time-off, geographic service areas, optional skill floor) and returns candidates nearest-arrival first.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List service areas
Read
Returns the business's geographic coverage: paginated service areas (service territories / coverage zones) used for routing jobs to the right teams.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List skill categories
Read
Returns paginated skill categories - how the business groups technician qualifications by trade or specialty (e.g.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List skills
Read
Returns the flat list of all active technician skills / qualifications for the current business - the vocabulary the dispatch engine uses for skill-based matching when assigning technicians and crews.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List skills by category
Read
Returns paginated skills (technician qualifications/certifications) belonging to the given trade/specialty category, ordered alphabetically.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List technician skills
Read
Returns paginated skills assigned to the technician.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List technician time off
Read
Returns the technician's time-off records (pending, approved, rejected, cancelled), paginated, optionally bounded by start_date/end_date (YYYY-MM-DD, inclusive overlap) and status.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List technicians
Read
Returns the field workforce roster: paginated technicians (field workers / engineers) with status, assignment tier (lead, buddy, float), skills and crew relations - the people the dispatch engine schedules onto jobs.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List vehicles
Read
Returns the business's fleet: paginated service vehicles (vans/trucks) with operational status (idle, on job, maintenance) - the fleet inventory behind crew carpooling and job mobilization.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
List webhook event types
Read
Returns the catalog of event types you can subscribe a webhook to (resource.action, e.g.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
Preview absence resolve
Read
Solves (WITHOUT writing) the re-staffing of every job on a technician's board for a date range: each job is handed to an ALTERNATE lead technician at its UNCHANGED window - the customer's appointment never moves, two overlapping jobs never land on the same alternate, and the absent technician is never a candidate.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
Preview emergency reschedule
Read
Computes (WITHOUT writing) the cascade of inserting an emergency job onto a technician at a chosen time: where the emergency lands + every job pushed back, grouped per business-local day.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
Preview job request move
Read
Computes (WITHOUT writing) the outcome of moving a confirmed job to a new time and/or technician: where it lands, every later job pushed back per mode, and the warnings the coordinator would accept (displaced jobs leaving their confirmed windows, overtime).
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
Quote job request
Write
Sends the quote: sets quoted_at + duration cols, advances pending_action to confirm_booking.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Replace technician buddies
Write
Overwrites the technician's buddy list with the provided set of technician IDs.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Replace technician leads
Write
Sets the full set of leads this buddy belongs to (many-to-many favorites).
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Replace technician service areas
Write
Overwrites the technician's service-area assignments with the provided set of service area IDs.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Replace technician skills
Write
Sets the technician's full skill set in one call (replace semantics): skills not in the list are removed, new ones added.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Replace technician vehicles
Write
Overwrites the technician's vehicle list with the provided set of vehicle IDs (the vehicles this technician uses).
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update customer
Write
PARTIAL update - send only the fields you are changing; anything you OMIT is left exactly as stored (two-way CRM sync friendly: push one field from your system of record without re-sending the record).
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update job priority
Write
Sets the P0-P3 priority on a non-archived, non-completed job (Owner / Administrator / Booking Coordinator).
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update job type
Write
Edits a catalog entry in place.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update service area
Write
Edits a service area in place, keeping its id and every technician already assigned to it.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update skill
Write
Updates a skill's name, description, and/or active status.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update technician
Write
Updates mutable technician profile fields.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update vehicle
Write
Edits an existing fleet record in place; the vehicle id and the technicians who use it are untouched.
Permissions and limits
Account permissions
A CrispHive secret API key with the permission each call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in CrispHive. A saved workflow is not a completed provider action.