Customer Events

You can create webhooks for the following events that occur for a customer.
CreatedA customer is created. This payload, with an action key of customer:created, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. This is an object with the following properties:
uniqueID: The unique id of the site.
name: The name of the site.
subdomain: The name of the sites subdomain.
sid: The sites internal identifier.
account
The account that the customer belongs to. This is an object with the following properties:
uniqueID: The unique id of the account.
name: The name of the account.
email: The email address on file for the account.
phone: The phone number on file for the account.
fax: The fax number on file for the account.
website: The web site on file for the account.
accountID: The account ID for the account.
user
The user who created the customer. This is an object with the following properties:
uniqueID: The unique id of the user.
firstname: The first name of the user.
lastname: The last name of the user.
email: The email address of the user.
phone: The phone number of the user.
customer
The customer that was created. This is an object with the following properties:
UniqueID: The unique id of the customer.
displayname: The unique display name of the customer.
ExternalID: The external ID of the customer.
FirstName: The customer's first name.
MiddleInitial: The customer's middle initial.
LastName: The customer's last name.
CompanyName: The name of the company the customer is with.
AccountNumber: The customer's account number.
JobNumber: The customer's job number.
SalesRep: The email address of the customer's sales rep.
Installer: The email address of the customer's installer.
Terms: The terms assigned to the customer.
LeadSource: The customer's lead source.
Location: The customer's location.
DiscountGroup: The discount group the customer belongs to.
CustomerType: The type of customer.
AlternateInstaller: The customer's alternate installer.
BillToAddress1: Line 1 of the customer's billing address.
BillToAddress2: Line 2 of the customer's billing address.
BillToCity: The customer's billing city.
BillToState: The customer's billing state.
BillToZip: The customer's billing postal code.
BillToCountry: The customer's billing country.
TaxExempt: True or false to indicate if the customer is tax exempt.
TaxExemptReason: A number that indicates the reason the customer is tax exempt. See Tax Exempt below for more information.
TaxExemptDetails: A more in-depth explanation of the customer's reason for being tax exempt.
AppointmentType: The customer's appointment type.
Phones: An array of phone number objects with the following properties:
Primary: True or false to indicate if the phone number is the primary phone number.
Sequence: The sort sequence of the phone number.
Label: The text label of the phone number.
Number: The phone number.
AddedOn. The date/time when the phone number was added.
UpdatedOn: The date/time when the phone number was last updated.
Addresses: An array of address objects with the following properties:
Primary: True or false to indicate if the address is the customer's primary shipping address.
Sequence: The sort sequence of the address.
Label: The text label of the address:
Address1: Line 1 of the address.
Address2: Line 2 of the address.
City: The address' city.
State: The address' state.
Zip: The address' postal code.
Country: The address' country.
AddedOn: The date/time when the address was added.
UpdatedOn: The date/time when the address was last updated.
Attachments: An array of attachment objects. See the Attachment added event for details.
Emails: An array of email objects with the following properties:
Primary: True or false to indicate if the email address is the primary email address.
Sequence: The sort sequence of the email address.
Label: The text label of the email address.
Address: The email address.
AddedOn. The date/time when the email address was added.
UpdatedOn: The date/time when the email address was last updated.
Links: An array of link objects. See the Link created event for details.
Notes: An array of note objects with the following properties:
NoteText: The text of the note.
AddedOn: The date/time when the note was added.
UpdatedOn: The date/time when the note was last updated.
Tags: An array of tag objects with the following properties:
TagText: The text of the tag.
AddedOn: The date/time when the tag was added.
TaxCodes: An array of tax code objects with the following properties:
Code: The code of the tax code.
Agency: The agency of the tax code.
Rate: The tax code's rate.
AddedOn: The date/time when the tax code was added.
UpdatedOn: The date/time when the tax code was last updated.
Tax exempt
None = 0
Federal Government = 1
State Government = 2
Local Government = 3
Tribal Government = 4
Charitable Organization = 5
Religious Organization = 6
Educational Organization = 7
Hospital = 8
Resale = 9
Direct Pay Permit = 10
Multiple Points of Use = 11
Direct Mail = 12
Agricultural Production = 13
Industrial Production or Manufacturing = 14
Foreign Diplomat = 15
customer:created payload
{
  "site": {
    "uniqueID": "5cf3c498-fffd-4a67-9143-d4f8219262cc",
    "name": "My Blinds",
    "subdomain": "myblinds",
    "sid": 749339
  },
  "account": {
    "UniqueID": "8d2a803f-c75e-4782-90e8-336be0ec1807",
    "name": "South Side Location",
    "email": "southsales@myblinds.com",
    "phone": "(234) 567-8901",
    "fax": "",
    "website": "www.myblinds.com",
    "accountID": "My Blinds South"
  },
  "user": {
    "FirstName": "Joe",
    "LastName": "Smith",
    "UniqueID": "6f22f0ec-cd58-4ae9-bc35-a797955b1156",
    "Email": "joe@myblinds.com",
    "Phone": "456-847-8487"
  },
  "customer": {
    "UniqueID": "a5b5a410-b321-4b45-a5b0-b10f96e6ca23",
    "ExternalID": "",
    "DisplayName": "Jack Black",
    "FirstName": "Jack",
    "LastName": "Black",
    "MiddleInitial": "",
    "CompanyName": "South Side Paints",
    "AccountNumber": "73833",
    "JobNumber": "12345",
    "Active": true,
    "SalesRep": "joe@myblinds.com",
    "Installer": "",
    "Terms": "Cash",
    "LeadSource": "Friend",
    "AppointmentType": "Initial Consult",
    "Location": "",
    "DiscountGroup": "Customer Discounts",
    "CustomerType": "",
    "AlternateInstaller": "",
    "BillToAddress1": "",
    "BillToAddress2": "",
    "BillToCity": "",
    "BillToState": "",
    "BillToZip": "",
    "BillToCountry": "",
    "TaxExempt": false,
    "TaxExemptReason": 0,
    "TaxExemptDetails": "",
    "Phones": [
      {
        "Primary": true,
        "Sequence": 1,
        "Label": "Work",
        "Number": "738-887-3803",
        "AddedOn": "2024-01-09T18:54:49.113",
        "UpdatedOn": "2024-10-28T15:57:16.61"
      },
      {
        "Primary": false,
        "Sequence": 2,
        "Label": "Mobile",
        "Number": "738-887-3893",
        "AddedOn": "2024-10-22T18:30:02.203",
        "UpdatedOn": "2024-10-28T15:57:16.613"
      }
    ],
    "ShippingAddresses": null,
    "Attachments": [
      {
        "uniqueid": "A04C28D3-929E-4CE7-B16E-2FDACA8BE13C",
        "name": "livingroom.jpg",
        "size": 36130,
        "filename": "livingroom.jpg",
        "url": "https://weboe2files.blob.core.windows.net/files/a04c28d3-929e-4ce7-b16e-2fdaca8be13c/livingroom.jpg",
        "addedon": "2025-04-14T14:21:35.690"
      }
    ],
    "EmailAddresses": null,
    "Links": [
      {
        "Type": 1,
        "Name": "Google",
        "URL": "www.google.com",
        "RelateType": 0,
        "RelateTarget": 0,
        "RelateUniqueID": "00000000-0000-0000-0000-000000000000",
        "AddedOn": "2025-04-11T16:30:16.113",
        "UpdatedOn": "2025-04-11T16:30:16.113"
      }
    ],
    "Notes": null,
    "Tags": null,
    "TaxCodes": null
  }
}
UpdatedA customer is changed. This payload, with an action key of customer:updated, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who created the customer. See the Create event for details.
customer
The customer that was updated. The details will be the same as for the Create event.
customer:updated payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer
}
Internal note createdAn internal note is added to a customer. This payload, with an action key of customer:note_created, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who created the note. See the Create event for details.
customer
The customer that the note belongs to. See the Create event for details.
Note: This will include the new note.
details
Details on the note that was added. This is an object with the following properties:
note: The text of the note.
customer:note_created payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": {
    "note": "This customer has a big dog."
  }
}
Internal note updatedA note on a customer is updated. This payload, with an action key of customer:note_updated, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who created the note. See the Create event for details.
customer
The customer that the note belongs to.
Note: This will include the updated note.
details
Details on the note that was added. This is an object with the following properties:
oldnote: The text of the note before it was changed.
newnote: The text of the note after it was changed.
customer:note_updated payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": {
    "oldnote": "This customer has a big dog.",
    "newnote": "This customer has a VERY big dog!"
  }
}
Internal note deletedA note on a customer is deleted. This payload, with an action key of customer:note_deleted, provides the following fields:
Parameter
Description
site
The site that the note belongs to. See the Create event for details.
account
The account that the note belongs to. See the Create event for details.
user
The user who created the note. See the Create event for details.
customer
The customer that the note belongs to.
details
Details on the note that was deleted. This is an object with the following properties:
note: The text of the note that was deleted.
customer:note_deleted payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": {
    "note": "This customer has a big dog."
  }
}
Attachment addedA file is attached to a customer. This payload, with an action key of customer:attachment_added, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who created the attachment. See the Create event for details.
customer
The customer that the attachment belongs to.
details
Details on the attachment that was added. This is an object with the following properties:
uniqueid: The unique id of the attachment.
name: The name given to the attachment. This is usually the same as the file name.
size: The size of the attachment, in bytes.
filename: The name of the file that was attached.
url: The fully qualified URL that can be used to access the attachment.
addedon: The date/time in UTC when the file was attached.
customer:attachment_added payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": {
    "uniqueid": "A04C28D3-929E-4CE7-B16E-2FDACA8BE13C",
    "name": "livingroom.jpg",
    "size": 36130,
    "filename": "livingroom.jpg",
    "url": "https://weboe2files.blob.core.windows.net/files/a04c28d3-929e-4ce7-b16e-2fdaca8be13c/livingroom.jpg",
    "addedon": "2025-04-14T14:21:35.690"
  }
}
Attachment deletedAn attachment is removed from a customer. This payload, with an action key of customer:attachment_deleted provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who removed the attachment. See the Create event for details.
customer
The customer that the attachment belongs to.
details
Details on the attachment that was removed.  See the Attachment added event for details.
Important: Attachments that are deleted are available for around 24 hours.
customer:attachment_deleted payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": attachment
}
Link createdA link is added to a customer. This payload, with an action key of customer:link_created, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who created the link. See the Create event for details.
customer
The customer that the link belongs to.
Note: This will include the new link.
details
Details on the link that was added. This is an object with the following properties:
name: The name given to the link.
type: A number that indicates the type of link.
0 = An entity such as a customer or sale
1 = An external URL.
url: For url links, the given url.
relatetype: A number that indicates the type of entity the link relates to:
0 = relates to
1 = duplicates
2 = duplicated by
3 = replaces
4 = replaced by
relatetarget: A number that indicates the type of entity the link relates to:
0 = Customer
1 = Quote/Sale
2 = Purchase Order
3 = Vendor
4 = Site Vendor
5 = Account Vendor
relateuniqueid: The unique id of the entity the links relates to.
customer:link_created payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": {
    "name": "Google",
    "type": 1,
    "url": "www.google.com",
    "relatetype": null,
    "relatetarget": null,
    "relateuniqueid": null
  }
}
Link updatedA link on a customer is changed. This payload, with an action key of customer:link_updated, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who changed the link. See the Create event for details.
customer
The customer that the link belongs to.
Note: This will include the updated link.
details
Details on the link that was changed. This is an object with the following properties:
oldname: The old name given to the link.
newname: The new name given to the link.
oldtype: A number that indicates the old type of link. See the Link Created event for details.
newtype: A number that indicates the new type of link. See the Link Created event for details.
oldurl: For url links, the given old url.
newurl: For url links, the given new url.
oldrelatetype: A number that indicates the old type of entity the link relates to. See the Link Created event for details.
newrelatetype: A number that indicates the newtype of entity the link relates to. See the Link Created event for details.
oldrelatetarget: A number that indicates the old type of entity the link relates to. See the Link Created event for details.
newrelatetarget: A number that indicates the new type of entity the link relates to. See the Link Created event for details.
oldrelateuniqueid: The old unique id of the entity the links relates to.
newrelateuniqueid: The new unique id of the entity the links relates to.
customer:link_updated payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": {
    "oldname": "Google",
    "newname": "Google Web Site",
    "oldtype": 1,
    "newtype": 1,
    "oldurl": "www.google.com",
    "newurl": "https://www.google.com",
    "oldrelatetype": null,
    "newrelatetype": null,
    "oldrelatetarget": null,
    "newrelatetarget": null,
    "oldrelateuniqueid": null,
    "newrelateuniqueid": null
  }
}
Link deletedA link on a customer is removed. This payload, with an action key of customer:link_deleted, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who deleted the link. See the Create event for details.
customer
The customer that the link belonged to.
details
Details on the link that was deleted. See the Link created event for details.
customer:link_deleted payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": {
    "name": "Google",
    "type": 1,
    "url": "www.google.com",
    "relatetype": null,
    "relatetarget": null,
    "relateuniqueid": null
  }
}
Measure sheet createdA measure sheet is added to a customer. This payload, with an action key of customer:measure_sheet_created, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who deleted the measure sheet. See the Create event for details.
customer
The customer that the measure sheet belongs to.
details
Details on the measure sheet that was created. This is an object with the following properties:
UserName: The user name of the user who created the sheet.
Location: The location name of the measure sheet.
customer:measure_sheet_created payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": {
    "UserName": "John Smith"
    "location": "Office"
  }
}
Measure sheet updatedA measure sheet, or a measurement belonging to it, is changed. This payload, with an action key of customer:measure_sheet_updated, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who created the measure sheet. See the Create event for details.
customer
The customer that the measure sheet belongs to.
details
Details on the measure sheet that was updated. The details of the object depends on whether the measure sheet or a measurement was updated.
UserName: The user name of the user who created the sheet.
Location: The location name of the measure sheet.
customer:measure_sheet_updated payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": {
    "UserName": "John Smith"
    "location": "Office"
  }
}
Measure sheet deletedA measure sheet is deleted. This payload, with an action key of customer:measure_sheet_deleted, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who deleted the measure sheet. See the Create event for details.
customer
The customer that the measure sheet belongs to.
details
Details on the measure sheet that was deleted. This is an object with the following properties:
UserName: The user name of the user who created the sheet.
Location: The location name of the measure sheet.
customer:measure_sheet_deleted payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": {
    "UserName": "John Smith"
    "location": "Office"
  }
}
Sales rep changedThe sales rep for a customer is changed. This payload, with an action key of customer:sales_rep_changed, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who changed the sales rep. See the Create event for details.
customer
The customer that the sales rep belongs to.
details
Details on the new sales rep. This is an object with the following properties:
 name: The full name of the sales rep.
email: The email address of the sales rep.
uniqueid: The unique id of the sales rep.
customer:sales_rep_changed payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": {
    "name": "Joe Smith",
    "email": "jsmith@gmail.com",
    "uniqueid": "6f0a26e2-1cee-42de-99c9-2313de5a397c"
  }
}
Sent to QuickBooksThe customer is sent to QuickBooks. This payload, with an action key of customer:qbo_sent, provides the following fields:
Parameter
Description
site
The site that the customer belongs to. See the Create event for details.
account
The account that the customer belongs to. See the Create event for details.
user
The user who sent the customer to QuickBooks. See the Create event for details.
customer
The customer that was sent.
details
Details on the time that the customer was sent. This is an object with the following properties:
sent: The date/time, in UTC,  when the customer was sent to QuickBooks.
customer:qbo_sent payload
{
  "site": site,
  "account": account,
  "user": user,
  "customer": customer,
  "details": {
    "sent": "2025-12-12T15:49:19.733"
  }
}
﻿