Often you may want to update your pos system when an even happens on Neves Business Solutions platform. The quickest way to update your site is to use a webhook. There are numerous events that can be sent to a webhook.
To setup a webhook in the merchant portal you will first need a url for the actual webhook to call. A webhook generates a get or post request to that call any time there is an event on our system.
If you have authentication credentials for the script that your hooking into you can add them on the webhooks screen.
Every time a webhook is called a http get or post request is sent to your script using the provided URL on the webhook setup screen and with the fields provided below. The fields are specific to the individual call. But there will be a common field which provides the transactionType.
Any of the fields with the following number 123e4567-e89b-12d3-a456-426655440000 represents a UUID number that is assigned using our system.
Description: Issue gift card event occured
transactionType: "issue_gift_card"
gift_card_type': 'regular' || 'promotional'
gift_card_id: 123e4567-e89b-12d3-a456-426655440000
cashier_no: 'pos cashier id.'
activation_location_id: 123e4567-e89b-12d3-a456-426655440000
amount: ######.##
Description: activate physical gift card event occured
transactionType: "activate_physical_card"
gift_card_type': 'physical' || 'physicalpromotional'
gift_card_id: 123e4567-e89b-12d3-a456-426655440000
cashier_no: 'pos cashier id.'
activation_location_id: 123e4567-e89b-12d3-a456-426655440000
amount: ######.##
Description: Apply credit to gift card event occured
transactionType: "credit_gift_card
gift_card_id: 123e4567-e89b-12d3-a456-426655440000
cashier_no: pos cashier id.
location_id: 123e4567-e89b-12d3-a456-426655440000
amount: ######.##
Description: Apply debit to gift card event occured
transactionType: "debitgift_card
gift_card_id: 123e4567-e89b-12d3-a456-426655440000
cashier_no: 'pos cashier id.'
location_id: 123e4567-e89b-12d3-a456-426655440000
amount: ######.##
Description: Apply debit to gift card event occured
transactionType: "debitgift_card
gift_card_id: 123e4567-e89b-12d3-a456-426655440000
reseller_id: 123e4567-e89b-12d3-a456-426655440000
amount: ######.##
Description: Issue voucher event occured
transactionType: 'voucher_sale',
voucher_type: 'voucher' || 'promotionalvoucher' || 'scratchandsavepromovoucher' || 'ticket' || 'promotionalticket',
sold_voucher_id: '123e4567-e89b-12d3-a456-426655440000',
amount: ######.##
cashier_no: 'pos cashier id.'
location_id: '123e4567-e89b-12d3-a456-426655440000'
Description: Voucher redeem event occured
transactionType: 'voucher_redeem',
voucher_type: 'voucher' || 'promotionalvoucher' || 'scratchandsavepromovoucher' || 'ticket' || 'promotionalticket',
sold_voucher_id: '123e4567-e89b-12d3-a456-426655440000',
amount: ######.##
cashier_no: 'pos cashier id.'
location_id: 123e4567-e89b-12d3-a456-426655440000
Description: Issue new points account.
transactionType: issue_points_account
points_account_id: '123e4567-e89b-12d3-a456-426655440000'
location_id: '123e4567-e89b-12d3-a456-426655440000'
cashier_no: 'pos cashier id.'
Description: add points to account occured.
transactionType: "add_points_to_account"
points_account_id => '123e4567-e89b-12d3-a456-426655440000'
points: #######
location_id: '123e4567-e89b-12d3-a456-426655440000'
cashier_no: 'pos cashier id.'
Description: add points to account occured.
transactionType: "debit_points_from_account"
points_account_id => '123e4567-e89b-12d3-a456-426655440000'
points: #######
location_id: '123e4567-e89b-12d3-a456-426655440000'
cashier_no: 'pos cashier id.'
Description: issue gift card event occured
transactionType: 'issue_stamp_card'
loyalty_stamp_card_id: '123e4567-e89b-12d3-a456-426655440000'
cashier_no: 'pos cashier id.'
location_id: '123e4567-e89b-12d3-a456-426655440000'
Description: stamp card event occured
transactionType: 'stamp_card'
loyalty_stamp_card_id: '123e4567-e89b-12d3-a456-426655440000'
cashier_no: 'pos cashier id.'
location_id: '123e4567-e89b-12d3-a456-426655440000'
Description: redeem stamp card event occured
transactionType: 'redeem_stamp_card'
loyalty_stamp_card_id: '123e4567-e89b-12d3-a456-426655440000'
cashier_no: 'pos cashier id.'
location_id: '123e4567-e89b-12d3-a456-426655440000'
Description: create reservation event occured
transactionType: 'create_reservation'
reservationId: 123e4567-e89b-12d3-a456-42665544000
locationid: 123e4567-e89b-12d3-a456-42665544000
contact_name: contact name
contact_phone: contact phone
contact_email: contact email
starttime: YYYY-MM-DD H:M:s
endtime: YYYY-MM-DD H:M:s
attendees: ##
notes: Reservation notes
Description: edit reservation event occured
transactionType: 'edit_reservation'
reservationId: 123e4567-e89b-12d3-a456-42665544000
locationid: 123e4567-e89b-12d3-a456-42665544000
contact_name: contact name
contact_phone: contact phone
contact_email: contact email
starttime: YYYY-MM-DD H:M:s
endtime: YYYY-MM-DD H:M:s
attendees: ##
notes: Reservation notes
