Новые конечные точки API: Контакты, События и Вебхуки
Мы только что выпустили три новые группы ресурсов в Emailit API v2: Контакты, События и Вебхуки. Вместе они дают вам полный программный контроль над адресной книгой, мониторингом событий и интеграциями вебхуков.
Контакты
API контактов позволяет создавать, читать, обновлять и удалять контакты в вашем рабочем пространстве. Каждый контакт содержит email-адрес, необязательное имя и пользовательские поля, а также может быть подписан на одну или несколько аудиторий за один вызов.
| Эндпоинт | Описание |
|---|---|
| Список контактов | Постраничный список всех контактов |
| Получить контакт | Получить контакт по ID или email |
| Создать контакт | Создать новый контакт и подписать на аудитории |
| Обновить контакт | Обновить имя, email, пользовательские поля или статус подписки |
| Удалить контакт | Удалить контакт и всех связанных подписчиков |
Контакты можно найти по их ID (con_xxx) или по email-адресу — используйте тот идентификатор, который удобнее.
{
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"custom_fields": { "company": "Acme" },
"audiences": ["aud_2BxFg7KNqr5M..."]
}
События
События создаются автоматически при любых изменениях в вашем рабочем пространстве. Например, когда доставляется письмо, создается контакт, обновляется домен и так далее. API событий предоставляет доступ только для чтения к этому потоку активности.
| Эндпоинт | Описание |
|---|---|
| Список событий | Постраничный список с фильтрацией по типу и опциональными данными |
| Получить событие | Получить одно событие с полными данными |
Вы можете фильтровать по одному или нескольким типам событий, используя значения через запятую, и переключать include_data для управления возвратом полных данных в списочных ответах.
GET /v2/events?type=email.accepted,email.delivered&include_data=true
Вебхуки
Вебхуки позволяют получать HTTP-уведомления в реальном времени при возникновении событий. Новый API вебхуков дает полный контроль. Вы можете создавать, обновлять, включать/отключать и удалять эндпоинты вебхуков — всё через API.
| Эндпоинт | Описание |
|---|---|
| Список вебхуков | Постраничный список всех вебхуков |
| Получить вебхук | Получить вебхук по ID |
| Создать вебхук | Создать новый эндпоинт вебхука |
| Обновить вебхук | Обновить URL, события или статус активности |
| Удалить вебхук | Удалить вебхук по ID или имени |
Вы можете подписаться на определенные типы событий или использовать all_events для получения всех уведомлений.
{
"name": "Production Webhook",
"url": "https://example.com/webhook",
"events": ["email.accepted", "email.delivered", "email.bounced"]
}
Доступно более 30 типов событий для писем, доменов, аудиторий, подписчиков, контактов, шаблонов, подавлений и проверки email-адресов. Полный список смотрите в документации Создать вебхук.
Начало работы
Все три API требуют API-ключ с полными правами доступа. Перейдите в Справочник API, чтобы изучить все новые эндпоинты, или сразу переходите к документации по ссылкам выше.
Блог
Последние новости и обновления напрямую от Emailit.
Будьте в курсе последних статей из блога Emailit.
