Request

POST http:///api/v1/partner/store/webHook

Request body

The request body takes an array of PartnerWebHookAddRequest resources, containing the following writable properties:

[
    {
        "shopId": "string",
        "url": "string",
        "webHookType": "string",
        "webHookUrls": [
            "string"
        ]
    }
]

Properties

Name Type Description Additional
shopId string 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
webHookUrls[] array of string

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

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