Перейти к содержимому

Отправка формы POST ​

Отправляет ответ. Отправка становится сообщением в аккаунте владельца и доставляется на его телефон push-уведомлением — тем же путём, что и вызов вебхука. Аутентификация не нужна.

Эндпоинт ​

POST https://api.pocketalert.app/v1/forms/{tid}/submit

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

Не требуется

Отправить может любой, у кого есть ссылка. Владелец сам задаёт, кто может отправлять: см. разрешённые источники и лимиты ниже.

Запрос ​

Параметры пути ​

ПараметрТипОбязательныйОписание
tidstring✅Идентификатор формы

Параметры тела запроса ​

ПараметрТипОбязательныйОписание
valuesobject✅Ответы, где ключ — id поля
websitestring❌Honeypot. Не передавайте его; любое непустое значение считается ботом

Значение для каждого типа поля:

ТипЗначение
text, textarea, email, phone, number, urlСтрока. Формат проверяется для email, телефона, числа и URL
dateСтрока, YYYY-MM-DD
dropdown, radioСтрока, одно из значений options поля
checkboxesМассив строк из options
checkboxBoolean
ratingЧисло, 1–5
npsЧисло, 0–10
hiddenСтрока, обычно берётся из URL страницы

Поля оформления (heading, paragraph, divider) значения не принимают, а неизвестные ключи игнорируются. Размер тела запроса ограничен 64 КБ.

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

bash
curl -X POST "https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9/submit" \
  -H "Content-Type: application/json" \
  -d '{
    "values": {
      "name": "Jane Doe",
      "email": "[email protected]",
      "message": "Do you ship to Canada?",
      "src": "newsletter"
    }
  }'
javascript
const response = await fetch(
  'https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9/submit',
  {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      values: {
        name: 'Jane Doe',
        email: '[email protected]',
        message: 'Do you ship to Canada?'
      }
    })
  }
);

const result = await response.json();
if (response.status === 400) {
  // result.fields = { email: "Enter a valid email address" }
  console.log(result.fields);
}
python
import requests

response = requests.post(
    'https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9/submit',
    json={
        'values': {
            'name': 'Jane Doe',
            'email': '[email protected]',
            'message': 'Do you ship to Canada?',
        }
    }
)

print(response.status_code, response.json())

Ответ ​

Успешный ответ ​

200 OK

json
{ "status": "ok" }

Владелец получает push-уведомление, составленное из ответов. Информация о владельце — его тариф, устройства, квоты — посетителю не раскрывается.

Ошибки валидации ​

400 Bad Request

fields сопоставляет id поля с причиной отклонения; именно это страница формы выводит под каждым полем.

json
{
  "error": "Please check the highlighted fields.",
  "fields": {
    "email": "Enter a valid email address",
    "name": "This field is required"
  }
}

Закрытая форма ​

410 Gone

json
{
  "error": "This form is no longer accepting responses.",
  "closed": true
}

В error передаётся собственное сообщение владельца closed_message.

Лимиты ​

ЛимитЗначение
С одного IP10 отправок в минуту
На форму60 в минуту, 300 в час
Квота владельцаКаждая отправка расходует одно сообщение из его дневного лимита

Отправка, которая превысила бы дневной лимит сообщений владельца, получает нейтральный ответ 429 с заголовком Retry-After без упоминания тарифа.

Ответы с ошибками ​

СтатусОписание
400Некорректное тело запроса или fields перечисляет ответы, которые нужно исправить
403Форма не принимает отправки с этого сайта — см. разрешённые источники
404Форма не найдена
410Форма закрыта
429Слишком много отправок или у владельца закончились сообщения на сегодня
500Форма настроена неправильно или не удалось создать сообщение

Документация Pocket Alert