scheduled.
Для отримання деталей див. огляд webhook.
Після реєстрації URL webhook, Ви будете отримувати POST-запит на Ваш URL при виникненні події.
POST-запит буде містити JSON-payload з деталями події.
Scheduled Action
Ви отримаєте це сповіщення webhook, коли запланований допис буде оброблено — незалежно від того, чи вдалося йому, чи він зазнав невдачі — та опубліковано у вибрані соціальні мережі. Наприклад, якщо Ви заплануєте допис на 12:00 1 серпня 2026 року, webhook буде надіслано точно в момент публікації допису. Сповіщення webhook надсилаються лише для дописів, запланованих на майбутнє за допомогою поляscheduleDate у кінцевій точці /post.
Подія Scheduled
Ви не отримаєте сповіщення webhook для негайних дописів, оскільки API повертає відповідь про успіх чи невдачу миттєво в JSON-відповіді.
Сповіщення webhook надсилаються лише для запланованих дописів, оскільки вони обробляються асинхронно і вимагають окремого сповіщення, щоб повідомити Вас про їх статус.
Webhook публікації TikTok
При роботі з TikTok через Ayrshare Ви можете отримати два різних webhook для запланованого допису. Якщо Ваш допис було заплановано, а не опубліковано негайно, Ви спочатку отримаєте стандартний webhook Scheduled Action. Це означає, що медіа успішно надіслано в TikTok для обробки та публікації. Після цього Ви отримаєте webhooksubAction: tikTokPublished.
Це активується, як тільки TikTok завершить обробку медіа та зробить його публічним.
Цей webhook активується як для негайних, так і для запланованих дописів.
У панелі керування Ayrshare ця подія позначена як tikTok (pub).
Social Action
Сповіщення, коли профіль користувача зв’язує або від’єднує соціальну мережу.Подія Social Action
account надсилається, коли Ayrshare має ідентифікаційні дані на рівні акаунта для підключеної платформи (наразі лише YouTube), і включається як у дії link, так і в дії unlink. Кожен ключ усередині account необов’язковий (канал YouTube без власної URL-адреси не має handle). Якщо ідентифікаційних даних немає, ключ account повністю пропускається, а не надсилається порожнім, тому перевіряйте наявність ключа перед його використанням.
Зверніть увагу, що account.title — це власна назва соціального акаунта, наприклад назва каналу YouTube, тоді як title верхнього рівня — це назва Вашого профілю користувача Ayrshare. Це різні значення.
source system означає, що Ayrshare автоматично від’єднав обліковий запис, наприклад коли з’єднання з соціальною мережею більше недійсне. Ми рекомендуємо повідомити Вашого користувача, щоб він міг продовжувати публікувати. Деталі від’єднання знаходяться в полі details. Електронний лист також буде надіслано на електронну адресу Primary Account, або на альтернативні електронні адреси, якщо їх було налаштовано.
source user означає, що користувач ініціював дію самостійно, наприклад, вручну від’єднав обліковий запис. Електронний лист не буде надіслано, коли відбувається дія, ініційована користувачем.
Messages Action
Для доступу до всіх кінцевих точок повідомлень і webhook потрібне доповнення Messaging. Для Facebook та Instagram отримуйте сповіщення, коли надходить пряме повідомлення, воно прочитане, або створена/видалена реакція. WhatsApp наразі надсилає сповіщення на ваш зареєстрований URL webhook лише коли зберігається нове вхідне повідомлення. Webhook X/Twitter доступні як опція для клієнтів Enterprise. Для отримання додаткової інформації про перехід на Enterprise зв’яжіться зі своїм представником облікового запису. WhatsApp сьогодні не надсилає webhook реакцій або статусу доставки на ваш зареєстрований URL. Збережені вихідні повідомлення можуть мати значенняstatus — sent, delivered, read або
failed — див. WhatsApp Message Status нижче.
Standby покриття для Facebook Pages з кількома додатками
Ayrshare підписується на поле webhookstandby Facebook на додаток до стандартних полів обміну повідомленнями. Це означає, що події Messenger доставляються до Вашого webhook навіть коли інший додаток на тій самій Facebook Page наразі утримує контроль потоку — наприклад, коли платформа чатботів встановлена як Ваш основний одержувач Page, або коли Meta Page Inbox активно обробляє розмову.
Для цих подій немає змін у схемі. Вони надходять як ті самі payload’и messageCreated / messageRead / reactionCreated / messageEdited, задокументовані в розділах нижче. Дві речі, про які слід знати для Pages з встановленим конкуруючим додатком Messenger:
- Обсяг вхідних повідомлень може збільшитися порівняно з попередньою поведінкою, коли події standby мовчазно відкидалися до підписки на них. Новий трафік представляє повідомлення, які Ваша Page отримувала і які обробляв інший додаток.
- Ви можете отримувати події
messageCreatedзtype: "sent", які не відповідають повідомленням, надісланим через Ayrshare. Це відлуння повідомлень, надісланих іншим додатком Messenger на Вашій Page (Meta доставляє копію кожного надсилання кожному підписаному додатку). Якщо Ваша інтеграція узгоджує вихідний трафік з Вашою власною історією надсилань, Ви можете використовувати цю історію, щоб відрізнити Ваші надсилання від надсилань конкуруючого додатка.
Події New Message
Сповіщення, коли надсилається або отримується нове повідомлення.conversationId та senderId — це номер телефону кореспондента у форматі E.164,
лише цифри. recipientId — це ID номера телефону вашого підключеного облікового запису WhatsApp у Meta.
timeStamp присутнє, коли увімкнено Webhook Security.
У кожній мережі повідомлення, яке містить медіа, несе його в attachments, як показано в прикладі
WhatsApp вище — включно з Facebook та Instagram. Типи вкладень можуть бути image, video, audio,
document або sticker. Webhook повідомлень ніколи не несуть mediaUrls — це поле належить до
payload’ів після доставки, таких як Scheduled Action, де воно повідомляє про
медіа, які Ви надіслали.
Подія Message Read
Сповіщення, коли повідомлення прочитане одержувачем.mid, яке однозначно ідентифікує, яке конкретне повідомлення було прочитано.
Для повідомлень Facebook прочитання повідомлень відстежується на рівні розмови за допомогою conversationId.
Коли відбувається подія прочитання, всі повідомлення в цій розмові з timestamps до created (або read) timestamp слід вважати прочитаними користувачем.
Події Reaction Created і Deleted
Сповіщення, коли реакція, наприклад like, створена або видалена на повідомленні.Подія Message Edit
Сповіщення, коли користувач редагує повідомлення, яке раніше надсилав. Доступно для прямих повідомлень Facebook та Instagram. ПолеmessageEdit.mid збігається з id оригінальної події messageCreated, тому споживачі можуть корелювати редагування з оригінальним повідомленням. Поле messageEdit.text містить новий, відредагований текст повідомлення.
WhatsApp Message Status
WhatsApp відстежує стан доставки для кожного повідомлення на збережених вихідних повідомленнях за допомогою одного поляstatus: sent, delivered, read або failed. Ці оновлення наразі не
доставляються на ваш зареєстрований URL webhook як окремі події. Якщо вам потрібен стан доставки
в реальному часі, зверніться до вашого представника з облікового запису Ayrshare.
Batch Action
Сповіщення, коли пакет завершив обробку і файл доступний, наприклад get all user profiles. Ви можете отримати доступ до файлу за попередньо підписаним URL у поліurl.
Подія Batch
Feed Action
Сповіщення, коли знайдено новий елемент RSS-стрічки для зареєстрованих RSS-стрічок. Примітка: якщо Webhook активний, нові елементи RSS не публікуватимуться автоматично у соціальних мережах.Подія Feed
Mentions Action
Сповіщення, коли Ваш під’єднаний обліковий запис згадується. Доступно для Instagram.Для Instagram достатньо зареєструвати webhook
mentions, щоб отримувати події згадувань. Доповнення Messaging, увімкнення месенджингу та повторне під’єднання соціального облікового запису не потрібні.action, refId, hookId, url та timeStamp з Webhook Security), subAction, platform та postId. Приклад нижче — форма Instagram: media_id, плюс comment_id, коли згадування в коментарі. Події згадок на сторінках Facebook наразі не доставляються — Ayrshare підтверджує їх отримання від Meta й не пересилає на ваш webhook. Сьогодні доставляються лише згадки Instagram, тож platform у цій дії завжди дорівнює instagram.
postId підпорядковується тому самому правилу, що й у Comments Action, і у згадуваннях він зазвичай відсутній: згадування, як правило, стається на чужому дописі, який не має id Ayrshare. Він з’являється лише тоді, коли згадування стосується допису, який Ви опублікували через Ayrshare.
Подія Mention (Instagram)
Comments Action
Сповіщення, коли створено коментар на Вашому під’єднаному контенті. Доступно для Facebook та Instagram.Для Instagram достатньо зареєструвати webhook
comments, щоб отримувати події коментарів. Доповнення Messaging, увімкнення месенджингу та повторне під’єднання соціального облікового запису не потрібні. Для Facebook події коментарів доставляються лише поки на профілі увімкнено месенджинг (доповнення Messaging) — самої реєстрації webhook comments недостатньо. Повторне під’єднання сторінки Facebook не потрібне.action, refId, hookId, url та timeStamp з Webhook Security), subAction, platform та postId. Приклад нижче — форма Instagram. Коментарі Facebook надходять як зміна feed на Page з різними назвами полів (наприклад comment_id, post_id, message та from.name); зверніться до довідки webhook Meta для набору полів Facebook. Оскільки обидві мережі доставляють на той самий endpoint comments, розгалужуйте за platform — instagram або facebook — замість того, щоб визначати мережу за наявними назвами полів.
Зіставлення коментаря з дописом, який Ви створили
postId — це id Ayrshare допису, під яким залишено коментар, — той самий id, який повернув Post, коли Ви його створили, і той, який приймають Get Post та Аналітика публікацій. Він існує для того, щоб Ви могли зіставити коментар із власним дописом, не ведучи власної таблиці відповідності нативних id.
Він надається за можливості й пропускається, коли його неможливо визначити. Трактуйте відсутній postId як «цей коментар не під дописом, який я опублікував», а не як помилку. Він відсутній, коли:
- Допис не було опубліковано через Ayrshare. Події коментарів спрацьовують для всього на Вашому під’єднаному обліковому записі, включно з дописами, створеними безпосередньо в додатку Instagram чи Facebook. Такі дописи взагалі не мають id Ayrshare — його нізвідки взяти.
- Допис було опубліковано до появи цього поля. Дані для зіставлення записуються в момент публікації й заднім числом не додаються, тож коментарі під Вашими старішими дописами не міститимуть
postId. - Допис було опубліковано іншим User Profile. До однієї й тієї самої Page чи облікового запису Instagram може бути під’єднано кілька профілів, і всі вони отримують подію коментаря, але лише профіль, який фактично опублікував допис, знає його id.
postId — це id допису Ayrshare, а не соціальної мережі. Власний id мережі для того самого допису залишається там, де й був завжди — media.id в Instagram, post_id у Facebook.
Подія Comment (Instagram)
Automations Action
Сповіщення, коли автоматизація активує webhook-дію для користувача, наприклад тригер автовідповіді на коментар або DM. На діїautomations надсилаються два типи подій, які розрізняються полем type. Див. webhook-події для повного довідника полів.
Подія Automation Triggered
Подія Automation Completed
Demo Action
Сповіщення про події життєвого циклу Demo User Profile. Demo User Profiles доступні на Enterprise plan; будь ласка, зв’яжіться з нами, якщо хочете дізнатися більше. На діюdemo надсилаються два типи подій, які розрізняються за полем type:
upgradeWarning— надсилається за два дні до того, як Demo User Profile автоматично перетвориться на стандартний User Profile, щоб ви могли запропонувати користувачу продовжити або видалити профіль.upgrade— надсилається, коли відбувається конвертація.
Подія Demo Upgrade Warning
Подія Demo Upgrade
Suspended Action
Сповіщення, коли User Profile призупинено або повторно активовано. Призупинення можуть надходити від власного контролю соціальної мережі (наприклад, вимога перевірки особи від Facebook), від захисту від перевищення rate limit або через проблеми з оплатою. Поки профіль призупинено, API-виклики для цього профілю повертають HTTP 403. На діюsuspended надсилаються два типи подій, які розрізняються за полем type:
suspend— надсилається, коли профіль призупинено. Призупиніть публікацію та іншу активність для цього профілю, доки його не буде повторно активовано.unsuspend— надсилається, коли профіль повторно активовано.
unsuspend, коли зникне остання причина. Щоб у будь-який момент перевірити поточний стан призупинення, скористайтеся Get Profiles з include=suspension.
Призупиненню, ініційованому платформою, зазвичай передує подія unlink Social Action для відповідної мережі. Призупинення можна вирішити лише в джерелі — наприклад, перевірку особи Facebook має завершити адміністратор Page у застосунку Facebook — після чого профіль можна повторно активувати, а мережу знову прив’язати.
Подія Suspend
Подія Unsuspend
Події призупинення надсилаються для профілю, стан якого змінився. Ви також можете перевірити стан призупинення на запит за допомогою Get Profiles, використовуючи
include=suspension, що повертає isSuspended, reason, suspendedAt, unsuspendAt та suspensionCount.