Skip to main content

Triggers

A trigger is what starts a Zap. The connector offers three, and all three are about appointmentsAppointmentA task scheduled to a resource for a specific period - the scheduled instance you see on the planning board.: created, updated, and removed. There is no trigger for a change to a taskTaskA unit of work that belongs to a job. It appears in the open task list until it is scheduled to a resource., a resourceResourceAn entity that can carry out work - a person, vehicle, tool, or room - that you schedule on the planning board., or a jobJobA high-level container, comparable to a project, that bundles related tasks together with common information such as customer, billing, and address., so a workflow that needs to react to one of those wants the webhook connector instead.

All three are webhook-based rather than polled, so they fire within seconds of the event rather than on a schedule.

New appointment

newAppointment fires when an appointment is created.

It carries the full appointment, so in most cases you do not need a follow-up lookup to enrich the data before acting on it.

FieldTypeDescription
idstringUnique identifier for the appointment
appointmentNostringHuman-readable appointment number
appointmentGuidstringGlobal unique identifier
jobNostringAssociated job number
taskNostringAssociated task number
resourceNostringAssigned resource number
subjectstringAppointment subject or title
bodystringAppointment description or notes
startdatetimeAppointment start date and time
enddatetimeAppointment end date and time
importanceinteger0 = normal, 1 = high, 2 = low
lockedbooleanWhether the appointment is locked
planningQuantitystringPlanning quantity for the appointment
unitOfMeasurestringUnit of measure, for example H for hours
createdAtdatetimeWhen the appointment was created
updatedAtdatetimeWhen the appointment was last modified

Updated appointment

updatedAppointment fires when an existing appointment is modified. It returns the same fields as above, with updatedAt reflecting the modification.

This is the trigger to treat with care, because any change fires it. A resize on the planning board, a category swap, a subject correction: all of them. A Zap that posts to a channel on every update will be muted by its recipients within a week.

Put a Zapier filter directly after the trigger and narrow it to what actually matters, whether that is a particular category, a resource, or a change in the start time.

Removed appointment

removedAppointment fires when an appointment is deleted. It returns the same fields plus one:

FieldTypeDescription
deletedAtdatetimeWhen the appointment was deleted

This is the trigger most often left unbuilt, and the omission is quiet. A workflow that creates a calendar event on newAppointment but ignores removedAppointment leaves cancelled work sitting in people's calendars, and nobody reports it for weeks. If you handle creation, handle removal.

Choosing an identifier

Three identifiers arrive with every trigger, and they are for different jobs:

  • appointmentGuid is the one to store in an external system, since it is globally unique and stable.
  • appointmentNo is the human-readable reference, for a message or a spreadsheet a person will read.
  • id is for operations back against Dime.Scheduler.

Picking the wrong one usually surfaces later as a lookup that cannot find the record it just wrote.

Dates and duplicates

Every datetime field uses ISO 8601. Zapier converts these automatically for downstream apps, but time zones remain worth checking, since an appointment that lands an hour out is easy to miss and hard to explain.

Duplicate deliveries are unlikely rather than impossible. If a repeated event would be damaging, for example one that charges a customer or sends a message, add deduplication on the receiving side rather than assuming exactly-once delivery.

Triggers themselves are instant and unmetered by Dime.Scheduler, but the downstream actions in your Zap are not. Rate limits on the services you call are usually what bites first on a busy planning day.