topic Re: Accessing Comments in Engagements API in APIs & Integrations

Accessing Comments in Engagements API

PaulAlmond91 — Mon, 10 Feb 2020 09:29:50 GMT

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

Re: Accessing Comments in Engagements API

Willson — Mon, 10 Feb 2020 10:58:35 GMT

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!

Re: Accessing Comments in Engagements API

PaulAlmond91 — Mon, 10 Feb 2020 13:27:59 GMT

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?

Re: Accessing Comments in Engagements API

Willson — Tue, 11 Feb 2020 09:28:29 GMT

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!

Re: Accessing Comments in Engagements API

PaulAlmond91 — Tue, 11 Feb 2020 09:38:40 GMT

Thanks for confirming Wilson.

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

Thanks

Re: Accessing Comments in Engagements API

renansantos — Fri, 26 Mar 2021 13:04:20 GMT

Hi@Willson ,

Do you know if there is a forecast for this implementation?
I really need to access the engagements comments via API.

Thanks

Re: Accessing Comments in Engagements API

ALitvinenko — Wed, 04 May 2022 18:15:15 GMT

Hello! Are there any changes to this? Where is this on the roadmap?

thanks,

Anton

Re: Accessing Comments in Engagements API

ahaack — Sat, 03 Sep 2022 12:07:51 GMT

Willson,

I am surprised that your response is shown as 'Accepted Solution', as this is neither a solution, nor a usable workaround.

Imagine that every sales team member has around 10-15 daily meetings, automatically planned and generated through google calendar integration.

For your described workaround, you would need to train the sales team to consistently do the following additional steps for each and every meeting they have:

1. Go into the meeting description and manually add a manually generated unique identifier, for example a sequential number. As it would need to be unique, they would need to coordinate with other team members for an available number range.

As the number or unique identifier would need to be stored in the description, it would also be visible to external customers, which would surely not be preferrable.

2. After the meeting, remember to NOT use the meeting comments to store meeting comments, but enter them into manually created notes instead.

3. Retrieve the unique identifier from the meeting description and place it into the manually created note in a standardized format, so that it could be used for reporting later.

Now think yourself how well this process would work.

Can we please have a statement from your development team when they will add this functionality to the API, as right now, our data is held hostage by hubspot.

Thanks for your help,

Andy