whmcs_hooks.php¶

Модуль обработки вебхуков WHMCS для автоматизации действий при оплате инвойсов, создании клиентов и изменении статусов услуг

Методы API¶

Метод	Действие	Описание
`ClientAdd`	получение групп	Обрабатывает создание нового клиента в WHMCS, отправляет приветственное письмо и автоматически переводит клиента в тестовую группу при использовании корпоративной почты.
`InvoiceCreation`	получение групп	Выполняет первичную обработку создания нового инвойса в WHMCS.
`invoice_total_updated`	получение групп	Пересчитывает кредиты инвойса после изменения его состава (удаление позиций).
`whmcs_invoice_created`	получение групп	Выполняет действия при создании нового инвойса в WHMCS.
`whmcs_invoice_paid`	получение групп	Обрабатывает событие оплаты инвойса: проверяет перерасход трафика, отправляет уведомления клиенту и создает тикеты в Kayako.
`whmcs_invoice_reminder`	получение групп	Обрабатывает напоминания о неоплаченных инвойсах, уведомляя клиентов.

whmcs_hooks/ClientAdd¶

Обрабатывает создание нового клиента в WHMCS, отправляет приветственное письмо и автоматически переводит клиента в тестовую группу при использовании корпоративной почты.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `ClientAdd`
email	❌	string	Электронная почта клиента для проверки на принадлежность к корпоративному домену
userid	❌	integer	Уникальный идентификатор пользователя в системе WHMCS
location	❌	string	Биллинговая локация для выполнения операций в WHMCS

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=ClientAdd"

Пример успешного ответа

{
"result": "OK",
"action": "ClientAdd operations completed: hook_send_welcome_email returned success, client updated to test group"
}

Примеры ошибок

{
"code": -1,
"message": "No client data provided"
}

whmcs_hooks/whmcs_invoice_paid¶

Обрабатывает событие оплаты инвойса: проверяет перерасход трафика, отправляет уведомления клиенту и создает тикеты в Kayako.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `whmcs_invoice_paid`
serviceid	❌	integer	Идентификатор сервиса в WHMCS
userid	❌	integer	Идентификатор пользователя в WHMCS
status	❌	string	Статус инвойса для проверки оплаты
location	❌	string	Идентификатор локации или региона сервера.
invoiceid	❌	integer	Уникальный номер счета в системе биллинга.
invoiceId	❌	string	Идентификатор счета (используется как строковый ключ).
orderId	❌	integer	Уникальный номер заказа клиента.
userId	❌	string	Идентификатор пользователя или клиента.
domainstatus	❌	string	Текущий статус доменного имени.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=whmcs_invoice_paid"

Пример успешного ответа

{
"result": "OK",
"action": "whmcs_invoice_paid operations completed: invoice 123 checked, traffic cleared"
}

Примеры ошибок

{
"code": -1,
"message": "Internal error"
}

whmcs_hooks/InvoiceCreation¶

Выполняет первичную обработку создания нового инвойса в WHMCS.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `InvoiceCreation`
invoice_id	✅	integer	Уникальный идентификатор инвойса для обработки.
location	✅	string	Местоположение (billing location) для привязки инвойса.
invoiceid	❌	integer	Уникальный идентификатор счета в системе.
invoiceId	❌	integer	Идентификатор счета для обработки операции.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=InvoiceCreation" \
--data "invoice_id=123" \
--data "location=US-EAST"

Пример успешного ответа

{
"result": "OK",
"action": "invoice 123 creation proceeded: true"
}

Примеры ошибок

{
"code": -1,
"message": "Invalid billing location"
}

whmcs_hooks/invoice_total_updated¶

Пересчитывает кредиты инвойса после изменения его состава (удаление позиций).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `invoice_total_updated`
invoice_id	✅	integer	Уникальный идентификатор инвойса для пересчета кредитов
location	✅	string	Биллинговая локация (billing location)
invoiceid	❌	string	Идентификатор счета в системе.
invoiceId	❌	string	Идентификатор счета в системе.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=invoice_total_updated" \
--data "invoice_id=12345" \
--data "location=us-east"

Пример успешного ответа

{
"result": "success",
"excess_returned": 0.5,
"invoice_gross": 10.0,
"transid": "rebalance-123-1678901234"
}

Примеры ошибок

{
"code": -1,
"message": "Invalid billing location"
}

whmcs_hooks/whmcs_invoice_reminder¶

Обрабатывает напоминания о неоплаченных инвойсах, уведомляя клиентов.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `whmcs_invoice_reminder`
token	✅	string	Токен авторизации для доступа к API
invoice_id	❌	integer	Идентификатор инвойса для обработки напоминаний
status	❌	string	Текущий статус инвойса
location	❌	string	Локация клиента для определения языка уведомления
invoiceid	❌	integer	Уникальный идентификатор счета в системе.
invoiceId	❌	integer	Идентификатор счета для обработки уведомлений.
userid	❌	integer	Уникальный идентификатор пользователя в системе.
userId	❌	integer	Идентификатор клиента для привязки к счету.
serviceid	❌	integer	Идентификатор услуги, связанной со счетом.
domainstatus	❌	string	Текущий статус доменного имени или услуги.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=whmcs_invoice_reminder" \
--data "token=HOSTKEY_TOKEN" \
--data "invoice_id=123"

Пример успешного ответа

{
"result": "OK",
"action": "whmcs_invoice_reminder operations completed: invoice 123 reminders proceeded"
}

Примеры ошибок

{
"code": -1,
"message": "Internal error"
}

whmcs_hooks/whmcs_invoice_created¶

Выполняет действия при создании нового инвойса в WHMCS.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `whmcs_invoice_created`
location	✅	string	Местоположение (billing location) для обработки инвойса
invoice_id	✅	integer	Идентификатор созданного инвойса в WHMCS
status	❌	string	Статус инвойса
invoiceid	❌	integer	Уникальный идентификатор созданного счета.
invoiceId	❌	integer	Уникальный идентификатор созданного счета.
userid	❌	integer	Идентификатор пользователя в системе биллинга.
userId	❌	integer	Идентификатор пользователя в системе биллинга.
serviceid	❌	integer	Идентификатор услуги, связанной со счетом.
domainstatus	❌	string	Текущий статус доменного имени или услуги.

Пример запроса

curl -s "https://invapi.hostkey.ru/whmcs_hooks.php" -X POST \
--data "action=whmcs_invoice_created" \
--data "location=VALUE" \
--data "invoice_id=VALUE"

Пример успешного ответа

{
"result": "OK",
"action": "invoice 123 creation proceeded: true"
}

Примеры ошибок

{
"code": -1,
"message": "Invalid billing location"
}