Нові API ендпоінти: Контакти, Події та Вебхуки
Ми щойно випустили три нові групи ресурсів в Emailit API v2. Це Контакти, Події та Вебхуки. Разом вони надають вам повний програмний контроль над вашою адресною книгою, моніторинг подій та інтеграції вебхуків.
Контакти
API контактів дозволяє створювати, читати, оновлювати та видаляти контакти у вашому робочому просторі. Кожен контакт містить електронну адресу, необов’язкове ім’я та користувацькі поля, і може бути підписаний на одну або кілька аудиторій за один виклик.
| Ендпоінт | Опис |
|---|---|
| Список контактів | Посторінковий список усіх контактів |
| Отримати контакт | Отримати контакт за ID або електронною поштою |
| Створити контакт | Створити новий контакт і підписати на аудиторії |
| Оновити контакт | Оновити ім’я, пошту, користувацькі поля або статус підписки |
| Видалити контакт | Видалити контакт та всіх пов’язаних підписників |
Контакти можна знаходити за їх ID (con_xxx) або за електронною адресою, тому ви можете використовувати той ідентифікатор, який вам зручніший.
{
"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 типів подій для електронних листів, доменів, аудиторій, підписників, контактів, шаблонів, придушень та верифікації електронної пошти. Дивіться повний список у документації Створити вебхук.
Почніть роботу
Усі три API потребують API-ключ з повними дозволами. Перейдіть до Довідника API, щоб дослідити всі нові ендпоінти, або одразу переходьте до документації за посиланнями вище.
Блог
Останні новини та оновлення прямо від Emailit.
Будьте в курсі останніх статей з блогу Emailit.