Web Hooks

Get a list of Web Hooks

GET https://www.whiplashmerch.com/api/web_hooksView Response
HTTP/1.1 200 OK
[
  {
    "id": 1,
    "active":true,
    "failed_attempts":0,
    "format":"json",
    "url":"https://yourteststore.com/api/whiplash/orderUpdate",
    "event_name":"order.shipped",
    "provider": "api",
    "originator_id": "123",
    "group_id": "11"
  },
  {
    "id": 2,
    "active":true,
    "failed_attempts":0,
    "format":"json",
    "url":"https://yourteststore.com/api/whiplash/shipNoticeUpdate",
    "event_name":"shipnotice.status_changed",
    "provider": "whiplash",
    "originator_id": "111",
    "group_id": "1"
  },
  {
    "id": 3,
    "active":true,
    "failed_attempts":3,
    "format":"json",
    "url":"https://yourteststore.com/api/whiplash/inventoryChanged",
    "event_name":"item.inventory_changed",
    "provider": "whiplash",
    "originator_id": "112",
    "group_id": null
  }
]

Parameters

NameTypeDescription
provider String Only get web hooks for a specified provider (i.e. 'api' 'whiplash' etc)
group_id String Only get web hooks for a specified group_id (if you have multiple apps using the API

Get a single Web Hook

GET https://www.whiplashmerch.com/api/web_hooks/{web-hook-id}View Response
HTTP/1.1 200 OK
{
  "id": 1,
  "active":true,
  "failed_attempts":0,
  "format":"json",
  "url":"https://yourteststore.com/api/whiplash/orderUpdate",
  "event_name":"order.shipped",
  "provider": "api",
  "originator_id": "123",
  "group_id": "11"
}

Create a Web Hook

Create a web hook for a specified Event

POST https://www.whiplashmerch.com/api/web_hooksView Response
HTTP/1.1 200 OK
{
  "id": 1,
  "active":true,
  "failed_attempts":0,
  "format":"json",
  "url":"https://yourteststore.com/api/whiplash/orderUpdate",
  "event_name":"order.shipped",
  "provider": "api",
  "originator_id": "123",
  "group_id": "11"
}

Parameters

NameTypeDescription
event_name String The event for which you'd like to receive a web hook (required)
url String The URL you'd like to send the web hook to (required)
format String 'json' or 'xml'
group_id String You can group web hooks--especially if you are creating them for multiple shops (optional)
originator_id String Additional identifier for web hook (optional)

Delete a Web Hook

NOTE: You may only delete web hooks for the current provider/shop. So web hooks created via the API can be deleted, but not web hooks created in the app or in other shops.

DELETE https://www.whiplashmerch.com/api/web_hooks/{web-hook-id}View Response
HTTP/1.1 204 OK
Whiplash_partner_program Warehouse with extra capacity? Checkout our Partner Program