Create Webhook

POST 
/openapi/2022-01/webhooks

Create a webhook with a unique identifier, notification URL, event name, and format.

Request

application/json

Body

Body

addressstringrequired

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

topicstringrequired

Event name, e.g. orders/cancelled

Example

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

Responses

200

200

application/json

Schema

Schema

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

Example

{
  "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

Schema

Schema

errors object
addressstring[]
topicstring[]

Example

{
  "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"
    ]
  }
}