创建 Webhook

POST 
/openapi/2022-01/webhooks

创建包含通知 URL、事件名称和格式的 Webhook。

请求

application/json

请求体

请求体

addressstring必填

Webhook notification URL, e.g. https://example.com/webhook

topicstring必填

Event name, e.g. orders/cancelled

示例

{
  "address": "string",
  "topic": "string"
}

响应

200

200

application/json

数据结构

数据结构

webhook object
idstring
示例： 37593634-c272-4ed5-9096-1a4f1212125e
addressstring
示例： https://abc.com
topicstring
示例： order/create
created_atstring
示例： 2018-08-26T06:50:00Z
updated_atstring
示例： 2018-08-26T06:50:00Z
formatstring
示例： json

示例

{
  "webhook": {
    "id": "37593634-c272-4ed5-9096-1a4f1212125e",
    "address": "https://abc.com",
    "topic": "order/create",
    "created_at": "2018-08-26T06:50:00Z",
    "updated_at": "2018-08-26T06:50:00Z",
    "format": "json"
  }
}

Result

{
  "webhook": {
    "id": "37593634-c272-4ed5-9096-1a4f1212125e",
    "address": "https://abc.com",
    "topic": "order/create",
    "created_at": "2018-08-26T06:50:00Z",
    "updated_at": "2018-08-26T06:50:00Z",
    "format": "json"
  }
}

422

422

application/json

数据结构

数据结构

errors object
addressstring[]
topicstring[]

示例

{
  "errors": {
    "address": [
      "can't be blank"
    ],
    "topic": [
      "can't be blank"
    ]
  }
}

Result

{
  "errors": {
    "address": [
      "can't be blank",
      "is invalid"
    ],
    "topic": [
      "can't be blank"
    ]
  }
}