scheduled 動作的 Webhook。
更多細節請參閱 Webhook 概觀。
在註冊 Webhook URL 之後,當事件發生時,你會收到一個 POST 請求送到該 URL。
該 POST 請求會包含含有事件詳細內容的 JSON payload。
Scheduled 動作
當排程貼文被處理時(無論成功或失敗)並發布至所選的社群網路時,你會收到此 Webhook 通知。 例如,若你將貼文排程於 2026 年 8 月 1 日中午 12:00,Webhook 會在該貼文實際發布的時間送出。 只有在 /post 端點中使用scheduleDate 欄位排程於未來的貼文,才會發送 Webhook 通知。
Scheduled 事件
即時發布的貼文不會收到 Webhook 通知,因為 API 會在 JSON 回應中立即回傳成功或失敗的結果。
只有排程貼文才會發送 Webhook 通知,因為排程貼文是非同步處理,需要另外的通知來告知你其狀態。
TikTok 發布 Webhook
當透過 Ayrshare 處理 TikTok 時,你可能會針對排程貼文收到兩個不同的 Webhook。 若你的貼文是排程而非即時發布,你會先收到標準的 Scheduled 動作 Webhook。 這代表媒體已成功送至 TikTok,等待處理與發布。 之後,你會收到subAction: tikTokPublished Webhook。
一旦 TikTok 完成媒體的處理且媒體被公開後,即會觸發此 Webhook。
此 Webhook 會針對即時貼文與排程貼文皆會觸發。
在 Ayrshare 控制台中,此事件會標示為 tikTok (pub)。
Social 動作
當使用者 Profile 連結或解除連結社群網路時的通知。Social 動作事件
source 為 system 表示是 Ayrshare 自動解除連結該帳號,例如社群網路連線不再有效。我們建議你通知使用者,以便他們可繼續發文。解除連結的詳細內容可在 details 欄位中找到。系統也會寄送電子郵件至 Primary Account 的電子郵件地址,或已設定的備用電子郵件。
source 為 user 表示使用者自行發起該操作,例如手動解除某帳號連結。使用者主動觸發的動作不會寄送電子郵件。
Messages 動作
存取所有 messages 端點與 Webhook 需要 Messaging 附加功能。 對於 Facebook 與 Instagram,當有新的私訊到達、被使用者已讀,或訊息上有反應(reaction)建立或刪除時會收到通知。WhatsApp 目前僅在新的進站訊息被儲存時,向你已註冊的 webhook URL 發送通知。 X/Twitter Webhook 是 Enterprise 客戶的可選項目。 如需成為 Enterprise 客戶的相關資訊,請聯絡你的專屬帳號代表。 WhatsApp 目前不會向已註冊的 URL 發出 reaction 或送達狀態的 webhook。已儲存的外送訊息可能會帶有status 值 sent、delivered、read 或 failed——請參閱下方WhatsApp 訊息狀態。
針對安裝了多個 App 的 Facebook 粉絲專頁的 Standby 涵蓋
Ayrshare 除了標準的 messaging 欄位外,也訂閱了 Facebook 的standby Webhook 欄位。這代表即使同一個 Facebook 粉絲專頁上有另一個 App 目前擁有對話控制權——例如某個 chatbot 平台被設為你的粉絲專頁主要接收者,或 Meta 的 Page Inbox 正在主動處理該對話——Messenger 事件仍會送到你的 Webhook。
這些事件的資料結構並無變更。它們會以下方章節所描述的相同 messageCreated / messageRead / reactionCreated / messageEdited payload 送達。若粉絲專頁上另有 Messenger App 存在,需注意兩點:
- 進入的訊息量可能會增加,相較於先前這些 standby 事件在未訂閱時會被靜默丟棄。新的流量代表你的粉絲專頁曾收到、但由其他 App 處理的訊息。
- 你可能會收到
type: "sent"的messageCreated事件,但這些訊息並非透過 Ayrshare 發出。 這些是同一粉絲專頁上另一個 Messenger App 所發送訊息的回聲(Meta 會將每次發送的副本傳送給所有已訂閱的 App)。若你的整合會依據自身發送記錄核對外送流量,可利用該記錄來區分你發送的訊息與其他 App 發送的訊息。
新訊息事件
當有新訊息被送出或收到時的通知。conversationId 與 senderId 都是對方的 E.164 電話號碼(僅數字格式)。recipientId 則是 Meta 為你連結的 WhatsApp 帳號所配發的電話號碼 ID。啟用 Webhook Security 時會包含 timeStamp。媒體訊息會使用 attachments(而非 mediaUrls);attachment 的 type 可為 image、video、audio、document 或 sticker。
訊息已讀事件
當訊息被收件者已讀時的通知。mid 欄位,用來唯一識別哪一則訊息被已讀。
對於 Facebook 訊息,訊息已讀是以對話層級透過 conversationId 進行追蹤。
當已讀事件發生時,該對話中時間戳早於 created(或 read)時間戳的所有訊息,都應被視為已被使用者讀取。
反應建立與刪除事件
當訊息上有反應(例如 like)被建立或刪除時的通知。訊息編輯事件
當使用者編輯他們先前傳送的訊息時的通知。支援 Facebook 與 Instagram 私訊。messageEdit.mid 欄位會對應原始 messageCreated 事件的 id,因此消費端可據此將編輯與原始訊息關聯起來。messageEdit.text 欄位為新的、已編輯的訊息內容。
WhatsApp 訊息狀態
WhatsApp 會針對已儲存的外送訊息使用單一status 欄位追蹤每則訊息的送達狀態:sent、delivered、read 或 failed。這些更新目前不會以個別事件的形式送達你註冊的 webhook URL。若你需要即時的送達狀態,請聯絡你的 Ayrshare 專屬帳號代表。
Batch 動作
當某個批次完成處理且檔案已可存取時的通知,例如取得所有 User Profile。你可以透過url 欄位中的預先簽署 URL 存取該檔案。
Batch 事件
Feed 動作
當已註冊的 RSS 訂閱有新的項目時的通知。注意:若 Webhook 為啟用狀態,新的 RSS 項目將不會自動發布至社群網路。Feed 事件
Mentions 動作
當你已連結的帳號被提及(mention)時的通知。支援 Instagram。對於 Instagram,註冊
mentions webhook 即是接收提及事件所需的全部。無需 Messaging 附加功能、訊息功能啟用或重新連結社群帳號。action、refId、hookId、url,以及啟用 Webhook Security 時的 timeStamp)、subAction、platform 與 postId。以下範例為 Instagram 的結構:media_id,若 mention 位於留言中則另有 comment_id。Facebook 粉絲專頁的提及事件目前不會送達 —— Ayrshare 會向 Meta 確認接收,但不會轉發到你的 webhook。目前僅送達 Instagram 的提及事件,因此此 action 上的 platform 一律為 instagram。
Mention 事件(Instagram)
Comments 動作
當你已連結的內容上有留言被建立時的通知。支援 Facebook 與 Instagram。對於 Instagram,註冊
comments webhook 即是接收留言事件所需的全部。無需 Messaging 附加功能、訊息功能啟用或重新連結社群帳號。action、refId、hookId、url,以及啟用 Webhook Security 時的 timeStamp)、subAction、platform 與 postId。以下範例為 Instagram 的結構。Facebook 留言是以 Page feed change 送達,欄位名稱不同(例如 comment_id、post_id、message 與 from.name);請參閱 Meta 的 Webhook 參考文件以取得 Facebook 的欄位組合。由於兩個社群網路都會送到同一個 comments 端點,請依 platform(instagram 或 facebook)分支,而不是靠出現的欄位名稱推斷來源網路。
Comment 事件(Instagram)
Automations 動作
當某個 automation 為使用者觸發 Webhook 動作時(例如留言或 DM 自動回覆觸發)的通知。Automation 事件
Demo 動作
Demo User Profile 生命週期事件的通知。Demo User Profile 僅適用於 Enterprise plan;如想了解更多,請聯絡我們。demo 動作會發送兩種事件類型,透過 type 欄位加以區分:
upgradeWarning——在 Demo User Profile 自動轉換為標準 User Profile 的兩天前發送,讓你能提示使用者選擇繼續或移除該 Profile。upgrade——在轉換發生時發送。
Demo 升級預告事件
Demo 升級事件
Suspended 動作
當 User Profile 被停權或重新啟用時的通知。停權可能來自社群網路自身的執行行動(例如 Facebook 的身份驗證要求)、來自速率限制保護,或來自帳單問題。當 profile 處於停權狀態時,該 profile 的 API 呼叫會回傳 HTTP 403。suspended 動作會發送兩種事件類型,透過 type 欄位加以區分:
suspend——當 profile 被停權時發送。請在此 profile 重新啟用前,暫停該 profile 的發文與其他活動。unsuspend——當 profile 被重新啟用時發送。
unsuspend。若要隨時檢視目前的停權狀態,請使用 Get Profiles 並帶入 include=suspension。
由平台觸發的停權,通常會先出現受影響網路的一個 Social 動作 unlink 事件。停權只能從來源端解除——例如 Facebook 的身份驗證必須由粉絲專頁管理員在 Facebook app 中完成——之後 profile 才能被重新啟用並重新連結該網路。
Suspend 事件
Unsuspend 事件
停權事件會針對狀態發生變化的 profile 發送。你也可以隨時透過 Get Profiles 搭配
include=suspension 主動查詢停權狀態,該查詢會回傳 isSuspended、reason、suspendedAt、unsuspendAt 與 suspensionCount。