Create an on-call calendar event

Better Stack Team
Updated on September 9, 2024

Create a new event in the given on-call calendar.

POST https://uptime.betterstack.com/api/v2/on-calls/{calendar_id}/events

URL parameters

calendar_id
required string

The ID of the on-call calendar you want to create the event for. Use default to refer to the default on-call calendar for the team.

Headers

Authorization
required string

Bearer $TOKEN

Body parameters

starts_at
required date

Start time of the event

ends_at
required date

End time of the event

users
required array

List of email addresses of the users that will be on-call during this event

200

Event was created

Response body

{
  "id": 12345678,
  "starts_at": "2025-01-01T09:00:00Z",
  "ends_at": "2025-01-01T17:00:00",
  "users": [
    "[email protected]"
  ]
}

Example cURL

Example
curl --request POST \
  --url "https://uptime.betterstack.com/api/v2/on-calls/default/events" \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"starts_at":"2025-01-01T09:00:00Z","ends_at":"2025-01-01T17:00:00","users":["[email protected]"]}'
Got an article suggestion? Let us know
Licensed under CC-BY-NC-SA

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Make your mark

Join the writer's program

Are you a developer and love writing and sharing your knowledge with the world? Join our guest writing program and get paid for writing amazing technical guides. We'll get them to the right readers that will appreciate them.

Write for us
Writer of the month
Marin Bezhanov
Marin is a software engineer and architect with a broad range of experience working...
Build on top of Better Stack

Write a script, app or project on top of Better Stack and share it with the world. Make a public repository and share it with us at our email.

[email protected]

or submit a pull request and help us build better products for everyone.

See the full list of amazing projects on github