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

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

Базовый URL: http://api.mailhandler.ru/webhooks/

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

Отправьте GET запрос на URL http://api.mailhandler.ru/webhooks/. Запрос не должен содержать параметров.

В результате вы получите ответ в формате JSON со списком созданных вами HTTP-уведомлений.

Пример получения списка объектов с помощью curl:

curl 'http://api.mailhandler.ru/webhooks/' \ 
-X GET \ -H 'Accept: application/json' \ 
-H 'Content-Type: application/json' \ 
-H 'X-Secure-Token: <YOUR_TOKEN>'

Пример получения списка объектов на python:

import requests 

def get_list():     
    headers = {         
        'X-Secure-Token': '<YOUR_TOKEN>',         
        'Accept': 'application/json',         
        'Content-Type': 'application/json',     
    }      
    response = requests.get('http://api.mailhandler.ru/webhooks/',                              
                  json=data, 
                  headers=headers)     
    print(response.status_code)

В случае успешного выполнения запроса вы получите ответ в формате JSON со статусом 200 OK

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 2,
      "url": "http://google.com",
      "type": "OPENED",
      "is_auth_enabled": false,
      "login": "",
      "password": "",
      "date_created": "2017-03-16T15:16:41.239464"
    }
  ]
}

Создание 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 с данными созданного объекта.

Пример создания объекта с помощью curl:

curl 'http://api.mailhandler.ru/webhooks/' \ 
-X POST \ -H 'Accept: application/json' \ 
-H 'Content-Type: application/json' \ 
-H 'X-Secure-Token: <YOUR_TOKEN>' \ 
-d '{"url":"http://google.com", "type":"OPENED"}'

Пример создания объекта на python:

import requests 

def create():     
    headers = {         
        'X-Secure-Token': '<YOUR_TOKEN>',         
        'Accept': 'application/json',         
        'Content-Type': 'application/json',     
    }     
    data = {         
        'url': 'http://google.com',         
        'type': 'OPENED'
    }     
    response = requests.post('http://api.mailhandler.ru/webhooks/',                              
                  json=data, 
                  headers=headers)     
    print(response.status_code)

В случае успешного создания объекта вы получите ответ в формате JSON со статусом 201 Created

{
      "id": 2,
      "url": "http://google.com",
      "type": "OPENED",
      "is_auth_enabled": false,
      "login": "",
      "password": "",
      "date_created": "2017-03-16T15:16:41.239464"
}

Редактирование 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 с данными отредактированного объекта.

Пример редактирования объекта с помощью curl:

curl 'http://api.mailhandler.ru/webhooks/100/' \ 
-X PATCH \ -H 'Accept: application/json' \ 
-H 'Content-Type: application/json' \ 
-H 'X-Secure-Token: <YOUR_TOKEN>' \ 
-d '{"url":"https://mailhandler.ru"}'

Пример редактирования объекта на python:

import requests 

def edit():     
    headers = {         
        'X-Secure-Token': '<YOUR_TOKEN>',         
        'Accept': 'application/json',         
        'Content-Type': 'application/json',     
    }     
    data = {         
        'url': 'https://mailhandler.ru'
    }     
    response = requests.patch('http://api.mailhandler.ru/webhooks/100/',                              
                  json=data, 
                  headers=headers)     
    print(response.status_code)

В случае успешного изменения объекта вы получите ответ в формате JSON со статусом 200 OK

{
      "id": 100,
      "url": "https://mailhandler.ru",
      "type": "OPENED",
      "is_auth_enabled": false,
      "login": "",
      "password": "",
      "date_created": "2017-03-16T15:16:41.239464"
}

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

Отправьте GET запрос на URL http://api.mailhandler.ru/webhooks/{hook_id}/, где hook_id - идентификатор нужного вам HTTP-уведомления.

Запрос не должен содержать параметров.

В результате успешного запроса вы получите ответ в формате JSON с данными отредактированного объекта.

Пример получения данных объекта с помощью curl:

curl 'http://api.mailhandler.ru/webhooks/100' \ 
-X GET \ -H 'Accept: application/json' \ 
-H 'Content-Type: application/json' \ 
-H 'X-Secure-Token: <YOUR_TOKEN>'

Пример получения данных объекта на python:

import requests 

def get():     
    headers = {         
        'X-Secure-Token': '<YOUR_TOKEN>',         
        'Accept': 'application/json',         
        'Content-Type': 'application/json',     
    }     
    response = requests.get('http://api.mailhandler.ru/webhooks/100/',
                  headers=headers)     
    print(response.status_code)

В случае успешного получения данных объекта вы получите ответ в формате JSON со статусом 200 OK

{
      "id": 100,
      "url": "https://mailhandler.ru",
      "type": "OPENED",
      "is_auth_enabled": false,
      "login": "",
      "password": "",
      "date_created": "2017-03-16T15:16:41.239464"
}

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

Отправьте DELETE запрос на URL http://api.mailhandler.ru/webhooks/{hook_id}/, где hook_id - идентификатор нужного вам HTTP-уведомления.

Запрос не должен содержать параметров.

В результате успешного запроса вы получите ответ со статусом 204 No Content.

Пример удаления объекта с помощью curl:

curl 'http://api.mailhandler.ru/webhooks/100' \ 
-X DELETE \ -H 'Accept: application/json' \ 
-H 'Content-Type: application/json' \ 
-H 'X-Secure-Token: <YOUR_TOKEN>'

Пример удаления объекта на python:

import requests 

def delete():     
    headers = {         
        'X-Secure-Token': '<YOUR_TOKEN>',         
        'Accept': 'application/json',         
        'Content-Type': 'application/json',     
    }     
    response = requests.delete('http://api.mailhandler.ru/webhooks/100/',
                  headers=headers)     
    print(response.status_code)

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

Отправьте GET запрос на URL http://api.mailhandler.ru/webhooks/{hook_id}/run_test/, где hook_id - идентификатор нужного вам HTTP-уведомления.

Запрос не должен содержать параметров.

В результате успешного запроса мы отправим тестовое уведомление на url адрес выбранного вами HTTP-уведомления.

Пример тестирования уведомления с помощью curl:

curl 'http://api.mailhandler.ru/webhooks/100/run_test/' \ 
-X GET \ -H 'Accept: application/json' \ 
-H 'Content-Type: application/json' \ 
-H 'X-Secure-Token: <YOUR_TOKEN>'

Пример тестирования уведомления на python:

import requests 

def delete():     
    headers = {         
        'X-Secure-Token': '<YOUR_TOKEN>',         
        'Accept': 'application/json',         
        'Content-Type': 'application/json',     
    }     
    response = requests.get('http://api.mailhandler.ru/webhooks/100/run_test/',
                  headers=headers)     
    print(response.status_code)

results matching ""

    No results matching ""