Для розробників

Pipevale API та інтеграції

Автентифікація за Bearer-ключем, RESTful ендпоінти, підписки на вебхуки — і рідні підключення до Zapier, Make та ApiX-Drive.

Автентифікація

Усі запити до API потребують API-ключа. Створіть ключ у Налаштування → API-ключі і передавайте його у заголовку:

Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx

Ліміт частоти: до 120 запитів за хвилину на робочий простір. При перевищенні API відповідає 429 із заголовком Retry-After — зачекайте вказану кількість секунд і повторіть запит.

REST API — ендпоінти

Базовий URL: https://<ваш-домен>/api/v1

Метод	Шлях	Опис	Параметри
GET	/api/v1/records	Список записів папки	folderId, search, page, pageSize
GET	/api/v1/records/:id	Один запис за ID	—
POST	/api/v1/records	Створити запис	folderId, title, email, phone, data{}
PATCH	/api/v1/records/:id	Оновити запис	title?, email?, phone?, data{}
DELETE	/api/v1/records/:id	Видалити запис (до кошика)	—
GET	/api/v1/records/:id/comments	Коментарі запису	—
POST	/api/v1/records/:id/comments	Додати коментар	text
GET	/api/v1/records/:id/calls	Логи дзвінків запису	—
POST	/api/v1/records/:id/calls	Залогувати дзвінок	direction?, outcome?, duration?, phone?, notes?, calledAt?
GET	/api/v1/folders	Список папок з їхніми полями	—
GET	/api/v1/pipelines	Список воронок (з етапами)	—
GET	/api/v1/pipelines/:id	Одна воронка за ID	—
GET	/api/v1/deals	Угоди воронки	pipelineId (обов'язковий)
POST	/api/v1/deals	Створити угоду	pipelineId, stageId?, title?, amount?, closeDate?, data{}
PATCH	/api/v1/deals/:id	Оновити угоду	stageId?, title?, amount?, closeDate?, data{}
DELETE	/api/v1/deals/:id	Видалити угоду	—
GET	/api/v1/tasks	Список задач	recordId?, status? (OPEN\|DONE)
POST	/api/v1/tasks	Створити задачу	title, dueAt?, assigneeId?, recordId?, priority?, type?, recurrence?
PATCH	/api/v1/tasks/:id	Оновити задачу	title?, dueAt?, assigneeId?, status?, priority?, type?
DELETE	/api/v1/tasks/:id	Видалити задачу	—

Приклади: запит і відповідь

Список записів папки

Запит

curl -H "Authorization: Bearer sk_live_xxx" \
  "https://pipevale.com/api/v1/records?folderId=fld_123&q=київ"

Відповідь

{
  "data": [
    {
      "id": "rec_abc",
      "folderId": "fld_123",
      "title": "ТОВ «Ромашка»",
      "email": "ceo@romashka.ua",
      "phone": "+380671234567",
      "data": { "city": "Київ", "status": "Активний" },
      "createdAt": "2026-07-09T08:15:00.000Z"
    }
  ]
}

Один запис за ID

Запит

curl -H "Authorization: Bearer sk_live_xxx" \
  "https://pipevale.com/api/v1/records/rec_abc"

Відповідь

{
  "data": {
    "id": "rec_abc",
    "folderId": "fld_123",
    "title": "ТОВ «Ромашка»",
    "email": "ceo@romashka.ua",
    "data": { "city": "Київ" }
  }
}

Створити запис

Запит

curl -X POST \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"folderId":"fld_123","title":"Нова компанія","email":"hi@acme.ua"}' \
  "https://pipevale.com/api/v1/records"

Відповідь

HTTP/1.1 201 Created

{
  "data": {
    "id": "rec_new",
    "folderId": "fld_123",
    "title": "Нова компанія",
    "email": "hi@acme.ua"
  }
}

Список папок з полями

Запит

curl -H "Authorization: Bearer sk_live_xxx" \
  "https://pipevale.com/api/v1/folders"

Відповідь

{
  "data": [
    {
      "id": "fld_123",
      "name": "Компанії",
      "type": "CUSTOM",
      "fields": [
        { "key": "city", "label": "Місто", "type": "TEXT" },
        { "key": "status", "label": "Статус", "type": "SELECT" }
      ]
    }
  ]
}

Коментарі запису

Запит

curl -H "Authorization: Bearer sk_live_xxx" \
  "https://pipevale.com/api/v1/records/rec_abc/comments"

Відповідь

{
  "data": [
    {
      "id": "note_1",
      "text": "Передзвонити у вівторок",
      "author": "Олег",
      "createdAt": "2026-07-09T09:00:00.000Z"
    }
  ]
}

Додати коментар

Запит

curl -X POST \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"text":"Оплатили рахунок №42"}' \
  "https://pipevale.com/api/v1/records/rec_abc/comments"

Відповідь

HTTP/1.1 201 Created

{
  "data": {
    "id": "note_2",
    "text": "Оплатили рахунок №42",
    "createdAt": "2026-07-09T10:30:00.000Z"
  }
}

Залогувати дзвінок

Запит

curl -X POST \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"direction":"OUTBOUND","duration":5,"phone":"+380671234567","notes":"Погодили ціну"}' \
  "https://pipevale.com/api/v1/records/rec_abc/calls"

Відповідь

HTTP/1.1 201 Created

{
  "data": {
    "id": "call_1",
    "direction": "OUTBOUND",
    "outcome": "CONNECTED",
    "duration": 5,
    "calledAt": "2026-07-09T11:00:00.000Z"
  }
}

Список воронок з етапами

Запит

curl -H "Authorization: Bearer sk_live_xxx" \
  "https://pipevale.com/api/v1/pipelines"

Відповідь

{
  "data": [
    {
      "id": "pl_1",
      "name": "Продажі",
      "stages": [
        { "id": "st_1", "name": "Новий" },
        { "id": "st_2", "name": "Переговори" }
      ]
    }
  ]
}

Створити угоду

Запит

curl -X POST \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"pipelineId":"pl_1","title":"Угода з ACME","amount":15000}' \
  "https://pipevale.com/api/v1/deals"

Відповідь

HTTP/1.1 201 Created

{
  "data": {
    "id": "deal_1",
    "pipelineId": "pl_1",
    "stageId": "st_1",
    "title": "Угода з ACME",
    "amount": 15000
  }
}

Створити задачу

Запит

curl -X POST \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"title":"Підготувати КП","dueAt":"2026-07-12T12:00:00Z","recordId":"rec_abc"}' \
  "https://pipevale.com/api/v1/tasks"

Відповідь

HTTP/1.1 201 Created

{
  "data": {
    "id": "task_1",
    "title": "Підготувати КП",
    "dueAt": "2026-07-12T12:00:00.000Z",
    "status": "OPEN"
  }
}

Вихідні вебхуки

Підпишіться на події в Налаштування → Вебхуки. Pipevale надсилатиме POST-запит на ваш URL при кожній події.

record.createdrecord.updateddeal.stage_changed

Формат payload:

{
  "event": "record.created",
  "recordId": "rec_xxx",
  "folderId": "fld_xxx",
  "workspaceId": "ws_xxx",
  "occurredAt": "2026-06-18T10:00:00Z",
  "record": {
    "id": "rec_xxx",
    "folderId": "fld_xxx",
    "title": "Нова компанія",
    "email": "ceo@example.com",
    "phone": "+380...",
    "data": { ... }
  }
}

Поле record — знімок запису на момент події (щоб не робити другий запит); буде null, якщо запис уже недоступний. Підпис у заголовку X-Pipevale-Signature: sha256=… — HMAC тіла секретом вебхука. Перевіряйте його на своєму боці.

Вхідні вебхуки (Incoming Webhooks)

Зовнішня система може ініціювати автоматизацію в Pipevale через унікальну POST-адресу. Це забезпечує двосторонню інтеграцію: події надходять не лише З Pipevale, а й ДО нього.

1Відкрийте Автоматизації → Нова автоматизація і оберіть тригер Вхідний вебхук.
2Скопіюйте згенеровану URL виду /api/webhooks/trigger/{workflowId}.
3Надсилайте POST-запит з довільним JSON-тілом. Опціонально передайте recordId — сценарій виконається в контексті цього запису.
4Автоматизація виконає налаштовані дії (призначити власника, змінити етап, надіслати API-запит тощо).

Приклад виклику:

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"recordId":"rec_xxx","source":"my-crm","event":"payment.received"}' \
  "https://pipevale.com/api/webhooks/trigger/<workflowId>"

Відповідь: { "ok": true, "workflowId": "..." }. Автоматизація виконується асинхронно у черзі.

Схема двосторонньої інтеграції

Pipevale підтримує повну двосторонню інтеграцію з вашою інфраструктурою:

Ваша система

ERP, сайт, магазин, бот, CRM…

REST API →Pipevale

Pipevale→ Вебхуки

Pipevale

Записи, угоди, задачі, автоматизації

IN — дані до Pipevale

• POST /api/v1/records — створити запис
• PATCH /api/v1/records/:id — оновити запис
• POST /api/v1/deals — нова угода
• POST /api/webhooks/trigger/:id — запустити сценарій

OUT — події з Pipevale

• record.created — новий запис
• record.updated — запис оновлено
• deal.stage_changed — етап угоди

⚡

Підключення через Zapier

Використовуйте «Webhooks by Zapier» (тригер) та «HTTP by Zapier» (дія) — без нативного конектора, просто через наш API.

1У Налаштування → API-ключі створіть ключ для Zapier. Скопіюйте значення — воно показується лише один раз.
2Тригер (нова подія з Pipevale): у Zapier оберіть «Webhooks by Zapier → Catch Hook». Скопіюйте URL. Потім у Налаштування → Вебхуки додайте новий вебхук, вставте URL і оберіть події, що цікавлять.
3Дія (записати в Pipevale): оберіть «HTTP by Zapier → POST». URL: https://<ваш-домен>/api/v1/records. Заголовок Authorization: Bearer sk_live_…. Тіло — JSON із потрібними полями.
4Протестуйте Zap і вмикайте — готово!

🔮

Підключення через Make (Integromat)

Make має гнучкий HTTP-модуль і вбудовану підтримку вебхуків — ідеально для багатокрокових сценаріїв.

1Отримайте API-ключ у Налаштування → API-ключі.
2Тригер (з Pipevale): додайте модуль «Webhooks → Custom webhook». Make згенерує URL — вставте його у Налаштування → Вебхуки і підпишіться на потрібні події.
3
Дія (в Pipevale): модуль «HTTP → Make a request».
- URL: https://<ваш-домен>/api/v1/records
- Метод: POST
- Заголовки: Authorization: Bearer sk_live_…
- Body type: Raw, Content-Type: application/json
4Запустіть сценарій і перевірте дані в Pipevale.

🔗

ApiX-Drive

ApiX-Drive — українська iPaaS-платформа. Pipevale підключається як зовнішня система через HTTP-модуль і вебхуки — двосторонньо, без коду.

1Отримайте API-ключ у Налаштування → API-ключі.
2Отримання даних з Pipevale: у ApiX-Drive створіть звʼязок із джерелом «Веб-хук», скопіюйте адресу та додайте її у Налаштування → Вебхуки з потрібними подіями (record.created тощо).
3Передавання даних у Pipevale: як приймач оберіть HTTP-запит на https://<ваш-домен>/api/v1/records (метод POST, заголовок Authorization: Bearer sk_…, тіло JSON).
4Авто-конфігурація: імпортуйте нашу OpenAPI-специфікацію у ApiX-Drive (або Postman/Insomnia) — усі ендпоінти, поля та приклади підтягнуться автоматично.

📄 Машиночитна специфікація: /api/v1/openapi.json — імпортуйте у будь-який інструмент, що підтримує OpenAPI 3.

Потрібна допомога?

Наша команда допоможе з налаштуванням інтеграцій і автоматизацій.

Написати у підтримку