July 24, 2023

This document provides an overview of the July 24, 2023 Karbon API release.

We have added an API endpoint that expands on the

endpoint, making it possible to retrieve more information about a user.

It is also possible to subscribe to a new User Webhook Subscription type, to receive information about a user.

1. JSONCopyCopied!

   GET User by UserId
2. JSONCopyCopied!

   POST Webhook Subscription for WebhookType User

---

JSONCopyCopied!

GET Users by UserId

Endpoint:

When used with

method, this end point returns information about a user, including their Permissions, Roles, Teams and billable Capacity.

See an example of the

by endpoint in our API documentation.

---

JSONCopyCopied!

POST WebhookSubscription for WebhookType User

Endpoint:

When successfully called with a JSON payload including your

and of , this API will return a status code of 201 and JSON payload confirming the and supplied in the initial request.

Additional information about the

API can be found in our API documentation.

Example use case

You want to retrieve a notification when a user invited to Karbon has accepted their invite:

Payload:

JSONCopyCopied!
{
  "TargetUrl": "https://example.com/",
  "WebhookType": "User"
}

This will create a Webhook Subscription that will be triggered for each new user that accepts an invitation to join Karbon. When triggered, a

request will be made to the with the payload:

JSONCopyCopied!
{
  "ResourcePermaKey": "{UserId}",
  "ResourceType": "User",
  "ActionType": "InviteAccepted"
}