Webhook Event Trigger Data Sent

Detailed list of Appointment, Payment, Message, User, Order, customers, Vehicle, and Inventory data sent.

Zack Buffum avatar
Written by Zack Buffum
Updated over a week ago

Event triggers send data using webhooks. This data can be used by other applications to automate processes in your shop. For more information on webhooks in Shopmonkey check out our help article.

Below is a list of the data that is sent out for each event trigger.

Appointment

  • eventId

  • apiVersion

  • webhookId

  • companyId

  • eventType

  • entity

  • documentId

  • data__technicians

  • data__sendEmail

  • data__sendSms

  • data__isSendConfirmation

  • data__isSendReminder

  • data__isRecurring

  • data__isRemovedFromRecurrency

  • data__reminderSentDate

  • data__daysTo

  • data__isPendingConfirmation

  • data__isAllDay

  • data__isDemo

  • data__isRepeatable

  • data__exceptions

  • data__company

  • data__createdByUser

  • data__name

  • data__startDate

  • data__endDate

  • data__customer

  • data__customerPhone

  • data__customerEmail

  • data__car

  • data__color

  • data__reminders

  • type: days

  • data__job

  • data__recurringParams__freq

  • data__recurringParams__interval

  • data__recurringParams__id

  • data__reminderTemplate__templateId

  • data__reminderTemplate__subject

  • data__reminderTemplate__message

  • data__reminderTemplate__id

  • data__confirmationTemplate__templateId

  • data__confirmationTemplate__subject

  • data__confirmationTemplate__message

  • data__confirmationTemplate__id

  • data__updateDate

  • data__publicId

  • data__id

Payments

  • eventId

  • apiVersion

  • webhookId

  • companyId

  • eventType

  • entity

  • documentId

  • data__amount

  • data__stripeData

  • data__firstMileData

  • data__cardData

  • data__checkData

  • data__isDemo

  • data__company

  • data__job

  • data__transactionType

  • data__collectType

  • data__paymentType

  • data__receiptNumber

  • data__creationDate

  • data__updateDate

  • data__id

Messages

  • eventId

  • apiVersion

  • webhookId

  • companyId

  • eventType

  • entity

  • documentId

  • data__files

  • data__isPublic

  • data__isEmailSent

  • data__isSmsSent

  • data__isDemo

  • data__creationDate

  • data__updateDate

  • data__company

  • data__text

  • data__parentType

  • data__parentId

  • data__user__role

  • data__user__useFlatRateForLabor

  • data__user__isActive

  • data__user__isArchived

  • data__user__hasEnabledSMSNotifications

  • data__user__isAllowedNotifyJobAssigned

  • data__user__isAllowedNotifyLaborStatusChanged

  • data__user__isAllowedNotifyOrderAuthorized

  • data__user__isAllowedNotifyCustomerSendsMessage

  • data__user__isAllowedNotifyTeammateSendsMessage

  • data__user__isAllowedNotifyCustomerMakesPayment

  • data__user__isAllowedNotifyChangeAppointmentStatus

  • data__user__isAllowedNotifyWorkRequestReceived

  • data__user__isAllowedNotifyTechRecommendationApproved

  • data__user__isAllowedNotifyQBInventoryAutoSyncUpdates

  • data__user__notifyJobAssigned

  • data__user__notifyLaborStatusChanged

  • data__user__notifyOrderAuthorized

  • data__user__notifyCustomerSendsMessage

  • data__user__notifyTeammateSendsMessage

  • data__user__notifyCustomerMakesPayment

  • data__user__notifyChangeAppointmentStatus

  • data__user__notifyWorkRequestReceived

  • data__user__notifyTechRecommendationApproved

  • data__user__notifyQBInventoryAutoSyncUpdates

  • data__user__isAllowedDashboard

  • data__user__isAllowedWorkflow

  • data__user__isAllowedCalendar

  • data__user__isAllowedInventory

  • data__user__isAllowedTimesheets

  • data__user__isAllowedReportCenter

  • data__user__isAllowedCompanySettings

  • data__user__isAllowedLists

  • data__user__isAllowedEditAuthorizedOrders

  • data__user__isAllowedEditInvoices

  • data__user__isAllowedViewAllOrders

  • data__user__isAllowedProfitability

  • data__user__isAllowedTimeclock

  • data__user__isAllowedCannedJobs

  • data__user__isAllowedInspections

  • data__user__isAllowedInventoryCategories

  • data__user__isAllowedPricingMatrices

  • data__user__isAllowedMessagingCustomers

  • data__user__isIncludedToCalendar

  • data__user__isAllowedViewEveryonesCalendar

  • data__user__isAllowedManualTimesheets

  • data__user__isAllowedAllTimeClocks

  • data__user__isAllowedEditTimesheetEntries

  • data__user__isAllowedEditUsers

  • data__user__isAllowedCompanySwitching

  • data__user__isAllowedChangeLaborStatus

  • data__user__isDemo

  • data__user__tireCommission

  • data__user__partCommission

  • data__user__laborCommission

  • data__user__activeWorkflow

  • data__user__firstName

  • data__user__lastName

  • data__user__email

  • data__user__confirmed

  • data__user__googleCredentials__id

  • data__user__googleCredentials__displayName

  • data__user__googleCredentials__name__familyName

  • data__user__googleCredentials__name__givenName

  • data__user__googleCredentials__emails

  • data__user__googleCredentials__photos

  • data__user__googleCredentials__provider

  • data__user__googleCredentials___raw

  • data__user__googleCredentials___json__sub

  • data__user__googleCredentials___json__name

  • data__user__googleCredentials___json__given_name

  • data__user__googleCredentials___json__family_name

  • data__user__googleCredentials___json__picture

  • data__user__googleCredentials___json__email

  • data__user__googleCredentials___json__email_verified

  • data__user__googleCredentials___json__locale

  • data__user__googleCredentials___json__hd

  • data__user__company

  • data__user__dateCreated

  • data__user__updateDate

  • data__user__publicKey

  • data__user__privateKey

  • data__user__id

  • data__publicId

  • data__customerEmail

  • data__customerPhone__type

  • data__customerPhone__value

  • data__customerPhone__id

  • data__id

User

  • eventId

  • apiVersion

  • webhookId

  • companyId

  • eventType

  • entity

  • documentId

  • data__role

  • data__useFlatRateForLabor

  • data__isActive

  • data__isArchived

  • data__hasEnabledSMSNotifications

  • data__isAllowedNotifyJobAssigned

  • data__isAllowedNotifyLaborStatusChanged

  • data__isAllowedNotifyOrderAuthorized

  • data__isAllowedNotifyCustomerSendsMessage

  • data__isAllowedNotifyTeammateSendsMessage

  • data__isAllowedNotifyCustomerMakesPayment

  • data__isAllowedNotifyChangeAppointmentStatus

  • data__isAllowedNotifyWorkRequestReceived

  • data__isAllowedNotifyTechRecommendationApproved

  • data__isAllowedNotifyQBInventoryAutoSyncUpdates

  • data__notifyJobAssigned

  • data__notifyLaborStatusChanged

  • data__notifyOrderAuthorized

  • data__notifyCustomerSendsMessage

  • data__notifyTeammateSendsMessage

  • data__notifyCustomerMakesPayment

  • data__notifyChangeAppointmentStatus

  • data__notifyWorkRequestReceived

  • data__notifyTechRecommendationApproved

  • data__notifyQBInventoryAutoSyncUpdates

  • data__isAllowedDashboard

  • data__isAllowedWorkflow

  • data__isAllowedCalendar

  • data__isAllowedInventory

  • data__isAllowedTimesheets

  • data__isAllowedReportCenter

  • data__isAllowedCompanySettings

  • data__isAllowedLists

  • data__isAllowedEditAuthorizedOrders

  • data__isAllowedEditInvoices

  • data__isAllowedViewAllOrders

  • data__isAllowedProfitability

  • data__isAllowedTimeclock

  • data__isAllowedCannedJobs

  • data__isAllowedInspections

  • data__isAllowedInventoryCategories

  • data__isAllowedPricingMatrices

  • data__isAllowedMessagingCustomers

  • data__isIncludedToCalendar

  • data__isAllowedViewEveryonesCalendar

  • data__isAllowedManualTimesheets

  • data__isAllowedAllTimeClocks

  • data__isAllowedEditTimesheetEntries

  • data__isAllowedEditUsers

  • data__isAllowedCompanySwitching

  • data__isAllowedChangeLaborStatus

  • data__isDemo

  • data__tireCommission

  • data__partCommission

  • data__laborCommission

  • data__activeWorkflow

  • data__dateCreated

  • data__updateDate

  • data__company

  • data__requestPasswordResetCode

  • data__firstName

  • data__lastName

  • data__email

  • data__phone

  • data__publicKey

  • data__privateKey

  • data__id

Order

  • eventId

  • apiVersion

  • webhookId

  • companyId

  • eventType

  • entity

  • documentId

  • data__isAuthorized

  • data__authorizerIPs

  • data__isPaid

  • data__totalCost

  • data__paidCost

  • data__remainingCost

  • data__isArchived

  • data__canCustomerAuthorize

  • data__canCustomerSeeActivity

  • data__canCustomerSeeAuthorizations

  • data__canCollectPayment

  • data__canCustomerSeeMessages

  • data__tags

  • data__includeEpaOnLabor

  • data__includeEpaOnParts

  • data__isEpaTaxable

  • data__isLaborTaxable

  • data__isPartShopSupplies

  • data__isLaborShopSupplies

  • data__isShopSuppliesTaxable

  • data__useGstPstHst

  • data__shouldTrackQBDepartment

  • data__isDemo

  • data__totalsFormulaVersion

  • data__isInvoice

  • data__poNumber

  • data__partCommission

  • data__tireCommission

  • data__laborCommission

  • data__sentToCarfax

  • data__isWorkOrderWithPricing

  • data__isWorkOrderWithHours

  • data__includeMessagesOnOrderPDF

  • data__includeAuthorizationsOnOrderPDF

  • data__statusDate

  • data__creationDate

  • data__updateDate

  • data__company

  • data__customer

  • data__customerPhone

  • data__workflow

  • data__jobNumber

  • data__jobCardPosition

  • data__publicId

  • data__invoicedDate

  • data__customerEmail

  • data__shopSupplies

  • data__shopSuppliesValueType

  • data__car

  • data__calculatedName

  • data__id

Customer

  • eventId

  • apiVersion

  • webhookId

  • companyId

  • eventType

  • entity

  • documentId

  • data__emails

  • data__shouldReceiveDiscount

  • data__shouldLaborRateOverride

  • data__shouldPricingMatrixOverride

  • data__shouldLaborMatrixOverride

  • data__type

  • data__isCorporateFleetTaxExempt

  • data__unsubscribedCampaignMethods

  • data__isDemo

  • data__tags

  • data__qbTaxExemptionReasonId

  • data__company

  • data__firstName

  • data__lastName

  • data__phones

  • type: mobile

  • data__creationDate

  • data__updateDate

  • data__referralSource

  • data__publicId

  • data__id

Vehicle

  • eventId

  • apiVersion

  • webhookId

  • companyId

  • eventType

  • entity

  • documentId

  • data__standardCarData__vehicleId

  • data__standardCarData__baseVehicleId

  • data__standardCarData__makeId

  • data__standardCarData__modelId

  • data__standardCarData__submodelId

  • data__standardCarData__engineId

  • data__standardCarData__year

  • data__standardCarData__make

  • data__standardCarData__model

  • data__standardCarData__submodel

  • data__standardCarData__engineSize

  • data__standardCarData__transmissionId

  • data__standardCarData__drivetrainId

  • data__mileageUnit

  • data__owners

  • data__isDemo

  • data__motors

  • data__creationDate

  • data__updateDate

  • data__company

  • data__type

  • data__make

  • data__year

  • data__model

  • data__submodel

  • data__engineSize

  • data__transmission

  • data__drivetrain

  • data__id

Inventory

  • eventId

  • apiVersion

  • webhookId

  • companyId

  • eventType

  • entity

  • documentId

  • data__quantity

  • data__criticalQuantity

  • data__description

  • data__binLocation

  • data__retailCost

  • data__wholesaleCost

  • data__showPartNumOnQuotesInvoices

  • data__showPriceQtyQuotesInvoices

  • data__showNoteOnQuotesInvoices

  • data__isShort

  • data__isReorder

  • data__isDemo

  • data__shouldSyncToQB

  • data__company

  • data__name

  • data__number

  • data__vendor

  • data__pricingMatrix

  • data__isTaxable

  • data__creationDate

  • data__updateDate

  • data__id

Inspections

Webhooks Inspections Data

 "body": [
    {
      "eventId":
      "apiVersion":
      "webhookId":
      "companyId":
      "eventType":
      "entity":
      "documentId":
      "data": {
        "creationDate":
        "updateDate":
        "isDemo":
        "id":
        "name":
        "isCompleted":
        "templateId":
        "orderId":
        "createdByUserId":
        "inspectionPdfUrl":
      },
      "mappings": {
        "techRecommendations": [
          {
            "company":
            "id":
            "inspectorUserId":
            "name":
            "authorizationStatus":
            "creationDate":
            "files":
            "inspectionDate":
            "isApproved":
            "isDemo":
            "status":
            "updateDate":
            "inspectorUser":
              "firstName":
              "lastName":
              "id":
          }
        ],
        "createdByUser":
          "firstName":
          "lastName":
          "id":
        },
        "customer":
          "firstName":
          "lastName":
          "id":
        },
        "vehicle": 
          "vin": 
          "licencePlate":
          "make": 
          "model": 
          "year": 
          "id": 
        },
        "order": {
          "authorizerIPs": 
          "canCollectPayment": 
          "canCustomerAuthorize": 
          "canCustomerSeeActivity": 
          "canCustomerSeeAuthorizations": 
          "canCustomerSeeMessages": 
          "car": 
          "company": 
          "creationDate": 
          "customerEmail": 
          "customerPhone": 
          "id": 
          "includeAppointmentsOnOrderPDF": 
          "includeAuthorizationsOnOrderPDF": 
          "includeEpaOnLabor": 
          "includeEpaOnParts": 
          "includeMessagesOnOrderPDF": 
          "invoicedDate": 
          "isArchived": 
          "isAuthorized": 
          "isDemo": 
          "isEpaTaxable": 
          "isInvoice": 
          "isLaborShopSupplies": 
          "isLaborTaxable":
          "isPaid":
          "isPartShopSupplies":
          "isShopSuppliesTaxable":
          "isWorkOrderWithAppointments":
          "isWorkOrderWithHours":
          "isWorkOrderWithInternalNotes":
          "isWorkOrderWithPricing":
          "jobCardPosition":
          "jobNumber":
          "laborCommission":
          "paidCost":
          "partCommission":
          "paymentDueDate":
          "paymentTermId":
          "poNumber":
          "profitabilityPct": 
          "profitabilityTotal":
          "publicId":
          "remainingCost":
          "requestedDeposit":
          "sentToCarfax":
          "shopSupplies":
          "shopSuppliesMaxCap":
          "shopSuppliesValueType":
          "shouldTrackQBDepartment":
          "statusDate":
          "tags":
          "tireCommission":
          "totalCost":
          "totalsFormulaVersion":
          "updateDate":
          "useGstPstHst":

Did this answer your question?