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 /v3/Users/ 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

1. GET User by UserId

2. POST Webhook Subscription for WebhookType User

GET Users by UserId

Endpoint: https://api.karbonhq.com/v3/Users/{UserId}

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

See an example of the Users by UserId endpoint in our API documentation

POST WebhookSubscription for WebhookType User

Endpoint: https://api.karbonhq.com/v3/WebhookSubscription

When successfully called with a JSON payload including your TargetUrl and WebhookType of User, this API will return a status code of 201 and JSON payload confirming the TargetUrl and WebhookType supplied in the initial request.

Additional information about the WebhookSubscriptions 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:

POST https://api.karbonhq.com/v3/WebhookSubscriptions

Payload:

{
"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 POST request will be made to the TargetUrl with the payload:

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