webhooks
Webhook API Endpoint: Register a webhook to receive asynchronous updates on events.
A Webhook allows you to be notified when certain system actions occur via a call to a URL you provide. Webhooks are also known as "URL Callbacks" or "HTTP push calls". Your URL must use SSL and begin with HTTPS.
Webhooks are registered at the primary account, Primary Profile, level. Any updates for the Primary or User Profiles are sent to the registered Webhooks. For example, if a User Profile unlinks TikTok, the registered Social Action Webhook URL will be called.
Register a Webhook by providing your URL and the type of action you wish to be notified to the POST
/hook/webhook endpoint. When the action occurs an HTTP POST message will be sent to the provided URL. E.g. register a URL to get notified of the status of scheduled post.After your Webhook receives the HTTP POST, respond with an HTTP status of 200 to mark the call as successful.
You may choose to add additional security by setting HMAC authentication as an HTTP request. This is often done to prevent replay attacks. Ayrshare uses HMAC-SHA256 to hash the body of the message and includes it and the UNIX timestamp in the header of the POST.
X-Authorization-Timestamp : <Unix Timestamp In Seconds>
X-Authorization-Content-SHA256 : <HashedContent>
Based on a secret key set when registering your Webhook, you may validate the post by comparing the header X-Authorization-Content-SHA256 with SHA256 hash of the POST body.
You may view the active Webhooks in the Ayrshare Dashboard, see the logs since June 13th, 2022, and resend the post to the registered URL.
Please note, the first column indicated a successful HTTP response (200, 300) from the Webhook ✔️ or a failed response ✖️ (400, 500).
Switch to a particular user profile to view that profile's Webhook logs.
Business Plan required.
❗Click the › in the endpoint to view details.
post
https://app.ayrshare.com/api
/hook/webhook
Register Webhook
delete
https://app.ayrshare.com/api
/hook/webhook
Unregister Webhook
get
https://app.ayrshare.com/api
/hook/webhook
List Registered Webhooks
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 in sent on the scheduleDate.Business Plan required.
{
"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://api.myapp.com/Webhook/Ayrshare/Scheduled"
}
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 (published).Notification when a user's profile links or unlinks a social network.
Business Plan required.
{
"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://api.myapp.com/Webhook/Ayrshare/Social"
}
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 setup.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.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.
Business Plan required.
{
"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"
}
Last modified 1mo ago