Event catalog

ServFlo sends 107 kinds of event. Each delivery's body is the event envelope with the fields below in data. Event data carries ids, statuses, amounts and dates only: never names, addresses, notes, secrets or costs. Read the full record with the API when you need it (the record's id is data.recordId).

Subscribe to any of these by name when you create a webhook endpoint, or leave the list empty to receive every event. The same list is available from the API: List event types.

Common to every event:

Customers

customer.created

A customer (or lead) was created.

customer.updated

A customer's details changed. fields names what changed (never the values).

portal.link_created

A customer portal link was created or replaced.

portal.session_revoked

A customer's portal session ended early: they signed out, staff signed them out, or sign-in was turned off. recordId is the session.

portal.signed_in

A customer signed in to their portal with a code or a one-tap email link. recordId is the customer session.

portal.viewed

A customer opened their portal.

Requests and quotes

booking.confirmed

A slot booked online became a job: by staff, or at once with automatic confirmation.

quote.approved

A quote was approved (by the customer, or by staff for them).

quote.changes_requested

The customer asked for changes to a quote.

quote.converted

An approved quote became a job or an invoice.

quote.created

A quote was created.

quote.declined

The customer declined a quote.

quote.sent

A quote was sent to the customer.

request.archived

A request was archived.

request.assessment_scheduled

An on-site assessment was booked for a request.

request.converted

A request became a job.

request.created

A service request came in (by staff, online booking or the portal).

Jobs and visits

agreement.signed

A pre-service agreement on a job was signed.

form.submitted

A job form was submitted.

job.cancelled

A job was cancelled.

job.completed

A job (or visit) was completed.

job.created

A job was created.

job.scheduled

A job (or one of its visits) got a new date, time or technician.

job.signed

The customer signed off a job.

job.started

Work on a job (or visit) started.

service_report.assistant_applied

A person accepted a change the inspection assistant proposed for a report (status, describe answers, findings, notes or a new section); it was applied through the normal report edits.

service_report.published

A service report (inspection, service or test report) was published as a new version.

service_report.released

A published service report opened for its client (by its release rule: published, paid, agreement signed, or a manual unlock).

service_report.viewed

Someone opened a service report from their link for the first time.

service_report_template_draft.ready

A report template drafted by AI from a business's standards document finished reading (ready to review) or failed. recordId is the draft.

technician.on_my_way

A technician is on the way to a job.

visit.cancelled

A visit of a job was cancelled (its reminders are withdrawn).

Invoices

invoice.created

An invoice was created (usually as a draft).

invoice.overdue

An unpaid invoice passed its due date (the scheduler's overdue sweep).

invoice.paid

An invoice was paid in full.

invoice.partially_paid

A payment left part of an invoice due.

invoice.sent

An invoice was issued to the customer (status SENT).

invoice_batch.completed

A batch action on invoices finished (batch create from jobs, batch send, reminders or mark sent); recordId is the batch key.

progress_billing.completed

A progress billing has billed its whole contract and released any retainage.

progress_billing.created

A quote or job was set up for progress billing (milestones or percent complete).

progress_billing.invoiced

A progress, final or retainage-release invoice was made from a progress billing.

Payments

payment.disputed

A customer's bank opened a dispute (chargeback) on an online payment.

payment.failed

An online payment failed: declined, the bank asked for authentication on an automatic charge, a bank debit bounced, or the checkout page expired unpaid.

payment.recorded

Money was received: against an invoice, or a quote deposit.

payment.refunded

A payment was (partly) refunded.

payments.account_updated

The business's Stripe account changed standing: connected, charges or payouts enabled or paused, details submitted, or disconnected.

Memberships

membership.billed

A membership billing period was invoiced.

membership.cancelled

A membership was cancelled.

membership.created

A customer signed up to a membership plan.

membership.expired

A membership's term ended without renewal.

membership.paused

A membership was paused.

membership.renewed

A membership started a new term.

membership.visit_due

An included member visit's window opened; its job waits to be scheduled.

Team

chat.message_sent

Someone wrote in team chat (the team, a direct message or a job's conversation).

payroll.closed

A pay period was closed for payroll: its time entries are locked until it is reopened. recordId is organizationId:periodStart.

payroll.reopened

A closed pay period was reopened so its time can change. recordId is organizationId:periodStart.

technician.linked

A technician record was linked to a ServFlo account.

time.clocked_in

Someone clocked in.

time.clocked_out

Someone clocked out.

timesheet.approved

A weekly timesheet was approved.

timesheet.rejected

A weekly timesheet was sent back.

timesheet.submitted

A weekly timesheet was submitted for approval.

Inventory and purchasing

expense.recorded

An expense was recorded.

inventory.low_stock

An item reached its reorder point at a location.

inventory.negative_stock

An item went below zero at a location.

inventory.transferred

Stock moved between locations.

parts_request.created

A technician asked for parts (for a job or to restock their truck).

parts_request.status_changed

The office moved a parts request along (on order, ready, done, cancelled).

pricebook.imported

A pricebook CSV was imported.

pricebook.repriced

Markup items were repriced.

purchase_order.cancelled

A purchase order was cancelled.

purchase_order.received

Items on a purchase order were received.

purchase_order.sent

A purchase order was sent to its vendor.

Commissions

commission.approved

Commission lines were approved.

commission.calculated

Commissions were calculated for a pay period.

commission.paid

Commission lines were marked paid.

Messages and automations

automation.disabled

An automation (engagement rule) was turned off.

automation.enabled

An automation (engagement rule) was turned on.

consent.changed

A contact method's messaging consent changed (STOP / START reply, the unsubscribe page, staff, a bounce).

message.bounced

An email bounced or was marked as spam; its address is suppressed.

message.delivered

The provider confirmed a message was delivered.

message.failed

A message could not be sent (the provider refused it).

message.replied

A customer replied to a text (logged as an inbound message). Ends cadences that list it as an exit.

message.sent

A customer email or text was sent (or, in test mode, rendered and logged as SENT_TEST).

Marketing

campaign.cancelled

A campaign was cancelled before it finished.

campaign.completed

Every recipient of a campaign was handled (queued, or skipped with the reason).

campaign.paused

A sending or scheduled campaign was paused.

campaign.resumed

A paused campaign was resumed.

campaign.scheduled

A marketing campaign was scheduled for later (a time, or each recipient's local time).

campaign.started

A marketing campaign started sending.

referral.converted

A referred customer converted (first paid invoice by default); the referrer's reward was issued unless the cap withheld it.

referral.created

Someone came in through a customer's referral link, or staff recorded a referral.

referral.rejected

A referral was refused: self-referral, an existing customer, or by staff.

referral.reward_applied

A referral reward was used: a credit line on an invoice, or the gift card was sent.

referral.reward_issued

A referral reward was earned.

Website

website.deleted

The business's website was deleted with its pages, addresses and stats (the image library stays).

website.domain_activated

A custom domain passed its DNS checks and now serves the website.

website.published

The business's website was published (or republished).

website.unpublished

The business's website was taken down.

Reviews

feedback.submitted

A customer rated their service when paying (stars and a comment, kept in ServFlo). Low ratings are worth a call.

review.received

A new Google review arrived (synced from the Business Profile). Low ratings are worth a quick reply.

review.replied

The business replied publicly to a Google review.

Phone

call.completed

A call ended: answered (COMPLETED), MISSED, VOICEMAIL or, for an outbound call, FAILED.

call.received

An inbound call reached one of the business's numbers (before anyone answered).

System

billing.addon_acknowledged

An owner accepted a paid add-on's usage terms (adding it, turning on ServFlo-managed telephony, or after a price change). recordId is the acknowledgement.

import.completed

A migration import finished. The only event of an import: its records emit no events of their own. recordId is the import run.

webhook.test

A test event sent from Settings → Developers → Webhooks to one endpoint only. Sent only by Send test event; you cannot subscribe to it.