Accessing Comments in Engagements API

SOLVE
Highlighted
Regular Contributor

Hi,

 

Is it possible to GET comments specifically for meetings via the Engagements API.

We've been looking into the best method for logging post meeting notes and it appears the only suitable way is through comments but now I am unable to identify from the docs that this can be retrieved via the API.

 

Thanks

Paul

Reply
0 Upvotes
1 Accepted solution

Accepted Solutions
Solution
HubSpot Moderator

Hi @PaulAlmond91 

 

As the comments added via a Meeting engagement cannot be fetched via the API, we use the Notes engagement instead to record these.

 

However, these engagements do not have any means of being directly associated by a relationship such as: Engagement - Engagement. 

 

To your point, you're correct. This does indeed create a note and a meeting engagement without any pairing method currently. Instead the recommendation when creating notes for meetings is to ensure you're able to identify the meeting notes in the engagement by including unique information as the identifier whilst this functionality it currently unavailable. 

 

I hope this helps!

Matthew Willson

HubSpot Developer Support

View solution in original post

Reply
0 Upvotes
4 Replies 4
Highlighted
HubSpot Moderator

Hi @PaulAlmond91 

 

The best process here would indeed to store the notes as an actual Note on the Contacts Timeline. When referencing our Enagements API, you'll be then able to fetch these. 

 

An example Request URL would be:

https://api.hubapi.com/engagements/v1/engagements/enagement_id?hapikey={{hapikey}}

This would give us a response of:

 

{
    "engagement": {
        "id": engagement_id,
        "portalId": portal_id,
        "active": true,
        "createdAt": 1581332102578,
        "lastUpdated": 1581332103751,
        "createdBy": user_id,
        "modifiedBy": user_id,
        "ownerId": user_id,
        "type": "NOTE",
        "timestamp": 1581332102578,
        "teamId": team_id,
        "source": "CRM_UI",
        "sourceId": "user_id",
        "allAccessibleTeamIds": [
            team_id
        ],
        "bodyPreview": "Meetings notes stored as note engagement on the Timeline Activity.",
        "queueMembershipIds": [],
        "bodyPreviewIsTruncated": false,
        "bodyPreviewHtml": "<html>\n <head></head>\n <body>\n <p>Meetings notes stored as note engagement on the Timeline Activity.</p>\n </body>\n</html>",
        "gdprDeleted": false
    },
    "associations": {
        "contactIds": [
            contact_id
        ],
        "companyIds": [
            company_id
        ],
        "dealIds": [],
        "ownerIds": [],
        "workflowIds": [],
        "ticketIds": [],
        "contentIds": [],
        "quoteIds": []
    },
    "attachments": [],
    "metadata": {
        "body": "<p>Meetings notes stored as note engagement on the Timeline Activity.</p>"
    }
}

If you store them as comments in the Meeting itself, these cannot be referenced via the API as they are internal only. 

 

I hope this helps!

 

Matthew Willson

HubSpot Developer Support
Reply
0 Upvotes
Highlighted
Regular Contributor

Hi Matthew,

 

Thanks for the response.

How do I create a 1 - 1 correlation between the meeting and an outcome if the user creates the outcome as notes. This would create a note and a meeting engagement without any method of pairing surely?

Reply
0 Upvotes
Solution
HubSpot Moderator

Hi @PaulAlmond91 

 

As the comments added via a Meeting engagement cannot be fetched via the API, we use the Notes engagement instead to record these.

 

However, these engagements do not have any means of being directly associated by a relationship such as: Engagement - Engagement. 

 

To your point, you're correct. This does indeed create a note and a meeting engagement without any pairing method currently. Instead the recommendation when creating notes for meetings is to ensure you're able to identify the meeting notes in the engagement by including unique information as the identifier whilst this functionality it currently unavailable. 

 

I hope this helps!

Matthew Willson

HubSpot Developer Support

View solution in original post

Reply
0 Upvotes
Highlighted
Regular Contributor

Thanks for confirming Wilson.

Bit of a gap in the meetings activity really. We will pick this up with our customer success manager.

 

Thanks