Actions des webhooks - Ayrshare API Documentation

Il existe plusieurs types de webhooks disponibles, catégorisés par type d’action. Par exemple, une publication programmée déclenchera un webhook d’action scheduled. Veuillez consulter la vue d’ensemble des webhooks pour plus de détails. Après avoir enregistré une URL de webhook, vous recevrez une requête POST à votre URL lorsqu’un événement se produit. La requête POST inclura une charge utile JSON avec les détails de l’événement.

Action Scheduled

Vous recevrez cette notification de webhook lorsqu’une publication programmée est traitée — qu’elle réussisse ou échoue — et publiée sur les réseaux sociaux sélectionnés. Par exemple, si vous programmez une publication pour 12h00 le 1er août 2026, le webhook sera envoyé à l’heure exacte à laquelle la publication est publiée. Les notifications de webhook ne sont envoyées que pour les publications programmées dans le futur à l’aide du champ scheduleDate dans le point de terminaison /post.

Événement Scheduled

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

Vous ne recevrez pas de notification de webhook pour les publications immédiates, car l’API retourne la réponse de succès ou d’échec instantanément dans la réponse JSON. Les notifications de webhook ne sont envoyées que pour les publications programmées, car celles-ci sont traitées de manière asynchrone et nécessitent une notification séparée pour vous informer de leur statut.

Webhook de publication TikTok

Lorsque vous travaillez avec TikTok via Ayrshare, vous pouvez recevoir deux webhooks différents pour une publication programmée. Si votre publication a été programmée plutôt qu’immédiate, vous recevrez d’abord le webhook Scheduled Action standard. Cela indique que le média a été envoyé avec succès à TikTok pour traitement et publication. Par la suite, vous recevrez le webhook subAction: tikTokPublished. Il est déclenché une fois que TikTok a terminé le traitement du média et que le média est rendu public. Ce webhook est activé à la fois pour les publications immédiates et les publications programmées. Dans le tableau de bord Ayrshare, cet événement est étiqueté tikTok (pub).

Le webhook tikTokPublished n’est pas envoyé tant que le média n’est pas rendu public. Si le média est défini sur private, followers ou friends, le webhook ne sera pas envoyé.Si vous ne recevez pas le webhook tikTokPublished et que le statut de la publication reste pending, vérifiez l’application mobile TikTok pour vous assurer que le média a été accepté par TikTok.

Notification lorsque le profil d’un utilisateur lie ou délie un réseau social.

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

Une source de system signifie qu’Ayrshare a automatiquement délié le compte, par exemple lorsque la connexion au réseau social n’est plus valide. Nous vous recommandons de notifier votre utilisateur afin qu’il puisse continuer à publier. Les détails du déliage se trouvent dans le champ details. Un e-mail sera également envoyé à l’adresse e-mail du compte principal, ou aux e-mails alternatifs s’ils ont été configurés. Une source de user signifie que l’utilisateur a lancé l’action lui-même, par exemple qu’il a manuellement délié un compte. Aucun e-mail ne sera envoyé lorsqu’une action initiée par l’utilisateur se produit.

Action Messages

Le module complémentaire de messagerie est requis pour accéder à tous les points de terminaison et webhooks de messages. Notification lorsqu’un nouveau message direct arrive, est lu par l’utilisateur, ou lorsqu’une réaction est créée ou supprimée sur un message pour Facebook et Instagram uniquement. Les webhooks X/Twitter sont disponibles en option pour les clients Enterprise. Veuillez contacter votre représentant de compte pour plus d’informations sur la manière de devenir client Enterprise.

Couverture standby pour les pages Facebook avec plusieurs applications

Ayrshare s’abonne au champ webhook standby de Facebook en plus des champs de messagerie standard. Cela signifie que les événements Messenger sont livrés à votre webhook même lorsqu’une autre application sur la même page Facebook détient actuellement le contrôle de la conversation — par exemple, lorsqu’une plateforme de chatbot est définie comme récepteur principal de votre page, ou lorsque la boîte de réception Page de Meta traite activement une conversation. Il n’y a pas de changement de schéma pour ces événements. Ils arrivent sous les mêmes charges utiles messageCreated / messageRead / reactionCreated / messageEdited documentées dans les sections ci-dessous. Deux choses à savoir pour les pages avec une application Messenger concurrente installée :

Le volume de messages entrants peut augmenter par rapport au comportement précédent, où les événements standby étaient silencieusement ignorés avant l’abonnement. Le nouveau trafic représente les messages que votre page a reçus qui étaient traités par l’autre application.
Vous pouvez recevoir des événements messageCreated avec type: "sent" qui ne correspondent pas à des messages que vous avez envoyés via Ayrshare. Il s’agit d’échos de messages envoyés par l’autre application Messenger sur votre page (Meta livre une copie de chaque envoi à chaque application abonnée). Si votre intégration réconcilie le trafic sortant avec votre propre historique d’envoi, vous pouvez utiliser cet historique pour distinguer vos envois de ceux d’une application concurrente.

Pour les pages avec uniquement Ayrshare installé (pas d’application Messenger concurrente), le seul changement observable est le nouvel événement Message Edit — tout le reste semble identique au comportement précédent.

Nouveaux événements de message

Notification lorsqu’un nouveau message est envoyé ou reçu.

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

{
  "action": "messages",
  "conversationId": "aWdfZAG06MTpJR01lc3NhZA2VUaHJlYWQ6MTc4",
  "created": "2024-06-07T11:58:44Z",
  "hookId": "JC6IgqFjvDliTJ8MLqzE",
  "id": "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDUyMjEyNzA",
  "mediaUrls": [],
  "message": "This is an amazing message",
  "platform": "instagram",
  "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
}

Événement de lecture de message

Notification lorsqu’un message est lu par le destinataire.

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

{
  "action": "messages",
  "conversationId": "t_10161117434308938",
  "created": "2024-06-08T23:33:30Z",
  "hookId": "CviPBMXEy3cdJnK0EESd",
  "platform": "instagram",
  "read": {
    "mid": "aWdfZAG1faXRlbToxOkl" // Instagram message ID
  },
  "readerDetails": {
    "name": "John Smith",
    "id": "7101149746568444",
    "picture": "https://platform-lookaside.fbsbx.com/platform/profilepic",
    "username": "johnsmith"
  },
  "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
}

Lorsqu’un message est lu sur Instagram, la charge utile du webhook inclut un champ mid qui identifie de manière unique le message spécifique lu. Pour les messages Facebook, les lectures de messages sont suivies au niveau de la conversation à l’aide du conversationId. Lorsqu’un événement de lecture se produit, tous les messages de cette conversation avec des horodatages antérieurs à l’horodatage created (ou read) doivent être considérés comme lus par l’utilisateur.

Événements de création et suppression de réaction

Notification lorsqu’une réaction, telle qu’un « j’aime », est créée ou supprimée sur un 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
}

{
  "action": "messages",
  "conversationId": "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEO",
  "created": "2024-06-06T00:49:18Z",
  "hookId": "LcgLuXzZki15lqBNt69h",
  "mediaUrls": [],
  "platform": "instagram",
  "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
}

Événement de modification de message

Notification lorsqu’un utilisateur modifie un message qu’il a précédemment envoyé. Disponible pour les messages directs Facebook et Instagram. Le champ messageEdit.mid correspond à l’id de l’événement messageCreated original, afin que les consommateurs puissent corréler la modification avec le message d’origine. Le champ messageEdit.text contient le texte du message modifié.

{
  "action": "messages",
  "conversationId": "t_10161117434308936",
  "created": "2024-06-06T00:49:18Z",
  "hookId": "LcgLuXzZki15lqBNt69h",
  "id": "m_xyz...",                    // Message ID — matches the original messageCreated event
  "messageEdit": {
    "mid": "m_xyz...",
    "text": "the edited message text"
  },
  "platform": "facebook",
  "recipientId": "106638148652444",
  "refId": "9abf1426d6ce9432",
  "senderId": "7101149746568444",
  "subAction": "messageEdited",
  "timeStamp": 1717634958,              // Present if Webhook Security enabled
  "title": "Primary Profile",
  "type": "edit",
  "url": "https://mysite.com/webhook"   // Your webhook URL
}

{
  "action": "messages",
  "conversationId": "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEO",
  "created": "2024-06-06T00:49:18Z",
  "hookId": "LcgLuXzZki15lqBNt69h",
  "id": "aWdfZAG1faXRlbToxOkl",
  "messageEdit": {
    "mid": "aWdfZAG1faXRlbToxOkl",
    "text": "the edited message text"
  },
  "platform": "instagram",
  "recipientId": "106638148652444",
  "refId": "9abf1426d6ce9432",
  "senderId": "7101149746568444",
  "subAction": "messageEdited",
  "timeStamp": 1717634958,              // Present if Webhook Security enabled
  "title": "Primary Profile",
  "type": "edit",
  "url": "https://mysite.com/webhook"   // Your webhook URL
}

Action Batch

Notification lorsqu’un lot a terminé son traitement et que le fichier est disponible, par exemple obtenir tous les profils d’utilisateur. Vous pouvez accéder au fichier avec l’URL pré-signée dans le champ url.

Événement Batch

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

Notification lorsqu’un nouvel élément de flux RSS est trouvé pour les flux RSS enregistrés. Remarque : si le webhook est actif, les nouveaux éléments RSS ne seront pas automatiquement publiés sur les réseaux sociaux.

Événement Feed

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

Notification lorsque votre compte connecté est mentionné. Disponible pour Facebook et Instagram. Ayrshare relaie la charge utile de mention native de Meta sans modification, en n’ajoutant que les champs d’enveloppe standard (action, refId, hookId, url et timeStamp avec la sécurité des webhooks) et subAction. L’exemple ci-dessous est la forme Instagram : media_id, plus comment_id lorsque la mention est dans un commentaire. Les mentions Facebook arrivent sous la forme du changement mention natif de la page Meta, dont les champs diffèrent de l’exemple Instagram ; consultez la référence des webhooks de Meta pour l’ensemble de champs Facebook.

Événement Mention (Instagram)

{
  "action": "mentions",
  "subAction": "mention",
  "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

Notification lorsqu’un commentaire est créé sur votre contenu connecté. Disponible pour Facebook et Instagram. Ayrshare relaie la charge utile de commentaire native de Meta sans modification, en n’ajoutant que les champs d’enveloppe standard (action, refId, hookId, url et timeStamp avec la sécurité des webhooks) et subAction. L’exemple ci-dessous est la forme Instagram. Les commentaires Facebook arrivent sous la forme d’un changement feed de la page avec des noms de champ différents (par exemple comment_id, post_id, message et from.name) ; consultez la référence des webhooks de Meta pour l’ensemble de champs Facebook.

Événement Comment (Instagram)

{
  "action": "comments",
  "subAction": "comment",
  "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

Notification lorsqu’une automatisation déclenche une action de webhook pour un utilisateur, par exemple un déclencheur de réponse automatique à un commentaire ou à un DM.

Événement Automation

{
  "action": "automations",
  "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
  "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 Scheduled

​Événement Scheduled

​Webhook de publication TikTok

​Action Social

​Événement Social Action

​Action Messages

​Couverture standby pour les pages Facebook avec plusieurs applications

​Nouveaux événements de message

​Événement de lecture de message

​Événements de création et suppression de réaction

​Événement de modification de message

​Action Batch

​Événement Batch

​Action Feed

​Événement Feed

​Action Mentions

​Événement Mention (Instagram)

​Action Comments

​Événement Comment (Instagram)

​Action Automations

​Événement Automation

Action Scheduled

Événement Scheduled

Webhook de publication TikTok

Action Social

Événement Social Action

Action Messages

Couverture standby pour les pages Facebook avec plusieurs applications

Nouveaux événements de message

Événement de lecture de message

Événements de création et suppression de réaction

Événement de modification de message

Action Batch

Événement Batch

Action Feed

Événement Feed

Action Mentions

Événement Mention (Instagram)

Action Comments

Événement Comment (Instagram)

Action Automations

Événement Automation