Webhook Actions

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.

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

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.

Scheduled Event

{
  "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
}

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 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.

Notification when a user’s profile links or unlinks a social network.

{
  "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.

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.

{
  "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.

{
  "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
}

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.

Reaction Created and Deleted Events

Notification when a reaction, such as a like, is created or deleted on a message.

{
  "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 the url field.

Batch Event

{
  "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

{
    "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
}

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 the xAccountActivityActive parameter to true when updating your profile via the Update Profile API.

Active X Account Activity

{
  "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.

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "hookId": "nN9Ph2NtDSMy3fkYsGQB",
  "mediaUrls": [],
  "platform": "twitter",
  "refId": "870bdf66bc796f244626925fa7ce64dedb3febdd",
  "retryAttempt": 0,
  "scheduleDate": "2025-06-21T10:34:15Z",
  "source": "system",
  "title": "X Activity Account 8",
  "type": "accountActivity",
  "url": "https://your-webhook-endpoint.com/webhook",
  "forUserId": "1194274338779881472",
  "tweetCreateEvents": [
    {
      "source": "<a href=\"https://www.ayrshare.com\" rel=\"nofollow\">Ayrshare</a>",
      "truncated": true,
      "filterLevel": "low",
      "editControls": {
        "editsRemaining": 5,
        "editableUntilMs": 1750505654000
      },
      "extendedTweet": {
        "entities": {
          "symbols": [],
          "hashtags": [],
          "userMentions": [],
          "urls": []
        },
        "displayTextRange": [0, 155],
        "fullText": "#24861 If you look at what you have in life, you'll always have more. If you look at what you don't have in life, you'll never have enough. - Oprah Winfrey"
      },
      "entities": {
        "urls": [
          {
            "url": "https://t.co/rAwYbklseM",
            "displayUrl": "twitter.com/i/web/status/1…",
            "indices": [117, 140],
            "expandedUrl": "https://twitter.com/i/web/status/1936372080158646764"
          }
        ],
        "hashtags": [],
        "userMentions": [],
        "symbols": []
      },
      "inReplyToStatusIdStr": "1936372004803727431",
      "replyCount": 0,
      "retweetCount": 0,
      "text": "#24861 If you look at what you have in life, you'll always have more. If you look at what you don't have in life, y… https://t.co/rAwYbklseM",
      "retweeted": false,
      "createdAt": "2025-06-21T10:34:14.000Z",
      "id": 1936372080158646800,
      "favorited": false,
      "editHistory": {
        "editTweetIds": ["1936372080158646764"],
        "initialTweetId": "1936372080158646764"
      },
      "idStr": "1936372080158646764",
      "inReplyToUserId": 1194274338779881500,
      "inReplyToStatusId": 1936372004803727400,
      "quoteCount": 0,
      "lang": "en",
      "isQuoteStatus": false,
      "user": {
        "statusesCount": 2476,
        "friendsCount": 6,
        "createdAt": "Tue Nov 12 15:22:57 +0000 2019",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 45,
        "profileTextColor": "333333",
        "name": "wondrouswaffles",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/1194274338779881472/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.wondrouswaffles.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 27,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 1194274338779881500,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "NYC",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "wondrouswaffles",
        "description": "Tired of those frozen waffles for the kids? We're parents too and they just need to go! Wondrous Waffles are healthy, delicious, and take 1 minute to make.",
        "translatorType": "none",
        "idStr": "1194274338779881472",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      },
      "inReplyToScreenName": "wondrouswaffles",
      "editable": false,
      "favoriteCount": 0,
      "inReplyToUserIdStr": "1194274338779881472"
    }
  ]
}

For @mentions, an additional field userHasBlocked may be present at the top level:

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "forUserId": "1194274338779881472",
  "userHasBlocked": false,
  "tweetCreateEvents": [
    {
      // Tweet object with mention data
    }
  ]
}

Favorite Event

Like event with user and target.

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "forUserId": "1194274338779881472",
  "favoriteEvents": [
    {
      "id": "a7ba59eab0bfcba386f7acedac279542",
      "createdAt": "2025-06-21T10:34:14.000Z",
      "timestampMs": 1719837255000,
      "favoritedStatus": {
        // Tweet object that was favorited
        "id": 1936372080158646800,
        "idStr": "1936372080158646764",
        "text": "Tweet that was favorited...",
        "createdAt": "2025-06-21T10:34:14.000Z",
        "user": {
          "id": 1194274338779881500,
          "idStr": "1194274338779881472",
          "name": "Account Name",
          "screenName": "account_username"
        }
      },
      "user": {
        // User who performed the favorite
        "statusesCount": 2476,
        "friendsCount": 6,
        "createdAt": "Tue Nov 12 15:22:57 +0000 2019",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 45,
        "profileTextColor": "333333",
        "name": "User Name",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/987654321/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.example.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 100,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 987654321,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "NYC",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "username",
        "description": "User description here",
        "translatorType": "none",
        "idStr": "987654321",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      }
    }
  ]
}

Follow Event

Follow event with user and target.

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "forUserId": "1194274338779881472",
  "followEvents": [
    {
      "type": "follow",
      "createdTimestamp": "1719837255000",
      "source": {
        "statusesCount": 500,
        "friendsCount": 50,
        "createdAt": "Mon Jan 01 12:00:00 +0000 2020",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 25,
        "profileTextColor": "333333",
        "name": "Follower Name",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/123456789/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.follower.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 100,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 123456789,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "San Francisco",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "follower_username",
        "description": "Follower account description",
        "translatorType": "none",
        "idStr": "123456789",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      },
      "target": {
        "statusesCount": 1000,
        "friendsCount": 75,
        "createdAt": "Wed Feb 01 15:30:00 +0000 2020",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 50,
        "profileTextColor": "333333",
        "name": "Followed User",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/987654321/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.followed.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 200,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 987654321,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "Los Angeles",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "followed_username",
        "description": "Followed user account description",
        "translatorType": "none",
        "idStr": "987654321",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      }
    }
  ]
}

Unfollow Event

Unfollow event with user and target.

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "forUserId": "1194274338779881472",
  "unfollowEvents": [
    {
      "type": "unfollow",
      "createdTimestamp": "1719837255000",
      "source": {
        "statusesCount": 750,
        "friendsCount": 80,
        "createdAt": "Thu Mar 15 09:00:00 +0000 2020",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 30,
        "profileTextColor": "333333",
        "name": "User Name",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/123456789/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.user.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 150,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 123456789,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "Seattle",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "username",
        "description": "User account description",
        "translatorType": "none",
        "idStr": "123456789",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      },
      "target": {
        "statusesCount": 800,
        "friendsCount": 90,
        "createdAt": "Fri Apr 20 14:45:00 +0000 2020",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 40,
        "profileTextColor": "333333",
        "name": "Unfollowed User",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/987654321/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.unfollowed.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 180,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 987654321,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "Portland",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "unfollowed_username",
        "description": "Unfollowed user account description",
        "translatorType": "none",
        "idStr": "987654321",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      }
    }
  ]
}

Block Event

Block event with user and target.

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "forUserId": "1194274338779881472",
  "blockEvents": [
    {
      "type": "block",
      "createdTimestamp": "1719837255000",
      "source": {
        "statusesCount": 600,
        "friendsCount": 45,
        "createdAt": "Sat May 10 11:20:00 +0000 2020",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 20,
        "profileTextColor": "333333",
        "name": "Blocker Name",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/123456789/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.blocker.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 120,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 123456789,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "Austin",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "blocker_username",
        "description": "Blocker account description",
        "translatorType": "none",
        "idStr": "123456789",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      },
      "target": {
        "statusesCount": 400,
        "friendsCount": 30,
        "createdAt": "Sun Jun 05 16:30:00 +0000 2020",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 15,
        "profileTextColor": "333333",
        "name": "Blocked User",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/987654321/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.blocked.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 80,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 987654321,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "Denver",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "blocked_username",
        "description": "Blocked user account description",
        "translatorType": "none",
        "idStr": "987654321",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      }
    }
  ]
}

Unblock Event

Unblock event with user and target.

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "forUserId": "1194274338779881472",
  "unblockEvents": [
    {
      "type": "unblock",
      "createdTimestamp": "1719837255000",
      "source": {
        "statusesCount": 550,
        "friendsCount": 65,
        "createdAt": "Mon Jul 01 13:15:00 +0000 2020",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 35,
        "profileTextColor": "333333",
        "name": "User Name",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/123456789/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.user.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 140,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 123456789,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "Phoenix",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "username",
        "description": "User account description",
        "translatorType": "none",
        "idStr": "123456789",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      },
      "target": {
        "statusesCount": 350,
        "friendsCount": 25,
        "createdAt": "Tue Aug 10 10:45:00 +0000 2020",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 10,
        "profileTextColor": "333333",
        "name": "Unblocked User",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/987654321/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.unblocked.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 90,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 987654321,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "Miami",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "unblocked_username",
        "description": "Unblocked user account description",
        "translatorType": "none",
        "idStr": "987654321",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      }
    }
  ]
}

Mute Event

Mute event with user and target.

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "forUserId": "1194274338779881472",
  "muteEvents": [
    {
      "type": "mute",
      "createdTimestamp": "1719837255000",
      "source": {
        "statusesCount": 480,
        "friendsCount": 55,
        "createdAt": "Wed Sep 15 08:30:00 +0000 2020",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 28,
        "profileTextColor": "333333",
        "name": "User Name",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/123456789/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.user.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 110,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 123456789,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "Boston",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "username",
        "description": "User account description",
        "translatorType": "none",
        "idStr": "123456789",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      },
      "target": {
        "statusesCount": 320,
        "friendsCount": 40,
        "createdAt": "Thu Oct 22 12:00:00 +0000 2020",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 18,
        "profileTextColor": "333333",
        "name": "Muted User",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/987654321/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.muted.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 85,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 987654321,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "Chicago",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "muted_username",
        "description": "Muted user account description",
        "translatorType": "none",
        "idStr": "987654321",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      }
    }
  ]
}

Unmute Event

Unmute event with user and target.

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "forUserId": "1194274338779881472",
  "unmuteEvents": [
    {
      "type": "unmute",
      "createdTimestamp": "1719837255000",
      "source": {
        "statusesCount": 650,
        "friendsCount": 70,
        "createdAt": "Fri Nov 12 14:20:00 +0000 2020",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 32,
        "profileTextColor": "333333",
        "name": "User Name",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/123456789/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.user.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 160,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 123456789,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "Dallas",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "username",
        "description": "User account description",
        "translatorType": "none",
        "idStr": "123456789",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      },
      "target": {
        "statusesCount": 420,
        "friendsCount": 35,
        "createdAt": "Sat Dec 05 17:45:00 +0000 2020",
        "profileSidebarBorderColor": "C0DEED",
        "protected": false,
        "geoEnabled": false,
        "favouritesCount": 22,
        "profileTextColor": "333333",
        "name": "Unmuted User",
        "profileBannerUrl": "https://pbs.twimg.com/profile_banners/987654321/1573572462",
        "profileBackgroundImageUrlHttps": "",
        "isTranslator": false,
        "verifiedType": "none",
        "url": "https://www.unmuted.com/",
        "profileBackgroundImageUrl": "",
        "profileSidebarFillColor": "DDEEF6",
        "followersCount": 95,
        "profileBackgroundTile": false,
        "withheldInCountries": [],
        "profileUseBackgroundImage": true,
        "profileLinkColor": "1DA1F2",
        "id": 987654321,
        "defaultProfileImage": false,
        "defaultProfile": true,
        "location": "Atlanta",
        "contributorsEnabled": false,
        "verified": false,
        "profileBackgroundColor": "F5F8FA",
        "screenName": "unmuted_username",
        "description": "Unmuted user account description",
        "translatorType": "none",
        "idStr": "987654321",
        "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
        "listedCount": 0,
        "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
      }
    }
  ]
}

User Event

Revoke events when a user removes app authorization (subscription auto-deleted).

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "userEvent": {
    "revoke": {
      "dateTime": "2025-06-21T10:34:15Z",
      "target": {
        "appId": "13090192"
      },
      "source": {
        "userId": "63046977"
      }
    }
  }
}

Direct Message Event

DM status for sent or received messages.

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "forUserId": "1194274338779881472",
  "directMessageEvents": [
    {
      "type": "messageCreate",
      "id": "954491830116155396",
      "createdTimestamp": "1719837255000",
      "messageCreate": {
        "target": {
          "recipientId": "1194274338779881472"
        },
        "senderId": "3001969357",
        "sourceAppId": "13090192",
        "messageData": {
          "text": "Hello World!",
          "entities": {
            "hashtags": [],
            "symbols": [],
            "userMentions": [],
            "urls": []
          }
        }
      }
    }
  ],
  "apps": {
    "13090192": {
      "id": "13090192",
      "name": "Ayrshare",
      "url": "https://www.ayrshare.com"
    }
  },
  "users": {
    "3001969357": {
      "statusesCount": 500,
      "friendsCount": 50,
      "createdAt": "Wed Jan 28 15:22:57 +0000 2015",
      "profileSidebarBorderColor": "C0DEED",
      "protected": false,
      "geoEnabled": false,
      "favouritesCount": 35,
      "profileTextColor": "333333",
      "name": "User Name",
      "profileBannerUrl": "https://pbs.twimg.com/profile_banners/3001969357/1573572462",
      "profileBackgroundImageUrlHttps": "",
      "isTranslator": false,
      "verifiedType": "none",
      "url": "https://www.user.com/",
      "profileBackgroundImageUrl": "",
      "profileSidebarFillColor": "DDEEF6",
      "followersCount": 100,
      "profileBackgroundTile": false,
      "withheldInCountries": [],
      "profileUseBackgroundImage": true,
      "profileLinkColor": "1DA1F2",
      "id": 3001969357,
      "defaultProfileImage": false,
      "defaultProfile": true,
      "location": "NYC",
      "contributorsEnabled": false,
      "verified": false,
      "profileBackgroundColor": "F5F8FA",
      "screenName": "username",
      "description": "User description",
      "translatorType": "none",
      "idStr": "3001969357",
      "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
      "listedCount": 0,
      "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
    }
  }
}

Direct Message Indicate Typing Event

DM typing event with user and target.

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "forUserId": "1194274338779881472",
  "directMessageIndicateTypingEvents": [
    {
      "createdTimestamp": "1719837255000",
      "senderId": "3284025577",
      "target": {
        "recipientId": "3001969357"
      }
    }
  ],
  "users": {
    "3001969357": {
      "statusesCount": 509,
      "friendsCount": 47,
      "createdAt": "Wed Jan 28 15:22:57 +0000 2015",
      "profileSidebarBorderColor": "C0DEED",
      "protected": false,
      "geoEnabled": false,
      "favouritesCount": 23,
      "profileTextColor": "333333",
      "name": "User Name",
      "profileBannerUrl": "https://pbs.twimg.com/profile_banners/3001969357/1573572462",
      "profileBackgroundImageUrlHttps": "",
      "isTranslator": false,
      "verifiedType": "none",
      "url": "https://www.user.com/",
      "profileBackgroundImageUrl": "",
      "profileSidebarFillColor": "DDEEF6",
      "followersCount": 100,
      "profileBackgroundTile": false,
      "withheldInCountries": [],
      "profileUseBackgroundImage": true,
      "profileLinkColor": "1DA1F2",
      "id": 3001969357,
      "defaultProfileImage": false,
      "defaultProfile": true,
      "location": "NYC",
      "contributorsEnabled": false,
      "verified": false,
      "profileBackgroundColor": "F5F8FA",
      "screenName": "username",
      "description": "User description",
      "translatorType": "none",
      "idStr": "3001969357",
      "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
      "listedCount": 0,
      "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
    },
    "3284025577": {
      "statusesCount": 100,
      "friendsCount": 20,
      "createdAt": "Fri Jul 17 08:32:56 +0000 2015",
      "profileSidebarBorderColor": "C0DEED",
      "protected": false,
      "geoEnabled": false,
      "favouritesCount": 5,
      "profileTextColor": "333333",
      "name": "Sender Name",
      "profileBannerUrl": "https://pbs.twimg.com/profile_banners/3284025577/1573572462",
      "profileBackgroundImageUrlHttps": "",
      "isTranslator": false,
      "verifiedType": "none",
      "url": "https://www.sender.com/",
      "profileBackgroundImageUrl": "",
      "profileSidebarFillColor": "DDEEF6",
      "followersCount": 10,
      "profileBackgroundTile": false,
      "withheldInCountries": [],
      "profileUseBackgroundImage": true,
      "profileLinkColor": "1DA1F2",
      "id": 3284025577,
      "defaultProfileImage": false,
      "defaultProfile": true,
      "location": "LA",
      "contributorsEnabled": false,
      "verified": false,
      "profileBackgroundColor": "F5F8FA",
      "screenName": "sender_username",
      "description": "Sender account description",
      "translatorType": "none",
      "idStr": "3284025577",
      "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
      "listedCount": 0,
      "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
    }
  }
}

Direct Message Mark Read Event

DM read event with user and target.

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "forUserId": "1194274338779881472",
  "directMessageMarkReadEvents": [
    {
      "createdTimestamp": "1719837255000",
      "senderId": "199566737",
      "target": {
        "recipientId": "3001969357"
      },
      "lastReadEventId": "963085315333238788"
    }
  ],
  "users": {
    "199566737": {
      "statusesCount": 752,
      "friendsCount": 336,
      "createdAt": "Mon Oct 04 16:36:28 +0000 2010",
      "profileSidebarBorderColor": "C0DEED",
      "protected": false,
      "geoEnabled": false,
      "favouritesCount": 45,
      "profileTextColor": "333333",
      "name": "Reader Name",
      "profileBannerUrl": "https://pbs.twimg.com/profile_banners/199566737/1573572462",
      "profileBackgroundImageUrlHttps": "",
      "isTranslator": false,
      "verifiedType": "none",
      "url": "https://www.reader.com/",
      "profileBackgroundImageUrl": "",
      "profileSidebarFillColor": "DDEEF6",
      "followersCount": 299,
      "profileBackgroundTile": false,
      "withheldInCountries": [],
      "profileUseBackgroundImage": true,
      "profileLinkColor": "1DA1F2",
      "id": 199566737,
      "defaultProfileImage": false,
      "defaultProfile": true,
      "location": "Denver, CO",
      "contributorsEnabled": false,
      "verified": false,
      "profileBackgroundColor": "F5F8FA",
      "screenName": "reader_username",
      "description": "Reader account description",
      "translatorType": "none",
      "idStr": "199566737",
      "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
      "listedCount": 0,
      "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
    },
    "3001969357": {
      "statusesCount": 509,
      "friendsCount": 47,
      "createdAt": "Wed Jan 28 15:22:57 +0000 2015",
      "profileSidebarBorderColor": "C0DEED",
      "protected": false,
      "geoEnabled": false,
      "favouritesCount": 23,
      "profileTextColor": "333333",
      "name": "Target Name",
      "profileBannerUrl": "https://pbs.twimg.com/profile_banners/3001969357/1573572462",
      "profileBackgroundImageUrlHttps": "",
      "isTranslator": false,
      "verifiedType": "none",
      "url": "https://www.target.com/",
      "profileBackgroundImageUrl": "",
      "profileSidebarFillColor": "DDEEF6",
      "followersCount": 23,
      "profileBackgroundTile": false,
      "withheldInCountries": [],
      "profileUseBackgroundImage": true,
      "profileLinkColor": "1DA1F2",
      "id": 3001969357,
      "defaultProfileImage": false,
      "defaultProfile": true,
      "location": "Boulder, CO",
      "contributorsEnabled": false,
      "verified": false,
      "profileBackgroundColor": "F5F8FA",
      "screenName": "target_username",
      "description": "Target account description",
      "translatorType": "none",
      "idStr": "3001969357",
      "profileImageUrlHttps": "https://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png",
      "listedCount": 0,
      "profileImageUrl": "http://pbs.twimg.com/profile_images/1194274436456894464/lvQZPpt4_normal.png"
    }
  }
}

Tweet Delete Event

Notice of deleted Posts for compliance.

{
  "action": "accountActivity",
  "code": 200,
  "created": "2025-06-21T10:34:15Z",
  "platform": "twitter",
  "type": "accountActivity",
  "forUserId": "1194274338779881472",
  "tweetDeleteEvents": [
    {
      "status": {
        "id": 1936372080158646800,
        "idStr": "1936372080158646764",
        "userId": 1194274338779881500,
        "userIdStr": "1194274338779881472"
      },
      "timestampMs": "1719837255000"
    }
  ]
}

Get Started

API Endpoints

Multiple Users

Dashboard

Additional

Scheduled Action

Scheduled Event

TikTok Publishing Webhook

Messages Action

New Message Events

Message Read Event

Reaction Created and Deleted Events

Batch Action

Batch Event

Feed Action

Feed Event

Account Activity Action

Tweet Create Event

Favorite Event

Follow Event

Unfollow Event

Block Event

Unblock Event

Mute Event

Unmute Event

User Event

Direct Message Event

Direct Message Indicate Typing Event

Direct Message Mark Read Event

Tweet Delete Event

Get Started

API Endpoints

Multiple Users

Dashboard

Additional

​Scheduled Action

​Scheduled Event

​TikTok Publishing Webhook

​Social Action

​Social Action Event

​Messages Action

​New Message Events

​Message Read Event

​Reaction Created and Deleted Events

​Batch Action

​Batch Event

​Feed Action

​Feed Event

​Account Activity Action

​Tweet Create Event

​Favorite Event

​Follow Event

​Unfollow Event

​Block Event

​Unblock Event

​Mute Event

​Unmute Event

​User Event

​Direct Message Event

​Direct Message Indicate Typing Event

​Direct Message Mark Read Event

​Tweet Delete Event

Scheduled Action

Scheduled Event

TikTok Publishing Webhook

Social Action

Social Action Event

Messages Action

New Message Events

Message Read Event

Reaction Created and Deleted Events

Batch Action

Batch Event

Feed Action

Feed Event

Account Activity Action

Tweet Create Event

Favorite Event

Follow Event

Unfollow Event

Block Event

Unblock Event

Mute Event

Unmute Event

User Event

Direct Message Event

Direct Message Indicate Typing Event

Direct Message Mark Read Event

Tweet Delete Event