HTTP-уведомления
С помощью API вы можете создавать, редактировать и удалять HTTP-уведомления о событиях, происходящих с вашими письмами.

Получение списка HTTP-уведомлений

Отправьте GET запрос на URL http://api.mailhandler.ru/webhooks/. Запрос не должен содержать параметров.
В результате вы получите ответ в формате JSON со списком созданных вами HTTP-уведомлений.
Bash
Python
Пример получения списка объектов с помощью curl:
1
curl 'http://api.mailhandler.ru/webhooks/' \
2
-X GET \ -H 'Accept: application/json' \
3
-H 'Content-Type: application/json' \
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример получения списка объектов на python:
1
import requests
2
3
def get_list():
4
headers = {
5
'X-Secure-Token': '<YOUR_TOKEN>',
6
'Accept': 'application/json',
7
'Content-Type': 'application/json',
8
}
9
response = requests.get('http://api.mailhandler.ru/webhooks/',
10
json=data,
11
headers=headers)
12
print(response.status_code)
Copied!
В случае успешного выполнения запроса вы получите ответ в формате JSON со статусом 200 OK
1
{
2
"count": 1,
3
"next": null,
4
"previous": null,
5
"results": [
6
{
7
"id": 2,
8
"url": "http://google.com",
9
"type": "OPENED",
10
"is_auth_enabled": false,
11
"login": "",
12
"password": "",
13
"date_created": "2017-03-16T15:16:41.239464"
14
}
15
]
16
}
Copied!

Создание HTTP-уведомления

Отправьте POST запрос на URL http://api.mailhandler.ru/webhooks/. Запрос должен содержать следующие параметры:
Название
Описание
Обязателен
Пример
url
URL адрес, на который будет отправлено уведомление при срабатывании триггера
Да
http://google.com
type
Тип уведомления
Да. Может принимать значения: OPENED, UNSUBSCRIBED, REDIRECTED, HARDBOUNCED, SOFTBOUNCED
OPENED
is_auth_enabled
bool, использовать или нет HTTP-авторизацию, по умолчанию False
Нет
True
login
Имя пользователя для HTTP-авторизации
Нет
username
password
Пароль для HTTP-авторизации
Нет
secret
В результате успешного создания объекта вы получите ответ в формате JSON с данными созданного объекта.
Bash
Python
Пример создания объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/webhooks/' \
2
-X POST \ -H 'Accept: application/json' \
3
-H 'Content-Type: application/json' \
4
-H 'X-Secure-Token: <YOUR_TOKEN>' \
5
-d '{"url":"http://google.com", "type":"OPENED"}'
Copied!
Пример создания объекта на python:
1
import requests
2
3
def create():
4
headers = {
5
'X-Secure-Token': '<YOUR_TOKEN>',
6
'Accept': 'application/json',
7
'Content-Type': 'application/json',
8
}
9
data = {
10
'url': 'http://google.com',
11
'type': 'OPENED'
12
}
13
response = requests.post('http://api.mailhandler.ru/webhooks/',
14
json=data,
15
headers=headers)
16
print(response.status_code)
Copied!
В случае успешного создания объекта вы получите ответ в формате JSON со статусом 201 Created
1
{
2
"id": 2,
3
"url": "http://google.com",
4
"type": "OPENED",
5
"is_auth_enabled": false,
6
"login": "",
7
"password": "",
8
"date_created": "2017-03-16T15:16:41.239464"
9
}
Copied!

Редактирование HTTP-уведомления

Отправьте PUT или PATCH запрос на URL http://api.mailhandler.ru/webhooks/{hook_id}/, где hook_id - идентификатор нужного вам уведомления.
Запрос может содержать следующие параметры:
Название
Описание
Обязателен
Пример
url
URL адрес, на который будет отправлено уведомление при срабатывании триггера
Да
http://google.com
type
Тип уведомления
Да. Может принимать значения: OPENED, UNSUBSCRIBED, REDIRECTED, HARDBOUNCED, SOFTBOUNCED
OPENED
is_auth_enabled
bool, использовать или нет HTTP-авторизацию, по умолчанию False
Нет
True
login
Имя пользователя для HTTP-авторизации
Нет
username
password
Пароль для HTTP-авторизации
Нет
secret
В результате успешного создания объекта вы получите ответ в формате JSON с данными отредактированного объекта.
Bash
Python
Пример редактирования объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/webhooks/100/' \
2
-X PATCH \ -H 'Accept: application/json' \
3
-H 'Content-Type: application/json' \
4
-H 'X-Secure-Token: <YOUR_TOKEN>' \
5
-d '{"url":"https://mailhandler.ru"}'
Copied!
Пример редактирования объекта на python:
1
import requests
2
3
def edit():
4
headers = {
5
'X-Secure-Token': '<YOUR_TOKEN>',
6
'Accept': 'application/json',
7
'Content-Type': 'application/json',
8
}
9
data = {
10
'url': 'https://mailhandler.ru'
11
}
12
response = requests.patch('http://api.mailhandler.ru/webhooks/100/',
13
json=data,
14
headers=headers)
15
print(response.status_code)
Copied!
В случае успешного изменения объекта вы получите ответ в формате JSON со статусом 200 OK
1
{
2
"id": 100,
3
"url": "https://mailhandler.ru",
4
"type": "OPENED",
5
"is_auth_enabled": false,
6
"login": "",
7
"password": "",
8
"date_created": "2017-03-16T15:16:41.239464"
9
}
Copied!

Получение данных HTTP-уведомления

Отправьте GET запрос на URL http://api.mailhandler.ru/webhooks/{hook_id}/, где hook_id - идентификатор нужного вам HTTP-уведомления.
Запрос не должен содержать параметров.
В результате успешного запроса вы получите ответ в формате JSON с данными отредактированного объекта.
Bash
Python
Пример получения данных объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/webhooks/100' \
2
-X GET \ -H 'Accept: application/json' \
3
-H 'Content-Type: application/json' \
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример получения данных объекта на python:
1
import requests
2
3
def get():
4
headers = {
5
'X-Secure-Token': '<YOUR_TOKEN>',
6
'Accept': 'application/json',
7
'Content-Type': 'application/json',
8
}
9
response = requests.get('http://api.mailhandler.ru/webhooks/100/',
10
headers=headers)
11
print(response.status_code)
Copied!
В случае успешного получения данных объекта вы получите ответ в формате JSON со статусом 200 OK
1
{
2
"id": 100,
3
"url": "https://mailhandler.ru",
4
"type": "OPENED",
5
"is_auth_enabled": false,
6
"login": "",
7
"password": "",
8
"date_created": "2017-03-16T15:16:41.239464"
9
}
Copied!

Удаление HTTP-уведомления

Отправьте DELETE запрос на URL http://api.mailhandler.ru/webhooks/{hook_id}/, где hook_id - идентификатор нужного вам HTTP-уведомления.
Запрос не должен содержать параметров.
В результате успешного запроса вы получите ответ со статусом 204 No Content.
Bash
Python
Пример удаления объекта с помощью curl:
1
curl 'http://api.mailhandler.ru/webhooks/100' \
2
-X DELETE \ -H 'Accept: application/json' \
3
-H 'Content-Type: application/json' \
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример удаления объекта на python:
1
import requests
2
3
def delete():
4
headers = {
5
'X-Secure-Token': '<YOUR_TOKEN>',
6
'Accept': 'application/json',
7
'Content-Type': 'application/json',
8
}
9
response = requests.delete('http://api.mailhandler.ru/webhooks/100/',
10
headers=headers)
11
print(response.status_code)
Copied!

Тестирование HTTP-уведомления

Отправьте GET запрос на URL http://api.mailhandler.ru/webhooks/{hook_id}/run_test/, где hook_id - идентификатор нужного вам HTTP-уведомления.
Запрос не должен содержать параметров.
В результате успешного запроса мы отправим тестовое уведомление на url адрес выбранного вами HTTP-уведомления.
Bash
Python
Пример тестирования уведомления с помощью curl:
1
curl 'http://api.mailhandler.ru/webhooks/100/run_test/' \
2
-X GET \ -H 'Accept: application/json' \
3
-H 'Content-Type: application/json' \
4
-H 'X-Secure-Token: <YOUR_TOKEN>'
Copied!
Пример тестирования уведомления на python:
1
import requests
2
3
def delete():
4
headers = {
5
'X-Secure-Token': '<YOUR_TOKEN>',
6
'Accept': 'application/json',
7
'Content-Type': 'application/json',
8
}
9
response = requests.get('http://api.mailhandler.ru/webhooks/100/run_test/',
10
headers=headers)
11
print(response.status_code)
Copied!
Last modified 2yr ago