HirePOS Webhooks

In this documentation, you will learn how to set up and activate webhooks in HirePOS to send data to Zapier based on specific events that occur within the system. Webhooks allow for seamless integration and automation between HirePOS and other applications.

This webhook triggers when a Customer in HirePOS is created or updated via Setup > Customers.

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.

{
    "Company": "AnyDay Hire",
    "FirstName": "John",
    "LastName": "Smith",
    "Code": "1000",
    "AddressLine1": "1 Any Street",
    "AddressLine2": " ",
    "City": "Cairns",
    "State": "QLD",
    "Postcode": "4870",
    "Country": "Australia",
    "Phone1": "(07) 1000 0000",
    "Phone2": "",
    "Phone3": "",
    "Fax": "",
    "Email": "anyday@hirepos.com.au",
    "ReferralSource": "",
    "Notes": "Great customer"
}

This webhook triggers when an Item in HirePOS is created or updated via Setup > Items or Sales > Online Store > Setup Store Items.

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": "",
    "EachPrice",
    "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": "",
	"Link": "",
	"Link2": "",
	"CustomField1": "",
	"CustomField2": "",
	"CustomField3": "",
	"CustomField4": "",
	"CustomField5": "",
	"CustomField6": "",
	"CustomField7": "",
	"CustomField8": "",
    "Tags": "'red','blue','green'"  
}

This webhook triggers when an Item in HirePOS is deleted or made inactive via Setup > Items or Sales > Online Store > Setup Store Items.

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"
}

This webhook triggers when an Invoice is created or updated in HirePOS. This webhook is only triggered for record in 'Invoice' mode.

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"
}

This webhook triggers when a new Quote is created in HirePOS. This webhook is only triggered for records in 'Quote' mode.

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 that the InvoiceNo and InvoiceDate fields are generic field names that also apply to Quotes and any other sales record mode.

{
    "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"
}

By following these steps, you can effectively set up webhooks in HirePOS to automate data transfer to Zapier based on specific events, enhancing your workflow efficiency and integration capabilities.