There are several types of webhooks available and categorized by Action type. For example, a scheduled post will trigger aDocumentation Index
Fetch the complete documentation index at: https://www.ayrshare.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
scheduled action webhook.
Please see the webhook overview for more details.
After registering a webhook URL, you will receive an POST request to your URL when an event occurs.
The POST request will include a JSON payload with the event details.
Scheduled Action
You will receive this webhook notification when a scheduled post is processed — whether it succeeds or fails — and published to the selected social networks. For example, if you schedule a post for 12:00 PM on August 1, 2026, the webhook will be sent at the exact time the post is published. Webhook notifications are only sent for posts scheduled in the future using thescheduleDate field in the /post endpoint.
Scheduled Event
You will not receive a webhook notification for immediate posts, because the API returns the success or failure response instantly in the JSON reply.
Webhook notifications are only sent for scheduled posts, since these are processed asynchronously and require a separate notification to inform you of their status.
TikTok Publishing Webhook
When working with TikTok via Ayrshare, you might receive two different webhooks for a scheduled post. If your post was scheduled rather than immediate, you’ll receive the standard Scheduled Action webhook first. This indicates that the media has been successfully sent to TikTok for processing and posting. Afterwards, you will receive thesubAction: tikTokPublished webhook.
This is triggered once TikTok has completed processing the media and the media is made public.
This webhook is activated for both immediate posts and scheduled posts.
In the Ayrshare dashboard, this event is labeled as tikTok (pub).
Social Action
Notification when a user’s profile links or unlinks a social network.Social Action Event
source of system means Ayrshare automatically unlinked the account, such as when the social network connection is no longer valid. We recommend you notify your user so they can continue posting. Details of the unlinking found details field. An email will also be sent to the Primary Account email address, or alt emails if they have been set up.
A source of user means the user initiated the action themselves, such as they manually unlinked an account. An email will not be sent when a user initiated action occurs.
Messages Action
The Messaging Add-On is required to access all messages endpoints and webhooks. Notification when a new direct message arrives, is read by the user, or a reaction is created or deleted on a message for Facebook and Instagram only. X/Twitter webhooks are available as an option for Enterprise clients. Please contact your account representative for more information about becoming an Enterprise client.Standby coverage for Facebook Pages with multiple apps
Ayrshare subscribes to Facebook’sstandby webhook field in addition to the standard messaging fields. This means Messenger events are delivered to your webhook even when another app on the same Facebook Page is currently holding thread control — for example, when a chatbot platform is set as your Page’s primary receiver, or when Meta’s Page Inbox is actively handling a conversation.
There is no schema change for these events. They arrive as the same messageCreated / messageRead / reactionCreated / messageEdited payloads documented in the sections below. Two things to be aware of for Pages with a competing Messenger app installed:
- Inbound message volume may increase compared to the previous behavior, where standby events were silently dropped before being subscribed to. The new traffic represents messages your Page received that were being handled by the other app.
- You may receive
messageCreatedevents withtype: "sent"that do not correspond to messages you sent through Ayrshare. These are echoes of messages sent by the other Messenger app on your Page (Meta delivers a copy of every send to every subscribed app). If your integration reconciles outbound traffic against your own send history, you can use that history to distinguish your sends from a competing app’s sends.
New Message Events
Notification when a new message is sent or received.Message Read Event
Notification when a message is read by the recipient.mid field that uniquely identifies which specific message was read.
For Facebook messages, message reads are tracked at the conversation level using the conversationId.
When a read event occurs, all messages in that conversation with timestamps before the created (or read) timestamp should be considered read by the user.
Reaction Created and Deleted Events
Notification when a reaction, such as a like, is created or deleted on a message.Message Edit Event
Notification when a user edits a message they previously sent. Available for Facebook and Instagram direct messages. ThemessageEdit.mid field matches the id of the original messageCreated event, so consumers can correlate the edit with the original message. The messageEdit.text field carries the new, edited message text.
Batch Action
Notification when a batch has completed processing and the file is available, such as get all user profiles. You may access the file with the pre-signed URL in theurl field.
Batch Event
Feed Action
Notification when a new RSS feed item is found for registered RSS feeds. Note: if the Webhook is active, new RSS items will not be automatically posted to the social networks.Feed Event
X Account Activity Action
Notification when real-time events occur for any action taken on a linked X account. This includes posts, mentions, DMs, likes, follows, blocks, and more. The X Account Activity feature must be enabled for your linked X account to receive these webhooks. Please contact your account representative to enable this feature. Enable X Account Activity for your profile by setting thexAccountActivityActive
parameter to true when updating your profile via the Update Profile API.
Active X Account Activity
Account Activity Setup: When linking and activating Account Activity, connect with an X user profile that has messaging enabled.
Messaging can be enabled from the User Profiles page.
This will enable any authenticated media in direct message events to be included as mediaUrl
ayrshareUrl in the webhook payload.Tweet Create Event
Post status for Posts, Retweets, Replies, @mentions, Quote Tweets, or Retweet of Quote Tweets.userHasBlocked may be present at the top level:
