Sale Events

Sale Events

You can create webhooks for the following events that occur for a sale.

Created

A sale is created. This payload, with an action key of sale:created, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who created the sale. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that was created. This is an object with the following properties:
  • OrderNumber: The DOS number for the sale.
  • Sidemark: The sale's sidemark.
  • JobNumber: The sale's job number.
  • CustomerPONumber: The customer's custom PO Number for the sale.
  • Workflow: The current workflow of the sale.
  • Status: The current status of the sale.
  • QuoteCreatedOn: The date on which the original quote was created.
  • SaleCreatedOn: The date on which the sale was created from the quote.
  • Subtotal1: The sale's subtotal 1.
  • Subtotal2: The sale's subtotal 2.
  • Total: The sale's total.
  • Balance: The sale's balance.
  • ItemsCost: The cost of all line items associated with the quote.
  • OrderCost: The cost of the order, calculated as the cost of line items plus the cost of additional charges.
  • SuggestedDepositPercent: The percentage of the suggested deposit for the sale.
  • SuggestedDepositAmount: The calculated amount of the suggested deposit.
  • CCFeePercent: The percentage of the sub-total used to calculate the credit card fee amount.
  • CCFeeAmount: The calculated amount of the credit card fee. This is automatically applied to the total.
  • RGA: True or false, depending on whether the sale was created through an RGA process.
  • Sent: True or false, depending on whether the sale has been sent to the vendor.
  • Reprocess: True or false, depending on whether the sale needs to be reprocessed.
  • UniqueID: A unique identifier for the sale.
  • OnHold: True or false, depending on whether the sale is on hold.
  • OnHoldMessage: A message indicating why the sale is on hold, set by the user who put it on hold.
  • Canceled: True or false, depending on whether the sale has been cancelled.
  • Closed: True or false, depending on whether the sale has been closed.
  • CustomerName: The name of the customer to whom the sale is attached.
  • SalesRep: The email address of the sales rep.
  • Installer: The email address of the installer.
  • Terms: The terms for the sale.
  • LeadSource: The lead source for the sale.
  • DeliveryRange: The delivery range for the sale.
  • AppointmentType: The appointment type for the sale.
  • Location: The location for the sale.
  • AlternateInstaller: The sale's alternate installer.
  • InstallationLabel: The label associated with the installation address.
  • InstallationAddress1: The first address line of the installation address.
  • InstallationAddress2: The second address line of the installation address.
  • InstallationCity: The city of the installation address.
  • InstallationState: The state of the installation address.
  • InstallationZip: The postal code of the installation address.
  • InstallationCountry: The country of the installation address.
  • InstallationName: The name associated with the installation address.
  • InstallationPhoneLabel: The label of the phone number associated with the installation address.
  • InstallationPhoneNumber: The phone number associated with the installation address.
  • InstallationEmailLabel: The label of the email address associated with the installation address.
  • InstallationEmailAddress: The email address associated with the installation address.
  • Attachments: An array of attachment objects 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.
  • Comments: An array of comment objects with the following properties:
  • CommentText: The text of the comment.
  • AddedOn: The date/time when the comment was added.
  • UpdatedOn: The date/time when the comment 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.
  • Payments: An array of payment objects with the following properties:
  • PaymentType: The type or method of payment.
  • ReferenceNumber: A reference number for the payment.
  • Amount: The amount of the payment.
  • Memo: A memo for the payment.
  • AddedOn: The date/time when the payment was added.
  • UpdatedOn: The date/time when the payment 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.
  • LineItems: An array of line item objects with the following properties:
  • LineItemNumber: The number of the line item.
  • Quantity: The quantity of the line item.
  • ProductName: The name of the product in the line item.
  • ProductType: The name of the product type.
  • Manufacturer: The name of the products manufacturer.
  • ProductVersion: The revision of the product used by the line item.
  • ProductDate: The date on which the the product revision used was completed.
  • Style: The style of the product in the line item.
  • Taxable: True or false, depending on whether the item is taxable.
  • Description: A description of the line item.
  • ItemCost: The cost of the line item.
  • ItemPrice: The price of the line item.
  • UniqueID: A unique identifier for the line item.
  • AddedOn: The date/time when the line item was added.
  • UpdatedOn: The date/time when the line item was last updated.
  • Options: The visible options used for the line item, as a list in the following format:
  • Name: The option's name.
  • Value: The option's value.
  • AdditionalCharges: An array of additional charge objects with the following properties:
  • Group: The group that the charge belongs to.
  • Category: The category of the charge.
  • ChargeCode: The unique code given to the charge.
  • Name: The name of the charge.
  • Quantity: The quantity of the charge. This is usually1.
  • QuantityOverridden: True or false, depending on if the quantity of the charge was changed from the default.
  • Taxable: True or false, depending on whether the charge is taxable.
  • Promotion: True or false, depending on whether the charge is a promotion (discount) or not (a surcharge).
  • Automatic: True or false, depending on whether the charge is applied automatically.
  • Cost: The cost of the charge.
  • Amount: The amount of the charge.
  • UpdatedOn: The date/time when the charge was last updated.
sale: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
},
"sale":
{
"OrderNumber": 40,
"Sidemark": "Black 20250619",
"JobNumber": "12345",
"CustomerPONumber": "PO # 256544",
"Workflow": "Quote",
"Status": "Presented",
"QuoteCreatedOn": "2023-02-22 14:31:20.180",
"SaleCreatedOn": "2025-05-27 12:02.41.450",
"Subtotal1": 3011.00,
"Subtotal2": 2898.30,
"Total": 3119.97,
"Balance": 0,
"ItemsCost": 1271.25,
"OrderCost": 1271.25,
"SuggestedDepositPercent": 0.75,
"SuggestedDepositAmount": 2339.98,
"CCFeePercent": 0.04,
"CCFeeAmount": 115.93,
"RGA": false,
"Sent": false,
"Reprocess": false,
"UniqueID": "8E8FCC20-4B0E-4F7B-A2EE-440C5B7F6762",
"OnHold": true,
"OnHoldMessage": "Customer needs to wait a few months",
"Canceled": false,
"Closed": false,
"CustomerName": "Jack Black",
"SalesRep": "joe@myblinds.com",
"Installer": "",
"Terms": "50% Deposit",
"LeadSource": "Friend",
"DeliveryRange": "4-5 Weeks",
"AppointmentType": "",
"Location": "Archdale",
"AlternateInstaller": "",
"InstallationLabel": "Home",
"InstallationAddress1": "123 Main St",
"InstallationAddrss2": "",
"InstallationCity": "Greensboro",
"InstallationState": "NC",
"InstallationZip": "27401",
"InstallationCountry": "",
"InstallationName": "Jack Black",
"InstallationPhoneLabel": "Mobile",
"InstallationPhoneNumber": "738-887-3893",
"InstallationEmailLabel": "Home",
"InstallationEmailAddress": "jblack@gmail.com",
"Attachments": [
{
"uniqueid": "c808127e-eb03-4438-b589-76f4f8ca3c49",
"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"
}
],
"Comments": [
{
"CommentText": "This customer has a dog.",
"AddedOn": "2025-05-23T17:15:42.106",
"UpdatedOn": "2025-05-23T17:15:42.106"
}
],
"Links": null,
"Notes": null,
"Payments": [
{
"PaymentType": "American Express",
"ReferenceNumber": "12345",
"Amount": 101.23,
"Memo": "Remaining balance",
"AddedOn": "2025-05-29T14:40:25.436",
"UpdatedOn": "2025-05-29T14:40:25.436"
}
],
"Tags": [
{
"TagText": "june sales",
"Added On": "2025-05-23T17:17:02.284"
},
{
"TagText": "alta",
"Added On": "2025-05-23T17:17:05.328"
},
],
"TaxCodes": null,
"LineItems": [
{
"LineItemNumber": 1,
"Quantity": 3,
"ProductName": "GRA - Exterior Solar Shades",
"ProductType": "Roller Shades",
"Manufacturer": "Graber",
"ProductVersion": null,
"ProductDate": null,
"Style": "Continuous Loop",
"Taxable": false,
"Description": "w:64 | h:64 | SS Broadcast | Alfresco (47504) | Inside | Right | Standard Roll | val:No Valance (N) | PLEASE SELECT",
"ItemCost": 423.75,
"ItemPrice": 565.00,
"UniqueID": "5A2DE1D4-86B2-4991-B985-31EFC9A40B22",
"AddedOn": "2022-10-06T19:48:34.897",
"UpdatedOn": "2025-04-18T20:03:10.283",
"Options": [
{
"Name": "Room Location",
"Value": "Kitchen"
},
{
"Name": "Color",
"Value": "Ivory"
},
{
"Name": "Remarks",
"Value": null
}
]
}
],
"AdditionalCharges": [
{
"Group": "",
"Category": "Shipping",
"ChargeCode": "HG0WLVCV",
"Name": "Shipping & Handling",
"Quantity": 1,
"QuantityOverridden": false,
"Taxable": false,
"Promotion": false,
"Automatic": true,
"Cost": 0.00,
"Amount": 75.00,
"UpdatedOn": "2025-07-21 14:33:28.000"
}
]
}
}

Updated

A sale is updated. This payload, with an action key of sale:updated, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who updated the sale. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that was updated. See the Sale Create event for details.
sale:updated payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale
}

Deleted

A sale is updated. This payload, with an action key of sale:deleted, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who updated the sale. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that was updated. See the Sale Create event for details.
details
Details on the sale that was deleted. This is an object with the following properties:
  • ordernumber: The order number of the sale that was deleted.
  • uniqueid: The unique identifier of the sale that was deleted.
sale:deleted payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"ordernumber": "503",
"uniqueid": "32a53eef-65c6-449c-8721-be167468ef5e"
}
}

Internal note created

An internal note is added to a sale. This payload, with an action key of sale:note_created, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who created the note. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the note is for. See the Sale Create event for details.
details
Details on the note that was added. This is an object with the following properties:
  • note: The text of the note.
sale:note_created payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"note": "This was approved on 5/17."
}
}

Internal note updated

A note on a sale is updated. This payload, with an action key of sale:note_updated, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who updated the note. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the note is for. See the Sale Create event for details.
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.
sale:note_updated payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"oldnote": "This was approved on 5/17.",
"newnote": "The customer changed their mind on 5/19."
}
}

Internal note deleted

A note on a sale is deleted. This payload, with an action key of sale:note_deleted, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who deleted the note. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the note is for. See the Sale Create event for details.
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.
sale:note_deleted payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"note": "This was approved on 5/17."
}
}

Attachment added

A file is attached to a sale. This payload, with an action key of sale:attachment_added, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who created the attachment. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the attachment is for. See the Sale Create event for details.
details
Details on the attachment that was added. See the Sale Create event for details.
sale:attachment_added payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"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 deleted

An attachment is removed from a sale. This payload, with an action key of sale:attachment_deleted, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who deleted the attachment. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the attachment is for. See the Sale Create event for details.
details
Details on the attachment that was deleted. See the Sale Create event for details.
sale:attachment_deleted payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"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"
}
}

A link is created

A link is added to a sale. This payload, with an action key of sale:link_created, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who created the link. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the link is for. See the Sale Create event for details.
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.
sale:link_created payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"type": 0,
"name": "Amazon",
"url": "https://amazon.com",
"relatetype": null,
"relatetarget": null,
"relateuniqueid": null
}
}

A link is updated

A link on a sale is changed. This payload, with an action key of sale:link_updated, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who updated the link. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the link is for. See the Sale Create event for details.
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.
sale:link_updated payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"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
}
}

A link is deleted

A link on a sale is removed. This payload, with an action key of sale:link_deleted, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who deleted the link. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the link is for. See the Sale Create event for details.
details
Details on the link that was deleted. See the Link created event for details.
sale:link_deleted payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"type": 0,
"name": "Amazon",
"url": "https://amazon.com",
"relatetype": null,
"relatetarget": null,
"relateuniqueid": null
}
}

Comment created

A comment is added to a sale. This payload, with an action key of sale:comment_created, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who added the comment. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the comment is for. See the Sale Create event for details.
details
Details on the comment that was added. This is an object with the following properties:
  • comment: The text of the comment.
sale:comment_created payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"comment": "The window is hard to reach"
}
}

Comment updated

A comment on a sale is updated. This payload, with an action key of sale:comment_updated, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who updated the comment. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the comment is for. See the Sale Create event for details.
details
Details on the comment that was updated. This is an object with the following properties:
  • oldcomment: The text of the comment before it was changed.
  • newcomment: The text of the comment after it was changed.
sale:comment_updated payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"oldcomment": "The window is hard to reach",
"newcomment": "The window is hard to reach. Bring a tall ladder"
}
}

Comment deleted

A comment on a sale is deleted. This payload, with an action key of sale:comment_deleted, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who deleted the comment. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the comment is for. See the Sale Create event for details.
details
Details on the comment that was deleted. This is an object with the following properties:
  • comment: The text of the comment.
sale:comment_deleted payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"comment": "The window is hard to reach"
}
}


Payment added

A payment is added to the sale. This payload, with an action key of sale:payment_added, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who added the payment. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the payment is for. See the Sale Create event for details.
details
Details on the payment that was added. This is an object with the following properties:
  • paymenttype: The ID of the payment type.
  • referencenumber: The reference number for the payment.
  • receivedon: A date/time, in UTC, when the payment was received.
  • amount: The amount of the payment.
  • memo: A memo about the payment.
sale:payment_added payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"paymenttype": 5,
"referencenumber": "503",
"receivedon": "2022-10-06T19:48:34.897",
"amount": "150.00",
"memo": "First installment"
}
}

Payment changed

A payment for the sale is changed. This payload, with an action key of sale:payment_changed, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who changed the payment. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the payment is for. See the Sale Create event for details.
details
Details on the payment that was changed. This is an object with the following properties:
  • oldpaymenttypeid: The old ID of the payment type.
  • newpaymenttypeid: The new ID of the payment type.
  • oldreferencenumber: The old reference number for the payment.
  • newreferencenumber: The new reference number for the payment.
  • oldreceivedon: A date/time, in UTC, when the payment was originally received.
  • newreceivedon: An updated date/time, in UTC, when the payment was received.
  • oldamount: The old amount of the payment.
  • newamount: The new amount of the payment.
  • oldmemo: An old memo about the payment.
  • newmemo: The new memo about the payment.
sale:payment_changed payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"oldpaymenttypeid": 5,
"newpaymenttypeid": 5,
"oldreferencenumber": "503",
"newreferencenumber": "504",
"oldreceivedon": "2022-10-06T19:48:34.897",
"newreceivedon": "2022-10-06T19:48:34.897",
"oldamount": "15.00"
"newamount": "150.00",
"oldmemo": "First installment"
"newmemo": "First installment - typo"
}
}

Payment deleted

A payment for the sale is deleted. This payload, with an action key of sale:payment_deleted, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who deleted the payment. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that the payment is for. See the Sale Create event for details.
details
Details on the payment that was deleted. This is an object with the following properties:
  • paymenttype: The ID of the payment type.
  • referencenumber: The reference number for the payment.
  • receivedon: A date/time, in UTC, when the payment was received.
  • amount: The amount of the payment.
  • memo: A memo about the payment.
sale:payment_deleted payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"paymenttype": 5,
"referencenumber": "503",
"receivedon": "2022-10-06T19:48:34.897",
"amount": "150.00",
"memo": "First installment"
}
}

Status changed

The status of the sale is changed. This payload, with an action key of sale:status_changed, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who changed the status. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale whose status is changing. See the Sale Create event for details.
details
Details on the status that was changed. This is an object with the following properties:
  • name: The name of the new status.
  • uniqueid: The unique id of the new status.
sale:status_changed payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"name": "Pending Approval",
"uniqueid": "b6302987-0d07-414c-bda3-5734339a6dd5"
}
}

Workflow changed

The workflow of the sale is changed. This payload, with an action key of sale:workflow_changed, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who changed the workflow. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale whose workflow is changing. See the Sale Create event for details.
details
Details on the workflow that was changed. This is an object with the following properties:
  • name: The name of the new workflow.
  • uniqueid: the unique id of the new workflow.
sale:workflow_changed payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"name": "Sale Approval",
"uniqueid": "b6302987-0d07-414c-bda3-5734339a6dd5"
}
}

Delivery range changed

The delivery range of the sale is changed. This payload, with an action key of sale:delivery_range_changed, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who changed the delivery range. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale whose delivery range is changing. See the Sale Create event for details.
details
Details on the delivery range that was changed. This is an object with the following properties:
  • name: The name of the new delivery range.
  • uniqueid: The unique id of the new delivery range.
sale:delivery_range_changed payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"name": "3-4 Weeks",
"uniqueid": "b6302987-0d07-414c-bda3-5734339a6dd5"
}
}

Sales rep changed

The sales rep for a sale is changed. This payload, with an action key of sale:sales_rep_changed, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who changed the sales rep. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale whose sales rep is changing. See the Sale Create event for details.
details
Details on the new sales rep. This is an object with the following properties:
  • name: The name of the sales rep.
  • email: The email address of the sales rep.
  • uniqueid: The unique ID of the sales rep.
sale:sales_rep_changed payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"name": "Todd Jones",
"email": "tjones@gmail.com",
"uniqueid": "b6302987-0d07-414c-bda3-5734339a6dd5"
}
}

Cancelled

The sale is cancelled. This payload, with an action key of sale:cancelled, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who cancelled the sale. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that has been cancelled. See the Sale Create event for details.
details
Details on the time at which the sale was cancelled. This is an object with the following properties:
  • canceledon: The date/time, in UTC, when the sale was cancelled.
sale:cancelled payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"canceledon": "2022-10-06T19:48:34.897"
}
}

Un-cancelled

The sale is un-cancelled. This payload, with an action key of sale:uncancelled, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who un-cancelled the sale. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
The quote that has been cancelled. See the Quote Create event for details.
sale
The sale that has been un-cancelled. See the Sale Create event for details.
sale:uncancelled payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale
}

Put on hold

The sale is put on hold. This payload, with an action key of sale:put_on_hold, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who put the sale on hold. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that has been put on hold. See the Sale Create event for details.
details
Details on the message provided for the sale's hold status. This is an object with the following properties:
  • message: The message explaining the sale's hold status.
sale:put_on_hold payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"message": "The customer wants to wait until after the holidays."
}
}

Removed from hold

The sale is removed from being on hold. This payload, with an action key of sale:removed_from_hold, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who removed the sale from hold. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that has been removed from hold. See the Sale Create event for details.
sale:removed_from_hold payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale
}

Sent to QuickBooks Online

The sale is sent to QuickBooks. This payload, with an action key of sale:qbo_sent, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who sent the sale to QuickBooks. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale that has been sent to QuickBooks. See the Sale Create event for details.
details
Details on the time the sale was sent. This is an object with the following properties:
  • sent: The date/time, in UTC, when the sale was sent to QuickBooks.
sale:qbo_sent payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"sent": "2022-10-06T19:48:34.897"
}
}

Payment sent to QuickBooks Online

A payment for a sale is sent to QuickBooks Online. This payload, with an action key of sale:payment_send_to_quickbooks, provides the following fields:
Parameter
Description
site
The site that the sale belongs to. See the Customer Create event for details.
account
The account that the sale belongs to. See the Customer Create event for details.
user
The user who sent the payment to QuickBooks. See the Customer Create event for details.
customer
The customer to whom the sale belongs. See the Customer Create event for details.
sale
The sale for the payment that has been sent to QuickBooks. See the Sale Create event for details.
details
Details on the time the payment was sent. This is an object with the following properties:
  • sent: The date/time, in UTC, when the payment was sent to QuickBooks.
sale:payment_send_to_quickbooks payload
{
"site": site,
"account": account,
"user": user,
"customer": customer,
"sale": sale,
"details": {
"sent": "2022-10-06T19:48:34.897"
}
}