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://… или {{secrets.NAME}} со всем URL; до 2 048 символов, переменные кодируются для URL.
headersarray[]До 20 пар { "name", "value" }; значения до 2 048 символов, с переменными и секретами.
bodystringпараметры в виде JSONТолько POST, PUT и PATCH: JSON-шаблон длиной до 10 000 символов.

Тело

Тело — это JSON-шаблон: вне кавычек переменная становится значением JSON, внутри кавычек — текстом; см. Тела JSON. С назначением выше CRM получает:

{ "email": "ana@acme.com", "score": 0.8414, "note": "Routed to sales by Dcision" }
  • Без шаблона тела в POST, PUT или PATCH параметры отправляются как JSON-объект.
  • Content-Type: application/json устанавливается, если вы не добавите свой заголовок Content-Type.
  • У GET и DELETE нет тела — тело у них считается ошибкой схемы. Их параметры добавляются в строку запроса (?email=ana%40acme.com&score=0.8414), если только URL уже не использует {{params.…}}.

Заголовки

Ваши заголовки отправляются вместе с заголовками Dcision:

ЗаголовокЗначение
Ваши заголовкиИх значения, сформированные как текст, — переносы строк становятся пробелами.
Content-Typeapplication/json, если есть тело, — если вы не задали его сами.
User-AgentDcision-Destinations/1.0 (+https://docs.dcision.io/destinations), если вы не задали его сами.
Idempotency-KeyID доставки, dlv_…, если вы не задали его сами, — одинаковый во всех попытках, поэтому API с поддержкой ключей идемпотентности никогда не применяют повтор дважды.
Dcision-Delivery, Dcision-Attempt, Dcision-Event, Dcision-SignatureКак для вебхуков.

Некоторые имена задаются Dcision или уровнем HTTP и не могут использоваться: Host, Content-Length, Connection, Transfer-Encoding, Upgrade, Keep-Alive, TE, Trailer, Expect, а также любое имя, начинающееся с Proxy- или Dcision-.

Аутентификация

Передавайте учётные данные в заголовке с секретом — Authorization: Bearer {{secrets.CRM_TOKEN}} — или в URL в виде секрета, когда API ожидает секретный URL ({{secrets.SLACK_WEBHOOK}}). Учётные данные прямо в URL (https://user:password@…) отклоняются.

Подпись

API-запросы подписываются так же, как вебхуки, по точному отправленному телу — пустому для GET и DELETE. Если принимающий API ваш, проверяйте Dcision-Signature с помощью verifySignature (TypeScript) или verify_signature (Python): тело — это ваш шаблон, а не событие вебхука. См. Проверка подписи.

Пример: сообщение в Slack

Входящие вебхуки Slack ожидают собственный JSON, поэтому используйте API-запрос с 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.

На этой странице