Using the Check-ins API
Create check-ins remotely with the Check-ins API
Last updated
Was this helpful?
Create check-ins remotely with the Check-ins API
Last updated
Was this helpful?
You can create check-ins using a special URL to which you send a JSON payload with the corresponding data.
For a full public API, please refer to
Remote check-ins can be enabled separately for each outcome in your workspace.
Open up your outcome panel
Click on the Check-ins API in the outcome panel menu
Enable the remote check-ins options and you'll be able to copy the remote check-ins URL
Before creating your new check-in, Tability will need a way to know that it's you.
Open up a new window, and go to where you'll find your Personal API Token.
Keep that window open as we'll need to copy that value later.
Now you can use this URL to post a new check-in with a simple HTTP POST request that will look like this:
The remote_checkins_token value should be the same as the one in Tability, and the personal_api_token value should be the same as your Personal API Token.
That's it! If you refresh your outcome panel you should see a new value on the graph. You'll notice that Tability automatically picks a color based on the score, but this is something that you can change as we'll see below.
By default, Tability will pick the confidence based on the estimated progress.
Green if the progress is above 70% of the projected growth.
Yellow if the progress is between 50% and 70% of the projected growth.
Red if the progress is below 50% of the projected growth.
You can set your own confidence in the POST request by adding the confidence parameter to the request:
There might be times when you'll want the new value to be added to the previous check-in. For instance, you're recording the total number of calls made, and you want to add 5 calls this week to the previous 30 calls recorded.
You can do that simply by adding the parameter score_type and setting its value to "increment":
You can use a negative value for the score if you need to decrease the total value instead.
