Home

May 10, 2022

High level summary

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

In summary, the API changes impact 1 endpoint and have introduced 2 webhooks:

  1. WebhookSubscriptions (existing endpoints)
  2. Introduced Webhooks for WorkItems and Notes

WebhookSubscriptions (existing)

  • GET endpoint /v3/WebhookSubscriptions will by default search for contact webhook subscription for a tenant
  • GET endpoint /v3/WebhookSubscriptions/Work will search for WorkItem webhook subscription for a tenant
  • GET endpoint /v3/WebhookSubscriptions/ContentItem will search for Notes webhook subscription for a tenant
  • POST endpoint /v3/WebhookSubscriptions will by default create Contact webhook subscription for a tenant
  • POST endpoint /v3/WebhookSubscriptions/Work will create WorkItem webhook subscription for a tenant
  • POST endpoint /v3/WebhookSubscriptions/ContentItem will create Note webhook subscription for a tenant
  • DELETE endpoint /v3/WebhookSubscriptions will by default delete Contact webhook subscription for a tenant
  • DELETE endpoint /v3/WebhookSubscriptions/Work will delete WorkItem webhook subscription for a tenant
  • DELETE endpoint /v3/WebhookSubscriptions/ContentItem will delete Note webhook subscription for a tenant