跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.shipthing.com/llms.txt

Use this file to discover all available pages before exploring further.

ShipThing支持使用Svix向您的用户发送Webhooks。Svix是一个企业级的Webhooks发送服务。
当存在SVIX_TOKEN环境变量时，Webhooks功能会自动启用。

​
工作原理

ShipThing以无状态方式使用Svix API。认证用户的组织ID会被用作Svix应用UID，该UID会在发送第一条消息时自动创建。

​
使用方法

​
发送Webhook

要发送Webhook，只需使用@repo/webhooks包中的send函数： 
import { webhooks } from '@repo/webhooks';

await webhooks.send('invoice.created', {
  data: {
    id: 'inv_1234567890',
  },
});

​
添加Webhook端点

Svix提供了一个预构建的消费者应用门户，用户可以在其中添加端点并管理所有与Webhook订阅相关的内容。应用门户访问基于使用特殊魔法链接的短期会话，并且可以嵌入到您仪表板的iframe中。 要访问应用门户，请使用@repo/webhooks中的getAppPortal函数，并在仪表板中使用返回的URL创建一个iframe。 
import { webhooks } from '@repo/webhooks';

const { url } = await webhooks.getAppPortal();

return (
  <iframe src={url} style="width: 100%; height: 100%; border: none;" allow="clipboard-write" loading="lazy" />
);
我们有一个预构建的页面/zh/webhooks可以作为起点。