Request

PUT http:///api/v1/partner/webHooks/{webHookId}

Path parameters

Parameter name Value Description Additional
webHookId string Required

Request body

The request body takes a complete PartnerWebHook resource, containing the following writable properties:

{
    "companyId": "string",
    "created": "int64",
    "deleted": "boolean",
    "dirty": "boolean",
    "id": "string",
    "modified": "int64",
    "shopId": "string",
    "updated": "boolean",
    "url": "string",
    "webHookType": "string",
    "webHookUrls": [
        "string"
    ]
}

Properties

Name Type Description Additional
companyId string Optional
created int64 Optional
deleted boolean Optional
dirty boolean Optional
id string Optional
modified int64 Optional
shopId string Optional
updated boolean Optional
url string Optional
webHookType string

Possible values are:

  • NEW_CONSUMER_ORDER
  • NEW_CONSUMER_SIGNUP
  • UPDATE_CONSUMER_ORDER
  • NEW_MEMBER
  • UPDATE_MEMBER
  • COMPLETE_TRANSACTION
  • UPDATE_PRODUCT
Optional
webHookUrls[] array of string Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

PartnerWebHook

Explore this API

webHookId
body
Request Content-Type
Response Content-Type
Try it out!