instagram_basic, instagram_manage_messages, and pages_manage_metadata permissions| Webhook Field | Description |
|---|---|
message_reactions | A notification is sent when a customer reacts or unreacts to a message Graph API v12.0 and later supports angry, sad, wow, love, like, laugh, and other reactions. |
messages | A notification is sent when a customer sends your business:
A notification is also sent when your business sends a message to a customer. A notification will not be sent when your business reacts or unreacts to a customer message. This callback will occur when a message has been sent by your Instagram account. is_echo flag will be present to indicate that the message is sent from the Instagram account itself. message_reactions event will not have an echo webhook delivered |
messaging_postbacks | A notification is sent when a customer clicked an Icebreaker option or Generic Template button Requires v8.0 or later. Requires v11.0 or later for inclusion of the mid field. |
messaging_seen | A notification is sent when a message has been read by the recipient |
messaging_referral | A notification is sent when an ig.me link with a referral parameter is clicked by a customer in an existing conversation |
standby | When the messaging flow has multiple apps, a notification is sent when a customer sends your business a message but the app is not in control of the conversation at the time the message was sent. |
{
"object": "instagram",
"entry": [
{
"id": "IGID", // ID of your Instagram Professional account
"time": 1569262486134,
"messaging": [
{
"sender": { "id": "IGSID" }, // Instagram-scoped ID for the customer who sent the message
"recipient": { "id": "IGID" }, // ID of your Instagram Professional account
"timestamp": 1569262485349,
"message": {
"mid": "MESSAGE-ID", // ID of the message sent to your business
"text": "MESSAGE-TEXT" // Included when a customer sends a message containing text
"attachments": [ // Included when a customer sends multiple media attachments or a URL for a story mention or share
{
"type":"image", // Can be audio, file, image (image or sticker), share, story_mention, video, ig_reel or reel
"payload":{ "url":"LINK" }
},
{
"type":"video",
"payload":{ "url":"LINK" }
}
]
"is_deleted": true // Included when a customer deletes a message
"is_echo": true // Included when your business sends a message to the customer
"is_unsupported": true, // Included when a customer sends a message with unsupported media
"quick_reply": { // Included when a customer clicks a quick reply
"payload": "CUSTOMER-RESPONSE-PAYLOAD" // The payload with the option selected by the customer
},
"referral": { // Included when a customer clicks an Instagram Shop product
"product": {
"id": "PRODUCT-ID"
}
"referral": { // Included when a customer clicks an CTD ad
"ref": "REF-DATA-IN-AD-IF-SPECIFIED"
"ad_id": AD-ID,
"source": "ADS",
"type": "OPEN_THREAD",
"ads_context_data": {
"ad_title": TITLE-FOR-THE-AD,
"photo_url": IMAGE-URL-THAT-WAS-CLICKED,
"video_url": THUMBNAIL-URL-FOR-THE-AD-VIDEO,
}
}
"reply_to":{ // Included when a customer sends an inline reply
"mid":"MESSAGE-ID"
}
"reply_to": { // Included when a customer replies to a story
"story": {
"url":"CDN-URL",
"id":"STORY-ID"
}
}
}
}
]
}
]
}
{ "object": "instagram", "entry": [ { "id": "IGID", // ID for your Instagram Professional account "time": 1569262486134, "messaging": [ { "sender": { "id": "IGSID" // Instagram-scoped ID for the customer who sent the message }, "recipient": { "id": "IGID" // ID for your Instagram Professional account }, "timestamp": 1569262485349, "reaction" :{ "mid" : "MESSAGE-ID", "action": "react", // or unreact "reaction": "love", // optional, to unreact if there is no reaction field "emoji": "\u{2764}\u{FE0F}" // optional, to unreact if there is no emoji field } } ] } ] }
{ "object": "instagram", "entry": [ { "id": "IGSID", // ID of your Instagram Professional account "time": 1502905976963, "messaging": [ { "sender": { "id": "IGSID" }, // Instagram-scoped ID for the customer who sent the message "recipient": { "id": "IGID" }, // ID of your Instagram Professional account "timestamp": 1502905976377, "postback": { "mid":"MESSAGE-ID", // ID for the message sent to your business "title": "SELECTED-ICEBREAKER-REPLY-OR-CTA-BUTTON", "payload": "CUSTOMER-RESPONSE-PAYLOAD", // The payload with the option selected by the customer } } ] } ] }
{ "object": "instagram", "entry": [ { "id": "IGSID", // ID of your Instagram Professional account "time": 1502905976963, "messaging": [ { "sender": { "id": "IGSID" // Instagram-scoped ID for the customer who sent the message }, "recipient": { "id": "IGID" // ID of your Instagram Professional account }, "timestamp": 1502905976377, "referral": { "ref": "INFORMATION-INCLUDED-IN-REF-PARAMETER-OF-IGME-LINK" "source": "IGME-SOURCE-LINK" "type": "OPEN_THREAD" // Only supported for existing conversations } } ] } ] }
{ "object":"instagram", "entry":[ { "id":"IGID", // ID for your Instagram Professional account "time":1569262486134, "messaging":[ { "sender":{ "id":"IGSID" // Instagram-scoped ID for the customer who sent the message }, "recipient":{ "id":"IGID" // ID for your Instagram Professional account }, "timestamp":1569262485349, "read":{ "mid":"MESSAGE-ID" } } ] } ] }
{ "object": "instagram", "entry": [ { "id": "IGID", // ID of your Instagram Professional account "time": 1569262486134, "messaging": [ { "sender": { "id": "IGSID" }, // Instagram-scoped ID for the customer who sent the message "recipient": { "id": "IGID" }, // ID of your Instagram Professional account "timestamp": 1569262485349, "message": { "mid": "MESSAGE-ID", // ID of the message sent to your business "attachments": [ { "type":"ephemeral" // no URL is included for ephemeral media } ] } } ] } ] }