Zapier (Triggers)

Updated 1 week ago by HirePOS

Updated Customer

Triggers when a Customer in HirePOS is created or updated via Setup > Customers.

How to activate

  1. Go to Setup > Preferences > Accounting Integration & Other API's.
  2. Click Triggers & Webhooks (use for Zapier).
  3. Check the Customer Updated (or Added) checkbox.
  4. Click Save Changes.

Webhook Payload

The following is an example of data (JSON) posted to the subscriber's API endpoint.

{
    "Id": 1000,
    "Company": "AnyDay Hire",
    "FirstName": "John",
    "LastName": "Smith",
    "Code": "ADH",
    "AddressLine1": "Unit 1",
    "AddressLine2": "10 Any Street",
    "City": "Any City",
    "State": "QLD",
    "Postcode": "4870",
    "Country": "Australia",
    "Phone1": "07 1000 0000",
    "Phone2": "",
    "Phone3": "",
    "Fax": "",
    "Email": "api@hirepos.com.au",
    "ReferralSource": "Google Adwords",
    "Notes": "Please call an hour before delivery.",
    "LastModified": "2020-06-30T15:00:00+10:00"
}

Updated Item

Triggers when an Item in HirePOS is created or updated via Setup > Items, or via Sales > Online Store > Setup Store Items.

How to activate

  1. Go to Setup > Preferences > Accounting Integration & Other API's.
  2. Click Triggers & Webhooks (use for Zapier).
  3. Check the Item Updated (or Added) checkbox.
  4. Click Save Changes.

Webhook Payload

The following is an example of data (JSON) posted to the subscriber's API endpoint.

{
    "Id": 1000,
    "Code": "MTR1",
    "Description": "Metered Item",
    "Category": "Earth Moving",
    "ItemType": "Hire",
    "IsHireItem": "True",
    "WebsiteCode": "MTR",
    "WebsiteDescription": "",
    "WebsiteLongDescription": "",
    "WebsitePrice": "",
    "ImageURL": "https://cdn.hirepos.com/Image1.jpg",
    "ImageURL2": "https://cdn.hirepos.com/Image2.jpg",  
    "ImageURL3": "https://cdn.hirepos.com/Image3.jpg",
    "ImageURL4": "https://cdn.hirepos.com/Image4.jpg",
    "ImageURL5": "https://cdn.hirepos.com/Image5.jpg",
    "ImageURL6": "https://cdn.hirepos.com/Image6.jpg",
    "LastModified": "2020-11-27T08:49:52+10:00",
    "Colour": "Blue",
    "Height": "2.6",
    "Width": "5.4",
    "Depth": "",
    "Length": "",
    "Area": "",
    "Volume": "",
    "Weight": ""
}

Deleted Item

Triggers when an Item in HirePOS is deleted or made inactive via Setup > Items, or the Website Code or Website Description field is cleared in Sales > Online Store > Setup Store Items.

How to activate

  1. Go to Setup > Preferences > Accounting Integration & Other API's.
  2. Click Triggers & Webhooks (use for Zapier).
  3. Check the Item Updated (or Added) checkbox.
  4. Click Save Changes.

Webhook Payload

The following is an example of data (JSON) posted to the subscriber's API endpoint.

{
  "LastModified": "2020-11-29T13:53:24+1000",
  "WebsiteDescription": "Website Item A",
  "Code": "AAA1",
  "Description": "Item A",
  "WebsiteCode": "AAA"
}

Updated Invoice

Triggers when a Sales record (Quote/Booking/Invoice) in HirePOS is created or updated.

How to activate

  1. Go to Setup > Preferences > Accounting Integration & Other API's.
  2. Click Triggers & Webhooks (use for Zapier).
  3. Check the Sales Record Updated (or Added) checkbox.
  4. Click Save Changes.

Webhook Payload

The following is an example of data (JSON) posted to the subscriber's API endpoint.

{
    "Id": 1000,
    "Company": "AnyDay Hire",
    "FirstName": "John",
    "LastName": "Smith",
    "Code": "ADH",
    "Mode": "Booking",
    "InvoiceNo": 1234,    
    "InvoiceDate": "2020-06-30T15:00:00+10:00",
    "InvoiceDueDate": "2020-08-01T00:00:00+10:00",
    "InvoiceTotal": "2275.50",
    "CustomerPO": "PO-123",
    "Reference": "The big project",
    "BookedFrom": "2020-07-02T08:30:00+10:00",
    "BookedTo": "2020-07-04T14:30:00+10:00",
    "DateQuoted": "2020-06-30T15:00:00+10:00",
    "DateBooked": "2020-07-01T15:00:00+10:00",
    "DepositDue": "",
    "EventDate": "",
    "LastModified": "2020-06-30T15:00:00+10:00"
}

New Quote

Triggers when a new Quote record in HirePOS is created.

How to activate

  1. Go to Setup > Preferences > Accounting Integration & Other API's.
  2. Click Triggers & Webhooks (use for Zapier).
  3. Check the New Quote Records checkbox.
  4. Click Save Changes.

Webhook Payload

The following is an example of data (JSON) posted to the subscriber's API endpoint. Note the InvoiceNo and InvoiceDate fields are generic field names that also apply to Quotes (and any other sales record mode). When you create a Zap the field options may appear with the word Invoice but are actually referring to Quotes.

{
    "Id": 1000,
    "Company": "AnyDay Hire",
    "FirstName": "John",
    "LastName": "Smith",
    "Code": "ADH",
    "Mode": "Quote",
    "InvoiceNo": 1234,    
    "InvoiceDate": "2020-06-30T15:00:00+10:00",
    "InvoiceDueDate": "2020-08-01T00:00:00+10:00",
    "InvoiceTotal": "2275.50",
    "CustomerPO": "PO-123",
    "Reference": "The big project",
    "BookedFrom": "2020-07-02T08:30:00+10:00",
    "BookedTo": "2020-07-04T14:30:00+10:00",
    "DateQuoted": "2020-06-30T15:00:00+10:00",
    "DateBooked": "2020-07-01T15:00:00+10:00",
    "DepositDue": "",
    "EventDate": "",
    "LastModified": "2020-06-30T15:00:00+10:00"
}

Did this help?

Powered by HelpDocs (opens in a new tab)