Дії Webhook

Доступно кілька типів webhook, класифікованих за типом дії. Наприклад, запланований допис активує webhook дії scheduled. Для отримання деталей див. огляд webhook. Після реєстрації URL webhook, Ви будете отримувати POST-запит на Ваш URL при виникненні події. POST-запит буде містити JSON-payload з деталями події.

Scheduled Action

Ви отримаєте це сповіщення webhook, коли запланований допис буде оброблено — незалежно від того, чи вдалося йому, чи він зазнав невдачі — та опубліковано у вибрані соціальні мережі. Наприклад, якщо Ви заплануєте допис на 12:00 1 серпня 2026 року, webhook буде надіслано точно в момент публікації допису. Сповіщення webhook надсилаються лише для дописів, запланованих на майбутнє за допомогою поля scheduleDate у кінцевій точці /post.

Подія Scheduled

{
  "action": "scheduled", // Виконана дія
  "subAction": "tikTokPublished", // Присутнє лише коли публікація відео TikTok завершена
  "created": "2023-01-05T01:18:47Z",
  "code": 200, // HTTP код відповіді
  "refId": "140b8700bd6ade089b242d845e268fb886130c53", // User Reference ID
  "status": "success", // success або error
  "id": "TBAAAqAMMpoweA9wKHUp", // Ayrshare id допису
  "errors": [], // Список помилок, якщо виникли
  "postIds": [
    // Статус індивідуальних успішних дописів
    {
      "postUrl": "https://www.facebook.com/102775127855689_361718068618052",
      "platform": "facebook",
      "status": "success",
      "id": "102775127855689_361718068618052"
    }
  ],
  "url": "https://mysite.com/webhook" // Ваш URL webhook
}

Ви не отримаєте сповіщення webhook для негайних дописів, оскільки API повертає відповідь про успіх чи невдачу миттєво в JSON-відповіді. Сповіщення webhook надсилаються лише для запланованих дописів, оскільки вони обробляються асинхронно і вимагають окремого сповіщення, щоб повідомити Вас про їх статус.

Webhook публікації TikTok

При роботі з TikTok через Ayrshare Ви можете отримати два різних webhook для запланованого допису. Якщо Ваш допис було заплановано, а не опубліковано негайно, Ви спочатку отримаєте стандартний webhook Scheduled Action. Це означає, що медіа успішно надіслано в TikTok для обробки та публікації. Після цього Ви отримаєте webhook subAction: tikTokPublished. Це активується, як тільки TikTok завершить обробку медіа та зробить його публічним. Цей webhook активується як для негайних, так і для запланованих дописів. У панелі керування Ayrshare ця подія позначена як tikTok (pub).

Webhook tikTokPublished не надсилається, поки медіа не зроблено публічним. Якщо медіа встановлено як приватне, для followers або friends, webhook не буде надіслано.Якщо Ви не отримали webhook tikTokPublished, а статус допису залишається pending, перевірте мобільний додаток TikTok, щоб переконатися, що медіа прийнято TikTok.

Сповіщення, коли профіль користувача зв’язує або від’єднує соціальну мережу.

{
  "action": "social", // Виконана дія
  "created": "2023-01-05T01:18:47Z",
  "code": 200, // HTTP код відповіді
  "details": {
    // Опціонально: якщо деталі доступні
    "status": "error",
    "code": 349,
    "message": "Account locked"
  },
  "displayName": "Instagram Title", // Якщо ім'я облікового запису користувача присутнє в соціальній мережі
  "hookId": "TKLc30192HLGw5UeJ46",
  "platform": "instagram", // Соціальна платформа, де відбулася дія
  "refId": "140b8700bd6ade089b242d845e268fb886130c53", // User Reference ID
  "refreshBy": "2022-11-05T12:21:29Z", // Опціонально: якщо тип - refresh, дата, до якої необхідно оновити авторизацію соціальної мережі на сторінці зв'язування
  "source": "system", // Ініційовано "system" або "user".
  "title": "User Profile Name", // Назва облікового запису user profile
  "type": "link", // Тип дії: link, unlink або refresh
  "url": "https://mysite.com/webhook" // Ваш URL webhook
}

source system означає, що Ayrshare автоматично від’єднав обліковий запис, наприклад коли з’єднання з соціальною мережею більше недійсне. Ми рекомендуємо повідомити Вашого користувача, щоб він міг продовжувати публікувати. Деталі від’єднання знаходяться в полі details. Електронний лист також буде надіслано на електронну адресу Primary Account, або на альтернативні електронні адреси, якщо їх було налаштовано. source user означає, що користувач ініціював дію самостійно, наприклад, вручну від’єднав обліковий запис. Електронний лист не буде надіслано, коли відбувається дія, ініційована користувачем.

Messages Action

Для доступу до всіх кінцевих точок повідомлень і webhook потрібне доповнення Messaging. Сповіщення, коли надходить нове пряме повідомлення, воно прочитане користувачем, або створена/видалена реакція на повідомлення для Facebook та Instagram. Webhook X/Twitter доступні як опція для клієнтів Enterprise. Для отримання додаткової інформації про перехід на Enterprise зв’яжіться зі своїм представником облікового запису.

Standby покриття для Facebook Pages з кількома додатками

Ayrshare підписується на поле webhook standby 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 доставляє копію кожного надсилання кожному підписаному додатку). Якщо Ваша інтеграція узгоджує вихідний трафік з Вашою власною історією надсилань, Ви можете використовувати цю історію, щоб відрізнити Ваші надсилання від надсилань конкуруючого додатка.

Для Pages лише з встановленим Ayrshare (без конкуруючого додатка Messenger) єдиною спостережуваною зміною є нова подія Message Edit — все інше виглядає ідентично попередній поведінці.

Події New Message

Сповіщення, коли надсилається або отримується нове повідомлення.

{
  "action": "messages",
  "conversationId": "t_10161117434308936",
  "created": "2024-06-07T11:58:44Z",
  "hookId": "JC6IgqFjvDliTJ8MLqzE",
  "id": "m_aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDUyMjEyNzA",
  "mediaUrls": [],
  "message": "This is an amazing message",
  "platform": "facebook",
  "recipientId": "7270633706358444",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",
  "scheduleDate": "2024-06-07T11:58:44Z",
  "senderDetails": {
    // recipientDetails, якщо тип - sent
    "id": "7270633706358444",
    "picture": "https://scontent-ord5-2.cdninstagram.com/v/t51.jpg",
    "username": "SweetMessage",
    "name": "Sweet"
  },
  "senderId": "17841452212707444",
  "subAction": "messageCreated",
  "timeStamp": 1735189325, // Присутнє, якщо увімкнено Webhook Security
  "title": "Primary Profile",
  "type": "received", // received, sent або deleted
  "url": "https://mysite.com/webhook" // Ваш URL webhook
}

{
  "action": "messages",
  "conversationId": "aWdfZAG06MTpJR01lc3NhZA2VUaHJlYWQ6MTc4",
  "created": "2024-06-07T11:58:44Z",
  "hookId": "JC6IgqFjvDliTJ8MLqzE",
  "id": "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDUyMjEyNzA",
  "mediaUrls": [],
  "message": "This is an amazing message",
  "platform": "instagram",
  "recipientId": "7270633706358444",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",
  "scheduleDate": "2024-06-07T11:58:44Z",
  "senderDetails": {
    // recipientDetails, якщо тип - sent
    "id": "7270633706358444",
    "picture": "https://scontent-ord5-2.cdninstagram.com/v/t51.jpg",
    "username": "SweetMessage",
    "name": "Sweet"
  },
  "senderId": "17841452212707444",
  "subAction": "messageCreated",
  "timeStamp": 1735189325, // Присутнє, якщо увімкнено Webhook Security
  "title": "Primary Profile",
  "type": "received", // received, sent або deleted
  "url": "https://mysite.com/webhook" // Ваш URL webhook
}

Подія Message Read

Сповіщення, коли повідомлення прочитане одержувачем.

{
  "action": "messages",
  "conversationId": "t_10161117434308936",
  "created": "2024-06-08T23:33:30Z",
  "hookId": "CviPBMXEy3cdJnK0EESd",
  "platform": "facebook",
  "read": 1717889607802,  // UNIX timestamp прочитання повідомлення
  "readerDetails": {
    "name": "John Smith",
    "id": "7101149746568444",
    "picture": "https://platform-lookaside.fbsbx.com/platform/profilepic"
  },
  "recipientId": "106638148652329",
  "refId": "9abf1426d6ce9122ef11c8932",
  "scheduleDate": "2024-06-08T23:33:30Z",
  "senderId": "7101149746568522",
  "subAction": "messageRead",
  "timeStamp": 1717889610, // Присутнє, якщо увімкнено Webhook Security
  "title": "Primary Profile",
  "type": "read",
  "url": "https://mysite.com/webhook" // Ваш URL webhook
}

{
  "action": "messages",
  "conversationId": "t_10161117434308938",
  "created": "2024-06-08T23:33:30Z",
  "hookId": "CviPBMXEy3cdJnK0EESd",
  "platform": "instagram",
  "read": {
    "mid": "aWdfZAG1faXRlbToxOkl" // Instagram message ID
  },
  "readerDetails": {
    "name": "John Smith",
    "id": "7101149746568444",
    "picture": "https://platform-lookaside.fbsbx.com/platform/profilepic",
    "username": "johnsmith"
  },
  "recipientId": "106638148652329",
  "refId": "9abf1426d6ce9122ef11c8932",
  "scheduleDate": "2024-06-08T23:33:30Z",
  "senderId": "7101149746568522",
  "subAction": "messageRead",
  "timeStamp": 1717889610, // Присутнє, якщо увімкнено Webhook Security
  "title": "Primary Profile",
  "type": "read",
  "url": "https://mysite.com/webhook" // Ваш URL webhook
}

Коли повідомлення прочитано в Instagram, payload webhook включає поле mid, яке однозначно ідентифікує, яке конкретне повідомлення було прочитано. Для повідомлень Facebook прочитання повідомлень відстежується на рівні розмови за допомогою conversationId. Коли відбувається подія прочитання, всі повідомлення в цій розмові з timestamps до created (або read) timestamp слід вважати прочитаними користувачем.

Події Reaction Created і Deleted

Сповіщення, коли реакція, наприклад like, створена або видалена на повідомленні.

{
  "action": "messages",
  "conversationId": "t_10161117434308936",
  "created": "2024-06-06T00:49:18Z",
  "hookId": "LcgLuXzZki15lqBNt69h",
  "mediaUrls": [],
  "platform": "facebook",
  "reaction": "😮",
  "recipientId": "106638148652444",
  "refId": "9abf1426d6ce9432",
  "scheduleDate": "2024-06-06T00:49:18Z",
  "senderId": "7101149746568444",
  "subAction": "reactionCreated", // reactionDeleted, якщо видалено
  "timeStamp": 1717634958, // Присутнє, якщо увімкнено Webhook Security
  "title": "Primary Profile",
  "type": "reaction",
  "url": "https://mysite.com/webhook" // Ваш URL webhook
}

{
  "action": "messages",
  "conversationId": "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEO",
  "created": "2024-06-06T00:49:18Z",
  "hookId": "LcgLuXzZki15lqBNt69h",
  "mediaUrls": [],
  "platform": "instagram",
  "reaction": "😮",
  "recipientId": "106638148652444",
  "refId": "9abf1426d6ce9432",
  "scheduleDate": "2024-06-06T00:49:18Z",
  "senderId": "7101149746568444",
  "subAction": "reactionCreated", // reactionDeleted, якщо видалено
  "timeStamp": 1717634958, // Присутнє, якщо увімкнено Webhook Security
  "title": "Primary Profile",
  "type": "reaction",
  "url": "https://mysite.com/webhook" // Ваш URL webhook
}

Подія Message Edit

Сповіщення, коли користувач редагує повідомлення, яке раніше надсилав. Доступно для прямих повідомлень Facebook та Instagram. Поле messageEdit.mid збігається з id оригінальної події messageCreated, тому споживачі можуть корелювати редагування з оригінальним повідомленням. Поле messageEdit.text містить новий, відредагований текст повідомлення.

{
  "action": "messages",
  "conversationId": "t_10161117434308936",
  "created": "2024-06-06T00:49:18Z",
  "hookId": "LcgLuXzZki15lqBNt69h",
  "id": "m_xyz...",                    // Message ID — збігається з оригінальною подією messageCreated
  "messageEdit": {
    "mid": "m_xyz...",
    "text": "the edited message text"
  },
  "platform": "facebook",
  "recipientId": "106638148652444",
  "refId": "9abf1426d6ce9432",
  "senderId": "7101149746568444",
  "subAction": "messageEdited",
  "timeStamp": 1717634958,              // Присутнє, якщо увімкнено Webhook Security
  "title": "Primary Profile",
  "type": "edit",
  "url": "https://mysite.com/webhook"   // Ваш URL webhook
}

{
  "action": "messages",
  "conversationId": "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEO",
  "created": "2024-06-06T00:49:18Z",
  "hookId": "LcgLuXzZki15lqBNt69h",
  "id": "aWdfZAG1faXRlbToxOkl",
  "messageEdit": {
    "mid": "aWdfZAG1faXRlbToxOkl",
    "text": "the edited message text"
  },
  "platform": "instagram",
  "recipientId": "106638148652444",
  "refId": "9abf1426d6ce9432",
  "senderId": "7101149746568444",
  "subAction": "messageEdited",
  "timeStamp": 1717634958,              // Присутнє, якщо увімкнено Webhook Security
  "title": "Primary Profile",
  "type": "edit",
  "url": "https://mysite.com/webhook"   // Ваш URL webhook
}

Batch Action

Сповіщення, коли пакет завершив обробку і файл доступний, наприклад get all user profiles. Ви можете отримати доступ до файлу за попередньо підписаним URL у полі url.

Подія Batch

{
  "action": "batch",
  "batchType": "users",
  "created": "2024-01-11T22:00:30Z",
  "hookId": "dI3PNhrG83j2FzAFJqkb",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",
  "source": "user",
  "timeStamp": 1705010424, // Присутнє з Webhook Security
  "title": "Primary Profile",
  "type": "batch",
  "url": "https://storage.googleapis.com/batch.ayrshare.com/users/dfdf92jskd933r/users-batch-2024-01-11-22-00.json",
  "urlExpires": "2024-01-18T22:00:04Z",
  "userCount": 73
}

Feed Action

Сповіщення, коли знайдено новий елемент RSS-стрічки для зареєстрованих RSS-стрічок. Примітка: якщо Webhook активний, нові елементи RSS не публікуватимуться автоматично у соціальних мережах.

Подія Feed

{
    "action": "feed",
    "created": "2023-01-05T01:18:47Z",
    "code": 200,                                          // HTTP код відповіді
    "refId": "140b8700bd6ade089b242d845e268fb886130c53",  // User Reference ID
    "title": "Title of profile if available",             // опціонально, лише якщо доступно
    "data": { ... },
    "url": "https://api.myapp.com/Webhook/Ayrshare/Feed"  // Ваш URL webhook
}

Mentions Action

Сповіщення, коли Ваш під’єднаний обліковий запис згадується. Доступно для Facebook та Instagram. Ayrshare передає нативний payload згадування Meta без змін, додаючи лише стандартні поля конверта (action, refId, hookId, url та timeStamp з Webhook Security) та subAction. Приклад нижче — форма Instagram: media_id, плюс comment_id, коли згадування в коментарі. Згадування Facebook надходять як нативна зміна mention на Page від Meta, поля якої відрізняються від прикладу Instagram; зверніться до довідки webhook Meta для набору полів Facebook.

Подія Mention (Instagram)

{
  "action": "mentions",
  "subAction": "mention",
  "media_id": "17900000000000000",    // Meta media, на якому відбулося згадування
  "comment_id": "17900000000000001",  // Присутнє, коли згадування в коментарі
  "hookId": "dI3PNhrG83j2FzAFJqkb",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",  // User Reference ID
  "timeStamp": 1705010424,             // Присутнє з Webhook Security
  "url": "https://api.myapp.com/Webhook/Ayrshare/Mentions"  // Ваш URL webhook
}

Comments Action

Сповіщення, коли створено коментар на Вашому під’єднаному контенті. Доступно для Facebook та Instagram. Ayrshare передає нативний payload коментарів Meta без змін, додаючи лише стандартні поля конверта (action, refId, hookId, url та timeStamp з Webhook Security) та subAction. Приклад нижче — форма Instagram. Коментарі Facebook надходять як зміна feed на Page з різними назвами полів (наприклад comment_id, post_id, message та from.name); зверніться до довідки webhook Meta для набору полів Facebook.

Подія Comment (Instagram)

{
  "action": "comments",
  "subAction": "comment",
  "id": "17900000000000002",           // Comment ID
  "text": "Great post!",
  "from": {
    "id": "1234567890",
    "username": "alice"
  },
  "media": {
    "id": "17900000000000000",         // ID медіа, на якому коментується
    "media_product_type": "FEED"       // наприклад FEED, REELS, STORY
  },
  "hookId": "dI3PNhrG83j2FzAFJqkb",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",  // User Reference ID
  "timeStamp": 1705010424,             // Присутнє з Webhook Security
  "url": "https://api.myapp.com/Webhook/Ayrshare/Comments"  // Ваш URL webhook
}

Automations Action

Сповіщення, коли автоматизація активує webhook-дію для користувача, наприклад тригер автовідповіді на коментар або DM.

Подія Automation

{
  "action": "automations",
  "automationId": "a1B2c3D4",
  "triggerId": "t9X8y7Z6",
  "trigger": "comment_keyword",        // Тип тригера, що активував автоматизацію (варіюється залежно від автоматизації)
  "platform": "instagram",
  "recipientId": "17841400000000000",
  "recipientUsername": "alice",        // null, якщо недоступно
  "keyword": "INFO",                   // null, якщо не тригер за ключовим словом
  "timestamp": "2026-05-27T22:00:30Z", // Коли автоматизація активувалася (ISO 8601)
  "hookId": "dI3PNhrG83j2FzAFJqkb",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",  // User Reference ID
  "timeStamp": 1705010424,             // Unix timestamp, присутнє з Webhook Security
  "url": "https://api.myapp.com/Webhook/Ayrshare/Automations"  // Ваш URL webhook
}

Get Started

API Endpoints

Multiple Users

Dashboard

Additional

Scheduled Action

Подія Scheduled

Webhook публікації TikTok

Messages Action

Standby покриття для Facebook Pages з кількома додатками

Події New Message

Подія Message Read

Події Reaction Created і Deleted

Подія Message Edit

Batch Action

Подія Batch

Feed Action

Подія Feed

Mentions Action

Подія Mention (Instagram)

Comments Action

Подія Comment (Instagram)

Automations Action

Подія Automation

​Scheduled Action

​Подія Scheduled

​Webhook публікації TikTok

​Social Action

​Подія Social Action

​Messages Action

​Standby покриття для Facebook Pages з кількома додатками

​Події New Message

​Подія Message Read

​Події Reaction Created і Deleted

​Подія Message Edit

​Batch Action

​Подія Batch

​Feed Action

​Подія Feed

​Mentions Action

​Подія Mention (Instagram)

​Comments Action

​Подія Comment (Instagram)

​Automations Action

​Подія Automation

Scheduled Action

Подія Scheduled

Webhook публікації TikTok

Social Action

Подія Social Action

Messages Action

Standby покриття для Facebook Pages з кількома додатками

Події New Message

Подія Message Read

Події Reaction Created і Deleted

Подія Message Edit

Batch Action

Подія Batch

Feed Action

Подія Feed

Mentions Action

Подія Mention (Instagram)

Comments Action

Подія Comment (Instagram)

Automations Action

Подія Automation