Availability
Hotpot uses availability records to determine when someone doesn't want to be on-call, can't be on-call, or wants to take the pager. This API endpoint is currently under development.
Last updated
Hotpot uses availability records to determine when someone doesn't want to be on-call, can't be on-call, or wants to take the pager. This API endpoint is currently under development.
Last updated
© 2024 Oilcan, Inc. All rights reserved.
POST
https://app.hotpot.works/api/availabilities/upload
Heads up! This uses a different URL because of the file uploads. These requests will not work against api.hotpot.works
!
If you have employee time off managed in an external system and want to sync that data into Hotpot but only have batch systems, export the data as a CSV and import it into Hotpot with this endpoint.
The CSV file has a flexible format, but it must include headers.
The email
and start_time
columns are the only required columns. If no end_time
is specified, Hotpot will enter unavailability for 1 day. If the email
is not found in Hotpot, the entire run will fail. You can pass in an optional name
column to name the availability as well.
The initial run will give you a report of what would be created. You have to pass in commit=save
as parameter values to save the values to the database.
Headers
Name | Value |
---|---|
Parameters
Name | Type | Description |
---|---|---|
Response
With commit=save
provided, it will save the records:
Content-Type
application/x-www-form-urlencoded
Authorization
Bearer <token>
commit
string
Pass in save
to save the uploaded availability records