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
Copy
Ask AI
{
"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
}
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).
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.Social Action
Notification when a user’s profile links or unlinks a social network.Social Action Event
Copy
Ask AI
{
"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
}
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.New Message Events
Notification when a new message is sent or received.Copy
Ask AI
{
"action": "messages",
"conversationId": "t_10161117434308936",
"created": "2024-06-07T11:58:44Z",
"hookId": "JC6IgqFjvDliTJ8MLqzE",
"id": "m_aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDUyMjEyNzA",
"mediaUrls": [],
"message": "This is an amazing message",
"platform": "facebook",
"recipientId": "7270633706358444",
"refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",
"scheduleDate": "2024-06-07T11:58:44Z",
"senderDetails": {
// recipientDetails if type is sent
"id": "7270633706358444",
"picture": "https://scontent-ord5-2.cdninstagram.com/v/t51.jpg",
"username": "SweetMessage",
"name": "Sweet"
},
"senderId": "17841452212707444",
"subAction": "messageCreated",
"timeStamp": 1735189325, // Present if Webhook Security enabled
"title": "Primary Profile",
"type": "received", // received, sent, or deleted
"url": "https://mysite.com/webhook" // Your webhook URL
}
Message Read Event
Notification when a message is read by the recipient.Copy
Ask AI
{
"action": "messages",
"conversationId": "t_10161117434308936",
"created": "2024-06-08T23:33:30Z",
"hookId": "CviPBMXEy3cdJnK0EESd",
"platform": "facebook",
"read": 1717889607802, // UNIX timestamp of when the message was read
"readerDetails": {
"name": "John Smith",
"id": "7101149746568444",
"picture": "https://platform-lookaside.fbsbx.com/platform/profilepic"
},
"recipientId": "106638148652329",
"refId": "9abf1426d6ce9122ef11c8932",
"scheduleDate": "2024-06-08T23:33:30Z",
"senderId": "7101149746568522",
"subAction": "messageRead",
"timeStamp": 1717889610, // Present if Webhook Security enabled
"title": "Primary Profile",
"type": "read",
"url": "https://mysite.com/webhook" // Your webhook URL
}
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.Copy
Ask AI
{
"action": "messages",
"conversationId": "t_10161117434308936",
"created": "2024-06-06T00:49:18Z",
"hookId": "LcgLuXzZki15lqBNt69h",
"mediaUrls": [],
"platform": "facebook",
"reaction": "😮",
"recipientId": "106638148652444",
"refId": "9abf1426d6ce9432",
"scheduleDate": "2024-06-06T00:49:18Z",
"senderId": "7101149746568444",
"subAction": "reactionCreated", // reactionDeleted if deleted
"timeStamp": 1717634958, // Present if Webhook Security enabled
"title": "Primary Profile",
"type": "reaction",
"url": "https://mysite.com/webhook" // Your webhook URL
}
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
Copy
Ask AI
{
"action": "batch",
"batchType": "users",
"created": "2024-01-11T22:00:30Z",
"hookId": "dI3PNhrG83j2FzAFJqkb",
"refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",
"source": "user",
"timeStamp": 1705010424, // Present with Webhook Security
"title": "Primary Profile",
"type": "batch",
"url": "https://storage.googleapis.com/batch.ayrshare.com/users/dfdf92jskd933r/users-batch-2024-01-11-22-00.json",
"urlExpires": "2024-01-18T22:00:04Z",
"userCount": 73
}
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
Copy
Ask AI
{
"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
}
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
Copy
Ask AI
{
"xAccountActivityActive": true
}
Account Activity Setup: When linking and activating Account Activity, connect with an X user profile that does not have messaging enabled to avoid potential issues.
After enabling Account Activity, you may active messaging for the profile.
Tweet Create Event
Post status for Posts, Retweets, Replies, @mentions, Quote Tweets, or Retweet of Quote Tweets.Copy
Ask AI
{
"action": "accountActivity",
"code": 200,
"created": "2025-07-01T11:01:42Z",
"hookId": "ABC123XYZ456DEF789GH",
"mediaUrls": [],
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T11:01:42Z",
"source": "system",
"title": "X Account Activity",
"tweetCreateEvents": {
"editControls": {
"editsRemaining": 5,
"editableUntilMs": 1751371301000
},
"editable": true,
"entities": {
"userMentions": [],
"urls": [],
"symbols": [],
"hashtags": []
},
"id": 1234567890123456700,
"retweetCount": 0,
"editHistory": {
"initialTweetId": "1234567890123456708",
"editTweetIds": [
"1234567890123456708"
]
},
"quoteCount": 0,
"lang": "en",
"filterLevel": "low",
"favoriteCount": 0,
"idStr": "1234567890123456708",
"isQuoteStatus": false,
"replyCount": 0,
"text": "Hello from the up side!",
"retweeted": false,
"source": "<a href=\"https://mobile.twitter.com\" rel=\"nofollow\">Twitter Web App</a>",
"user": {
"profileBackgroundImageUrl": "",
"defaultProfileImage": false,
"profileTextColor": "333333",
"profileLinkColor": "1DA1F2",
"protected": false,
"defaultProfile": true,
"screenName": "example_business",
"createdAt": "Tue Nov 12 15:22:57 +0000 2019",
"profileSidebarBorderColor": "C0DEED",
"translatorType": "none",
"id": 9876543210987654500,
"verifiedType": "none",
"geoEnabled": false,
"profileBackgroundTile": false,
"verified": false,
"profileUseBackgroundImage": true,
"favouritesCount": 51,
"location": "New York",
"friendsCount": 6,
"description": "Sample business description for testing purposes. We make great products that people love and take just minutes to prepare!",
"profileBackgroundColor": "F5F8FA",
"contributorsEnabled": false,
"idStr": "9876543210987654472",
"followersCount": 27,
"isTranslator": false,
"statusesCount": 2476,
"profileSidebarFillColor": "DDEEF6",
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"profileBackgroundImageUrlHttps": "",
"withheldInCountries": [],
"profileImageUrl": "http://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"profileBannerUrl": "https://pbs.twimg.com/profile_banners/9876543210987654472/1573572462",
"listedCount": 0,
"name": "Example Business",
"url": "https://www.example-business.com/"
},
"favorited": false,
"createdAt": "2025-07-01T11:01:41.000Z",
"truncated": false
},
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint"
}
userHasBlocked
may be present at the top level:
Copy
Ask AI
{
"action": "accountActivity",
"code": 200,
"created": "2025-07-01T12:05:10Z",
"hookId": "DEF456GHI789JKL012MN",
"mediaUrls": [],
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T12:05:10Z",
"source": "system",
"title": "X Account Activity",
"userHasBlocked": false,
"tweetCreateEvents": {
// Tweet object with mention data
},
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint"
}
Tweet Delete Events
Notice of deleted Posts for compliance.Copy
Ask AI
{
"action": "accountActivity",
"code": 200,
"created": "2025-07-01T11:02:03Z",
"hookId": "KLM789NOP012QRS345TU",
"mediaUrls": [],
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T11:02:03Z",
"source": "system",
"title": "X Account Activity",
"tweetDeleteEvents": {
"status": {
"userId": "9876543210987654472",
"id": "1234567890123456306"
},
"createdAt": "2025-07-01T11:02:03.354Z"
},
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint"
}
Favorite Event
Like event with user and target.Copy
Ask AI
{
"action": "accountActivity",
"code": 200,
"created": "2025-07-01T10:44:58Z",
"favoriteEvents": {
"favoritedStatus": {
"idStr": "1111222233334444555",
"lang": "en",
"isQuoteStatus": false,
"possiblySensitive": false,
"createdAt": "Thu Jun 19 16:33:37 +0000 2025",
"filterLevel": "low",
"quoteCount": 0,
"replyCount": 1,
"source": "<a href=\"https://www.example-service.com\" rel=\"nofollow\">Example Service</a>",
"truncated": false,
"entities": {
"symbols": [],
"urls": [],
"userMentions": [],
"media": [
{
"sizes": {
"medium": {
"w": 600,
"h": 600,
"resize": "fit"
},
"small": {
"w": 600,
"h": 600,
"resize": "fit"
},
"thumb": {
"w": 150,
"resize": "crop",
"h": 150
},
"large": {
"w": 600,
"h": 600,
"resize": "fit"
}
},
"indices": [
100,
123
],
"mediaUrl": "http://pbs.twimg.com/media/ExampleMedia123.jpg",
"displayUrl": "pic.twitter.com/ABC123XYZ456",
"expandedUrl": "https://twitter.com/example_business/status/1111222233334444555/photo/1",
"id": 1111222233334444400,
"idStr": "1111222233334444384",
"url": "https://t.co/ABC123XYZ456",
"mediaUrlHttps": "https://pbs.twimg.com/media/ExampleMedia123.jpg",
"type": "photo"
}
],
"hashtags": []
},
"favorited": false,
"retweetCount": 0,
"favoriteCount": 1,
"user": {
"profileSidebarBorderColor": "C0DEED",
"profileTextColor": "333333",
"listedCount": 0,
"profileBackgroundTile": false,
"favouritesCount": 51,
"defaultProfile": true,
"profileBackgroundImageUrl": "",
"translatorType": "none",
"verified": false,
"profileImageUrl": "http://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"location": "New York",
"profileSidebarFillColor": "DDEEF6",
"contributorsEnabled": false,
"createdAt": "Tue Nov 12 15:22:57 +0000 2019",
"profileLinkColor": "1DA1F2",
"id": 9876543210987654500,
"friendsCount": 6,
"screenName": "example_business",
"geoEnabled": false,
"url": "https://www.example-business.com/",
"name": "Example Business",
"profileBackgroundColor": "F5F8FA",
"withheldInCountries": [],
"defaultProfileImage": false,
"profileBackgroundImageUrlHttps": "",
"isTranslator": false,
"description": "Sample business description for testing purposes. We make great products that people love and take just minutes to prepare!",
"profileUseBackgroundImage": true,
"followersCount": 26,
"protected": false,
"statusesCount": 2475,
"verifiedType": "none",
"idStr": "9876543210987654472",
"profileBannerUrl": "https://pbs.twimg.com/profile_banners/9876543210987654472/1573572462",
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png"
},
"id": 1111222233334444000,
"displayTextRange": [
0,
99
],
"extendedEntities": {
"media": [
{
"sizes": {
"thumb": {
"h": 150,
"w": 150,
"resize": "crop"
},
"large": {
"h": 600,
"w": 600,
"resize": "fit"
},
"medium": {
"w": 600,
"h": 600,
"resize": "fit"
},
"small": {
"h": 600,
"resize": "fit",
"w": 600
}
},
"mediaUrl": "http://pbs.twimg.com/media/ExampleMedia123.jpg",
"mediaUrlHttps": "https://pbs.twimg.com/media/ExampleMedia123.jpg",
"url": "https://t.co/ABC123XYZ456",
"indices": [
100,
123
],
"id": 1111222233334444400,
"idStr": "1111222233334444384",
"expandedUrl": "https://twitter.com/example_business/status/1111222233334444555/photo/1",
"displayUrl": "pic.twitter.com/ABC123XYZ456",
"type": "photo"
}
]
},
"retweeted": false,
"text": "#67370 A truly rich man is one whose children run into his arms when his hands are empty. - Unknown https://t.co/ABC123XYZ456"
},
"user": {
"profileSidebarFillColor": "DDEEF6",
"contributorsEnabled": false,
"geoEnabled": false,
"verified": false,
"withheldInCountries": [],
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/5555666677778888999/xyz789ab_normal.jpg",
"isTranslator": false,
"favouritesCount": 16,
"listedCount": 0,
"profileLinkColor": "1DA1F2",
"protected": false,
"profileUseBackgroundImage": true,
"profileBackgroundColor": "F5F8FA",
"translatorType": "none",
"defaultProfileImage": false,
"profileBackgroundImageUrlHttps": "",
"idStr": "5555666677778888520",
"profileTextColor": "333333",
"name": "sample_user",
"profileImageUrl": "http://pbs.twimg.com/profile_images/5555666677778888999/xyz789ab_normal.jpg",
"followersCount": 2,
"defaultProfile": true,
"profileBackgroundTile": false,
"friendsCount": 10,
"profileSidebarBorderColor": "C0DEED",
"profileBackgroundImageUrl": "",
"createdAt": "Mon Jan 06 19:05:05 +0000 2025",
"statusesCount": 83,
"screenName": "sample_user_123",
"id": 5555666677778888500,
"verifiedType": "none"
},
"createdAt": "2025-07-01T10:44:57.000Z",
"id": "ac33e9047a2488959d88dbdc524068d6"
},
"hookId": "GHI789JKL012MNO345PQ",
"mediaUrls": [],
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T10:44:58Z",
"source": "system",
"title": "X Account Activity",
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint"
}
Follow Event
Follow event with user and target.Copy
Ask AI
{
"action": "accountActivity",
"code": 200,
"created": "2025-07-01T10:54:54Z",
"followEvents": {
"createdAt": "2025-07-01T10:54:54.510Z",
"target": {
"createdAt": "Tue Nov 12 15:22:57 +0000 2019",
"geoEnabled": false,
"verified": false,
"following": false,
"profileBackgroundImageUrlHttps": "",
"profileLinkColor": -1,
"contributorsEnabled": false,
"timeZone": "",
"url": "https://t.co/ExampleUrl123",
"profileBackgroundColor": -1,
"location": "New York",
"utcOffset": 0,
"defaultProfileImage": false,
"notifications": false,
"description": "Sample business description for testing purposes. We make great products that people love and take just minutes to prepare!",
"isTranslator": false,
"lang": "",
"followRequestSent": false,
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"profileBackgroundTile": false,
"profileImageUrl": "http://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"profileSidebarBorderColor": -1,
"id": "9876543210987654472",
"profileUseBackgroundImage": false,
"friendsCount": 6,
"profileSidebarFillColor": -1,
"defaultProfile": true,
"profileBackgroundImageUrl": "",
"listedCount": 0,
"followersCount": 27,
"statusesCount": 2475,
"protected": false,
"profileTextColor": -1,
"favouritesCount": 51,
"screenName": "example_business",
"name": "Example Business"
},
"source": {
"utcOffset": 0,
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/5555666677778888999/xyz789ab_normal.jpg",
"protected": false,
"defaultProfileImage": false,
"lang": "",
"defaultProfile": true,
"isTranslator": false,
"name": "sample_user",
"friendsCount": 11,
"following": false,
"profileBackgroundTile": false,
"listedCount": 0,
"location": "",
"profileSidebarFillColor": -1,
"favouritesCount": 16,
"notifications": false,
"id": "5555666677778888520",
"geoEnabled": false,
"contributorsEnabled": false,
"profileBackgroundImageUrlHttps": "",
"profileTextColor": -1,
"timeZone": "",
"verified": false,
"profileImageUrl": "http://pbs.twimg.com/profile_images/5555666677778888999/xyz789ab_normal.jpg",
"profileUseBackgroundImage": false,
"profileBackgroundImageUrl": "",
"screenName": "sample_user_123",
"url": "",
"profileLinkColor": -1,
"createdAt": "Mon Jan 06 19:05:05 +0000 2025",
"statusesCount": 84,
"profileSidebarBorderColor": -1,
"followRequestSent": false,
"profileBackgroundColor": -1,
"followersCount": 2,
"description": ""
},
"type": "follow"
},
"hookId": "JKL012MNO345PQR678ST",
"mediaUrls": [],
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T10:54:54Z",
"source": "system",
"title": "X Account Activity",
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint"
}
Unfollow Event
Unfollow event with user and target.Copy
Ask AI
{
"action": "accountActivity",
"code": 200,
"created": "2025-07-01T11:40:46Z",
"followEvents": {
"target": {
"listedCount": 27,
"contributorsEnabled": false,
"profileBackgroundTile": false,
"profileSidebarBorderColor": -1,
"name": "Tech Enthusiast",
"description": "Technology lover | Tech Fan | Tech Investor",
"statusesCount": 7312,
"following": false,
"utcOffset": 0,
"profileBackgroundColor": -1,
"lang": "",
"profileBackgroundImageUrlHttps": "",
"profileBackgroundImageUrl": "",
"defaultProfile": true,
"createdAt": "Fri Nov 15 09:57:31 +0000 2024",
"profileImageUrl": "http://pbs.twimg.com/profile_images/7777888899990001234/ExampleImg_normal.jpg",
"screenName": "TechEnthusiast123",
"defaultProfileImage": false,
"verified": true,
"followRequestSent": false,
"notifications": false,
"timeZone": "",
"profileTextColor": -1,
"id": "7777888899990001234",
"profileSidebarFillColor": -1,
"url": "https://t.co/ExampleTechUrl",
"followersCount": 12737,
"location": "California, USA",
"geoEnabled": false,
"profileUseBackgroundImage": false,
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/7777888899990001234/ExampleImg_normal.jpg",
"protected": false,
"isTranslator": false,
"favouritesCount": 19551,
"profileLinkColor": -1,
"friendsCount": 1425
},
"type": "unfollow",
"source": {
"defaultProfileImage": false,
"friendsCount": 6,
"followRequestSent": false,
"profileBackgroundImageUrlHttps": "",
"lang": "",
"listedCount": 0,
"notifications": false,
"url": "https://t.co/ExampleUrl123",
"profileSidebarBorderColor": -1,
"profileSidebarFillColor": -1,
"profileLinkColor": -1,
"profileBackgroundColor": -1,
"timeZone": "",
"id": "9876543210987654472",
"favouritesCount": 51,
"profileBackgroundTile": false,
"utcOffset": 0,
"profileTextColor": -1,
"contributorsEnabled": false,
"verified": false,
"location": "New York",
"geoEnabled": false,
"statusesCount": 2475,
"profileUseBackgroundImage": false,
"profileImageUrl": "http://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"isTranslator": false,
"createdAt": "Tue Nov 12 15:22:57 +0000 2019",
"following": false,
"name": "Example Business",
"defaultProfile": true,
"profileBackgroundImageUrl": "",
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"description": "Sample business description for testing purposes. We make great products that people love and take just minutes to prepare!",
"followersCount": 26,
"protected": false,
"screenName": "example_business"
},
"createdAt": "2025-07-01T11:40:45.695Z"
},
"hookId": "MNO345PQR678STU901VW",
"mediaUrls": [],
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T11:40:46Z",
"source": "system",
"title": "X Account Activity",
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint"
}
Block Event
Block event with user and target.Copy
Ask AI
{
"action": "accountActivity",
"blockEvents": {
"type": "block",
"createdAt": "2025-07-01T11:04:31.866Z",
"target": {
"profileBackgroundTile": false,
"profileImageUrl": "http://pbs.twimg.com/profile_images/3333444455556666777/SampleImg_normal.jpg",
"friendsCount": 1953,
"profileUseBackgroundImage": false,
"favouritesCount": 6949,
"description": "Official account of Example Sports Network - production company specializing in sports content.",
"protected": false,
"location": "Los Angeles",
"screenName": "ExampleSports",
"profileBackgroundColor": -1,
"profileSidebarFillColor": -1,
"isTranslator": false,
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/3333444455556666777/SampleImg_normal.jpg",
"lang": "",
"profileBackgroundImageUrlHttps": "",
"defaultProfile": true,
"listedCount": 4013,
"notifications": false,
"defaultProfileImage": false,
"profileTextColor": -1,
"createdAt": "Fri Oct 09 13:42:35 +0000 2009",
"url": "https://t.co/ExampleSportsUrl",
"profileLinkColor": -1,
"following": false,
"contributorsEnabled": false,
"followRequestSent": false,
"timeZone": "",
"profileBackgroundImageUrl": "",
"statusesCount": 21468,
"name": "Example Sports",
"profileSidebarBorderColor": -1,
"geoEnabled": false,
"id": "8888999900001111222",
"followersCount": 484802,
"utcOffset": 0,
"verified": true
},
"source": {
"description": "Sample business description for testing purposes. We make great products that people love and take just minutes to prepare!",
"profileBackgroundImageUrlHttps": "",
"profileBackgroundTile": false,
"profileBackgroundColor": -1,
"timeZone": "",
"createdAt": "Tue Nov 12 15:22:57 +0000 2019",
"id": "9876543210987654472",
"profileUseBackgroundImage": false,
"profileTextColor": -1,
"statusesCount": 2475,
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"geoEnabled": false,
"utcOffset": 0,
"friendsCount": 6,
"protected": false,
"profileLinkColor": -1,
"profileSidebarBorderColor": -1,
"defaultProfileImage": false,
"verified": false,
"followersCount": 27,
"favouritesCount": 51,
"notifications": false,
"screenName": "example_business",
"following": false,
"name": "Example Business",
"url": "https://t.co/ExampleUrl123",
"contributorsEnabled": false,
"location": "New York",
"profileImageUrl": "http://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"defaultProfile": true,
"followRequestSent": false,
"listedCount": 0,
"isTranslator": false,
"lang": "",
"profileSidebarFillColor": -1,
"profileBackgroundImageUrl": ""
}
},
"code": 200,
"created": "2025-07-01T11:04:32Z",
"hookId": "PQR678STU901VWX234YZ",
"mediaUrls": [],
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T11:04:32Z",
"source": "system",
"title": "X Account Activity",
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint"
}
Unblock Event
Unblock event with user and target.Copy
Ask AI
{
"action": "accountActivity",
"blockEvents": {
"type": "unblock",
"createdAt": "2025-07-01T11:04:31.866Z",
"target": {
"profileBackgroundTile": false,
"profileImageUrl": "http://pbs.twimg.com/profile_images/3333444455556666777/SampleImg_normal.jpg",
"friendsCount": 1953,
"profileUseBackgroundImage": false,
"favouritesCount": 6949,
"description": "Official account of Example Sports Network - production company specializing in sports content.",
"protected": false,
"location": "Los Angeles",
"screenName": "ExampleSports",
"profileBackgroundColor": -1,
"profileSidebarFillColor": -1,
"isTranslator": false,
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/3333444455556666777/SampleImg_normal.jpg",
"lang": "",
"profileBackgroundImageUrlHttps": "",
"defaultProfile": true,
"listedCount": 4013,
"notifications": false,
"defaultProfileImage": false,
"profileTextColor": -1,
"createdAt": "Fri Oct 09 13:42:35 +0000 2009",
"url": "https://t.co/ExampleSportsUrl",
"profileLinkColor": -1,
"following": false,
"contributorsEnabled": false,
"followRequestSent": false,
"timeZone": "",
"profileBackgroundImageUrl": "",
"statusesCount": 21468,
"name": "Example Sports",
"profileSidebarBorderColor": -1,
"geoEnabled": false,
"id": "8888999900001111222",
"followersCount": 484802,
"utcOffset": 0,
"verified": true
},
"source": {
"description": "Sample business description for testing purposes. We make great products that people love and take just minutes to prepare!",
"profileBackgroundImageUrlHttps": "",
"profileBackgroundTile": false,
"profileBackgroundColor": -1,
"timeZone": "",
"createdAt": "Tue Nov 12 15:22:57 +0000 2019",
"id": "9876543210987654472",
"profileUseBackgroundImage": false,
"profileTextColor": -1,
"statusesCount": 2475,
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"geoEnabled": false,
"utcOffset": 0,
"friendsCount": 6,
"protected": false,
"profileLinkColor": -1,
"profileSidebarBorderColor": -1,
"defaultProfileImage": false,
"verified": false,
"followersCount": 27,
"favouritesCount": 51,
"notifications": false,
"screenName": "example_business",
"following": false,
"name": "Example Business",
"url": "https://t.co/ExampleUrl123",
"contributorsEnabled": false,
"location": "New York",
"profileImageUrl": "http://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"defaultProfile": true,
"followRequestSent": false,
"listedCount": 0,
"isTranslator": false,
"lang": "",
"profileSidebarFillColor": -1,
"profileBackgroundImageUrl": ""
}
},
"code": 200,
"created": "2025-07-01T11:04:32Z",
"hookId": "STU901VWX234YZA567BC",
"mediaUrls": [],
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T11:04:32Z",
"source": "system",
"title": "X Account Activity",
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint"
}
Mute Event
Mute event with user and target.Copy
Ask AI
{
"action": "accountActivity",
"code": 200,
"created": "2025-07-01T11:02:25Z",
"hookId": "VWX234YZA567BCD890EF",
"mediaUrls": [],
"muteEvents": {
"source": {
"profileSidebarBorderColor": -1,
"protected": false,
"listedCount": 0,
"defaultProfileImage": false,
"utcOffset": 0,
"contributorsEnabled": false,
"name": "Example Business",
"verified": false,
"favouritesCount": 51,
"followersCount": 27,
"following": false,
"friendsCount": 6,
"screenName": "example_business",
"profileUseBackgroundImage": false,
"defaultProfile": true,
"createdAt": "Tue Nov 12 15:22:57 +0000 2019",
"geoEnabled": false,
"profileBackgroundColor": -1,
"isTranslator": false,
"followRequestSent": false,
"location": "New York",
"profileLinkColor": -1,
"profileBackgroundImageUrl": "",
"profileBackgroundImageUrlHttps": "",
"profileImageUrl": "http://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"lang": "",
"id": "9876543210987654472",
"timeZone": "",
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"notifications": false,
"profileSidebarFillColor": -1,
"url": "https://t.co/ExampleUrl123",
"statusesCount": 2475,
"description": "Sample business description for testing purposes. We make great products that people love and take just minutes to prepare!",
"profileBackgroundTile": false,
"profileTextColor": -1
},
"type": "mute",
"createdAt": "2025-07-01T11:02:25.099Z",
"target": {
"profileImageUrl": "http://pbs.twimg.com/profile_images/3333444455556666777/SampleImg_normal.jpg",
"following": false,
"profileTextColor": -1,
"profileBackgroundColor": -1,
"contributorsEnabled": false,
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/3333444455556666777/SampleImg_normal.jpg",
"url": "https://t.co/ExampleSportsUrl",
"profileBackgroundTile": false,
"name": "Example Sports",
"profileSidebarFillColor": -1,
"utcOffset": 0,
"isTranslator": false,
"protected": false,
"defaultProfile": true,
"createdAt": "Fri Oct 09 13:42:35 +0000 2009",
"description": "Official account of Example Sports Network - production company specializing in sports content.",
"id": "8888999900001111222",
"profileLinkColor": -1,
"timeZone": "",
"profileSidebarBorderColor": -1,
"geoEnabled": false,
"followersCount": 484802,
"screenName": "ExampleSports",
"friendsCount": 1953,
"profileUseBackgroundImage": false,
"listedCount": 4013,
"location": "Los Angeles",
"notifications": false,
"profileBackgroundImageUrl": "",
"followRequestSent": false,
"defaultProfileImage": false,
"verified": true,
"statusesCount": 21468,
"favouritesCount": 6949,
"profileBackgroundImageUrlHttps": "",
"lang": ""
}
},
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T11:02:25Z",
"source": "system",
"title": "X Account Activity",
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint"
}
Unmute Event
Unmute event with user and target.Copy
Ask AI
{
"action": "accountActivity",
"code": 200,
"created": "2025-07-01T11:02:37Z",
"hookId": "YZA567BCD890EFG123HI",
"mediaUrls": [],
"muteEvents": {
"source": {
"profileLinkColor": -1,
"location": "New York",
"followersCount": 27,
"geoEnabled": false,
"verified": false,
"utcOffset": 0,
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"profileTextColor": -1,
"name": "Example Business",
"friendsCount": 6,
"defaultProfile": true,
"statusesCount": 2475,
"defaultProfileImage": false,
"description": "Sample business description for testing purposes. We make great products that people love and take just minutes to prepare!",
"lang": "",
"profileBackgroundImageUrl": "",
"timeZone": "",
"protected": false,
"createdAt": "Tue Nov 12 15:22:57 +0000 2019",
"profileSidebarBorderColor": -1,
"followRequestSent": false,
"profileBackgroundColor": -1,
"favouritesCount": 51,
"profileBackgroundTile": false,
"notifications": false,
"profileUseBackgroundImage": false,
"following": false,
"contributorsEnabled": false,
"profileSidebarFillColor": -1,
"url": "https://t.co/ExampleUrl123",
"isTranslator": false,
"listedCount": 0,
"screenName": "example_business",
"profileImageUrl": "http://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"profileBackgroundImageUrlHttps": "",
"id": "9876543210987654472"
},
"type": "unmute",
"target": {
"listedCount": 4013,
"protected": false,
"id": "8888999900001111222",
"profileSidebarFillColor": -1,
"defaultProfile": true,
"timeZone": "",
"followersCount": 484802,
"profileBackgroundTile": false,
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/3333444455556666777/SampleImg_normal.jpg",
"location": "Los Angeles",
"geoEnabled": false,
"profileBackgroundColor": -1,
"followRequestSent": false,
"following": false,
"notifications": false,
"profileBackgroundImageUrl": "",
"createdAt": "Fri Oct 09 13:42:35 +0000 2009",
"name": "Example Sports",
"profileSidebarBorderColor": -1,
"statusesCount": 21468,
"lang": "",
"contributorsEnabled": false,
"profileTextColor": -1,
"verified": true,
"profileImageUrl": "http://pbs.twimg.com/profile_images/3333444455556666777/SampleImg_normal.jpg",
"screenName": "ExampleSports",
"utcOffset": 0,
"profileBackgroundImageUrlHttps": "",
"profileUseBackgroundImage": false,
"profileLinkColor": -1,
"favouritesCount": 6949,
"description": "Official account of Example Sports Network - production company specializing in sports content.",
"friendsCount": 1953,
"isTranslator": false,
"defaultProfileImage": false,
"url": "https://t.co/ExampleSportsUrl"
},
"createdAt": "2025-07-01T11:02:37.604Z"
},
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T11:02:37Z",
"source": "system",
"title": "X Account Activity",
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint"
}
User Event
Revoke events when a user removes app authorization (subscription auto-deleted).Copy
Ask AI
{
"action": "accountActivity",
"code": 200,
"created": "2025-06-21T10:34:15Z",
"platform": "twitter",
"type": "accountActivity",
"userEvent": {
"revoke": {
"dateTime": "2025-06-21T10:34:15Z",
"target": {
"appId": "1234567890"
},
"source": {
"userId": "9999888877776666"
}
}
}
}
Direct Message Event
DM status for sent or received messages.Copy
Ask AI
{
"action": "accountActivity",
"code": 200,
"created": "2025-07-01T11:06:21Z",
"directMessageEvents": {
"type": "message_create",
"createdAt": "2025-07-01T11:06:21.247Z",
"id": "1234567890123456832",
"messageCreate": {
"target": {
"recipientId": "9876543210987654472"
},
"messageData": {
"entities": {
"hashtags": [],
"urls": [],
"symbols": [],
"userMentions": []
},
"text": "Yes"
},
"senderId": "1111222233334444555"
}
},
"hookId": "BCD890EFG123HIJ456KL",
"mediaUrls": [],
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T11:06:21Z",
"source": "system",
"title": "X Account Activity",
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint",
"users": {
"1111222233334444555": {
"verified": false,
"location": "New York, NY",
"profileImageUrl": "http://pbs.twimg.com/profile_images/2222333344445555666/example123_normal.jpg",
"followersCount": 1179,
"url": "https://t.co/ExampleCompanyUrl",
"screenName": "ExampleCompany",
"protected": false,
"createdTimestamp": "1496875880999",
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/2222333344445555666/example123_normal.jpg",
"friendsCount": 1015,
"id": "1111222233334444555",
"description": "A sample company description https://t.co/ExampleCompanyUrl",
"statusesCount": 2315,
"name": "EXAMPLE COMPANY"
},
"9876543210987654472": {
"friendsCount": 6,
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"profileImageUrl": "http://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"verified": false,
"location": "New York",
"id": "9876543210987654472",
"protected": false,
"followersCount": 27,
"name": "Example Business",
"description": "Sample business description for testing purposes. We make great products that people love and take just minutes to prepare!",
"statusesCount": 2475,
"screenName": "example_business",
"createdTimestamp": "1573572177562",
"url": "https://t.co/ExampleUrl123"
}
}
}
Direct Message Indicate Typing Event
DM typing event with user and target.Copy
Ask AI
{
"action": "accountActivity",
"code": 200,
"created": "2025-07-01T11:06:21Z",
"directMessageIndicateTypingEvents": {
"senderId": "1111222233334444555",
"createdAt": "2025-07-01T11:06:20.957Z",
"target": {
"recipientId": "9876543210987654472"
}
},
"hookId": "EFG123HIJ456KLM789NO",
"mediaUrls": [],
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T11:06:21Z",
"source": "system",
"title": "X Account Activity",
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint",
"users": {
"1111222233334444555": {
"location": "New York, NY",
"url": "https://t.co/ExampleCompanyUrl",
"protected": false,
"followersCount": 1179,
"statusesCount": 2315,
"name": "EXAMPLE COMPANY",
"profileImageUrl": "http://pbs.twimg.com/profile_images/2222333344445555666/example123_normal.jpg",
"screenName": "ExampleCompany",
"createdTimestamp": "1496875880999",
"id": "1111222233334444555",
"friendsCount": 1015,
"description": "A sample company description https://t.co/ExampleCompanyUrl",
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/2222333344445555666/example123_normal.jpg",
"verified": false
},
"9876543210987654472": {
"protected": false,
"location": "New York",
"statusesCount": 2475,
"description": "Sample business description for testing purposes. We make great products that people love and take just minutes to prepare!",
"name": "Example Business",
"profileImageUrl": "http://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"screenName": "example_business",
"id": "9876543210987654472",
"url": "https://t.co/ExampleUrl123",
"friendsCount": 6,
"followersCount": 27,
"verified": false,
"createdTimestamp": "1573572177562",
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png"
}
}
}
Direct Message Mark Read Event
DM read event with user and target.Copy
Ask AI
{
"action": "accountActivity",
"code": 200,
"created": "2025-07-01T11:07:01Z",
"directMessageMarkReadEvents": {
"createdAt": "2025-07-01T11:07:00.898Z",
"senderId": "5555666677778888520",
"target": {
"recipientId": "9876543210987654472"
},
"lastReadEventId": "1234567890123456781"
},
"hookId": "HIJ456KLM789NOP012QR",
"mediaUrls": [],
"platform": "twitter",
"refId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0",
"retryAttempt": 0,
"scheduleDate": "2025-07-01T11:07:01Z",
"source": "system",
"title": "X Account Activity",
"type": "accountActivity",
"url": "https://example.com/webhook-endpoint",
"users": {
"5555666677778888520": {
"followersCount": 2,
"verified": false,
"profileImageUrl": "http://pbs.twimg.com/profile_images/5555666677778888999/xyz789ab_normal.jpg",
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/5555666677778888999/xyz789ab_normal.jpg",
"screenName": "sample_user_123",
"id": "5555666677778888520",
"statusesCount": 84,
"createdTimestamp": "1736190305845",
"friendsCount": 11,
"protected": false,
"name": "sample_user"
},
"9876543210987654472": {
"location": "New York",
"verified": false,
"protected": false,
"createdTimestamp": "1573572177562",
"screenName": "example_business",
"url": "https://t.co/ExampleUrl123",
"profileImageUrl": "http://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1234567890123456789/abcd1234_normal.png",
"friendsCount": 6,
"name": "Example Business",
"followersCount": 27,
"id": "9876543210987654472",
"statusesCount": 2475,
"description": "Sample business description for testing purposes. We make great products that people love and take just minutes to prepare!"
}
}
}