JANDI

thumbnail

如何接收 Incoming Webhook？

Dahlia2024-10-28

Webhook 是什么？

Webhook 是透过预设格式匹配的数据并将通知发送到指定的 JANDI 聊天室的功能。如果 JANDI Connect 不支持某个服务，但支援 Outgoing Webhook，它可以与 JANDI 连接并接收有关不同更新的通知。

* 提示：您可以请开发人员或IT部门协助，以轻松设定 Webhook。

步骤1

通过消息向 JANDI 中生成的 Webhook URL 发送信息（HTTP POST 请求）。您必须在请求中指定 Accept 和 Content-Type，如下所示：

  • Accept: application/vnd.tosslab.jandi-v2+json

  • Content-Type: application/json

参考：JANDI Webhook 在restful API 中工作，因此您必须将http method置为POST。如果您将其设置为其他方法，它将不起作用。

步骤2

POST 请求如下:

Plaintext
{
"body" : "[[PizzaHouse]](http://url_to_text) You have a new Pizza order.",
"connectColor" : "#FAC11B",
"connectInfo" : [{
"title" : "Topping",
"description" : "Pepperoni"
},
{
"title": "Location",
"description": "Empire State Building, 5th Ave, New York",
"imageUrl": "http://url_to_text"
}]
}

每个字段具有以下功能。

  • “body”：信息的基本内容。如果您编辑并发送信息，它将在视图中接收。这是唯一必需的条目，如果将此留空，您将无法发送消息。如果未提供其他字段，您仍然可以仅使用此字段发送消息。 [[PizzaHouse]](http://url_to_text) - 这是Link Markdown的使用示例（它是一种生成超链接的文本格式，在JANDI中，您可以创建一个链接，如

  • JANDI提供的“[Text](Url Link)”，点击后会打开一个新窗口。

  • “connectColor” ：可以用Hex Code设置邮件底部附件区域的颜色属性。

  • “connectInfo”：这是一个字段，可让您定义附件区域中将包含哪些元素。

  • “title”：附件区域的标题，以“粗体”显示。

  • “description”：附件区域的详细信息。从上面的例子可以看出，可以根据消息的结构添加多个标题和描述。

  • “imageUrl” 如果 Webhook 消息中附加了图像文件，您可以将其附加为 URL 格式。稍后我们将提供带有消息的缩略图。

接下来是 curl 请求的示例。如果你在 CLI 中实现它们，比如终端，你实际上可以在 JANDI 中检查接收消息。

但，请不要忘记将“https://wh.jandi.com/connect-api/webhook/generated-link-in-JANDI”替换为您在 JANDI 中生成的实际 Webhook 地址。

curl \ -X POST https://wh.jandi.com/connect-api/webhook/generated_webhook_url \ -H "Accept: application/vnd.tosslab.jandi-v2+json" \ -H "Content-Type: application/json" \ --data-binary '{"body":"[[PizzaHouse]](http://url_to_text) You have a new Pizza order.","connectColor":"#FAC11B","connectInfo":[{"title":"Topping","description":"Pepperoni"}, {"title":"Location","description":"Empire State Building, 5th Ave, New York","imageUrl":"Url_to_text"}]}'

像这样收到的信息将被发送到生成 Webhook 的聊天室，如下所示。

小提示：

  1. 在您使用的服务中，即使它支援 Webhook，您也必须将源自服务的事件转换为 JANDI 可以形成为信息的某种格式。您其实可以为此任务开发像这样的流程，但您可以使用第三方服务，例如 Zapier。

  2. JANDI 中信息的最大字符数为 5000 个字符，通过 Webhook 接收的数据的最大大小为 256kb。 256kb足够存储26万个字符，但是如果数据超过256kb，就会返回错误信息。

  • 如果您通过 Webhook 发送包含 250,000 个字符的信息，它将最多显示 5000 个字符。

  • 如果您发送包含 270,000 个字符的信息，则它将不会自已发送信息。