WebhooksClient

用于处理 webhooks 的客户端

该客户端提供与 X API 的 webhooks 端点交互的方法，负责所有与 webhooks 相关操作的身份验证、请求格式与响应解析。

​

构造器

​

构造函数

• new WebhooksClient(client): WebhooksClient

创建新的 Webhooks 客户端实例

​

参数

名称	类型	描述
client	Client	X API 的主要客户端实例

​

返回值

WebhooksClient

​

定义于

webhooks/client.ts:96

​

方法

​

getStreamLinks

▸ getStreamLinks(): Promise<WebhookLinksGetResponse>

获取流链接 获取与筛选后的流规则集关联的 webhook 链接列表。

​

返回

Promise<WebhookLinksGetResponse>

解析为 API 响应的 Promise

​

定义于

webhooks/client.ts:109

---

​

createStreamLink

▸ createStreamLink(webhookId, options?): Promise<WebhookLinksCreateResponse>

创建流链接 创建一个用于将 FilteredStream 事件投递到指定 webhook 的链接。

​

参数

名称	类型	说明
webhookId	string	要链接到 FilteredStream 规则集的 webhook id。
options	CreateStreamLinkOptions	-

​

返回

Promise<WebhookLinksCreateResponse>

解析为 API 响应的 Promise

​

定义位置

webhooks/client.ts:145

---

​

deleteStreamLink

▸ deleteStreamLink(webhookId): Promise<WebhookLinksDeleteResponse>

删除流链接 删除从 FilteredStream 事件到指定 webhook 的关联。

​

参数

名称	类型	描述
webhookId	string	要关联到你的 FilteredStream 规则集的 webhook id。

​

返回

Promise<WebhookLinksDeleteResponse>

会解析为 API 响应的 Promise

​

定义位置

webhooks/client.ts:225

---

​

validate

▸ validate(webhookId): Promise<WebhookConfigPutResponse>

验证 webhook 对指定的 webhook 触发 CRC 校验。

​

参数

名称	类型	说明
webhookId	string	要检查的 webhook 的 id。

​

返回

Promise<WebhookConfigPutResponse>

解析为 API 响应的 Promise

​

定义于

webhooks/client.ts:263

---

​

delete

▸ delete(webhookId): Promise<WebhookConfigDeleteResponse>

删除 webhook 删除已有的 webhook 配置。

​

参数

名称	类型	说明
webhookId	string	要删除的 webhook 的 id。

​

返回

Promise<WebhookConfigDeleteResponse>

解析为 API 响应的 Promise

​

定义于

webhooks/client.ts:301

---

​

get

▸ get(options?): Promise<Get2WebhooksResponse>

获取 webhook 获取与客户端 App 关联的 webhook 配置清单。

​

参数

名称	类型
options	GetOptions

​

返回

Promise<Get2WebhooksResponse>

解析为 API 响应的 Promise

​

定义于

webhooks/client.ts:335

---

​

create

▸ create(options?): Promise<WebhookConfigCreateResponse>

创建 webhook 创建新的 webhook 配置。

​

参数

名称	类型
options	CreateOptions

​

返回

Promise<WebhookConfigCreateResponse>

解析为 API 响应的 Promise

​

定义位置

webhooks/client.ts:376