Create an event

Important note: Shift-based schedules use the V3 API and are not compatible with V2 automations. To create automations for Shift-Based Schedules, you need to:

Update your automations to use the V3 API for all new shift-based schedules

Keep the V2 endpoint for your existing schedules

An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. Learn more.

Create a new event that defines when and how users are on-call within a rotation.

Constraints:

Maximum 5 events per rotation
Events within a rotation cannot overlap
effective_since must be in the future (past values are clamped to now)
All users referenced in assignment_strategy.members must exist and belong to the account

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Path Parameters

id*string

The ID of the schedule.

rotation_id*string

The ID of the rotation.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

event*

Response Body

`application/json`

curl -X POST "https://api.pagerduty.com/v3/schedules/PSJUKNI/rotations/AGO462IDT5ZMNFBVSROUDT6B4M/events" \  -H "Content-Type: application/json" \  -d '{    "event": {      "name": "Weekly On-Call",      "start_time": {        "date_time": "2025-03-03T09:00:00Z",        "time_zone": "America/New_York"      },      "end_time": {        "date_time": "2025-03-10T09:00:00Z",        "time_zone": "America/New_York"      },      "effective_since": "2025-03-03T00:00:00Z",      "recurrence": [        "RRULE:FREQ=WEEKLY"      ],      "assignment_strategy": {        "type": "rotating_member_assignment_strategy",        "shifts_per_member": 1,        "members": [          {            "type": "user_member",            "user_id": "PUSER123"          },          {            "type": "user_member",            "user_id": "PUSER456"          }        ]      }    }  }'

{  "event": {    "id": "ABCDEFGHIJKLMNOPQRSTUVWXY2",    "type": "schedule_event",    "name": "Weekly On-Call",    "start_time": {      "date_time": "2025-03-03T09:00:00Z",      "time_zone": "America/New_York"    },    "end_time": {      "date_time": "2025-03-03T09:00:00Z",      "time_zone": "America/New_York"    },    "effective_since": "2025-03-03T00:00:00Z",    "effective_until": "2025-09-01T00:00:00Z",    "recurrence": [      "RRULE:FREQ=WEEKLY"    ],    "assignment_strategy": {      "type": "rotating_member_assignment_strategy",      "shifts_per_member": 1,      "members": [        {          "type": "user_member",          "user_id": "PUSER123"        }      ]    },    "self": "http://example.com",    "html_url": "http://example.com"  }}

Create an event

Authorization

Path Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

500application/json

Developer Agreement

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`