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

companyIdstringrequired

Company ID

Example: {{company}}

tracestringrequired

Global link unique identifier

Example: {{mock_trace}}

apiKeystringrequired

apiKey

Example: {{apikey}}

recvWindowstring

time window

Example: 5000

signaturestringrequired

sign

Example: {{sign}}

langstring

language

Example: zh-CN

versionstring

Interface version

Example: 0.0.1

Body

apiKeystringrequired

apiKey

webhookUrlstringrequired

Message notification callback address

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/global/admin.admin.CompanyApiKeyDubboService.subscribe' \
  --header 'companyId: text' \
  --header 'trace: text' \
  --header 'apiKey: text' \
  --header 'signature: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "apiKey": "dc483e80a7a0bd9ef71d8cf973673924",
    "webhookUrl": "https://webhook.site/4fe19259-6b56-425a-ab03-f9575e4a2c36"
  }'

200

200

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