API 参考Webhook

设置地址

PUThttps://api.astrum.shop/v1/webhook
权限范围 webhooks:manage, orders:read, wallet:read

您服务器的 https 地址;null 表示关闭。所有事件都会推送到该地址:order.updated、balance.updated、balance.low。

首次设置地址时会生成签名密钥,它只在该响应中出现一次:请将其保存到服务器的密钥存储中。

请求体

application/json
url
string | null · 必填

您服务器的 https 地址;null 表示关闭。

响应

url
string | null

Webhook 地址;null 表示未设置。

secret_set
boolean

true 表示签名密钥已生成。

previous_secret_expires_at
string | null

轮换后旧签名密钥仍用于签名的截止时间;否则为 null。

delivery
object

事件投递情况。

↳pending
integer

等待发送的事件数量。

↳dead_last_24h
integer

最近一天内经过全部重试后仍未送达的事件数量。

↳last_failure
object | null

最近一次失败的投递尝试;null 表示没有失败记录。

↳status_code
integer | null

您的服务器返回的 HTTP 状态码;null 表示没有响应。

↳error
string | null

没有响应时,未送达的原因。

secret
string | null

仅在生成第一个签名密钥的响应中返回:只显示一次。

所有接口通用的错误,详见「错误码」章节:

10001 invalid_key10002 key_scope_missing10003 ip_not_allowed10004 browser_not_allowed10005 account_suspended20001 too_many_requests90002 api_disabled90001 internal_error
测试 USDT,
密钥 ask_test_…
curl https://api.astrum.shop/v1/webhook -X PUT \
  -H "Authorization: Bearer $ASTRUM_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/astrum/webhook"
  }'