REL documentation
master webhooksconfig (http://api.3plcentral.com/rels/master/webhooksconfig)
Resource:
master web hooks configuration
C# Rel Const:
Rels.MasterSvc.WebHooksConfig
URI template:
handlerparameters/webhooksconfig
Obtain URI from:
Billboard
Success status: 200
none
Type Description
Params IEnumerable<Generic.Models.WebHookParametersForEvents>
Name string
Resource string Domain: Order, Receiver, Adjustment, Assembly, OrderItem, Item, InventorySummary
EventTypes string a comma-delimited list of supported event types; must be within 'Resource', e.g., if the Resource is 'Order", all EventTypes must be Orderxxx
Url string
IncludeResource bool
ResourceApiParameters string as defined in the REL documentation for the Resource
Sample accept: application/hal+json
{
  "params": [
    {
      "name": "str",
      "resource": "str",
      "eventTypes": "str",
      "url": "str",
      "includeResource": true,
      "resourceApiParameters": "str"
    }
  ]
}
Success status: 200
none
Type Description
Params IEnumerable<Generic.Models.WebHookParametersForEvents>
Name string
Resource string Domain: Order, Receiver, Adjustment, Assembly, OrderItem, Item, InventorySummary
EventTypes string a comma-delimited list of supported event types; must be within 'Resource', e.g., if the Resource is 'Order", all EventTypes must be Orderxxx
Url string
IncludeResource bool
ResourceApiParameters string as defined in the REL documentation for the Resource
Sample content-type: application/hal+json
 
{
  "params": [
    {
      "name": "str",
      "resource": "str",
      "eventTypes": "str",
      "url": "str",
      "includeResource": true,
      "resourceApiParameters": "str"
    }
  ]
}
Type Description
Params IEnumerable<Generic.Models.WebHookParametersForEvents>
Name string
Resource string Domain: Order, Receiver, Adjustment, Assembly, OrderItem, Item, InventorySummary
EventTypes string a comma-delimited list of supported event types; must be within 'Resource', e.g., if the Resource is 'Order", all EventTypes must be Orderxxx
Url string
IncludeResource bool
ResourceApiParameters string as defined in the REL documentation for the Resource
Sample accept: application/hal+json
{
  "params": [
    {
      "name": "str",
      "resource": "str",
      "eventTypes": "str",
      "url": "str",
      "includeResource": true,
      "resourceApiParameters": "str"
    }
  ]
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.