Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started with monitoring
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started with on-call
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced on-call setup
  5. Incidents
    1. Working with incidents
    2. Create incidents manually
    3. Post mortems
    4. Incident silencing
    5. Incident metadata
  6. Status pages
    1. Get started with status pages
    2. Working with status pages
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
    4. Migrating to pay as you go
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
    3. Heartbeats
    4. Heartbeat groups
  11. On-call & Incidents API
    1. On-call calendar
    2. On-call calendar events
      1. List on-call calendar events GET
      2. Get on-call calendar event GET
      3. Create on-call calendar event POST
      4. Update on-call calendar event PATCH
      5. Delete on-call calendar event DELETE
      6. Bulk update on-call calendar events PUT
      7. On-call calendar events API response params
    3. Escalation policies
    4. Escalation policy groups
    5. Severities
    6. Severity groups
    7. Incidents
    8. Comments
  12. Integrations API
    1. New Relic Integrations
    2. Datadog Integrations
    3. AWS CloudWatch Integrations
    4. Azure Integrations
    5. Google Monitoring Integrations
    6. Grafana Integrations
    7. Prometheus Integrations
    8. Email integrations
    9. Incoming webhooks
    10. Slack Integrations
    11. Splunk On-Call integrations
    12. PagerDuty Integrations
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
    4. Status page reports
    5. Status page report updates
  14. Other API
    1. Metadata

Create an on-call calendar event

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. Must be today at 0:00 UTC or later.

ends_at
required date

End time of the event

users
required array

List of email addresses of 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": [
    "tomas@betterstack.com"
  ]
}

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":["tomas@betterstack.com"]}'

Previous article

Get a single on-call calendar event

Next article

Update a single on-call calendar event