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.
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.
{ "action": "scheduled", // The action taken "subAction": "tikTokPublished", // Only present when TikTok video publishing complete "created": "2023-01-05T01:18:47Z", "code": 200, // HTTP response code "refId": "140b8700bd6ade089b242d845e268fb886130c53", // User Reference ID "status": "success", // success or error "id": "TBAAAqAMMpoweA9wKHUp", // Ayrshare id of post "errors": [], // List of errors if any occurred "postIds": [ // Individual successful posts status { "postUrl": "https://www.facebook.com/102775127855689_361718068618052", "platform": "facebook", "status": "success", "id": "102775127855689_361718068618052" } ], "url": "https://mysite.com/webhook" // Your webhook URL}
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 the subAction: 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).
The tikTokPublished webhook is not sent until the media is made public.
If the media is set to private, followers, or friends, the webhook will not be sent.
If you do not receive the tikTokPublished webhook and the post status remains pending, check the TikTok mobile app to ensure the media has been accepted by TikTok.
{ "action": "social", // The action taken "created": "2023-01-05T01:18:47Z", "code": 200, // HTTP response code "details": { // Optional: if details available "status": "error", "code": 349, "message": "Account locked" }, "displayName": "Instagram Title", // If a user account name is present at the social network "hookId": "TKLc30192HLGw5UeJ46", "platform": "instagram", // The social platform the action occured "refId": "140b8700bd6ade089b242d845e268fb886130c53", // User Reference ID "refreshBy": "2022-11-05T12:21:29Z", // Optional: If type is refresh, the date the social network authorization must be refreshed on the social account linkage page "source": "system", // Initiated by "system" or "user". "title": "User Profile Name", // The user profile's account title "type": "link", // Type of action: link, unlink, or refresh "url": "https://mysite.com/webhook" // Your webhook 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.
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.
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.
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.
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.
{ "action": "feed", "created": "2023-01-05T01:18:47Z", "code": 200, // HTTP response code "refId": "140b8700bd6ade089b242d845e268fb886130c53", // User Reference ID "title": "Title of profile if available", // optional, only if available "data": { ... }, "url": "https://api.myapp.com/Webhook/Ayrshare/Feed" // Your webhook URL}
