WFBSS :: Callback :: register

Views:

Last Updated: 1/22/2020 12:11:09 AM

Register a callback URL which will be triggered by event.

Request

POST /SMPI/{version}/service/wfbss/api/callback

Register a callback URL when customers are changed:
POST /SMPI/{version}/service/wfbss/api/callback

{
    "id": "0002",
    "event": {
        "name": "customer_changed"
    },
    "url": "http://target.server.trend.com/notify"
}

Name	Type	Description	Validation
Required Parameters
id	string	The ID of the callback which should be unique for the calling service. If it is registered, the callback will be replaced by the new one.
event.name	string	Name of the event that will trigger the callback	Valid event names are customer_changed, computer_changed, customer_group_changed, new_notifications, or vendor_changed.
url	string	Callback URL

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:

{
  "callback": {
    "url": "http://target.server.trend.com/notify",
    "id": "0002"
  }
}

Name	Type	Description	Length
id	string	Callback ID
url	string	Callback URL