Webhook subscription

Webhook subscription

post

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

Header parameters

companyIdstringRequired

Company ID

Example: {{company}}

tracestringRequired

Global link unique identifier

Example: {{mock_trace}}

apiKeystringRequired

apiKey

Example: {{apikey}}

recvWindowstringOptional

time window

Example: 5000

signaturestringRequired

sign

Example: {{sign}}

langstringOptional

language

Example: zh-CN

versionstringOptional

Interface version

Example: 0.0.1

Body

application/json

apiKeystringRequired

apiKey

webhookUrlstringRequired

Message notification callback address

Responses

200Success

application/json

codestringRequired

System common return code. 0-success, other exceptions

msgstringRequired

Return information

bizCodestringRequired

Module identification code

tmnumberRequired

Processing time (milliseconds)

tracestringRequired

Global link flag information

msgParamsstring · nullableRequired

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

databooleanRequired

Return results

post

/global/admin.admin.CompanyApiKeyDubboService.subscribe

HTTPcURLJavaScriptPython

POST /global/admin.admin.CompanyApiKeyDubboService.subscribe HTTP/1.1
companyId: text
trace: text
apiKey: text
signature: text
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "apiKey": "dc483e80a7a0bd9ef71d8cf973673924",
  "webhookUrl": "https://webhook.site/4fe19259-6b56-425a-ab03-f9575e4a2c36"
}

200Success

{
  "msg": "Success",
  "fail": false,
  "trace": "t-h2jv9x-4to64-9mp4wd7-793nv-1661227305",
  "code": "0",
  "data": "true",
  "bizCode": "",
  "tm": 236026513,
  "msgParams": null,
  "ok": true
}