HTTP 请求

在决策之后调用任意 API——方法、URL、请求头,以及由变量和工作区密钥构建的 JSON 请求体——投递时带有重试、Idempotency-Key 和签名。

API 请求目的地(类型 http)使用你设计的请求调用任意 HTTP API——在 CRM 中创建线索、创建工单、发布到 Slack——在后台运行,并带有重试。令牌保存在工作区密钥中,从不放在决策里。

配置

{
  "key": "create_lead",
  "type": "http",
  "when": { "conditions": [{ "field": "route", "on": "output", "operator": "eq", "value": "sales" }] },
  "params": {
    "email": { "from": "state.email", "required": true },
    "score": { "from": "composites.lead_score" }
  },
  "http": {
    "method": "POST",
    "url": "https://api.crm.example.com/v2/leads?source={{decision.slug}}",
    "headers": [{ "name": "Authorization", "value": "Bearer {{secrets.CRM_TOKEN}}" }],
    "body": "{\"email\": {{params.email}}, \"score\": {{params.score}}, \"note\": \"Routed to {{result.route}} by Dcision\"}"
  }
}
字段类型默认值说明
methodstringPOSTGET、POST、PUT、PATCH 或 DELETE。
urlstring—https://… 或保存整个 URL 的 {{secrets.NAME}};最多 2,048 个字符,变量会进行 URL 编码。
headersarray[]最多 20 个 { "name", "value" } 对;值最多 2,048 个字符,可使用变量和密钥。
bodystring以 JSON 形式发送的参数仅限 POST、PUT 和 PATCH:最多 10,000 个字符的 JSON 模板。

请求体

请求体是一个 JSON 模板:在引号外,变量会成为一个 JSON 值;在引号内,它会成为文本——参见 JSON 请求体。使用上面的目的地,CRM 会收到:

{ "email": "ana@acme.com", "score": 0.8414, "note": "Routed to sales by Dcision" }
  • 在 POST、PUT 或 PATCH 上没有请求体模板时:参数会作为一个 JSON 对象发送。
  • 除非你添加了自己的 Content-Type 请求头,否则会设置 Content-Type: application/json。
  • GET 和 DELETE 没有请求体——为它们设置请求体属于 schema 错误。它们的参数会被添加到查询字符串中(?email=ana%40acme.com&score=0.8414),除非 URL 已经使用了 {{params.…}}。

请求头

你的请求头会与 Dcision 的请求头一起发送:

请求头值
你的请求头其值渲染为文本——换行变为空格。
Content-Type有请求体时为 application/json,除非你自己设置。
User-AgentDcision-Destinations/1.0 (+https://docs.dcision.io/destinations),除非你自己设置。
Idempotency-Key投递 ID dlv_…,除非你自己设置——每次尝试都相同,因此支持幂等键的 API 永远不会把一次重试执行两次。
Dcision-Delivery、Dcision-Attempt、Dcision-Event、Dcision-Signature与 webhook 相同。

有些名称由 Dcision 或 HTTP 层设置,不能使用:Host、Content-Length、Connection、Transfer-Encoding、Upgrade、Keep-Alive、TE、Trailer、Expect,以及任何以 Proxy- 或 Dcision- 开头的名称。

认证

把凭据通过密钥放在请求头中——Authorization: Bearer {{secrets.CRM_TOKEN}}——或者当 API 需要秘密 URL 时,把 URL 作为密钥放入({{secrets.SLACK_WEBHOOK}})。URL 本身包含的凭据(https://user:password@…)会被拒绝。

签名

API 请求与 webhook 一样进行签名,基于实际发送的请求体——GET 和 DELETE 为空请求体。如果接收的 API 是你自己的,请使用 verifySignature(TypeScript)或 verify_signature(Python)验证 Dcision-Signature:请求体是你的模板,而不是 webhook 事件。参见验证签名。

示例:Slack 消息

Slack 的入站 webhook 需要它自己的 JSON,因此请使用 API 请求,并把 webhook URL 保存为密钥:

{
  "key": "escalation_alert",
  "type": "http",
  "when": { "actions": ["escalate"] },
  "params": { "message": { "from": "state.message" } },
  "http": {
    "method": "POST",
    "url": "{{secrets.SLACK_WEBHOOK}}",
    "body": "{\"text\": \"{{decision.slug}} asks for a person ({{action}}): {{params.message}}\"}"
  }
}

消息写在引号内,因此参数会以转义文本的形式插入——线索消息中的引号和换行不会破坏 JSON。

本页内容