Web Hooks Section Guide

If you need other systems to be triggered based on events within coreSTORE, the web hooks needed can be configured by going to the Store Config module and using the search box or the jump to drop-down menu to get you to the Web Hooks section.   The Web Hook URL should be an address that is listening for web hook events.

When triggered the webhook will transmit the full payload of information.   For example, when the New Customer webhook is invoked, the entire customer dataset will be transmitted containing all the fields for the new customer (see below for a sample payloads).

As a best practice each webhook should have a unique endpoint.  

Note:

This section is for users that are or have programmers who understand API's and programming. Otherwise, you probably do not need to use this section.

• New Customer Web Hook URL (1): Input the web hook URL for the New Customer event.
• New Sale Web Hook URL (2): Input the web hook URL for the New Sale event.
• New Receiving Web Hook (3): Input the web hook URL for the New Receiving event.
• Edit Customer Web Hook URL (4): Input the web hook URL for the Edit Customer event.
• Edit Sale Web Hook URL (5): Input the web hook URL for the Edit Sale event.
• Edit Receiving Web Hook URL (6): Input the web hook URL for the Edit Receiving event.

Sample Payload for New Customer  web hook:

[

    {

        "first_name": "Rachel",

        "last_name": "Jones",

        "suffix": "",

        "email": "rachel.jones@example.com",

        "phone_number": "512-554-3888",

        "address_1": "",

        "address_2": "",

        "city": "",

        "state": "",

        "zip": "",

        "county": "",

        "country": "",

        "comments": "",

        "birth_date": null,

        "middle_name": "",

        "license": "",

        "license_state": null,

        "license_issued": null,

        "license_expires": null,

        "ccl_license": "",

        "ccl_license_state": null,

        "ccl_license_issued": null,

        "ccl_license_expires": null,

        "ccl_occupation": "",

        "ccl_employer": "",

        "ccl_issuing_authority": "",

        "ccl_county_of_issue": "",

        "leo_badge_id": "",

        "gender": "1",

        "height": 0,

        "weight": "",

        "hair_color": "XXX",

        "eye_color": "XXX",

        "ecommerce_contact_id": null,

        "website": "",

        "full_name": "Rachel Jones",

        "create_date": "2022-12-28 07:17:46",

        "person_id": 594,

        "company_name": "",

        "tier_id": null,

        "account_number": null,

        "taxable": 1,

        "tax_certificate": "",

        "override_default_tax": 0,

        "tax_class_id": null,

        "internal_notes": "",

        "ffl_number": "",

        "ffl_expiration": null,

        "always_sms_receipt": 0,

        "do_not_serve": 0,

        "default_term_id": null,

        "location_id": null,

        "custom_field_1_value": "",

        "custom_field_2_value": null,

        "custom_field_3_value": null,

        "custom_field_4_value": "",

        "custom_field_5_value": "",

        "disable_loyalty": 0,

        "current_spend_for_points": 0,

        "balance": "0.00",

        "credit_limit": null,

        "points": "0.00"

    }

]

Sample Payload for Receiving web hook:

[

    {

        "receiving_id": 1506,

        "receiving_time": "12/28/2022 08:09 am",

        "location_id": "1",

        "employee_id": "2",

        "deleted": false,

        "comment": "",

        "mode": "receive",

        "is_po": false,

        "supplier_id": "239",

        "supplier_first_name": "",

        "supplier_last_name": "",

        "supplier_email": "",

        "supplier_phone_number": "",

        "supplier_address_1": "",

        "supplier_address_2": "",

        "supplier_city": "",

        "supplier_state": "",

        "supplier_zip": "",

        "supplier_country": "",

        "supplier_comments": "",

        "supplier_company_name": "Glenn Zanders Fur & Sporting Goods Co",

        "supplier_account_number": null,

        "supplier_override_default_tax": false,

        "supplier_tax_class_id": 0,

        "supplier_balance": 17045.59,

        "supplier_image_url": "",

        "supplier_created_at": "03/02/2021 10:14 am",

        "excluded_taxes": [],

        "paid_store_account_ids": [],

        "suspended": "0",

        "transfer_location_id": null,

        "subtotal": "300.00",

        "tax": "0.00",

        "total": "300.00",

        "shipping_cost": null,

        "custom_fields": {

            "TEST": null

        },

        "payments": [],

        "cart_items": [

            {

                "item_id": "1173",

                "quantity": 20,

                "quantity_received": 20,

                "unit_price": "15.00",

                "cost_price": "15.00",

                "discount": 0,

                "description": "Box of 15 twelve-gram CO2 cylinders.",

                "name": "Daisy Power Line 15 Ct. CO2",

                "item_number": "039256070154",

                "product_id": null,

                "serialnumber": {

                    "serialnumber_0": ""

                },

                "size": ""

            }

        ]

    }

]