Webhook Actions
Available Webhook Action Types
There are several types of webhooks available and categorized by Action type.
For example, a scheduled post will trigger a scheduled
action webhook.
Please see the webhook overview for more details.
Scheduled Action
Notification when a scheduled post has been processed. Only future scheduled posts using the scheduleDate
field of the /post endpoint receive a webhook notification.
The webhook will be called when the post is sent on the scheduleDate
.
POST Action to Your URL
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 video has been successfully sent to TikTok for processing and posting.
Afterwards, you will receive the subAction: tikTokPublished
webhook. This is triggered once TikTok has completed processing the video. 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.
POST Action to Your URL
A 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.
POST Action New Message
POST Action Message Read
When a message is read on Instagram, the webhook payload includes an 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.
POST Action Reaction Create and Deleted
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 the url
field.
POST Action to Your URL
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.