Webhook subscription

Webhook subscription

Subscribe to various messages, such as transaction information. For details, please refer to the transaction notification message description.

POST/global/admin.admin.CompanyApiKeyDubboService.subscribe

Header parameters

Body

application/json

apiKey*string

apiKey

webhookUrl*string

Message notification callback address

Response

200

Body

application/json

code*string

System common return code. 0-success, other exceptions

msg*string

Return information

bizCode*string

Module identification code

tm*number

Processing time (milliseconds)

trace*string

Global link flag information

msgParams*nullable string

Returns the placeholder parameter string in the description. Multiple parameters are separated by,

data*boolean

Return results

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/global/admin.admin.CompanyApiKeyDubboService.subscribe', {
    method: 'POST',
    headers: {
      "companyId": "text",
      "trace": "text",
      "apiKey": "text",
      "signature": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "apiKey": "dc483e80a7a0bd9ef71d8cf973673924",
      "webhookUrl": "https://webhook.site/4fe19259-6b56-425a-ab03-f9575e4a2c36"
    }),
});
const data = await response.json();

Response

200

{
  "code": "text",
  "msg": "text",
  "bizCode": "text",
  "tm": 0,
  "trace": "text",
  "msgParams": "text",
  "data": false
}