Home

May 31, 2022

High level summary

This document outlines the changes to Karbon’s public API as a result of the Karbon release on May 31, 2022.

In summary, the API changes impact 3 endpoints and a webhook:

  1. WebhookSubscriptions (existing endpoint)
  2. Notes (enhanced the POST method and added GET method)
  3. Comments (new endpoint with GET method)
  4. Introduced Webhook for Comment

WebhookSubscriptions

  • To subscribe to Notes and Comments webhooks, use WebhookType as Note instead of ContentItem:

    /v3/WebhookSubscriptions/Note

  • GET method will require a WebhookType (Contact, Work or Note ) to retrieve information. Providing no WebhookType will throw a validation error

  • Likewise for POST method, a proper WebhookType will be required and blanks will not be accepted (prompting a validation error)

Notes

  • The existing POST method in this endpoint has been enhanced to create Notes on Contacts, WorkItem or both together

  • GET method has been introduced to retrieve a Note along with its Comments and Timelines:

    /v3/Notes/{NoteKey}

Comments

  • A new endpoint with GET method has been introduced to retrieve individual Comments:

    /v3/Comments/{CommentKey}

Webhook for Comments

Webhook for Comments can be subscribed to using WebhookType as Note as mentioned above.

If you have already subscribed for Note webhook, then no separate subscription for Comment is required. If you are subscribing for Comments or Notes for the first time, then please use the following endpoint for it as mentioned earlier:

/v3/WebhookSubscriptions/Note