Keitaro icon

Keitaro

Работа с API Keitaro

Overview

This node interacts with the Keitaro API to manage postbacks, including creating new postbacks. It is useful for automating the setup and management of postbacks in Keitaro, which are URLs triggered on specific events like conversions, leads, or sales. For example, users can create a postback that sends conversion data to an external system using specified HTTP methods and parameters.

Use Case Examples

  1. Creating a postback to notify an external system of a conversion event with custom parameters and headers.
  2. Automating the creation of postbacks for different campaigns and countries with specific triggers and statuses.

Properties

Name Meaning
Название постбэка The name of the postback to be created.
URL постбэка The URL to which the postback will be sent, supporting macros like {sub_id_1}, {status}, {revenue}.
Статус The status of the postback, either active or inactive.
Триггер Defines when the postback should be sent: on any conversion, only on leads, or only on sales.
HTTP метод The HTTP method used to send the postback, either GET or POST.
Статусы лидов Comma-separated list of statuses considered as leads by Keitaro.
Статусы продаж Comma-separated list of statuses considered as sales by Keitaro.
Отклоненные статусы Comma-separated list of statuses considered as rejected conversions by Keitaro.
Дополнительные настройки Toggle to show advanced postback settings.
Ключ постбэка Authentication key for the postback to enhance security.
Валюта Default currency used for conversions.
Таймаут (сек) Timeout in seconds for sending the postback.
Количество повторных попыток Number of retry attempts if the postback sending fails.
Задержка между попытками (сек) Delay in seconds between retry attempts.
Кампании Comma-separated campaign IDs for which the postback will be sent; empty means all campaigns.
Страны Comma-separated country codes for which the postback will be sent; empty means all countries.
Настройка HTTP заголовков Toggle to configure custom HTTP headers for the postback.
HTTP заголовки Custom HTTP headers to include in the postback request.
Параметры постбека Additional parameters to include in the postback URL or body.
Статусы для отслеживания регистраций Comma-separated statuses considered as registrations (for Keitaro 10.3+).
Статусы для отслеживания депозитов Comma-separated statuses considered as deposits (for Keitaro 10.3+).

Output

JSON

  • request
    • url - The URL of the API request made to Keitaro.
    • method - The HTTP method used for the API request.
    • headers - Headers sent with the API request, with sensitive data masked.
  • resource - The resource type involved in the operation (e.g., postback).
  • operation - The operation performed (e.g., create).
  • success - Indicates if the operation was successful (true/false).
  • data - The data returned from the Keitaro API for the operation.
  • error - Indicates if there was an error during the operation.

Dependencies

  • Keitaro API with domain and API key credentials

Troubleshooting

  • Ensure that the domain and API key credentials are correctly set; missing these will cause errors.
  • When creating a postback, all required fields like postbackName and postbackUrl must be provided, or the node will throw an error.
  • If the API returns an error status, the node will throw an error with the API message; check the API key and permissions.
  • For the 'stats' resource, only the 'getAll' operation is supported; using other operations will cause an error.
  • When using advanced settings, ensure that parameters like campaigns and countries are correctly formatted as comma-separated lists.

Links

Discussion