Release Notes
May 31, 2022
We have made updates to Karbon's public API that impact 3 endpoints: WebhookSubscriptions, Notes, and Comments; and the Comment webhook.
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:
- (existing endpoint)JSONCopied!
WebhookSubscriptions - (enhanced theJSONCopied!
Notesmethod and addedJSONCopied!POSTmethod)JSONCopied!GET - (new endpoint withJSONCopied!
Commentsmethod)JSONCopied!GET - Introduced Webhook for JSONCopied!
Comment
WebhookSubscriptions
-
To subscribe to
andJSONCopied!Noteswebhooks, useJSONCopied!CommentsasJSONCopied!WebhookTypeinstead ofJSONCopied!Note:JSONCopied!ContentItemJSONCopied!/v3/WebhookSubscriptions/Note -
method will require aJSONCopied!
GET(JSONCopied!WebhookType,JSONCopied!ContactorJSONCopied!Work) to retrieve information. Providing noJSONCopied!Notewill throw a validation errorJSONCopied!WebhookType -
Likewise for
method, a properJSONCopied!POSTwill be required and blanks will not be accepted (prompting a validation error)JSONCopied!WebhookType
Notes
-
The existing
method in this endpoint has been enhanced to createJSONCopied!POSTonJSONCopied!Notes,JSONCopied!Contactsor both togetherJSONCopied!WorkItem -
method has been introduced to retrieve aJSONCopied!
GETalong with itsJSONCopied!NoteandJSONCopied!Comments:JSONCopied!TimelinesJSONCopied!/v3/Notes/{NoteKey}
Comments
-
A new endpoint with
method has been introduced to retrieve individualJSONCopied!GET:JSONCopied!CommentsJSONCopied!/v3/Comments/{CommentKey}
Webhook for Comments
Webhook for
JSONCopied!
CommentsJSONCopied!
WebhookTypeJSONCopied!
NoteIf you have already subscribed for
JSONCopied!
NoteJSONCopied!
CommentJSONCopied!
CommentsJSONCopied!
NotesJSONCopied!
/v3/WebhookSubscriptions/Note
