Webhook アクション

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

{
  "account": {
    // Optional: identity of the linked social account. Sent for YouTube only today,
    // not for other platforms.
    "id": "UCxyz123", // Optional: the social network's own account id. For YouTube, the channel id
    "handle": "@socialdept", // Optional: the @ handle, present when the account has one, such as a YouTube custom URL
    "title": "The Social Dept.", // Optional: the social account's own title, such as the YouTube channel name
    "profileUrl": "https://www.youtube.com/@socialdept" // Optional: the public URL of the social account
  },
  "action": "social", // The action taken
  "created": "2023-01-05T01:18:47Z",
  "code": 200, // HTTP response code
  "details": {
    // Optional: sent on unlink, if details are available
    "status": "error",
    "code": 349,
    "message": "Account locked"
  },
  "displayName": "Google Account Name", // If a user account name is present at the social network
  "hookId": "TKLc30192HLGw5UeJ46",
  "platform": "youtube", // The social platform the action occurred on
  "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", // Optional: sent on unlink and refresh. Initiated by "system" or "user".
  "title": "User Profile Name", // The user profile's account title
  "type": "unlink", // Type of action: link, unlink, or refresh
  "url": "https://mysite.com/webhook" // Your webhook URL
}

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

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

{
  "action": "mentions",
  "subAction": "mention",
  "platform": "instagram",            // The social network the mention came from
  "postId": "TBAAAqAMMpoweA9wKHUp",   // Ayrshare post id; absent unless you published the post
  "media_id": "17900000000000000",    // Meta media the mention occurred on
  "comment_id": "17900000000000001",  // Present when the mention is in a comment
  "hookId": "dI3PNhrG83j2FzAFJqkb",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",  // User Reference ID
  "timeStamp": 1705010424,             // Present with Webhook Security
  "url": "https://api.myapp.com/Webhook/Ayrshare/Mentions"  // Your webhook URL
}

{
  "action": "comments",
  "subAction": "comment",
  "platform": "instagram",             // The social network the comment came from
  "postId": "TBAAAqAMMpoweA9wKHUp",    // Ayrshare post id; absent unless you published the post
  "id": "17900000000000002",           // Comment ID
  "text": "Great post!",
  "from": {
    "id": "1234567890",
    "username": "alice"
  },
  "media": {
    "id": "17900000000000000",         // ID of the commented media
    "media_product_type": "FEED"       // e.g. FEED, REELS, STORY
  },
  "hookId": "dI3PNhrG83j2FzAFJqkb",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",  // User Reference ID
  "timeStamp": 1705010424,             // Present with Webhook Security
  "url": "https://api.myapp.com/Webhook/Ayrshare/Comments"  // Your webhook URL
}

{
  "action": "automations",
  "type": "automation.triggered",
  "automationId": "a1B2c3D4",
  "triggerId": "t9X8y7Z6",
  "trigger": "comment_keyword",        // The trigger type that fired the automation (varies by automation)
  "platform": "instagram",
  "recipientId": "17841400000000000",
  "recipientUsername": "alice",        // null if unavailable
  "keyword": "INFO",                   // null if not keyword-triggered; the emoji for dm_reaction
  "activityId": "a1B2c3D4:t9X8y7Z6:comment.received:17912345678901234", // Matches the row in GET /automations/:id/activity
  "actionId": "act_wh_1",              // The fire_webhook action that sent this; matches actionResults[].actionId
  "eventId": "comment.received:17912345678901234",
  "commentId": "17912345678901234",    // null for DM-driven triggers
  "commentText": "INFO please",        // DM text for dm_keyword, the emoji for dm_reaction, null when there is none
  "postId": "17895695668004550",       // null unless the engagement was on a post or reel
  "storyId": null,                     // null unless the engagement was on a story
  "timestamp": "2026-05-27T22:00:30Z", // When the automation fired (ISO 8601)
  "hookId": "dI3PNhrG83j2FzAFJqkb",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",  // User Reference ID
  "timeStamp": 1705010424,             // Unix timestamp, present with Webhook Security
  "url": "https://api.myapp.com/Webhook/Ayrshare/Automations"  // Your webhook URL
}

{
  "action": "automations",
  "type": "automation.completed",
  "automationId": "a1B2c3D4",
  "triggerId": "t9X8y7Z6",
  "trigger": "comment_keyword",
  "platform": "instagram",
  "recipientId": "17841400000000000",
  "activityId": "a1B2c3D4:t9X8y7Z6:comment.received:17912345678901234", // Join key; matches automation.triggered when one was sent
  "eventId": "comment.received:17912345678901234",
  "status": "sent",                    // sent, failed, rate_limited, deduplicated, skipped, or auth_error
  "actionResults": [                   // Empty when rate_limited, deduplicated, or failed after the retry limit
    { "actionId": "act_dm_1", "type": "send_dm", "status": "sent", "errorDetails": null },
    { "actionId": "act_wh_1", "type": "fire_webhook", "status": "sent", "errorDetails": null }
  ],
  "errorDetails": null,                // Reason when skipped, rate_limited, or failed after the retry limit
  "timestamp": "2026-05-27T22:00:58Z",
  "hookId": "Kq2LmN8pR4tV6wXyZ1aB",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",
  "timeStamp": 1705010452,
  "url": "https://api.myapp.com/Webhook/Ayrshare/Automations"
}

{
  "action": "demo",
  "type": "upgradeWarning",
  "demoExpires": "2026-08-27T09:57:00.000Z",  // プロファイルが変換される日時 (ISO 8601)
  "daysUntilUpgrade": 2,
  "hookId": "dI3PNhrG83j2FzAFJqkb",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",  // User Reference ID
  "timeStamp": 1787734624,             // Unix タイムスタンプ (2026-08-26)、Webhook Security 有効時に含まれます
  "url": "https://api.myapp.com/Webhook/Ayrshare/Demo"  // Webhook URL
}

{
  "action": "demo",
  "type": "upgrade",
  "upgradedAt": "2026-08-28T08:57:04.000Z",  // プロファイルが変換された日時 (ISO 8601)
  "hookId": "dI3PNhrG83j2FzAFJqkb",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",  // User Reference ID
  "timeStamp": 1787907424,             // Unix タイムスタンプ (2026-08-28)、Webhook Security 有効時に含まれます
  "url": "https://api.myapp.com/Webhook/Ayrshare/Demo"  // Webhook URL
}

{
  "action": "suspended",
  "type": "suspend",
  "reason": "Confirm your identity before you can publish as this Page.", // プラットフォームまたは Ayrshare から報告される内容。利用できない場合は null
  "platform": "facebook",              // 停止をトリガーしたソーシャルネットワーク。プラットフォーム起因でない場合は null
  "origin": "policy",                  // プロファイルが停止された理由: policy、payment、rateLimit、manual、report、subscription のいずれか。利用できない場合は null
  "suspendedAt": "2026-08-13T20:31:41.128Z", // 停止が発生した日時 (ISO 8601)。利用できない場合は null
  "unsuspendAt": null,                 // 自動再有効化の予定日時 (ISO 8601)。既にわかっている場合に含まれます
  "hookId": "dI3PNhrG83j2FzAFJqkb",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",  // User Reference ID
  "timeStamp": 1786731101,             // Unix タイムスタンプ、Webhook Security 有効時に含まれます
  "url": "https://api.myapp.com/Webhook/Ayrshare/Suspended"  // Webhook URL
}

{
  "action": "suspended",
  "type": "unsuspend",
  "reason": null,
  "platform": null,
  "origin": null,
  "suspendedAt": null,
  "unsuspendAt": null,
  "hookId": "dI3PNhrG83j2FzAFJqkb",
  "refId": "9abf1426d6ce9122ef11c72bd62e59807c5cc083",  // User Reference ID
  "timeStamp": 1786988742,             // Unix タイムスタンプ、Webhook Security 有効時に含まれます
  "url": "https://api.myapp.com/Webhook/Ayrshare/Suspended"  // Webhook URL
}