Guides

Event catalogue

Every event ClockLap sends, 134 in all, grouped by area. Subscribe to exact names, a whole group such as timesheet.*, or * for everything.

Building a payroll export? Subscribe to timesheet.approved and timesheet.reopened. Showing who's on site? time_entry.clocked_in and time_entry.clocked_out.

Clocking in and out#

Event	When
`punch.created`	A clock-in, clock-out or break punch was recorded (by the app, a kiosk, a manager or the API).
`punch.rejected`	A punch was refused, for example outside the geofence or with fake GPS.
`time_entry.clocked_in`	Someone started a shift.
`time_entry.clocked_out`	Someone ended a shift.
`time_entry.auto_closed`	A shift left open was closed automatically.
`break.started`	A break started.
`break.ended`	A break ended.
`time_entry.attested`	Someone answered the clock-out questions.
`break.due`	A break is due under the break rules.
`break_premium.waived`	Break premium: waived.
`break_premium.unwaived`	Break premium: unwaived.

Geofences#

Event	When
`geofence.entered`	A phone entered a site’s geofence.
`geofence.exited`	A phone left a site’s geofence.
`geofence.created`	Geofence: created.
`geofence.updated`	Geofence: updated.
`geofence.deleted`	Geofence: deleted.

Shifts (time entries)#

Event	When
`time_entry.created`	A shift was added (by a manager, an assistant or the API).
`time_entry.updated`	A shift’s times, site, project or notes changed. `data.previous` has the old values.
`time_entry.deleted`	A shift was deleted.
`time_entry.approved`	A shift was approved.
`time_entry.flagged`	A shift was flagged for review.

Correction requests#

Event	When
`edit_request.created`	Someone asked for a correction to their hours.
`edit_request.approved`	Edit request: approved.
`edit_request.rejected`	Edit request: rejected.

Time off#

Event	When
`time_off.requested`	Someone asked for time off.
`time_off.approved`	Time off was approved.
`time_off.rejected`	Time off: rejected.
`time_off.cancelled`	Time off: cancelled.
`time_off.balance_changed`	Time off: balance changed.
`holiday.updated`	Holiday: updated.

Weekly patterns#

Event	When
`schedule.updated`	Schedule: updated.

Scheduled shifts#

Event	When
`shift.created`	Shift: created.
`shift.updated`	Shift: updated.
`shift.published`	A schedule was published to the people on it.
`shift.cancelled`	Shift: cancelled.
`shift.claimed`	Shift: claimed.
`shift_request.created`	Shift request: created.
`shift_request.accepted`	Shift request: accepted.
`shift_request.approved`	Shift request: approved.
`shift_request.declined`	Shift request: declined.
`shift_request.cancelled`	Shift request: cancelled.

Clients, projects and activities#

Event	When
`customer.created`	Customer: created.
`customer.updated`	Customer: updated.
`customer.archived`	Customer: archived.
`project.created`	Project: created.
`project.updated`	Project: updated.
`project.archived`	Project: archived.
`activity.created`	Activity: created.
`activity.updated`	Activity: updated.
`activity.archived`	Activity: archived.

Timesheets#

Event	When
`timesheet.submitted`	Someone confirmed their hours for a pay period.
`timesheet.approved`	A timesheet was approved. The usual trigger to send hours to payroll.
`timesheet.reopened`	An approved timesheet went back to open (hours changed or a manager reopened it).
`timesheet.locked`	A pay period was locked: its hours can’t change.
`timesheet.unlocked`	Timesheet: unlocked.
`timesheet.exported`	Hours were exported.

Exceptions#

Event	When
`exception.raised`	Something needs a look: a missed clock-out, a late start, a punch outside the fence…
`exception.resolved`	An exception was closed.

People#

Event	When
`user.invited`	Someone was invited.
`user.activated`	Someone accepted their invite or was reactivated.
`user.updated`	A person’s details changed.
`user.suspended`	User: suspended.
`user.archived`	Someone was archived (left).
`user.role_changed`	User: role changed.
`user.locations_changed`	User: locations changed.
`user.deletion_requested`	User: deletion requested.
`user.anonymized`	User: anonymized.
`email.bounced`	Email: bounced.

Phones#

Event	When
`device.registered`	Device: registered.
`device.revoked`	Device: revoked.
`device.location_permission_changed`	Device: location permission changed.

Locations#

Event	When
`location.created`	Location: created.
`location.updated`	Location: updated.
`location.archived`	Location: archived.
`location.settings_changed`	Location: settings changed.

Site requests#

Event	When
`location_request.created`	Location request: created.
`location_request.approved`	Location request: approved.
`location_request.rejected`	Location request: rejected.
`location_request.cancelled`	Location request: cancelled.

Workspace#

Event	When
`client.created`	Client: created.
`client.updated`	Client: updated.
`branding.published`	Branding: published.
`policy.updated`	Policy: updated.
`monitoring_policy.published`	Monitoring policy: published.

Single sign-on#

Event	When
`sso_connection.created`	Sso connection: created.
`sso_connection.updated`	Sso connection: updated.
`sso_connection.deleted`	Sso connection: deleted.
`sso_domain.verified`	Sso domain: verified.
`user.signed_in_with_sso`	User: signed in with sso.

Billing#

Event	When
`billing.trial_started`	Billing: trial started.
`billing.invoice_finalized`	Billing: invoice finalized.
`billing.payment_method_added`	Billing: payment method added.

API keys and webhooks#

Event	When
`api_key.created`	Api key: created.
`api_key.revoked`	Api key: revoked.
`webhook_endpoint.created`	Webhook endpoint: created.
`webhook_endpoint.updated`	Webhook endpoint: updated.
`webhook_endpoint.disabled`	Webhook endpoint: disabled.

Payroll, HR and accounting connections#

Event	When
`connection.connected`	Connection: connected.
`connection.disconnected`	Connection: disconnected.
`connection.error`	Connection: error.
`connection.credentials_expiring`	Connection: credentials expiring.
`payroll.run_ready`	Payroll: run ready.
`payroll.run_sent`	Hours were sent to a connected payroll system.
`payroll.run_failed`	Payroll: run failed.
`people_sync.completed`	People sync: completed.
`accounting.invoice_synced`	Accounting: invoice synced.
`accounting.sync_failed`	Accounting: sync failed.
`field_service.jobs_imported`	Field service: jobs imported.
`field_service.hours_sent`	Field service: hours sent.

Reports and exports#

Event	When
`export.completed`	An export finished and is ready to download.
`export.failed`	Export: failed.
`report.scheduled_sent`	Report: scheduled sent.

Insights#

Event	When
`insights.digest_ready`	Insights: digest ready.

Invoices and payments#

Event	When
`invoice.created`	Invoice: created.
`invoice.updated`	Invoice: updated.
`invoice.sent`	Invoice: sent.
`invoice.viewed`	Invoice: viewed.
`invoice.paid`	An invoice was paid in full.
`invoice.voided`	Invoice: voided.
`payment.recorded`	A payment was recorded on an invoice.
`payment.failed`	Payment: failed.
`payment.refunded`	Payment: refunded.
`payments.account_connected`	Payments: account connected.
`payments.account_disconnected`	Payments: account disconnected.

Notes, photos and voice notes#

Event	When
`media.uploaded`	Media: uploaded.
`media.deleted`	Media: deleted.
`note.created`	Note: created.
`note.updated`	Note: updated.
`note.deleted`	Note: deleted.
`voice_note.ready`	Voice note: ready.
`voice_note.failed`	Voice note: failed.
`ai.connected`	Ai: connected.
`ai.disconnected`	Ai: disconnected.
`ai.limit_reached`	Ai: limit reached.

Exception types#

exception.raised carries one of these in data.object.type:

Type
`missed_clock_out`	missed clock out
`late`	late
`early_leave`	early leave
`outside_fence`	outside fence
`mock_location`	mock location
`long_shift`	long shift
`overtime_threshold`	overtime threshold
`clock_skew`	clock skew
`low_accuracy`	low accuracy
`unassigned_location`	unassigned location
`break_missed`	break missed
`break_short`	break short
`break_late`	break late
`attestation_flag`	attestation flag
`anomaly`	anomaly

Test event#

webhook.test is sent only when you press Send test event (or call the test endpoint). Its data.object.message is “Hello from ClockLap. Your endpoint is reachable.”